VideoPlayer¶
Not yet Class NotBrowsable
Used to play video assets.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
0 Nova members · 27 modern Roblox members not implemented yet
Description¶
An instance for playing video assets. It can be connected to a VideoDisplay via a Wire to show the video and can be connected to audio instances via a Wire to play the audio track.
Inheritance¶
Object → Instance → VideoPlayer
Properties¶
| Member | Signature | Summary |
|---|---|---|
AutoLoadInStudio |
AutoLoadInStudio: bool |
Loads the VideoContent while in Studio Edit mode. |
AutoPlayInStudio |
AutoPlayInStudio: bool |
Plays the VideoContent while in Studio Edit mode. |
InternalVideoUsage |
InternalVideoUsage: InternalVideoUsage |
— |
IsLoaded |
IsLoaded: bool |
Indicates when the VideoContent has loaded and is ready to play. |
IsPlaying |
IsPlaying: bool |
Denotes whether this VideoPlayer is currently playing. |
Looping |
Looping: bool |
Controls whether this VideoPlayer loops. |
MaximumResolution |
MaximumResolution: VideoSampleSize |
Caps the resolution of decoded video frames for this VideoPlayer. |
PlaybackSpeed |
PlaybackSpeed: float |
Controls the speed at which the video is played. |
PlayingReplicating |
PlayingReplicating: bool |
— |
Resolution |
Resolution: Vector2 |
Gets the original source resolution of the VideoContent file. |
TimeLength |
TimeLength: double |
Indicates the length of the VideoContent in seconds. |
TimePosition |
TimePosition: double |
Indicates the progress in seconds of the VideoContent. |
VideoContent |
VideoContent: Content |
The asset to be loaded into the VideoPlayer. |
Volume |
Volume: float |
Controls how loudly the audio track will be played. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
GetConnectedWires |
VideoPlayer:GetConnectedWires(pin: string): Instances |
Returns an array of Wires that are connected to the specified pin. |
GetInputPins |
VideoPlayer:GetInputPins(): Array |
Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its [Wire.TargetInstance](Wire.md#targetinsta… |
GetOutputPins |
VideoPlayer:GetOutputPins(): Array |
Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its [Wire.SourceInstance](Wire.md#sourceinsta… |
LoadAsync |
VideoPlayer:LoadAsync(): AssetFetchStatus |
Loads the VideoContent before it is played. |
Pause |
VideoPlayer:Pause(): null |
Pauses the VideoPlayer wherever its TimePosition is. |
Play |
VideoPlayer:Play(): null |
Plays the VideoPlayer from wherever its TimePosition is. |
SetStudioPreview |
VideoPlayer:SetStudioPreview(isPreview: bool): null |
— |
Unload |
VideoPlayer:Unload(): null |
Unloads the VideoPlayer.VideoContent to save resources. |
Events¶
| Member | Signature | Summary |
|---|---|---|
DidEnd |
DidEnd() |
Fires when the VideoContent has completed playback and stopped. |
DidLoop |
DidLoop() |
Fires when the VideoContent loops. |
PlayFailed |
PlayFailed(error: AssetFetchStatus) |
Fires when the VideoPlayer fails to load or play its VideoContent. |
WiringChanged |
WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance) |
Fires when another instance is connected to or disconnected from the VideoPlayer via a Wire. |
Roblox reference: VideoPlayer
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.