Machine
Base class: Resource
Properties
DVI_matrix_preset : str
IP_address : str (Read-Only)
active : bool (Read-Only)
audio : int
Options: {0: ‘Off’, 1: ‘Timeline Only’, 2: ‘Videofiles Only’, 3: ‘On’}
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 : int
Category: Understudy Targets
d3ProjectsFolder : str (Read-Only)
d3_projects_folder : str
d3_projects_folder_netname : str
Category: Understudy Targets
failed : bool (Read-Only)
failoverDisabled : bool (Read-Only)
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+’}
Category: Understudy Targets
Category: Understudy Targets
name : str (Read-Only)
networkConnected : bool (Read-Only)
networkStatus : int (Read-Only)
nodeId : optional[int] (Read-Only)
nodeName : str (Read-Only)
renderstream_engines_folder : str
renderstream_projects_folder : str
role : int
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 = 3
BITS_10 : Final = 2
BITS_8 : Final = 1
BP_MODEL_1 : Final = 0
BP_MODEL_2 : Final = 1
BP_MODEL_UNKNOWN : Final = 2
CustomRenderNode : Final = 23
DEVICE_STATUS_DIFFERENT_BIT_DEPTH : Final = 3
DEVICE_STATUS_DIFFERENT_EDID_EMULATION : Final = 4
DEVICE_STATUS_DIFFERENT_IPNETCONFIG_0 : Final = 10
DEVICE_STATUS_DIFFERENT_IPNETCONFIG_1 : Final = 11
DEVICE_STATUS_DIFFERENT_IPNETNVMCONFIG_0 : Final = 12
DEVICE_STATUS_DIFFERENT_IPNETNVMCONFIG_1 : Final = 13
DEVICE_STATUS_DIFFERENT_PTP_DOMAIN_NUMBER : Final = 16
DEVICE_STATUS_DIFFERENT_PTP_PROFILE : Final = 17
DEVICE_STATUS_DIFFERENT_REFRESH_RATE : Final = 2
DEVICE_STATUS_DIFFERENT_RESOLUTION : Final = 1
DEVICE_STATUS_DIFFERENT_VIDEOSINK_RATE : Final = 15
DEVICE_STATUS_DIFFERENT_VIDEO_OUTPUT_MODE : Final = 14
DEVICE_STATUS_ERROR : Final = 19
DEVICE_STATUS_INCOMPATIBLE_VFC : Final = 8
DEVICE_STATUS_INVALID_BIT_DEPTH : Final = 9
DEVICE_STATUS_NORMAL : Final = 0
DEVICE_STATUS_NO_MACHINE_CONNECTED : Final = 5
DEVICE_STATUS_NO_OUTPUT_CONNECTED : Final = 6
DEVICE_STATUS_NO_SFP_CONNECTED : Final = 7
DEVICE_STATUS_PTP_NOT_LOCKED : Final = 18
DEVICE_STATUS_UNRESPONSIVE : Final = 20
DEVICE_STATUS_VFC_FAILED_INIT : Final = 21
DedicatedDirector : Final = 1
Deltacast : Final = 0
Designer : Final = 0
Ex_2 : Final = 25
Ex_2c : Final = 26
Ex_3 : Final = 20
Ex_3Plus : Final = 27
FIFO_OK : Final = 0
FIFO_OVERFLOW : Final = 2
FIFO_UNDERRUN : Final = 1
FIFO_UNKNOWN : Final = 3
Gx_1 : Final = 8
Gx_2 : Final = 9
Gx_2c : Final = 12
Gx_3 : Final = 18
Matrox : Final = 1
MobileEditor : Final = 5
NET_MODE_DHCP : Final = 1
NET_MODE_STATIC : Final = 0
NET_MODE_UNKNOWN : Final = 2
NO_BP : Final = 3
Node : Final = 6
NonDedicatedDirector : Final = 2
PORT_STATUS_DESIGNER : Final = 10
PORT_STATUS_DIFFERENT_BIT_DEPTH : Final = 5
PORT_STATUS_DIFFERENT_COL_CONV_PRO : Final = 15
PORT_STATUS_DIFFERENT_QUAD_DIVISION : Final = 7
PORT_STATUS_DIFFERENT_REFRESH_RATE : Final = 3
PORT_STATUS_DIFFERENT_REFRESH_RATE_GLOBAL : Final = 4
PORT_STATUS_DIFFERENT_RESOLUTION : Final = 1
PORT_STATUS_DIFFERENT_SPLIT_MODE : Final = 2
PORT_STATUS_DIFFERENT_SUBSAMPLING : Final = 17
PORT_STATUS_DIFFERENT_TIMING_MODE : Final = 6
PORT_STATUS_DIFFERENT_TRANSPORT_TYPE : Final = 18
PORT_STATUS_DIFFERENT_TRANS_CHAR : Final = 16
PORT_STATUS_DIFFERENT_TXIPDEST_ETH0 : Final = 13
PORT_STATUS_DIFFERENT_TXIPDEST_ETH1 : Final = 14
PORT_STATUS_ERROR : Final = 19
PORT_STATUS_INCOMPATIBLE_VFC : Final = 11
PORT_STATUS_NORMAL : Final = 0
PORT_STATUS_NO_MACHINE_CONNECTED : Final = 8
PORT_STATUS_NO_OUTPUT_CONNECTED : Final = 9
PORT_STATUS_STREAM_DISABLED : Final = 12
PORT_STATUS_VFC_FAILED_INIT : Final = 20
PTP_PROFILE_SMPTE2059_2015 : Final = 0
PTP_PROFILE_SMPTE2059_2021 : Final = 1
PTP_PROFILE_UNKNOWN : Final = 2
PTP_STATES_FREERUN : Final = 1
PTP_STATES_LOCKED : Final = 4
PTP_STATES_LOCKING : Final = 3
PTP_STATES_STOPPED : Final = 0
PTP_STATES_UNKNOWN : Final = 5
PTP_STATES_UNLOCKED : Final = 2
Plus_2x2 : Final = 4
Pro_2x4 : Final = 7
Pro_4x2 : Final = 2
Pro_4x4 : Final = 3
Pro_4x4_NoVfcs : Final = 5
RenderNode : Final = 7
Rx : Final = 13
Rx_II : Final = 14
Rx_III : Final = 24
SFP_TYPE_10G : Final = 1
SFP_TYPE_25G : Final = 2
SFP_TYPE_DUAL_SDI : Final = 5
SFP_TYPE_INVALID_SFP_FOR_SLOT : Final = 6
SFP_TYPE_NONE : Final = 0
SFP_TYPE_SINGLE_SDI : Final = 4
SFP_TYPE_UNKNOWN : Final = 7
STATUS_GENLOCK : Final = 2
STATUS_GENLOCK_BY_PTP : Final = 1
STATUS_NO_GENLOCK : Final = 0
SYNC_STATUS_CONFLICTING_EDIDS : Final = 5
SYNC_STATUS_CONFLICTING_RESOLUTIONS : Final = 4
SYNC_STATUS_FREE_RUN : Final = 0
SYNC_STATUS_LOCKED_EXTERNAL : Final = 2
SYNC_STATUS_LOCKED_INTERNAL : Final = 1
SYNC_STATUS_LOCKED_PTP : Final = 3
SYS_SYNC_MODE_DP : Final = 2
SYS_SYNC_MODE_EXT : Final = 1
SYS_SYNC_MODE_PTP : Final = 0
SYS_SYNC_MODE_UNKNOWN : Final = 3
Solo : Final = 0
Solo_v1 : Final = 10
USE_PROJECT_BIT_DEPTH : Final = 0
Understudy : Final = 4
UnknownRole : Final = 6
V2_5 : Final = 1
VID_OUTPUT_NONE : Final = 2
VID_OUTPUT_SDI : Final = 1
VID_OUTPUT_ST2110 : Final = 0
Vx_1 : Final = 15
Vx_2 : Final = 16
Vx_2Plus : Final = 21
Vx_3 : Final = 22
Vx_4 : Final = 11
Vx_4Plus : Final = 17
Vx_4n : Final = 19
captureCardVendor : Callable
localApiEndpoint : Callable
machineRoleToString : Callable
Methods
allRequiredOutputsGenlocked(self) -> bool
applyDisplaySettings(self)
applyDisplaySettingsWillRequireReboot(self) -> bool
applyPortConfigs(self, blocking: bool)
assertHouseSync(self)
assignNewFeed(self)
bpModel(self) -> int
clearHouseSync(self)
fifoState(self, iSlot: int, iPort: int) -> int
getSlotToSyncPTP(self) -> optional[int]
getbitDepth(self) -> int
gpuVendor(self) -> int
hasIncomingHouseSyncSignal(self) -> bool
hasTakenOverFailedMachine(self) -> bool
incomingHouseSyncSignal(self) -> float
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
needsNVMNetworkSettingsApplied(self) -> bool
outputMode(self, iGpuPort: int) -> DisplayMode
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
swapVFCinterlacedField(self, iSlot: int, iPort: int)
syncStatus(self, iSlot: int) -> int
vfcDNSConfig(self, iSlot: int, nvm: bool) -> str
vfcFPGATemperature(self, iSlot: int) -> float
vfcFirmwareVersion(self, iSlot: int) -> VFCFpgaVersion
vfcGeneration(self, iSlot: int) -> int
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
vfcPTPLockDistance(self, iSlot: int) -> int
vfcPTPLockState(self, iSlot: int) -> int
vfcPTPPortNbr(self, iSlot: int) -> int
vfcPTPProfile(self, iSlot: int) -> int
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) -> int
vfcSFPType(self, iSlot: int, sfpIdx: int) -> int
vfcSoftwareVersion(self, iSlot: int) -> VFCFpgaVersion
vfcStatus(self, iSlot: int) -> int
vfcSysAlertMissingGenlock(self) -> int
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) -> int
vfcSysSyncModeMismatch(self) -> List[int]
vfcTemperature(self, iSlot: int) -> float
vfcVideoOutputMode(self, iSlot: int) -> int
