Reference API Roblox

Engine API

Website

Related

Reference API Roblox

VideoFrame

A GUI object that renders a rectangle, like a Frame does, with a moving video image.

Memory categoryGui

Member index 22

HistoryMember
726IsLoaded: bool
726Looped: bool
726Playing: bool
726Resolution: Vector2
726RollOffMaxDistance: float
726RollOffMinDistance: float
726RollOffMode: RollOffMode
726TimeLength: double
726TimePosition: double
645Video: ContentId
726VideoContent: Content
726Volume: float
573Pause(): null
573Play(): null
607SetStudioPreview(isPreview: bool): null
462DidLoop(video: string)
462Ended(video: string)
462Loaded(video: string)
462Paused(video: string)
462Played(video: string)
inherited from GuiObject
726Active: bool
726AnchorPoint: Vector2
726AutomaticSize: AutomaticSize
726BackgroundColor3: Color3
726BackgroundTransparency: float
726BorderColor3: Color3
726BorderMode: BorderMode
726BorderSizePixel: int
726ClipsDescendants: bool
726Draggable: bool
726GuiState: GuiState
726InputSink: InputSink
726Interactable: bool
726LayoutOrder: int
726NextSelectionDown: GuiObject
726NextSelectionLeft: GuiObject
726NextSelectionRight: GuiObject
726NextSelectionUp: GuiObject
726Position: UDim2
726Rotation: float
726Selectable: bool
726SelectionImageObject: GuiObject
726SelectionOrder: int
726Size: UDim2
726SizeConstraint: SizeConstraint
726Visible: bool
726ZIndex: int
462TweenPosition(endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
713TweenPositionInternal(endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462TweenSize(endSize: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462TweenSizeAndPosition(endSize: UDim2, endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
713TweenSizeAndPositionInternal(endSize: UDim2, endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
713TweenSizeInternal(endSize: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462DragBegin(initialPosition: UDim2)
462DragStopped(x: int, y: int)
483InputBegan(input: InputObject)
483InputChanged(input: InputObject)
483InputEnded(input: InputObject)
462MouseEnter(x: int, y: int)
462MouseLeave(x: int, y: int)
462MouseMoved(x: int, y: int)
462MouseWheelBackward(x: int, y: int)
462MouseWheelForward(x: int, y: int)
462SelectionGained()
462SelectionLost()
462TouchLongPress(touchPositions: Array, state: UserInputState)
462TouchPan(touchPositions: Array, totalTranslation: Vector2, velocity: Vector2, state: UserInputState)
462TouchPinch(touchPositions: Array, scale: float, velocity: float, state: UserInputState)
462TouchRotate(touchPositions: Array, rotation: float, velocity: float, state: UserInputState)
462TouchSwipe(swipeDirection: SwipeDirection, numberOfTouches: int)
462TouchTap(touchPositions: Array)
inherited from GuiBase2d
726AbsolutePosition: Vector2
726AbsoluteRotation: float
726AbsoluteSize: Vector2
726AutoLocalize: bool
726RootLocalizationTable: LocalizationTable
726SelectionBehaviorDown: SelectionBehavior
726SelectionBehaviorLeft: SelectionBehavior
726SelectionBehaviorRight: SelectionBehavior
726SelectionBehaviorUp: SelectionBehavior
726SelectionGroup: bool
525SelectionChanged(amISelected: bool, previousSelection: GuiObject, newSelection: GuiObject)
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: 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
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(className: string): bool
647Changed(property: string)

Removed member index 5

HistoryMember
438GetInfo(): Dictionary

Description

A VideoFrame renders a rectangle, like a Frame does, with a moving video image. The video must be from a file uploaded to the Roblox website.

The video is scaled to fit the entirety of the rectangle, but looks best when displayed at its native resolution.

2D and 3D Sound

A VideoFrame placed underneath SurfaceGui on a BasePart will emit its sound from that part's BasePart.Position.

A VideoFrame exhibits the Doppler effect, meaning its frequency and pitch varies with the relative motion of whatever part it is attached to.

The volume of the VideoFrame will be determined by the distance between the client's sound listener (by default the Camera position) and the position of the VideoFrame's part.

A VideoFrame is considered "global" if it is not placed underneath SurfaceGui on a BasePart. In this case, the sound will play at the same volume throughout the entire place.

History 84

Members 22

DidLoop

Parameters (1)
videostring

An event that fires whenever the VideoFrame.Video loops. Returns the content ID of the video.

Thread safetyUnsafe

History 2

Ended

Parameters (1)
videostring

This event fires when the VideoFrame.Video has completed playback and stopped.

Thread safetyUnsafe

History 2

IsLoaded

TypeDefault
bool

This property will be true when the VideoFrame.Video has loaded from Roblox servers and is ready to play.

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
CategoryVideo
Loaded/Savedfalse

History 5

Tags: [ReadOnly, NotReplicated]

Loaded

Parameters (1)
videostring

This event fires when the VideoFrame.Video is loaded.

Thread safetyUnsafe

History 2

Looped

TypeDefault
bool

This property sets whether or not the VideoFrame.Video repeats once it has finished when it is playing.

Thread safetyReadSafe
CategoryVideo
Loaded/Savedtrue

History 5

Pause

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

Sets VideoFrame.Playing to false, pausing playback if the VideoFrame.Video is playing.

As VideoFrame.TimePosition is not reset, when the video is resumed it will continue from its previous position.

Thread safetyUnsafe

History 3

Paused

Parameters (1)
videostring

This event fires whenever the VideoFrame.Video is paused using VideoFrame:Pause() or by setting VideoFrame.Playing to false.

Thread safetyUnsafe

History 2

Play

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

Sets VideoFrame.Playing to true, playing the VideoFrame.Video from the current VideoFrame.TimePosition. To save resources and improve performance, set the VideoFrame.Video property to "" when the VideoFrame is not visible or in use.

Thread safetyUnsafe

History 3

Played

Parameters (1)
videostring

This event fires whenever the VideoFrame.Video is played using the VideoFrame:Play() function or by setting VideoFrame.Playing to true.

Thread safetyUnsafe

History 2

Playing

TypeDefault
bool

This property indicates whether the VideoFrame.Video is currently playing. It can be set to start or pause playback as an alternative to the VideoFrame:Play() and VideoFrame:Pause() functions.

This property is not replicated. Its interface does not cross the network boundary.
Thread safetyReadSafe
CategoryVideo
Loaded/Savedtrue

History 5

Tags: [NotReplicated]

Resolution

TypeDefault
Vector2

This property gets the original source resolution of the VideoFrame.Video file.

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
CategoryVideo
Loaded/Savedfalse

History 5

Tags: [ReadOnly, NotReplicated]

RollOffMaxDistance

TypeDefault
float
Thread safetyReadSafe
CategoryVideo
Loaded/Savedtrue

History 2

RollOffMinDistance

TypeDefault
float
Thread safetyReadSafe
CategoryVideo
Loaded/Savedtrue

History 2

RollOffMode

TypeDefault
RollOffMode
Thread safetyReadSafe
CategoryVideo
Loaded/Savedtrue

History 2

SetStudioPreview

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

History 1

TimeLength

TypeDefault
double

This property indicates the length of the VideoFrame.Video in seconds. If the video is not loaded, this value will be 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
CategoryVideo
Loaded/Savedfalse

History 5

Tags: [ReadOnly, NotReplicated]

TimePosition

TypeDefault
double

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

This property is not replicated. Its interface does not cross the network boundary.
Thread safetyReadSafe
CategoryVideo
Loaded/Savedtrue

History 5

Tags: [NotReplicated]

Video

TypeDefault
ContentId

The content ID of the video file a VideoFrame object is associated with. To save resources and improve performance, set this property to "" when the VideoFrame is not visible or in use.

Thread safetyReadSafe
CategoryVideo
Loaded/Savedtrue

History 4

VideoContent

TypeDefault
Content
Thread safetyReadSafe
CategoryVideo
Loaded/Savedtrue

History 5

Volume

TypeDefault
float

This property determines how loud the VideoFrame.Video plays back. It can be set to a number between 0 and 100.

Thread safetyReadSafe
CategoryVideo
Loaded/Savedtrue

History 5

Removed members 5

GetInfo

Parameters (0)
No parameters.
Returns (1)
Dictionary

History 2

Settings