disguise developers

Python API

Execute Python code in Designer sessions to control and query projects programmatically.

VFCDevice

Properties

activePortConfigs : List[VFCPortConfig] (Read-Only)

colourFormat : ColorFormat

emulateEDID : int

Always - Emulated EDID always, even when no display is connected
If Connected - Emulate EDID only when a display is connected to the output
Unmanaged - Do not modify current EDID emulation
Force Off - Do not emulate EDID, remove existing if set

Options: {0: ‘Always’, 1: ‘If Connected’, 2: ‘Unmanaged’, 3: ‘Force Off’}

model : int

Options: {0: ‘No VFC’, 1: ‘Passthrough’, 2: ‘Quad DVI’, 3: ‘Quad SDI’, 4: ‘HDMI’, 5: ‘IP’}

modelString : str (Read-Only)

nActivePorts : int (Read-Only)

networkConfigEth : List[VFCIPNetConfig]

networkConfigNVMEth : List[VFCIPNetConfig]

outputResolution : Int2

portConfigs : List[VFCPortConfig]

portsLayout : Int2 (Read-Only)

slotType : VFCSlotType

splitMode : int

Options: {0: ‘Mirror’, 1: ‘Dual’, 2: ‘Quad’, 3: ‘Quad 4K’}

splitModeString : str (Read-Only)

subSampling : int

Options: {0: ‘RGB 4:4

’, 1: ‘YCbCr 4:4
’, 2: ‘YCbCr 4:2
’}

videoOutputMode : int

Options: {0: ‘ST2110’, 1: ‘SDI’}

Variables

COLOUR_FMT_422 : Final[ColorFormat] = ColorFormat.YUV422

COLOUR_FMT_444 : Final[ColorFormat] = ColorFormat.YUV444

COLOUR_FMT_AUTO : Final[ColorFormat] = ColorFormat.AUTO

COLOUR_FMT_RGB : Final[ColorFormat] = ColorFormat.RGB

COLOUR_FMT_RGB_LIMITED : Final[ColorFormat] = ColorFormat.RGB_LIMITED

GEN_ONE : Final[VFCGeneration] = VFCGeneration.One

GEN_TWO : Final[VFCGeneration] = VFCGeneration.Two

MODEL_HDMI : Final[VFCDeviceModel] = VFCDeviceModel.HDMI

MODEL_IP : Final[VFCDeviceModel] = VFCDeviceModel.IP

MODEL_NO_VFC : Final[VFCDeviceModel] = VFCDeviceModel.NO_VFC

MODEL_PASSTHROUGH : Final[VFCDeviceModel] = VFCDeviceModel.PASSTHROUGH

MODEL_QUAD_DVI : Final[VFCDeviceModel] = VFCDeviceModel.QUAD_DVI

MODEL_QUAD_SDI : Final[VFCDeviceModel] = VFCDeviceModel.QUAD_SDI

SLOTTYPE_BLANK_PLATE : Final[VFCSlotType] = VFCSlotType.BLANK_PLATE

SLOTTYPE_DIRECT : Final[VFCSlotType] = VFCSlotType.DIRECT

SLOTTYPE_GUI : Final[VFCSlotType] = VFCSlotType.GUI

SLOTTYPE_PLUGGABLE : Final[VFCSlotType] = VFCSlotType.PLUGGABLE

SPLIT_DUAL : Final[VFCDeviceSplitMode] = VFCDeviceSplitMode.DUAL

SPLIT_MIRROR : Final[VFCDeviceSplitMode] = VFCDeviceSplitMode.MIRROR

SPLIT_QUAD : Final[VFCDeviceSplitMode] = VFCDeviceSplitMode.QUAD

SPLIT_QUAD_4K : Final[VFCDeviceSplitMode] = VFCDeviceSplitMode.QUAD_4K

VID_OUT_SDI : Final[VideoOutput] = VideoOutput.SDI

VID_OUT_ST2110 : Final[VideoOutput] = VideoOutput.ST2110

Methods

getOrCreateIPNetConfig(self, itf: int) -> VFCIPNetConfig

Get an existing VFCIPNetConfig for the given interface, or create one if it doesn’t exist

getOrCreateIPNetNVMConfig(self, itf: int) -> VFCIPNetConfig

updateOutputResolution(self)

Static Methods

onSplitModeChanged(previousSplitMode: VFCDeviceSplitMode, previousNActivePorts: int, iSlot: int, machine: Machine, vfc: VFCDevice)