VideoPlayer

By default, VideoContent does not load while in Studio Edit mode and shows no output when wired to VideoDisplay to reduce studio memory usage. Toggle this option to load VideoContent while in Studio Edit mode.

Plays the VideoContent while in Studio Edit mode. AutoLoadInStudio must be on for this option to show.

This property is true when the VideoContent has loaded and is ready to play.

Denotes whether this VideoPlayer is currently playing. This property is read-only, but replicates. To play and pause a VideoPlayer at runtime, use the Play() and Pause() methods.

Controls whether this VideoPlayer loops after reaching the end of its TimeLength.

The maximum resolution, as an VideoSampleSize value, that the video decoder produces when playing this VideoPlayer. Defaults to VideoSampleSize.Full, which doesn't limit the decoded resolution. Lower VideoSampleSize values reduce the resolution the decoder outputs, which can lower memory usage on constrained devices.

Multiplier that controls how quickly the video plays, directly controlling the perceived pitch of the audio track. Ranges from 0 to 1.

This property gets the original source resolution of the VideoContent file.

This property indicates the length of the VideoContent in seconds. If the video is not loaded, this value is 0.

This property indicates the progress in seconds of the VideoContent. It can be changed to move the playback position of the video both before and during playback.

The content ID of the video file a VideoPlayer object is associated with. To save resources and improve performance, call the Unload() method to unload the VideoContent when the VideoPlayer is not visible or in use.

Volume level, which is multiplied onto the output audio stream, controlling how loudly the audio track plays. Ranges from 0 to 3.

Returns an array of Wires that are connected to the specified pin. VideoPlayer has one "Output" pin.

Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.

For VideoPlayer, there are none.

Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.

For VideoPlayer, this is Output only.

VideoContent is typically only loaded when Play() is called, causing some buffering delay. This function can preload VideoContent so that it can be immediately played when Play() is called. Loading videos can consume a significant amount of device memory.

Pauses the VideoPlayer wherever its TimePosition is. Replicates from server to client.

Plays the VideoPlayer from wherever its TimePosition is. Replicates from server to client. To save resources and improve performance, call the Unload() method to unload the VideoContent when the VideoPlayer is not visible or in use.

Unloads the VideoContent to save resources. After calling this method, the IsLoaded property is false, and the TimePosition resets to 0. To play the video again, the LoadAsync() or Play() method must be called to reload the video.

Fires after the VideoPlayer has completed playback and stopped. Note this event does not fire for videos with Looped set to true since it continues playing upon reaching its end. This event also does not fire when the video is stopped before playback has completed; for this, use VideoPlayer:GetPropertyChangedSignal() on the IsPlaying property.

Event that fires after the VideoPlayer loops. This happens when the video reaches the end of its content. This event does not fire if the video is looped manually by changing its TimePosition.

Fires when the VideoPlayer fails to load or play its VideoContent. The error parameter is an AssetFetchStatus value that describes why the content couldn't be fetched.

Event that fires after a Wire becomes connected or disconnected, and that Wire is now or was previously connected to a pin on the VideoPlayer and to some other wirable instance.