VideoFrame

Visualizza obsoleti

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.

Campioni di codice

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()

Sommario

Proprietà

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

Proprietà inherited from GuiObject

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

Proprietà inherited from GuiBase2d

AbsolutePosition:Vector2
sola lettura
non replicato
Describes the actual screen position of a UI element, in pixels.
AbsoluteRotation:number
sola lettura
non replicato
Describes the actual screen rotation of a UI element, in degrees.
AbsoluteSize:Vector2
sola lettura
non replicato
Describes the actual screen size of a UI element, in pixels.
AutoLocalize:bool
lettura parallela
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
lettura parallela
A reference to a LocalizationTable to be used to apply automated localization to this GuiBase2d and its descendants.
SelectionBehaviorDown:Enum.SelectionBehavior
lettura parallela
Customizes gamepad selection behavior in the down direction.
SelectionBehaviorLeft:Enum.SelectionBehavior
lettura parallela
Customizes gamepad selection behavior in the left direction.
SelectionBehaviorRight:Enum.SelectionBehavior
lettura parallela
Customizes gamepad selection behavior in the right direction.
SelectionBehaviorUp:Enum.SelectionBehavior
lettura parallela
Customizes gamepad selection behavior in the up direction.
SelectionGroup:bool
lettura parallela
Allows customization of gamepad selection movement.

View all inherited from Instance

Metodi

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.

Metodi inherited from 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.

View all inherited from Instance

Eventi

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.

Eventi inherited from 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.

Eventi inherited from 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.

View all inherited from Instance

Proprietà

IsLoaded

bool

sola lettura

non replicato

lettura parallela

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

Looped

bool

lettura parallela

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

Playing

bool

non replicato

lettura parallela

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

sola lettura

non replicato

lettura parallela

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

TimeLength

number

sola lettura

non replicato

lettura parallela

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 replicato

lettura parallela

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

lettura parallela

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

Campioni di codice

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

lettura parallela

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

Proprietà ereditato da GuiObject

Proprietà ereditato da GuiBase2d

View all inherited from Instance

Metodi

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.

Restituzioni

void

Play

void

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

Restituzioni

void

Campioni di codice

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()

Proprietà ereditato da GuiObject

View all inherited from Instance

Eventi

DidLoop

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

Parametri

video: string

The content ID of the video that looped.

Ended

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

Parametri

video: string

The content ID of the paused that ended.

Loaded

This event fires when the VideoFrame.Video is loaded.

Parametri

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.

Parametri

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.

Parametri

video: string

The content ID of the played video.

Proprietà ereditato da GuiObject

Proprietà ereditato da GuiBase2d

View all inherited from Instance