Reference API Roblox

Engine API

Website

Related

Reference API Roblox

VideoPlayer

This class is not browsable. It is not visible in Studio's object browser.
Memory categoryInstances
Tags: [NotBrowsable]

Member index 24

HistoryMember
690AutoLoadInStudio: bool
690AutoPlayInStudio: bool
668IsLoaded: bool
668IsPlaying: bool
653Looping: bool
653PlaybackSpeed: float
653Resolution: Vector2
653TimeLength: double
653TimePosition: double
687VideoContent: Content
653Volume: float
653GetConnectedWires(pin: string): Instances
668GetInputPins(): Array
668GetOutputPins(): Array
668LoadAsync(): AssetFetchStatus
668Pause(): null
653Play(): null
653SetStudioPreview(isPreview: bool): null
668Unload(): null
661DidEnd()
661DidLoop()
668PlayFailed(error: AssetFetchStatus)
668WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
691GetPredictionMode(): PredictionMode
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
690IsPredicted(): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
690SetPredictionMode(mode: PredictionMode): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 7

HistoryMember
690Asset: ContentId
668AutoLoad: bool
668IsReady: bool
668Thumbnail: ContentId
668Stop(): null
661Ended()
661Looped()

Description

History 43

Members 24

AutoLoadInStudio

TypeDefault
boolfalse
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.
Write securityRobloxScriptSecurity
Thread safetyReadSafe
CategoryDebug
Loaded/Savedfalse

History 2

Tags: [NotReplicated, NotScriptable]

AutoPlayInStudio

TypeDefault
boolfalse
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.
Write securityRobloxScriptSecurity
Thread safetyReadSafe
CategoryDebug
Loaded/Savedfalse

History 2

Tags: [NotReplicated, NotScriptable]

DidEnd

Parameters (0)
No parameters.
Thread safetyUnsafe

History 1

DidLoop

Parameters (0)
No parameters.
Thread safetyUnsafe

History 1

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Instances
Thread safetyUnsafe

History 1

GetInputPins

Parameters (0)
No parameters.
Returns (1)
Array
Thread safetyUnsafe

History 1

GetOutputPins

Parameters (0)
No parameters.
Returns (1)
Array
Thread safetyUnsafe

History 1

IsLoaded

TypeDefault
boolfalse
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryAsset
Loaded/Savedfalse

History 1

Tags: [ReadOnly, NotReplicated]

IsPlaying

TypeDefault
boolfalse
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryPlayback
Loaded/Savedfalse

History 3

Tags: [ReadOnly, NotReplicated]

LoadAsync

Parameters (0)
No parameters.
Returns (1)
AssetFetchStatus
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

Looping

TypeDefault
boolfalse
Thread safetyReadSafe
CategoryPlayback
Loaded/Savedtrue

History 1

Pause

Parameters (0)
No parameters.
Returns (1)
null
Thread safetyUnsafe

History 1

Play

Parameters (0)
No parameters.
Returns (1)
null
Thread safetyUnsafe

History 1

PlayFailed

Parameters (1)
errorAssetFetchStatus
Thread safetyUnsafe

History 1

PlaybackSpeed

TypeDefault
float1
Thread safetyReadSafe
CategoryPlayback
Loaded/Savedtrue

History 1

Resolution

TypeDefault
Vector20, 0
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryAsset
Loaded/Savedfalse

History 1

Tags: [ReadOnly, NotReplicated]

SetStudioPreview

Parameters (1)
isPreviewbool
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

TimeLength

TypeDefault
double0
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryAsset
Loaded/Savedfalse

History 1

Tags: [ReadOnly, NotReplicated]

TimePosition

TypeDefault
double0
Thread safetyReadSafe
CategoryPlayback
Loaded/Savedtrue

History 1

Unload

Parameters (0)
No parameters.
Returns (1)
null
Thread safetyUnsafe

History 1

VideoContent

TypeDefault
Content
Thread safetyReadSafe
CategoryAsset
Loaded/Savedtrue

History 1

Volume

TypeDefault
float1
Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 1

WiringChanged

Parameters (4)
connectedbool
pinstring
wireWire
instanceInstance
Thread safetyUnsafe

History 1

Removed members 7

Asset

TypeDefault
ContentId
Thread safetyReadSafe
CategoryAsset
Loaded/Savedtrue

History 2

AutoLoad

TypeDefault
boolfalse
Thread safetyReadSafe
CategoryAsset
Loaded/Savedtrue

History 2

Ended

Parameters (0)
No parameters.
Thread safetyUnsafe

History 2

IsReady

TypeDefault
boolfalse
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryAsset
Loaded/Savedfalse

History 2

Tags: [ReadOnly, NotReplicated]

Looped

Parameters (0)
No parameters.
Thread safetyUnsafe

History 2

Stop

Parameters (0)
No parameters.
Returns (1)
null
Thread safetyUnsafe

History 2

Thumbnail

TypeDefault
ContentId
Thread safetyReadSafe
CategoryAsset
Loaded/Savedtrue

History 2

Settings