disguise developers

Python API

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

D3State

Nested Classes

Properties

activeEditorMan : ActiveEditorManager

archiveAction : int

autoSaveFrequency : int

bit_depth : D3State.BitDepthOptions

Set bit depth for video outputs.

colourManagementAllowed : bool (Read-Only)

colourManager : ColourManager

colourManagerVmap : ColourManager

‘Disabled’ performs no colour space conversion on assets. ‘Gamma Space’ assets are blended to a common sRGB colour/gamma space, then converted to selected output space. ‘ACES’ a linear colour/gamma space with ACES v1.2 CM & sweeteners

commit_mode : int

d3Nmos : D3Nmos (Read-Only)

defaultGammaSpaceDisplayProfile : ColourProfile

Default display profile

defaultGammaSpaceIngestProfile : ColourProfile

Default ingest profile

defaultTransitionInfo : TrackTransitionInfo

Default UX fade transition behaviour

deviceMan : DeviceManager (Read-Only)

devices : DeviceManager

Input and output devices

domain_number : int

Set domain number for PTP

enableBlackout : int

fadeDurationSec : float

Specify the time taken to fade up or down in seconds

UserName: Fade up/down duration

feed : FeedScene (Read-Only)

The current output feed configuration

force_dmx_send : int

globalRefreshRate : Rational

isInShow : bool (Read-Only)

lastExportDate : DateStamp

layerColourRuleSet : LayerColourRuleSet

Layer colour for all tracks unless overridden

UserName: Global layer colour rules

license : str

lockedToDirector : bool

m : int

m_hasDoneScheduledExit : int

minimumGuiProxyLevel : int

Maximum visualiser proxy caps quality of GUI-only display renders (visualiser, editors etc.). Feed outputs unaffected.

Options: {0: ‘1

’, 1: ‘1
’, 2: ‘1
’, 3: ‘1
’, 4: ‘1
’}
UserName: Maximum visualiser proxy

mixedRealityAllowed : bool (Read-Only)

monitorAudio : LogicalAudioOutDevice

nOldVersionsToKeep : int

ocioConfig : OcioConfig

projectClockType : SMPTEClockType (Read-Only)

The SMPTE timecode clock type for the project.

projectName : str (Read-Only)

ptpprofile : PTPProfile

quit_h : int

realtimeConnectorLicenceActive : bool (Read-Only)

rename_table : RenameTableSetting

resetOnStop : int

Defines behaviour of the stop button; you can either reset to the start of the bar, or stay where you are

slcRegionManagement : unique_ptr[SlcRegionManagement] (Read-Only)

stage : Stage

The current stage

stageUid : int

sync_source : SystemSyncMode

Sync to external signal or sync to PTP from IP VFC

target_speed : D3State.SpeedOption

use_video_thumbnails : int

videoOverlayOption : int

Variables

ACES : Final[ColourManager] = ColourManager.ACES

Disabled : Final[ColourManager] = ColourManager.Disabled

DragStart : Final[InputDragState] = InputDragState.DragStart

GammaSpace : Final[ColourManager] = ColourManager.GammaSpace

OCIO : Final[ColourManager] = ColourManager.OCIO

Methods

archiveUnusedMedia(self, files: List[str], action: int)

cmdMachineFailed(self, machineHostname: str)

cmdMachineRestored(self, machineHostname: str)

getDaysLeftDesigner(self) -> int

getTestNames(self) -> List[str]

getUnusedMedia(self) -> List[str]

listUnused(self)

localOrDirectorState(self) -> LocalState

runTest(self, iTest: int)

sendCommand(self, cmd: str, param: float, p2: float, p3: float, p4: float, iParam: int)

Send a command

strikeFixtures(self, onOff: bool)

unpack(self)