video
The video namespace — the engine's Luau API reference for video.
The video namespace — 9 functions.
globals/video/create
globals/video/create(url: string, options: VideoOptions?) -> string
Create a video player. Returns a texture handle (e.g.
"video_0") usable directly in material.setTexture() — its
frames sample like any other texture.
globals/video/destroy
globals/video/destroy(handle: string) -> boolean
Destroy a video player and free the render target and all resources.
globals/video/getInfo
globals/video/getInfo(handle: string) -> VideoInfo?
Get video information and current playback state.
globals/video/pause
globals/video/pause(handle: string) -> boolean
Pause video playback. Can be resumed with video.play.
globals/video/play
globals/video/play(handle: string) -> boolean
Start or resume video playback.
globals/video/seek
globals/video/seek(handle: string, time: number) -> boolean
Seek to a specific time (seconds) in the video.
globals/video/setLoop
globals/video/setLoop(handle: string, loop: boolean) -> boolean
Enable or disable looping.
globals/video/setRate
globals/video/setRate(handle: string, rate: number) -> boolean
Set the playback speed multiplier. 1.0 = normal, 2.0 = double speed, 0.5 = half speed.
globals/video/stop
globals/video/stop(handle: string) -> boolean
Stop video playback and reset to the beginning.