VideoFrame

Missing API Documentation

This API Class does not have any or complete API documentation. Please add API documentation if possible.

VideoFrame
Icon
Legacy IconsThese icon(s) are only a part of legacy Roblox Studio versions, or are unused as of the studio icons update.
Category	GUI
Added in	414 (January 2020)
Memory category	Gui
Inheritance
Object Instance GuiBase GuiBase2d GuiObject VideoFrame

The VideoFrame class inherits from GuiObject. It can be used to display videos in-game. This class was added in version 414.

Properties

IsLoaded: bool

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:VideoFrame/IsLoaded.

• Category: Video.
• Serialization: cannot load or save.
• Thread safety: read safe

Looped: bool

This class member is missing documentation. Create or add to its subpage at Class:VideoFrame/Looped.

• Category: Video.
• Serialization: can save and load.
• Thread safety: read safe

Playing: bool

• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:VideoFrame/Playing.

• Category: Video.
• Serialization: can save and load.
• Thread safety: read safe

Resolution: Vector2

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:VideoFrame/Resolution.

• Category: Video.
• Serialization: cannot load or save.
• Thread safety: read safe

TimeLength: double

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:VideoFrame/TimeLength.

• Category: Video.
• Serialization: cannot load or save.
• Thread safety: read safe

TimePosition: double

• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:VideoFrame/TimePosition.

• Category: Video.
• Serialization: can save and load.
• Thread safety: read safe

Video: ContentId

This class member is missing documentation. Create or add to its subpage at Class:VideoFrame/Video.

• Category: Video.
• Serialization: can save and load.
• Thread safety: read safe

VideoContent: Content

• HiddenThis property is not shown in the object browser and properties window.

This class member is missing documentation. Create or add to its subpage at Class:VideoFrame/VideoContent.

• Category: Video.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

Volume: float

This class member is missing documentation. Create or add to its subpage at Class:VideoFrame/Volume.

• Category: Video.
• Serialization: can save and load.
• Thread safety: read safe

Methods

Pause(): null

This class member is missing documentation. Create or add to its subpage at Class:VideoFrame/Pause.

• Thread safety: unsafe

Play(): null

This class member is missing documentation. Create or add to its subpage at Class:VideoFrame/Play.

• Thread safety: unsafe

SetStudioPreview(isPreview: bool): null

This class member is missing documentation. Create or add to its subpage at Class:VideoFrame/SetStudioPreview.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Events

DidLoop(video: string)

Parameters

Name	Type
video	string

• Thread safety: unsafe

Ended(video: string)

Parameters

Name	Type
video	string

• Thread safety: unsafe

Loaded(video: string)

Parameters

Name	Type
video	string

• Thread safety: unsafe

Paused(video: string)

Parameters

Name	Type
video	string

• Thread safety: unsafe

Played(video: string)

Parameters

Name	Type
video	string

• Thread safety: unsafe

Removed members

Methods

• GetInfo

External links

• VideoFrame in the Roblox Creator Documentation
• VideoFrame in the Roblox API Reference