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 20

HistoryMember
553IsLoaded: bool
553Looped: bool
553Playing: bool
553Resolution: Vector2
553TimeLength: double
553TimePosition: double
645Video: ContentId
553Volume: 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
553Active: bool
553AnchorPoint: Vector2
553AutomaticSize: AutomaticSize
553BackgroundColor3: Color3
553BackgroundTransparency: float
553BorderColor3: Color3
553BorderMode: BorderMode
553BorderSizePixel: int
553ClipsDescendants: bool
553Draggable: bool
588GuiState: GuiState
589Interactable: bool
553LayoutOrder: int
553NextSelectionDown: GuiObject
553NextSelectionLeft: GuiObject
553NextSelectionRight: GuiObject
553NextSelectionUp: GuiObject
553Position: UDim2
553Rotation: float
553Selectable: bool
553SelectionImageObject: GuiObject
553SelectionOrder: int
553Size: UDim2
553SizeConstraint: SizeConstraint
553Visible: bool
553ZIndex: int
462TweenPosition(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
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
553AbsolutePosition: Vector2
553AbsoluteRotation: float
553AbsoluteSize: Vector2
553AutoLocalize: bool
553RootLocalizationTable: LocalizationTable
553SelectionBehaviorDown: SelectionBehavior
553SelectionBehaviorLeft: SelectionBehavior
553SelectionBehaviorRight: SelectionBehavior
553SelectionBehaviorUp: SelectionBehavior
553SelectionGroup: bool
525SelectionChanged(amISelected: bool, previousSelection: GuiObject, newSelection: GuiObject)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): 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()
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 1

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 56

Members 20

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
boolfalse

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 4

Tags: [ReadOnly, NotReplicated]

Loaded

Parameters (1)
videostring

This event fires when the VideoFrame.Video is loaded.

Thread safetyUnsafe

History 2

Looped

TypeDefault
boolfalse

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

Thread safetyReadSafe
CategoryVideo
Loaded/Savedtrue

History 4

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, This plays the VideoFrame.Video, continuing from the current VideoFrame.TimePosition.

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
boolfalse

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 4

Tags: [NotReplicated]

Resolution

TypeDefault
Vector20, 0

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 4

Tags: [ReadOnly, NotReplicated]

SetStudioPreview

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

History 1

TimeLength

TypeDefault
double0

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 4

Tags: [ReadOnly, NotReplicated]

TimePosition

TypeDefault
double0

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 4

Tags: [NotReplicated]

Video

TypeDefault
ContentId

The content ID of the video file a VideoFrame object is associated with.

Thread safetyReadSafe
CategoryVideo
Loaded/Savedtrue

History 4

Volume

TypeDefault
float1

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 4

Removed members 1

GetInfo

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

History 2

Settings