Reference API Roblox

Engine API

Website

Related

Reference API Roblox

VideoDisplay

A GUI object that displays video content from a connected VideoPlayer.

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

Member index 11

HistoryMember
661ResampleMode: ResamplerMode
661ScaleType: ScaleType
661TileSize: UDim2
661VideoColor3: Color3
661VideoRectOffset: Vector2
661VideoRectSize: Vector2
661VideoTransparency: float
661GetConnectedWires(pin: string): Instances
668GetInputPins(): Array
668GetOutputPins(): Array
661WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)
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
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)

Description

A VideoDisplay is a GUI object that displays video content from a VideoPlayer connected via a Wire. It functions similarly to a ImageLabel but is designed for video playback.

History 12

Members 11

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Instances

Returns an array of Wires that are connected to the specified pin. VideoDisplay has one "Input" pin.

History 1

GetInputPins

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

History 1

GetOutputPins

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

History 1

ResampleMode

TypeDefault
ResamplerModeDefault

Determines how the video looks when it is scaled. By default, the video smooths out texturing when displayed on the screen larger or smaller than its size in texture memory. When set to Enum.ResamplerMode.Pixelated, the video preserves the sharp edges of pixels.

History 1

ScaleType

TypeDefault
ScaleTypeStretch

Determines how a video texture is rendered when the UI element's aspect ratio differs from the source video's aspect ratio.

By default, this property is ScaleType.Stretch which will simply stretch/compact the video texture dimensions so it fits the UI element's space exactly.

History 1

TileSize

TypeDefault
UDim2{1, 0}, {1, 0}

History 1

VideoColor3

TypeDefault
Color31, 1, 1

Determines how a video is colorized. When set to white, no colorization occurs. This property is useful for reusing video assets.

History 1

VideoRectOffset

TypeDefault
Vector20, 0

Allows the partial display of a video in conjunction with VideoRectSize. This property determines the pixel offset (from the top-left) of the video area to be displayed.

History 1

VideoRectSize

TypeDefault
Vector20, 0

Allows the partial display of a video in conjunction with VideoRectOffset. This property determines the pixel size of the video area to be displayed. If either dimension is set to 0, the entire video is displayed instead.

History 1

VideoTransparency

TypeDefault
float0

Determines the alpha of a UI element's rendered video texture. A value of 0 is completely opaque, and a value of 1 is completely transparent (invisible).

History 1

WiringChanged

Parameters (4)
connectedbool
pinstring
wireWire
instanceInstance

Fires after a Wire becomes connected or disconnected, and that Wire is now or was previously connected to a pin on the VideoDisplay and to some other wirable instance.

History 1

Settings