12 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

VideoPlayer

Inherits from: Instance → Object

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.

Inherits from: Instance

Memory category: Instances

Tags: NotBrowsable

Code samples: View on Creator Hub (video-player-server, video-player-client).

Properties

Name	Type / Returns	Description
VideoPlayer.AutoLoadInStudio	boolean	Loads the `VideoContent` while in Studio Edit mode.
VideoPlayer.AutoPlayInStudio	boolean	Plays the `VideoContent` while in Studio Edit mode.
VideoPlayer.IsLoaded	boolean	Indicates when the `VideoContent` has loaded and is ready to play.
VideoPlayer.IsPlaying	boolean	Denotes whether this `VideoPlayer` is currently playing.
VideoPlayer.Looping	boolean	Controls whether this `VideoPlayer` loops.
VideoPlayer.MaximumResolution	VideoSampleSize	Caps the resolution of decoded video frames for this `VideoPlayer`.
VideoPlayer.PlaybackSpeed	float	Controls the speed at which the video is played.
VideoPlayer.Resolution	Vector2	Gets the original source resolution of the `VideoContent` file.
VideoPlayer.TimeLength	double	Indicates the length of the `VideoContent` in seconds.
VideoPlayer.TimePosition	double	Indicates the progress in seconds of the `VideoContent`.
VideoPlayer.VideoContent	Content	The asset to be loaded into the `VideoPlayer`.
VideoPlayer.Volume	float	Controls how loudly the audio track will be played.

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

VideoPlayer.AutoLoadInStudio

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.

Field	Value
type	boolean
tags	["NotReplicated","NotScriptable"]
security	{"read":"None","write":"RobloxScriptSecurity"}
thread safety	ReadSafe
category	Debug
serialization	{"can_load":false,"can_save":false}
capabilities	["Audio","UI"]

VideoPlayer.AutoPlayInStudio

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

Field	Value
type	boolean
tags	["NotReplicated","NotScriptable"]
security	{"read":"None","write":"RobloxScriptSecurity"}
thread safety	ReadSafe
category	Debug
serialization	{"can_load":false,"can_save":false}
capabilities	["Audio","UI"]

VideoPlayer.IsLoaded

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

Field	Value
type	boolean
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Asset
serialization	{"can_load":false,"can_save":false}
capabilities	["Audio","UI"]

VideoPlayer.IsPlaying

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.

Field	Value
type	boolean
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Playback
serialization	{"can_load":false,"can_save":false}
capabilities	["Audio","UI"]

VideoPlayer.Looping

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

Field	Value
type	boolean
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Playback
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio","UI"]

VideoPlayer.MaximumResolution

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.

Field	Value
type	VideoSampleSize
tags	["Hidden"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Playback
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio","UI","InternalTest"]

VideoPlayer.PlaybackSpeed

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

Field	Value
type	float
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Playback
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio","UI"]

VideoPlayer.Resolution

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

Field	Value
type	Vector2
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Asset
serialization	{"can_load":false,"can_save":false}
capabilities	["Audio","UI"]

VideoPlayer.TimeLength

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

Field	Value
type	double
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Asset
serialization	{"can_load":false,"can_save":false}
capabilities	["Audio","UI"]

VideoPlayer.TimePosition

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.

Field	Value
type	double
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Playback
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio","UI"]

VideoPlayer.VideoContent

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.

Field	Value
type	Content
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Asset
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio","UI"]

VideoPlayer.Volume

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

Field	Value
type	float
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	State
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio","UI"]

Methods

Name	Type / Returns	Description
VideoPlayer:GetConnectedWires	List	Returns an array of `Wires` that are connected to the specified pin.
VideoPlayer:GetInputPins	Array	Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
VideoPlayer:GetOutputPins	Array	Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
VideoPlayer:LoadAsync	AssetFetchStatus	Loads the `VideoContent` before it is played.
VideoPlayer:Pause	()	Pauses the `VideoPlayer` wherever its `TimePosition` is.
VideoPlayer:Play	()	Plays the `VideoPlayer` from wherever its `TimePosition` is.
VideoPlayer:Unload	()	Unloads the `VideoPlayer.VideoContent` to save resources.

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

VideoPlayer:GetConnectedWires

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

Parameters

Name	Type	Default	Description
pin	string		An input or output pin on this instance

Returns

Type	Description
List	An array of `Wires`

Field	Value
security	None
thread safety	Unsafe
capabilities	["Audio","UI"]

VideoPlayer:GetInputPins

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.

Returns

Type	Description
Array	An array of strings representing valid pin names.

Field	Value
security	None
thread safety	Unsafe
capabilities	["Audio","UI"]

VideoPlayer:GetOutputPins

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.

Returns

Type	Description
Array	An array of strings representing valid pin names.

Field	Value
security	None
thread safety	Unsafe
capabilities	["Audio","UI"]

VideoPlayer:LoadAsync

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.

Returns

Type	Description
AssetFetchStatus	An `AssetFetchStatus` describing the outcome of the load — `AssetFetchStatus.Success` once the `VideoContent` has loaded, or a failure status such as `AssetFetchStatus.Failure` or `AssetFetchStatus.TimedOut` if it could not be fetched.

Field	Value
tags	["Yields"]
security	None
thread safety	Unsafe
capabilities	["Audio","UI"]

VideoPlayer:Pause

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

Returns

Type	Description
()

Field	Value
security	None
thread safety	Unsafe
capabilities	["Audio","UI"]

VideoPlayer:Play

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.

Returns

Type	Description
()

Field	Value
security	None
thread safety	Unsafe
capabilities	["Audio","UI"]

VideoPlayer:Unload

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.

Returns

Type	Description
()

Field	Value
security	None
thread safety	Unsafe
capabilities	["Audio","UI"]

Events

Name	Type / Returns	Description
VideoPlayer.DidEnd		Fires when the `VideoContent` has completed playback and stopped.
VideoPlayer.DidLoop		Fires when the `VideoContent` loops.
VideoPlayer.PlayFailed		Fires when the `VideoPlayer` fails to load or play its `VideoContent`.
VideoPlayer.WiringChanged		Fires when another instance is connected to or disconnected from the `VideoPlayer` via a `Wire`.

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.

VideoPlayer.DidEnd

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.

Field	Value
security	None
capabilities	["Audio","UI"]

VideoPlayer.DidLoop

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.

Field	Value
security	None
capabilities	["Audio","UI"]

VideoPlayer.PlayFailed

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.

Parameters

Name	Type	Default	Description
error	AssetFetchStatus		An `AssetFetchStatus` value describing why the `VideoContent` failed to load.

Field	Value
security	None
capabilities	["Audio","UI"]

VideoPlayer.WiringChanged

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.

Parameters

Name	Type	Description
connected	boolean	Whether the instance was connected or disconnected.
pin	string	The pin on the `VideoPlayer` that the `Wire` targets.
wire	Wire	The `Wire` between the `VideoPlayer` and the other instance.
instance	Instance	The other instance that is or was connected through the `Wire`.

Field	Value
security	None
capabilities	["Audio","UI"]