# VideoDisplay

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [GuiObject](https://rapi.sleaze.dev/classes/GuiObject.md), [GuiBase2d](https://rapi.sleaze.dev/classes/GuiBase2d.md), [GuiBase](https://rapi.sleaze.dev/classes/GuiBase.md), [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Tags: Not browsable
- Memory category: Gui
- HTML page: https://rapi.sleaze.dev/classes/VideoDisplay/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/VideoDisplay

A GUI object that displays video content from a connected [`VideoPlayer`](https://rapi.sleaze.dev/classes/VideoPlayer.md).

## Properties

### ResampleMode

```luau
VideoDisplay.ResampleMode: Enum.ResamplerMode = Enum.ResamplerMode.Default
```

- Tags: Read capabilities: UI

Selects the texture resampling mode for the [`VideoDisplay`](https://rapi.sleaze.dev/classes/VideoDisplay.md).

### ScaleType

```luau
VideoDisplay.ScaleType: Enum.ScaleType = Enum.ScaleType.Stretch
```

- Tags: Read capabilities: UI

Determines how a video will scale if displayed in a UI element whose aspect ratio differs from the source video.

### TileSize

```luau
VideoDisplay.TileSize: UDim2 = UDim2.new(1, 0, 1, 0)
```

- Tags: Read capabilities: UI

Sets the tiling size of the [`VideoDisplay`](https://rapi.sleaze.dev/classes/VideoDisplay.md).

### VideoColor3

```luau
VideoDisplay.VideoColor3: Color3 = Color3.new(1, 1, 1)
```

- Tags: Read capabilities: UI

Determines how a rendered video will be colorized.

### VideoRectOffset

```luau
VideoDisplay.VideoRectOffset: Vector2 = Vector2.zero
```

- Tags: Read capabilities: UI

The offset in pixels of the sub-area of a video to be displayed.

### VideoRectSize

```luau
VideoDisplay.VideoRectSize: Vector2 = Vector2.zero
```

- Tags: Read capabilities: UI

Determines the size in pixels of the sub-area of a video to be displayed.

### VideoTransparency

```luau
VideoDisplay.VideoTransparency: number = 0
```

- Tags: Read capabilities: UI

Determines the transparency of the rendered video.

## Methods

### GetConnectedWires

```luau
VideoDisplay:GetConnectedWires(pin: string): { Instance }
```

- Tags: Capabilities: UI

Returns an array of `Wires` that are connected to the specified pin.

Parameters:

- `pin`: An input or output pin on this instance

Returns: An array of `Wires`

### GetInputPins

```luau
VideoDisplay:GetInputPins(): { any }
```

- Tags: Capabilities: UI

Gets the list of pins that [`Wire`](https://rapi.sleaze.dev/classes/Wire.md) can use in [`Wire.TargetName`](https://rapi.sleaze.dev/classes/Wire.md) to connect to this instance via its [`Wire.TargetInstance`](https://rapi.sleaze.dev/classes/Wire.md) property.

Returns: An array of strings representing valid pin names.

### GetOutputPins

```luau
VideoDisplay:GetOutputPins(): { any }
```

- Tags: Capabilities: UI

Gets the list of pins that [`Wire`](https://rapi.sleaze.dev/classes/Wire.md) can use in [`Wire.SourceName`](https://rapi.sleaze.dev/classes/Wire.md) to connect to this instance via its [`Wire.SourceInstance`](https://rapi.sleaze.dev/classes/Wire.md) property.

Returns: An array of strings representing valid pin names.

## Events

### WiringChanged

```luau
VideoDisplay.WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance)>
```

- Tags: Capabilities: UI

Fires when another instance is connected to or disconnected from the [`VideoDisplay`](https://rapi.sleaze.dev/classes/VideoDisplay.md) via a [`Wire`](https://rapi.sleaze.dev/classes/Wire.md).

## Inherited members

- From [GuiObject](https://rapi.sleaze.dev/classes/GuiObject.md): `SelectionImageObject`, `ClipsDescendants`, `Draggable`, `Active`, `AnchorPoint`, `AutomaticSize`, `BackgroundColor3`, `BackgroundTransparency`, `BorderColor3`, `BorderMode`, `BorderSizePixel`, `InputSink`, `Interactable`, `LayoutOrder`, `Position`, `Rotation`, `SelectionRect2D`, `Sink`, `Size`, `SizeConstraint`, `Visible`, `ZIndex`, `BackgroundColor`, `BorderColor`, `Transparency`, `DragBeginConnectionCount`, `DragStoppedConnectionCount`, `MouseEnterConnectionCount`, `MouseLeaveConnectionCount`, `MouseMovedConnectionCount`, `MouseWheelBackwardConnectionCount`, `MouseWheelForwardConnectionCount`, `NextSelectionDown`, `NextSelectionLeft`, `NextSelectionRight`, `NextSelectionUp`, `Selectable`, `SelectionOrder`, `GuiState`, `TweenPositionInternal`, `TweenSizeAndPositionInternal`, `TweenSizeInternal`, `TweenPosition`, `TweenSize`, `TweenSizeAndPosition`, `InputBegan`, `InputChanged`, `InputEnded`, `MouseEnter`, `MouseLeave`, `MouseMoved`, `MouseWheelBackward`, `MouseWheelForward`, `SelectionGained`, `SelectionLost`, `TouchLongPress`, `TouchPan`, `TouchPinch`, `TouchRotate`, `TouchSwipe`, `TouchTap`, `DragBegin`, `DragStopped`
- From [GuiBase2d](https://rapi.sleaze.dev/classes/GuiBase2d.md): `AbsolutePosition`, `AbsoluteRotation`, `AbsoluteSize`, `ActiveQueryNames`, `ReplicatedInsertionOrder`, `ClippedRect`, `IsNotOccluded`, `RawRect2D`, `TotalGroupScale`, `AutoLocalize`, `RootLocalizationTable`, `Localize`, `SelectionBehaviorDown`, `SelectionBehaviorLeft`, `SelectionBehaviorRight`, `SelectionBehaviorUp`, `SelectionGroup`, `SelectionChanged`
- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`
