Machine
Nested Classes
Properties
DVI_matrix_preset : str
IP_address : str (Read-Only)
active : bool (Read-Only)
alternate_feed : FeedScene
audio : int
Options: {0: ‘Off’, 1: ‘Timeline Only’, 2: ‘Videofiles Only’, 3: ‘On’}
bandwidthSources : List[BandwidthSource]
Network bandwidth contributions attributed to this machine
bit_depth_selection : int
Options: {0: ‘Use Project Bit Depth’, 1: ‘8 Bit’, 2: ‘10 Bit’}
Category: Understudy Targets
captureCardVariant : int
Select which capture card the server has
Options: {0: ‘Deltacast’, 1: ‘Matrox’}
Category: Understudy Targets
UserName: Capture card variant
content_distribution_target_mode : ContentDistributionTargetMode
d3ProjectsFolder : str (Read-Only)
d3_projects_folder : str
d3_projects_folder_netname : str
device_mapping : DeviceMapping
failed : bool (Read-Only)
failoverDisabled : bool (Read-Only)
feed : FeedScene
hasDedicatedGui : bool (Read-Only)
hostname : str
httpPort : int
isGuiVisible : bool (Read-Only)
machineType : int
Options: {0: ‘Designer’, 1: ‘V2.5’, 2: ‘4x2pro’, 3: ‘4x4pro’, 4: ‘2x2plus’, 5: ‘4x4pro (No VFC)’, 6: ‘Node’, 7: ‘2x4pro’, 8: ‘gx 1’, 9: ‘gx 2’, 10: ‘solo’, 11: ‘vx 4’, 12: ‘gx 2c’, 13: ‘rx’, 14: ‘rx II’, 15: ‘vx 1’, 16: ‘vx 2’, 17: ‘vx 4+’, 18: ‘gx 3’, 19: ‘vx 4n’, 20: ‘ex 3’, 21: ‘vx 2+’, 22: ‘vx 3’, 23: ‘Custom RenderNode’, 24: ‘rx III’, 25: ‘ex 2’, 26: ‘ex 2c’, 27: ‘ex 3+’, 28: ‘gx 3+’}
Category: Understudy Targets
media : MachineMediaRegistry
name : str (Read-Only)
networkConnected : bool (Read-Only)
networkStatus : Network_CommsNodeStatus (Read-Only)
nodeId : optional[int] (Read-Only)
nodeName : str (Read-Only)
renderstream_engines_folder : str
renderstream_projects_folder : str
role : MachineRole
runningAs : Machine (Read-Only)
startupGuiMode : int
Options: {0: ‘Off When Actor’, 1: ‘Always On’, 2: ‘Always Off’}
targets : List[Machine]
typeName : str (Read-Only)
Variables
Actor : Final[MachineRole] = MachineRole.Actor
BITS_10 : Final[Machine.BitDepthOptions] = Machine.BitDepthOptions.Bits10
BITS_8 : Final[Machine.BitDepthOptions] = Machine.BitDepthOptions.Bits8
BP_MODEL_1 : Final[BPModel] = BPModel.BPv1
BP_MODEL_2 : Final[BPModel] = BPModel.BPv2
BP_MODEL_UNKNOWN : Final[BPModel] = BPModel.UNKNOWN
CustomRenderNode : Final[MachineType] = MachineType.CustomRenderNode
DEVICE_STATUS_DIFFERENT_BIT_DEPTH : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_DIFFERENT_BIT_DEPTH
DEVICE_STATUS_DIFFERENT_EDID_EMULATION : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_DIFFERENT_EDID_EMULATION
DEVICE_STATUS_DIFFERENT_IPNETCONFIG_0 : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_DIFFERENT_IPNETCONFIG_0
DEVICE_STATUS_DIFFERENT_IPNETCONFIG_1 : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_DIFFERENT_IPNETCONFIG_1
DEVICE_STATUS_DIFFERENT_IPNETNVMCONFIG_0 : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_DIFFERENT_IPNETNVMCONFIG_0
DEVICE_STATUS_DIFFERENT_IPNETNVMCONFIG_1 : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_DIFFERENT_IPNETNVMCONFIG_1
DEVICE_STATUS_DIFFERENT_PTP_DOMAIN_NUMBER : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_DIFFERENT_PTP_DOMAIN_NUMBER
DEVICE_STATUS_DIFFERENT_PTP_PROFILE : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_DIFFERENT_PTP_PROFILE
DEVICE_STATUS_DIFFERENT_REFRESH_RATE : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_DIFFERENT_REFRESH_RATE
DEVICE_STATUS_DIFFERENT_RESOLUTION : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_DIFFERENT_RESOLUTION
DEVICE_STATUS_DIFFERENT_VIDEOSINK_RATE : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_DIFFERENT_VIDEOSINK_RATE
DEVICE_STATUS_DIFFERENT_VIDEO_OUTPUT_MODE : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_DIFFERENT_VIDEO_OUTPUT_MODE
DEVICE_STATUS_ERROR : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_ERROR
DEVICE_STATUS_INCOMPATIBLE_VFC : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_INCOMPATIBLE_VFC
DEVICE_STATUS_INVALID_BIT_DEPTH : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_INVALID_BIT_DEPTH
DEVICE_STATUS_NORMAL : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_NORMAL
DEVICE_STATUS_NO_MACHINE_CONNECTED : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_NO_MACHINE_CONNECTED
DEVICE_STATUS_NO_OUTPUT_CONNECTED : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_NO_OUTPUT_CONNECTED
DEVICE_STATUS_NO_SFP_CONNECTED : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_NO_SFP_CONNECTED
DEVICE_STATUS_PTP_NOT_LOCKED : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_PTP_NOT_LOCKED
DEVICE_STATUS_UNRESPONSIVE : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_UNRESPONSIVE
DEVICE_STATUS_VFC_FAILED_FTDI : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_VFC_FAILED_FTDI
The VFC’s FTDI device was detected but Designer could not communicate with it
DEVICE_STATUS_VFC_FAILED_INIT : Final[VFCDeviceStatus] = VFCDeviceStatus.STATUS_VFC_FAILED_INIT
The VFC failed initialisation
DedicatedDirector : Final[MachineRole] = MachineRole.DedicatedDirector
Deltacast : Final[MachineCaptureCardVariant] = MachineCaptureCardVariant.Deltacast
Designer : Final[MachineType] = MachineType.Designer
Ex_2 : Final[MachineType] = MachineType.Ex_2
Ex_2c : Final[MachineType] = MachineType.Ex_2c
Ex_3 : Final[MachineType] = MachineType.Ex_3
Ex_3Plus : Final[MachineType] = MachineType.Ex_3Plus
FIFO_OK : Final[FIFOState] = FIFOState.OK
FIFO_OVERFLOW : Final[FIFOState] = FIFOState.Overflow
FIFO_UNDERRUN : Final[FIFOState] = FIFOState.Underrun
FIFO_UNKNOWN : Final[FIFOState] = FIFOState.Unknown
Gx_1 : Final[MachineType] = MachineType.Gx_1
Gx_2 : Final[MachineType] = MachineType.Gx_2
Gx_2c : Final[MachineType] = MachineType.Gx_2c
Gx_3 : Final[MachineType] = MachineType.Gx_3
Gx_3Plus : Final[MachineType] = MachineType.Gx_3Plus
Matrox : Final[MachineCaptureCardVariant] = MachineCaptureCardVariant.Matrox
MobileEditor : Final[MachineRole] = MachineRole.MobileEditor
NET_MODE_DHCP : Final[NetworkMode] = NetworkMode.DHCP
NET_MODE_STATIC : Final[NetworkMode] = NetworkMode.STATIC
NET_MODE_UNKNOWN : Final[NetworkMode] = NetworkMode.UNKNOWN
NO_BP : Final[BPModel] = BPModel.NO_BP
Node : Final[MachineType] = MachineType.Node
NonDedicatedDirector : Final[MachineRole] = MachineRole.NonDedicatedDirector
PORT_STATUS_DESIGNER : Final[VFCPortStatus] = VFCPortStatus.STATUS_DESIGNER
PORT_STATUS_DIFFERENT_BIT_DEPTH : Final[VFCPortStatus] = VFCPortStatus.STATUS_DIFFERENT_BIT_DEPTH
PORT_STATUS_DIFFERENT_COL_CONV_PRO : Final[VFCPortStatus] = VFCPortStatus.STATUS_DIFFERENT_COL_CONV_PRO
PORT_STATUS_DIFFERENT_QUAD_DIVISION : Final[VFCPortStatus] = VFCPortStatus.STATUS_DIFFERENT_QUAD_DIVISION
PORT_STATUS_DIFFERENT_REFRESH_RATE : Final[VFCPortStatus] = VFCPortStatus.STATUS_DIFFERENT_REFRESH_RATE
PORT_STATUS_DIFFERENT_REFRESH_RATE_GLOBAL : Final[VFCPortStatus] = VFCPortStatus.STATUS_DIFFERENT_REFRESH_RATE_GLOBAL
PORT_STATUS_DIFFERENT_RESOLUTION : Final[VFCPortStatus] = VFCPortStatus.STATUS_DIFFERENT_RESOLUTION
PORT_STATUS_DIFFERENT_SPLIT_MODE : Final[VFCPortStatus] = VFCPortStatus.STATUS_DIFFERENT_SPLIT_MODE
PORT_STATUS_DIFFERENT_SUBSAMPLING : Final[VFCPortStatus] = VFCPortStatus.STATUS_DIFFERENT_SUBSAMPLING
PORT_STATUS_DIFFERENT_TIMING_MODE : Final[VFCPortStatus] = VFCPortStatus.STATUS_DIFFERENT_TIMING_MODE
PORT_STATUS_DIFFERENT_TRANSPORT_TYPE : Final[VFCPortStatus] = VFCPortStatus.STATUS_DIFFERENT_TRANSPORT_TYPE
PORT_STATUS_DIFFERENT_TRANS_CHAR : Final[VFCPortStatus] = VFCPortStatus.STATUS_DIFFERENT_TRANS_CHAR
PORT_STATUS_DIFFERENT_TXIPDEST_ETH0 : Final[VFCPortStatus] = VFCPortStatus.STATUS_DIFFERENT_TXIPDEST_ETH0
PORT_STATUS_DIFFERENT_TXIPDEST_ETH1 : Final[VFCPortStatus] = VFCPortStatus.STATUS_DIFFERENT_TXIPDEST_ETH1
PORT_STATUS_ERROR : Final[VFCPortStatus] = VFCPortStatus.STATUS_ERROR
PORT_STATUS_INCOMPATIBLE_VFC : Final[VFCPortStatus] = VFCPortStatus.STATUS_INCOMPATIBLE_VFC
PORT_STATUS_NORMAL : Final[VFCPortStatus] = VFCPortStatus.STATUS_NORMAL
PORT_STATUS_NO_MACHINE_CONNECTED : Final[VFCPortStatus] = VFCPortStatus.STATUS_NO_MACHINE_CONNECTED
PORT_STATUS_NO_OUTPUT_CONNECTED : Final[VFCPortStatus] = VFCPortStatus.STATUS_NO_OUTPUT_CONNECTED
PORT_STATUS_STREAM_DISABLED : Final[VFCPortStatus] = VFCPortStatus.STATUS_STREAM_DISABLED
PORT_STATUS_VFC_FAILED_FTDI : Final[VFCPortStatus] = VFCPortStatus.STATUS_VFC_FAILED_FTDI
The VFC’s FTDI device was detected but Designer could not communicate with it
PORT_STATUS_VFC_FAILED_INIT : Final[VFCPortStatus] = VFCPortStatus.STATUS_VFC_FAILED_INIT
The VFC failed initialisation
PTP_PROFILE_SMPTE2059_2015 : Final[PTPProfile] = PTPProfile.SMPTE2059_2015
PTP_PROFILE_SMPTE2059_2021 : Final[PTPProfile] = PTPProfile.SMPTE2059_2021
PTP_PROFILE_UNKNOWN : Final[PTPProfile] = PTPProfile.Unknown
PTP_STATES_FREERUN : Final[PTPLockStates] = PTPLockStates.FREERUN
PTP_STATES_LOCKED : Final[PTPLockStates] = PTPLockStates.LOCKED
PTP_STATES_LOCKING : Final[PTPLockStates] = PTPLockStates.LOCKING
PTP_STATES_STOPPED : Final[PTPLockStates] = PTPLockStates.STOPPED
PTP_STATES_UNKNOWN : Final[PTPLockStates] = PTPLockStates.UNKNOWN
PTP_STATES_UNLOCKED : Final[PTPLockStates] = PTPLockStates.UNLOCKED
Plus_2x2 : Final[MachineType] = MachineType.Plus_2x2
Pro_2x4 : Final[MachineType] = MachineType.Pro_2x4
Pro_4x2 : Final[MachineType] = MachineType.Pro_4x2
Pro_4x4 : Final[MachineType] = MachineType.Pro_4x4
Pro_4x4_NoVfcs : Final[MachineType] = MachineType.Pro_4x4_NoVfcs
RenderNode : Final[MachineRole] = MachineRole.RenderNode
Rx : Final[MachineType] = MachineType.Rx
Rx_II : Final[MachineType] = MachineType.Rx_II
Rx_III : Final[MachineType] = MachineType.Rx_III
SFP_TYPE_10G : Final[SFPType] = SFPType.TenG
SFP_TYPE_25G : Final[SFPType] = SFPType.TwentyFiveG
SFP_TYPE_DUAL_SDI : Final[SFPType] = SFPType.DualSDI
SFP_TYPE_INVALID_SFP_FOR_SLOT : Final[SFPType] = SFPType.InvalidSFPForSlot
SFP_TYPE_NONE : Final[SFPType] = SFPType.None_
SFP_TYPE_SINGLE_SDI : Final[SFPType] = SFPType.SingleSDI
SFP_TYPE_UNKNOWN : Final[SFPType] = SFPType.Unknown
STATUS_GENLOCK : Final[GenlockSyncState] = GenlockSyncState.STATUS_GENLOCK
STATUS_GENLOCK_BY_PTP : Final[GenlockSyncState] = GenlockSyncState.STATUS_GENLOCK_BY_PTP
STATUS_NO_GENLOCK : Final[GenlockSyncState] = GenlockSyncState.STATUS_NO_GENLOCK
SYNC_STATUS_CONFLICTING_EDIDS : Final[OutputSyncState] = OutputSyncState.STATUS_CONFLICTING_EDIDS
SYNC_STATUS_CONFLICTING_RESOLUTIONS : Final[OutputSyncState] = OutputSyncState.STATUS_CONFLICTING_RESOLUTIONS
SYNC_STATUS_FREE_RUN : Final[OutputSyncState] = OutputSyncState.STATUS_FREE_RUN
SYNC_STATUS_LOCKED_EXTERNAL : Final[OutputSyncState] = OutputSyncState.STATUS_LOCKED_EXTERNAL
SYNC_STATUS_LOCKED_INTERNAL : Final[OutputSyncState] = OutputSyncState.STATUS_LOCKED_INTERNAL
SYNC_STATUS_LOCKED_PTP : Final[OutputSyncState] = OutputSyncState.STATUS_LOCKED_PTP
SYS_SYNC_MODE_DP : Final[SystemSyncMode] = SystemSyncMode.DP_SYNC
SYS_SYNC_MODE_EXT : Final[SystemSyncMode] = SystemSyncMode.EXT_SYNC
SYS_SYNC_MODE_PTP : Final[SystemSyncMode] = SystemSyncMode.PTP_SYNC
SYS_SYNC_MODE_UNKNOWN : Final[SystemSyncMode] = SystemSyncMode.UNKNOWN
Solo : Final[MachineRole] = MachineRole.Solo
Solo_v1 : Final[MachineType] = MachineType.Solo_v1
USE_PROJECT_BIT_DEPTH : Final[Machine.BitDepthOptions] = Machine.BitDepthOptions.ProjectBitDepth
Understudy : Final[MachineRole] = MachineRole.Understudy
UnknownRole : Final[MachineRole] = MachineRole.UnknownRole
V2_5 : Final[MachineType] = MachineType.V2_5
VID_OUTPUT_NONE : Final[VideoOutput] = VideoOutput.NONE
VID_OUTPUT_SDI : Final[VideoOutput] = VideoOutput.SDI
VID_OUTPUT_ST2110 : Final[VideoOutput] = VideoOutput.ST2110
Vx_1 : Final[MachineType] = MachineType.Vx_1
Vx_2 : Final[MachineType] = MachineType.Vx_2
Vx_2Plus : Final[MachineType] = MachineType.Vx_2Plus
Vx_3 : Final[MachineType] = MachineType.Vx_3
Vx_4 : Final[MachineType] = MachineType.Vx_4
Vx_4Plus : Final[MachineType] = MachineType.Vx_4Plus
Vx_4n : Final[MachineType] = MachineType.Vx_4n
Methods
allRequiredOutputsGenlocked(self) -> bool
applyDisplaySettings(self)
applyDisplaySettingsWillRequireReboot(self) -> bool
applyPortConfigs(self, blocking: bool)
assertHouseSync(self)
assignNewFeed(self)
bpModel(self) -> BPModel
clearHouseSync(self)
fifoState(self, iSlot: int, iPort: int) -> FIFOState
findDisplayAdapterList(self) -> DisplayAdapterList
getDeviceActivePortsCount(self) -> int
Calculates the number of active ports for each vfc device of a given machine.
Returns the number of vfc devices active ports
getDeviceVFCCount(self) -> int
Calculates the number of vfc device of a given machine.
Returns the number of vfc
getNetworkAdaptors(self) -> List[netsys_NetworkAdaptor]
Returns a list of all network adaptors on this machine.
getSlotToSyncPTP(self) -> optional[int]
getbitDepth(self) -> int
gpuVendor(self) -> GPUVendor
hasHDMICapture(self) -> bool
Tells us if this machine has HDMI capture so we can give the user an additional option
Returns true if this machine has HDMI capture
hasIncomingHouseSyncSignal(self) -> bool
hasTakenOverFailedMachine(self) -> bool
incomingHouseSyncSignal(self) -> float
injectVFCEvent(self, iSlot: int, event: str)
ipVfcSdpPath(self, iSlot: int, iPort: int, eth: int) -> str
isApplyingFeeds(self) -> bool
isExRange(self) -> bool
isVfcReady(self, iSlot: int) -> bool
machineUsesMapping(self, mapping: Projection) -> bool
needsDisplaySettingsApplied(self) -> bool
Whether this machine needs to Apply Feed Settings.
needsNVMNetworkSettingsApplied(self) -> bool
notifyIfNeedsDisplaySettingsApplied(self) -> bool
Notify user if this machine needs to Apply Feed Settings.
outputMode(self, iGpuPort: int) -> DisplayMode
refreshDisplayAdapters(self)
resetEdids(self)
resetHDMI(self, iSlot: int)
runVFCDebugCommand(self, iSlot: int, command: str)
setCompatibleQuadResolution(self)
setVFCTracing(self, iSlot: int, tracing: bool)
slotsWithInvalidSFPState(self) -> List[int]
streamEnabled(self, iSlot: int, iPort: int) -> bool
supports10Bit(self) -> bool
supportsMultipleCaptureCardVendors(self) -> bool
swapVFCinterlacedField(self, iSlot: int, iPort: int)
syncStatus(self, iSlot: int) -> OutputSyncState
vfcDNSConfig(self, iSlot: int, nvm: bool) -> str
vfcEthernetLinkStatusCount(self, iSlot: int) -> int
vfcEthernetLinkStatuses(self, iSlot: int) -> List[EthernetLinkStatus]
vfcFPGATemperature(self, iSlot: int) -> float
vfcFirmwareVersion(self, iSlot: int) -> VFCFpgaVersion
vfcGeneration(self, iSlot: int) -> VFCGeneration
vfcIPNetConfigAddress(self, iSlot: int, eth: int, nvm: bool) -> IPAddress
vfcMacAddress(self, iSlot: int, eth: int) -> str
vfcPTPClkID(self, iSlot: int) -> str
vfcPTPDomainNbr(self, iSlot: int) -> int
vfcPTPGrandmasterCount(self, iSlot: int) -> int
vfcPTPGrandmasters(self, iSlot: int) -> List[PTPGrandmaster]
vfcPTPLockDistance(self, iSlot: int) -> int
vfcPTPLockState(self, iSlot: int) -> PTPLockStates
vfcPTPPortNbr(self, iSlot: int) -> int
vfcPTPProfile(self, iSlot: int) -> PTPProfile
vfcPortCurrentDisplayMode(self, iSlot: int, iPort: int) -> DisplayMode
vfcPortDisplayModes(self, iSlot: int, iPort: int) -> List[DisplayMode]
vfcPortFsStart(self, iSlot: int, iPort: int) -> int
vfcPortLed(self, iSlot: int, iPort: int) -> Colour
vfcPortSelectedDisplayMode(self, iSlot: int, iPort: int) -> DisplayMode
vfcPortState(self, iSlot: int, iPort: int) -> str
vfcPortStatus(self, iSlot: int, iPort: int) -> VFCPortStatus
vfcSFPType(self, iSlot: int, sfpIdx: int) -> SFPType
vfcSoftwareVersion(self, iSlot: int) -> VFCFpgaVersion
vfcStatus(self, iSlot: int) -> VFCDeviceStatus
vfcSysAlertMissingGenlock(self) -> GenlockSyncState
vfcSysAlertMissingIpVfc(self) -> List[int]
vfcSysAlertMissingPtp(self) -> int
vfcSysAlertStatusBoardTempExceeded(self, iSlot: int) -> bool
vfcSysAlertStatusFPGATempExceeded(self, iSlot: int) -> bool
vfcSysAlertStatusPTPStepped(self, iSlot: int) -> bool
vfcSysAlertStatusSynError(self, iSlot: int) -> bool
vfcSysAlertStatusTime(self, iSlot: int) -> str
vfcSysPtpDomainMismatch(self) -> int
vfcSysSyncFrate(self, iSlot: int) -> float
vfcSysSyncMode(self, iSlot: int) -> SystemSyncMode
vfcSysSyncModeMismatch(self) -> List[int]
vfcTemperature(self, iSlot: int) -> float
vfcVideoOutputMode(self, iSlot: int) -> VideoOutput
Static Methods
captureCardVendor() -> str
localApiEndpoint() -> str
machineRoleToString(r: MachineRole) -> str
splitMatrixInputs(input: str) -> List[str]
Split a matrix input string containing one or more matrix inputs separated via a pipe ( | ) operator
into individual per-matrix inputs
splitMatrixOutputs(output: str) -> List[str]
Split a matrix output string containing one or more matrix outputs separated via a pipe ( | ) operator
into individual per-matrix outputs (which may themselves contain multiple comma or semicolon-separated outputs)