disguise developers

Python API

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

DmxDevice

Properties

IP_address : str

IP address to send or receive DMX commands

actualStatus : str

UserName: Status

configured : bool (Read-Only)

directionality : int

Options: {0: ‘Input And Output’, 1: ‘Output’, 2: ‘Input’}
UserName: Directionality

driver : int

Defines the protocol the driver accepts

Options: {0: ‘Art-Net’, 1: ‘Enttec’, 2: ‘SoundLight’, 3: ‘ezDMX’, 4: ‘KiNET v1’, 5: ‘KiNET v2’, 6: ‘sACN’}
UserName: Driver

driverSpecificOptions : DmxDriverSpecificOptions

machine : Machine

Machine designated to output DMX through this device. If (none), director outputs DMX

UserName: Machine

mappingSynopsis : str (Read-Only)

speed : int

Limit send frequency, as a multiple of video output frames. Set to 44Hz if experiencing issues on receiving devices.
At 60fps, 44Hz limit would output at 30Hz - every other frame, as 60Hz exceeds the limit.

Options: {0: ‘44Hz limit’, 1: ‘Unlimited’}
UserName: Maximum rate

start_universe : int

In conjunction with ‘number of universes’, defines the universe range of the device. ‘start universe’ is the 1-based number of the first universe handled by the device

UserName: d3 universe start

universe_mapping : List[int]

universes : int

In conjunction with ‘start universe’, defines the universe range of the device. ‘number of universes’ is the number of universes in the range

UserName: Number of universes

Variables

ArtnetDevice : Final[DmxDriverType] = DmxDriverType.Artnet

EnttecDevice : Final[DmxDriverType] = DmxDriverType.Enttec

EzdmxDevice : Final[DmxDriverType] = DmxDriverType.Ezdmx

KinetV1Device : Final[DmxDriverType] = DmxDriverType.KinetV1

KinetV2Device : Final[DmxDriverType] = DmxDriverType.KinetV2

Receive : Final[DmxDirectionality] = DmxDirectionality.RECEIVE

SacnDevice : Final[DmxDriverType] = DmxDriverType.Sacn

Send : Final[DmxDirectionality] = DmxDirectionality.SEND

SendAndReceive : Final[DmxDirectionality] = DmxDirectionality.BOTH

SoundlightDevice : Final[DmxDriverType] = DmxDriverType.Soundlight

WendiUnsupportedDevice : Final[DmxDriverType] = DmxDriverType.WendiUnsupported

Methods

driverStatus(self) -> str

driverType(self) -> str

lastSent(self) -> float

lastValid(self) -> float

updateDriverOptions(self)