disguise developers

Designer Plugins

Plugins for Disguise Designer software.

LogicalVideoInDevice

Represents a virtual video input, which may be mapped to a different physical video input for each server in a session.

Categories: [‘Devices’, ‘Video Input’]

Base class: LogicalDevice

Properties

acesTransform : AcesInputTransformParameters

ACES Input Display Transform (IDT)

UserName: Input transform

cropOffset : Vec2

Size of the crop frame offset in pixels.

UserName: Crop offset

cropRectangle : Rect

The crop rectangle of the video input device in UV space (between 0-1).

cropSize : Vec2

Size of crop frame in camera feed in pixels.

UserName: Crop size

deinterlaceMethod : int

The deinterlace method used by the video input device.

Options: {0: ‘Discard even’, 1: ‘Discard odd’, 2: ‘Bob - Interpolate’, 3: ‘Bob - Duplicate’, 4: ‘Weave’, 5: ‘Weave & Interpolate’, 6: ‘Weave on odd’, 7: ‘Weave on odd & Interpolate’, 8: ‘Weave on even’, 9: ‘Weave on even & Interpolate’, 10: ‘Weston 3 Field’}
UserName: Deinterlace method

interlaced : int

Interlaced mode of the video input device. Off = progressive, On = interlaced.

layerStack : LayerStack

A Layer Stack is a time-independent stack of effects which are applied directly to a VideoIn object.
You can add, remove and re-order effects in a Layer Stack via its editor.

UserName: Layer stack

localVideoIn : VideoIn (Read-Only)

Physical video input on the local server associated with this virtual video input device.

Local video input. If the input is not mapped locally, it returns None.

ocioTransform : OcioColourSpace

OCIO colour space of the video input

UserName: Input transform

pixelFormat : str

Pixel format of the video input device.

placeholder : DxTexture

The placeholder texture used by the device.

placeholderImage : DxTexture

The placeholder image used by the video input device, if no physical input is mapped.

The placeholder image. If none is set, returns None.

UserName: Placeholder image

resolution : Vec2

Resolution of the video input device in pixels.

Variables

deinterlaceMethodCount : Final = 11

deinterlaceMethodName : Callable

getDeinterlaceHelpText : Callable

makeACESLabel : Callable

Methods

getCurrentFrame(self, guiRequest: bool) -> DxTexture

Get the current frame from the video input device.

This method requests a new frame from the device and returns the latest frame.

Parameters:

Returns The current frame from the device. If no frames are available, it will return a black texture or the placeholder video in texture depending on the state of the device.

getPreviewFrame(self, size: Int2) -> DxTexture

Get a preview frame from the video input device.

This method returns a downsampled texture of the latest frame of the video input device, which can be used to display a live preview of the video feed in the GUI.

Parameters:

Returns A DxTexture containing the preview frame, or None if there is no current frame available.

getResolution(self) -> Vec2

Get the resolution of the video input device.

This method returns the resolution of the video input device, which is used to determine the size of the frame buffer.

Returns The resolution of the video input device.

getVideoInTexture(self) -> VideoInTexture

Get the texture of this video input, after it has been composited on a Layer Stack.

Returns VideoInTexture for this video input.
*/

setFormat(self, resolution: Vec2, interlaced: bool, pixelFormat: str)

Set the format of the video input device.

This method sets the expected resolution, interlaced mode and pixel format of the video input device.
It also notifies any observers that the expected resolution has changed.

Parameters:

updateTexture(self)

Updates the texture associated with the video input device.

This method updates the texture associated with this video input device, if it exists.
It takes the latest capture video frame, and composites the layer stack on top of it.