Skip to content

VideoFrame ​

Plays a video. Maps to Roblox VideoFrame.

luau
PeanutUI.VideoFrame {
    video = "rbxassetid://123456",
    playing = true,
}

Properties ​

In addition to the shared widget properties:

PropertyTypeDescription
videostringVideo asset.
playingbooleanWhether the video is playing.
loopedbooleanWhether the video loops.
volumenumberPlayback volume.
timePositionnumberCurrent playback position.
playbackSpeednumberPlayback speed.
imageColorColor3Tint color.
imageTransparencynumberTransparency.

Events ​

In addition to the shared widget events:

EventSignature
DidLoop(video: string) -> ...boolean?
Ended(video: string) -> ...boolean?
Loaded(video: string) -> ...boolean?
Paused(video: string) -> ...boolean?
Played(video: string) -> ...boolean?