VideoDisplay
CreatorHub

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

It is not visible in Studio's object browser.

Memory category	Gui

Tags: [NotBrowsable]

Member index 11

History		Member
731		ResampleMode: ResamplerMode
731		ScaleType: ScaleType
731		TileSize: UDim2
731		VideoColor3: Color3
731		VideoRectOffset: Vector2
731		VideoRectSize: Vector2
731		VideoTransparency: float
661		GetConnectedWires(pin: string): Instances
668		GetInputPins(): Array
668		GetOutputPins(): Array
661		WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)
62 members inherited from GuiObject
731		Active: bool
731		AnchorPoint: Vector2
731		AutomaticSize: AutomaticSize
731		BackgroundColor: BrickColor
731		BackgroundColor3: Color3
731		BackgroundTransparency: float
731		BorderColor: BrickColor
731		BorderColor3: Color3
731		BorderMode: BorderMode
731		BorderSizePixel: int
731		ClipsDescendants: bool
731		DragBeginConnectionCount: int
731		DragStoppedConnectionCount: int
731		Draggable: bool
731		GuiState: GuiState
731		InputSink: InputSink
731		Interactable: bool
731		LayoutOrder: int
731		MouseEnterConnectionCount: int
731		MouseLeaveConnectionCount: int
731		MouseMovedConnectionCount: int
731		MouseWheelBackwardConnectionCount: int
731		MouseWheelForwardConnectionCount: int
731		NextSelectionDown: GuiObject
731		NextSelectionLeft: GuiObject
731		NextSelectionRight: GuiObject
731		NextSelectionUp: GuiObject
731		Position: UDim2
731		Rotation: float
731		Selectable: bool
731		SelectionImageObject: GuiObject
731		SelectionOrder: int
731		SelectionRect2D: Rect
731		Size: UDim2
731		SizeConstraint: SizeConstraint
731		Transparency: float
731		Visible: bool
731		ZIndex: int
462		TweenPosition(endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
713		TweenPositionInternal(endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462		TweenSize(endSize: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462		TweenSizeAndPosition(endSize: UDim2, endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
713		TweenSizeAndPositionInternal(endSize: UDim2, endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
713		TweenSizeInternal(endSize: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462		DragBegin(initialPosition: UDim2)
462		DragStopped(x: int, y: int)
483		InputBegan(input: InputObject)
483		InputChanged(input: InputObject)
483		InputEnded(input: InputObject)
462		MouseEnter(x: int, y: int)
462		MouseLeave(x: int, y: int)
462		MouseMoved(x: int, y: int)
462		MouseWheelBackward(x: int, y: int)
462		MouseWheelForward(x: int, y: int)
462		SelectionGained()
462		SelectionLost()
462		TouchLongPress(touchPositions: Array, state: UserInputState)
462		TouchPan(touchPositions: Array, totalTranslation: Vector2, velocity: Vector2, state: UserInputState)
462		TouchPinch(touchPositions: Array, scale: float, velocity: float, state: UserInputState)
462		TouchRotate(touchPositions: Array, rotation: float, velocity: float, state: UserInputState)
462		TouchSwipe(swipeDirection: SwipeDirection, numberOfTouches: int)
462		TouchTap(touchPositions: Array)
18 members inherited from GuiBase2d
731		AbsolutePosition: Vector2
731		AbsoluteRotation: float
731		AbsoluteSize: Vector2
731		ActiveQueryNames: string
731		AutoLocalize: bool
731		ClippedRect: Rect
731		IsNotOccluded: bool
731		Localize: bool
731		RawRect2D: Rect
731		ReplicatedInsertionOrder: int
731		RootLocalizationTable: LocalizationTable
731		SelectionBehaviorDown: SelectionBehavior
731		SelectionBehaviorLeft: SelectionBehavior
731		SelectionBehaviorRight: SelectionBehavior
731		SelectionBehaviorUp: SelectionBehavior
731		SelectionGroup: bool
731		TotalGroupScale: float
525		SelectionChanged(amISelected: bool, previousSelection: GuiObject, newSelection: GuiObject)
68 members inherited from Instance
731		Archivable: bool
731		Attributes: string
731		AttributesReplicate: string
731		AttributesSerialize: BinaryString
731		Capabilities: SecurityCapabilities
731		DataCost: int
731		DefinesCapabilities: bool
731		HistoryId: UniqueId
731		IsInSandbox: bool
731		Name: string
731		Parent: Instance
731		PredictionMode: PredictionMode
731		PropertyStatusStudio: PropertyStatus
731		RobloxLocked: bool
731		Sandboxed: bool
731		SourceAssetId: int64
731		Tags: SharedString
731		UniqueId: UniqueId
731		archivable: bool
731		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: string?): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
698		QueryDescendants(selector: string): Instances
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
731		children(): Instances
731		clone(): Instance
731		destroy(): null
731		findFirstChild(name: string, recursive: bool = false): Instance
731		getChildren(): Instances
731		isDescendantOf(ancestor: Instance): bool
731		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
731		childAdded(child: Instance)
6 members inherited from Object
731		ClassName: string
731		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
731		isA(className: string): bool
647		Changed(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 26
Hide member changes

731 Change Default of VideoTransparency from to 0
731 Change Default of VideoRectSize from to Vector2(0, 0)
731 Change Default of VideoRectOffset from to Vector2(0, 0)
731 Change Default of VideoColor3 from to Color3(1, 1, 1)
731 Change Default of TileSize from to UDim2({1, 0}, {1, 0})
731 Change Default of ScaleType from to Stretch
731 Change Default of ResampleMode from to Default
726 Change Default of VideoTransparency from 0 to
726 Change Default of VideoRectSize from Vector2(0, 0) to
726 Change Default of VideoRectOffset from Vector2(0, 0) to
726 Change Default of VideoColor3 from Color3(1, 1, 1) to
726 Change Default of TileSize from UDim2({1, 0}, {1, 0}) to
726 Change Default of ScaleType from Stretch to
726 Change Default of ResampleMode from Default to
668 Add GetOutputPins
668 Add GetInputPins
661 Add WiringChanged
661 Add GetConnectedWires
661 Add VideoTransparency
661 Add VideoRectSize
661 Add VideoRectOffset
661 Add VideoColor3
661 Add TileSize
661 Add ScaleType
661 Add ResampleMode
661 Add VideoDisplay

Members 11

GetConnectedWires
CreatorHub

Parameters (1)
pin	string
Returns (1)
Instances

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

Thread safety	Unsafe

History 1

661 Add GetConnectedWires

GetInputPins
CreatorHub

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

Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.

For VideoDisplay, this is Input only.

Thread safety	Unsafe

History 1

668 Add GetInputPins

GetOutputPins
CreatorHub

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

Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.

For VideoDisplay, there are none.

Thread safety	Unsafe

History 1

668 Add GetOutputPins

ResampleMode
CreatorHub

Type		Default
ResamplerMode		Default

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.

Thread safety	ReadSafe
Category	Video
Loaded/Saved	true

History 3

731 Change Default of ResampleMode from to Default
726 Change Default of ResampleMode from Default to
661 Add ResampleMode

ScaleType
CreatorHub

Type		Default
ScaleType		Stretch

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.

Thread safety	ReadSafe
Category	Video
Loaded/Saved	true

History 3

731 Change Default of ScaleType from to Stretch
726 Change Default of ScaleType from Stretch to
661 Add ScaleType

TileSize
CreatorHub

Type		Default
UDim2		{1, 0}, {1, 0}

This property sets the tiling size of the VideoDisplay with a default of UDim2.new(1, 0, 1, 0). Tiling starts at the top-left corner of the video. This property is only active if the ScaleType for the VideoDisplay is set to ScaleType.Tile.

Thread safety	ReadSafe
Category	Video
Loaded/Saved	true

History 3

731 Change Default of TileSize from to UDim2({1, 0}, {1, 0})
726 Change Default of TileSize from UDim2({1, 0}, {1, 0}) to
661 Add TileSize

VideoColor3
CreatorHub

Type		Default
Color3		1, 1, 1

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

Thread safety	ReadSafe
Category	Video
Loaded/Saved	true

History 3

731 Change Default of VideoColor3 from to Color3(1, 1, 1)
726 Change Default of VideoColor3 from Color3(1, 1, 1) to
661 Add VideoColor3

VideoRectOffset
CreatorHub

Type		Default
Vector2		0, 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.

Thread safety	ReadSafe
Category	Video
Loaded/Saved	true

History 3

731 Change Default of VideoRectOffset from to Vector2(0, 0)
726 Change Default of VideoRectOffset from Vector2(0, 0) to
661 Add VideoRectOffset

VideoRectSize
CreatorHub

Type		Default
Vector2		0, 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.

Thread safety	ReadSafe
Category	Video
Loaded/Saved	true

History 3

731 Change Default of VideoRectSize from to Vector2(0, 0)
726 Change Default of VideoRectSize from Vector2(0, 0) to
661 Add VideoRectSize

VideoTransparency
CreatorHub

Type		Default
float		0

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

Thread safety	ReadSafe
Category	Video
Loaded/Saved	true

History 3

731 Change Default of VideoTransparency from to 0
726 Change Default of VideoTransparency from 0 to
661 Add VideoTransparency

WiringChanged
CreatorHub

Parameters (4)
connected	bool
pin	string
wire	Wire
instance	Instance

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.

Thread safety	Unsafe

History 1

661 Add WiringChanged

Reference API Roblox

Engine API

Website

Related

Reference API Roblox

VideoDisplay
CreatorHub

Member index 11

Description

History 26
Hide member changes

Members 11

GetConnectedWires
CreatorHub

History 1

GetInputPins
CreatorHub

History 1

GetOutputPins
CreatorHub

History 1

ResampleMode
CreatorHub

History 3

ScaleType
CreatorHub

History 3

TileSize
CreatorHub

History 3

VideoColor3
CreatorHub

History 3

VideoRectOffset
CreatorHub

History 3

VideoRectSize
CreatorHub

History 3

VideoTransparency
CreatorHub

History 3

WiringChanged
CreatorHub

History 1

Settings