VideoFrame

Afficher les obsolètes

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.

Échantillons de code

Creating and Playing a Video

local screenPart = Instance.new("Part")
screenPart.Parent = workspace

local surfaceGui = Instance.new("SurfaceGui")
surfaceGui.Parent = screenPart

local videoFrame = Instance.new("VideoFrame")
videoFrame.Parent = surfaceGui

videoFrame.Looped = true
videoFrame.Video = "rbxassetid://" -- add an asset ID to this

while not videoFrame.IsLoaded do
	task.wait()
end

videoFrame:Play()

Résumé

Propriétés

IsLoaded:bool
lecture uniquement
non répliqué
lecture parallèle
Indicates when the VideoFrame.Video has loaded from Roblox servers and is ready to play.
Looped:bool
lecture parallèle
Sets whether or not the VideoFrame.Video repeats once it has finished when it is playing.
Playing:bool
non répliqué
lecture parallèle
Indicates whether the VideoFrame.Video is currently playing. It can be set to start or pause playback.
Resolution:Vector2
lecture uniquement
non répliqué
lecture parallèle
Gets the original source resolution of the VideoFrame.Video file.
TimeLength:number
lecture uniquement
non répliqué
lecture parallèle
Indicates the length of the VideoFrame.Video in seconds.
TimePosition:number
non répliqué
lecture parallèle
Indicates the progress in seconds of the VideoFrame.Video.
Video:Content
lecture parallèle
The content ID of the video file a VideoFrame object is associated with.
Volume:number
lecture parallèle
Indicates how loud the VideoFrame.Video is currently playing back.

Propriétés hérités de GuiObject

Active:bool
lecture parallèle
Determines whether a UI element sinks input.
AnchorPoint:Vector2
lecture parallèle
Determines the origin point of a GuiObject, relative to its absolute size.
AutomaticSize:Enum.AutomaticSize
lecture parallèle
Determines whether resizing occurs based on child content.
BackgroundColor3:Color3
lecture parallèle
Determines the GuiObject background color.
BackgroundTransparency:number
lecture parallèle
Determines the transparency of the GuiObject background and border.
BorderColor3:Color3
lecture parallèle
Determines the color of the GuiObject border.
BorderMode:Enum.BorderMode
lecture parallèle
Determines in what manner the GuiObject border is laid out relative to its dimensions.
BorderSizePixel:number
lecture parallèle
Determines the pixel width of a GuiObject border.
ClipsDescendants:bool
lecture parallèle
Determines if descendant GUIs outside of the bounds of a parent GUI element should render.
GuiState:Enum.GuiState
lecture uniquement
non répliqué
lecture parallèle
Interactable:bool
lecture parallèle
LayoutOrder:number
lecture parallèle
Controls the sort order of a GUI when used with a UIGridStyleLayout.
NextSelectionDown:GuiObject
lecture parallèle
Sets the GuiObject which will be selected when the Gamepad selector is moved in this direction.
NextSelectionLeft:GuiObject
lecture parallèle
Sets the GuiObject which will be selected when the Gamepad selector is moved in this direction.
NextSelectionRight:GuiObject
lecture parallèle
Sets the GUI which will be selected when the Enum.Gamepad selector is moved in this direction.
NextSelectionUp:GuiObject
lecture parallèle
Sets the GuiObject which will be selected when the Gamepad selector is moved in this direction.
Position:UDim2
lecture parallèle
Determines the pixel and scalar position of the GuiObject.
Rotation:number
lecture parallèle
Determines the number of degrees by which a UI element is rotated.
Selectable:bool
lecture parallèle
Determine whether the GUI can be selected by a gamepad.
SelectionImageObject:GuiObject
lecture parallèle
Overrides the default selection adornment used for gamepads.
SelectionOrder:number
lecture parallèle
The order of GuiObjects selected by the gamepad UI selection.
Size:UDim2
lecture parallèle
Determine the pixel and scalar size of a GUI.
SizeConstraint:Enum.SizeConstraint
lecture parallèle
Selects the GuiObject.Size axes that a GUI will be based relative to the size of its parent.
Transparency:number
caché
non répliqué
lecture parallèle
obsolète
A mixed property of BackgroundTransparency and TextTransparency.
Visible:bool
lecture parallèle
Determines whether a GuiObject.GUI and its descendants will be rendered.
ZIndex:number
lecture parallèle
Determines the order in which a GUI renders relative to other GUIs.

Propriétés hérités de GuiBase2d

AbsolutePosition:Vector2
lecture uniquement
non répliqué
Describes the actual screen position of a UI element, in pixels.
AbsoluteRotation:number
lecture uniquement
non répliqué
Describes the actual screen rotation of a UI element, in degrees.
AbsoluteSize:Vector2
lecture uniquement
non répliqué
Describes the actual screen size of a UI element, in pixels.
AutoLocalize:bool
lecture parallèle
When set to true, localization will be applied to this GuiBase2d and its descendants based on the GuiBase2d.RootLocalizationTable specified for this GuiBase2d.
RootLocalizationTable:LocalizationTable
lecture parallèle
A reference to a LocalizationTable to be used to apply automated localization to this GuiBase2d and its descendants.
SelectionBehaviorDown:Enum.SelectionBehavior
lecture parallèle
Customizes gamepad selection behavior in the down direction.
SelectionBehaviorLeft:Enum.SelectionBehavior
lecture parallèle
Customizes gamepad selection behavior in the left direction.
SelectionBehaviorRight:Enum.SelectionBehavior
lecture parallèle
Customizes gamepad selection behavior in the right direction.
SelectionBehaviorUp:Enum.SelectionBehavior
lecture parallèle
Customizes gamepad selection behavior in the up direction.
SelectionGroup:bool
lecture parallèle
Allows customization of gamepad selection movement.

Afficher tous les hérités de Instance

Méthodes

Pause():void
Sets VideoFrame.Playing to false, pausing playback if the VideoFrame.Video is playing.
Play():void
Sets VideoFrame.Playing to true, playing the VideoFrame.Video from the current VideoFrame.TimePosition.

Méthodes hérités de GuiObject

TweenPosition(endPosition : UDim2,easingDirection : Enum.EasingDirection,easingStyle : Enum.EasingStyle,time : number,override : bool,callback : function):bool
Smoothly moves a GUI to a new UDim2.
TweenSize(endSize : UDim2,easingDirection : Enum.EasingDirection,easingStyle : Enum.EasingStyle,time : number,override : bool,callback : function):bool
Smoothly resizes a GUI to a new UDim2.
TweenSizeAndPosition(endSize : UDim2,endPosition : UDim2,easingDirection : Enum.EasingDirection,easingStyle : Enum.EasingStyle,time : number,override : bool,callback : function):bool
Smoothly moves a GUI to a new size and position.

Afficher tous les hérités de Instance

Évènements

DidLoop(video : string):RBXScriptSignal
Fires whenever the VideoFrame.Video loops.
Ended(video : string):RBXScriptSignal
Fires when the VideoFrame.Video has completed playback and stopped.
Loaded(video : string):RBXScriptSignal
Fires when the VideoFrame.Video is loaded.
Paused(video : string):RBXScriptSignal
This event fires whenever the VideoFrame.Video is paused using VideoFrame:Pause() or by setting VideoFrame.Playing to false.
Played(video : string):RBXScriptSignal
Fires whenever the VideoFrame.Video is played using the VideoFrame:Play() function or by setting VideoFrame.Playing to true.

Évènements hérités de GuiObject

InputBegan(input : InputObject):RBXScriptSignal
Fired when a user begins interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).
InputChanged(input : InputObject):RBXScriptSignal
Fired when a user changes how they're interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).
InputEnded(input : InputObject):RBXScriptSignal
Fired when a user stops interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).
MouseEnter(x : number,y : number):RBXScriptSignal
Fires when a user moves their mouse into a GUI element.
MouseLeave(x : number,y : number):RBXScriptSignal
Fires when a user moves their mouse out of a GUI element.
MouseMoved(x : number,y : number):RBXScriptSignal
Fires whenever a user moves their mouse while it is inside a GUI element.
MouseWheelBackward(x : number,y : number):RBXScriptSignal
Fires when a user scrolls their mouse wheel back when the mouse is over a GUI element.
MouseWheelForward(x : number,y : number):RBXScriptSignal
Fires when a user scrolls their mouse wheel forward when the mouse is over a GUI element.
SelectionGained():RBXScriptSignal
Fired when the GuiObject is being focused on with the Gamepad selector.
SelectionLost():RBXScriptSignal
Fired when the Gamepad selector stops focusing on the GuiObject.
TouchLongPress(touchPositions : Array,state : Enum.UserInputState):RBXScriptSignal
Fires when the player starts, continues and stops long-pressing the UI element.
TouchPan(touchPositions : Array,totalTranslation : Vector2,velocity : Vector2,state : Enum.UserInputState):RBXScriptSignal
Fires when the player moves their finger on the UI element.
TouchPinch(touchPositions : Array,scale : number,velocity : number,state : Enum.UserInputState):RBXScriptSignal
Fires when the player performs a pinch or pull gesture using two fingers on the UI element.
TouchRotate(touchPositions : Array,rotation : number,velocity : number,state : Enum.UserInputState):RBXScriptSignal
Fires when the player performs a rotation gesture using two fingers on the UI element.
TouchSwipe(swipeDirection : Enum.SwipeDirection,numberOfTouches : number):RBXScriptSignal
Fires when the player performs a swipe gesture on the UI element.
TouchTap(touchPositions : Array):RBXScriptSignal
Fires when the player performs a tap gesture on the UI element.

Évènements hérités de GuiBase2d

SelectionChanged(amISelected : bool,previousSelection : GuiObject,newSelection : GuiObject):RBXScriptSignal
Fires when the gamepad selection moves to, leaves, or changes within the connected GuiBase2d or any descendent GuiObjects.

Afficher tous les hérités de Instance

Propriétés

IsLoaded

bool

lecture uniquement

non répliqué

lecture parallèle

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

Looped

bool

lecture parallèle

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

Playing

bool

non répliqué

lecture parallèle

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.

Resolution

Vector2

lecture uniquement

non répliqué

lecture parallèle

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

TimeLength

number

lecture uniquement

non répliqué

lecture parallèle

This property indicates the length of the VideoFrame.Video in seconds. If the video is not loaded, this value will be 0.

TimePosition

number

non répliqué

lecture parallèle

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.

Video

Content

lecture parallèle

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

Échantillons de code

Creating and Playing a Video

local screenPart = Instance.new("Part")
screenPart.Parent = workspace

local surfaceGui = Instance.new("SurfaceGui")
surfaceGui.Parent = screenPart

local videoFrame = Instance.new("VideoFrame")
videoFrame.Parent = surfaceGui

videoFrame.Looped = true
videoFrame.Video = "rbxassetid://" -- add an asset ID to this

while not videoFrame.IsLoaded do
	task.wait()
end

videoFrame:Play()

Volume

number

lecture parallèle

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

Propriétés hérité de GuiObject

Propriétés hérité de GuiBase2d

Afficher tous les hérités de Instance

Méthodes

Pause

void

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.

Retours

void

Play

void

Sets VideoFrame.Playing to true, This plays the VideoFrame.Video, continuing from the current VideoFrame.TimePosition.

Retours

void

Échantillons de code

Creating and Playing a Video

local screenPart = Instance.new("Part")
screenPart.Parent = workspace

local surfaceGui = Instance.new("SurfaceGui")
surfaceGui.Parent = screenPart

local videoFrame = Instance.new("VideoFrame")
videoFrame.Parent = surfaceGui

videoFrame.Looped = true
videoFrame.Video = "rbxassetid://" -- add an asset ID to this

while not videoFrame.IsLoaded do
	task.wait()
end

videoFrame:Play()

Propriétés hérité de GuiObject

Afficher tous les hérités de Instance

Évènements

DidLoop

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

Paramètres

video: string

The content ID of the video that looped.

Ended

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

Paramètres

video: string

The content ID of the paused that ended.

Loaded

This event fires when the VideoFrame.Video is loaded.

Paramètres

video: string

The content ID of the loaded video.

Paused

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

Paramètres

video: string

The content ID of the paused video.

Played

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

Paramètres

video: string

The content ID of the played video.

Propriétés hérité de GuiObject

Propriétés hérité de GuiBase2d

Afficher tous les hérités de Instance