disguise developers

Python API

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

r34.0 Change Log

Previous version: r33.2

Date: 07/15/2026, 13:41

Added

Classes

StageRenderModuleConfig

class StageRenderModuleConfig(ModuleConfig):
    """
    Configuration for a StageRenderModule.

DmxFixtureType

class DmxFixtureType(Resource):
    """
    Allows users to define their own custom per-pixel DMX channel layouts in DMX Screens

TwoPoint5DModuleConfig

class TwoPoint5DModuleConfig(ModuleConfig):
    """
    Configuration for a TwoPoint5DModule.

Class.properties

DmxScreen.fixtureType

    @property
    def fixtureType(self) -> DmxFixtureType:
    @fixtureType.setter
    def fixtureType(self, value: DmxFixtureType) -> None:

EventTransportMidiNote.transportSpeedInputType

    @property
    def transportSpeedInputType(self) -> int:
    @transportSpeedInputType.setter
    def transportSpeedInputType(self, value: int) -> None:

EventTransportMidiNote.transportSpeed

    @property
    def transportSpeed(self) -> int:
    @transportSpeed.setter
    def transportSpeed(self, value: int) -> None:

EventTransportOSC.speed

    @property
    def speed(self) -> str:
    @speed.setter
    def speed(self, value: str) -> None:

FeedHeadConfig.clearColourGuiSpace

    @property
    def clearColourGuiSpace(self) -> Colour:
    @clearColourGuiSpace.setter
    def clearColourGuiSpace(self, value: Colour) -> None:

LogicalVideoInDevice.processHDMIRGBLimitedAsFull

    @property
    def processHDMIRGBLimitedAsFull(self) -> bool:
    @processHDMIRGBLimitedAsFull.setter
    def processHDMIRGBLimitedAsFull(self, val: bool) -> None:

Machine.bandwidthSources

    @property
    def bandwidthSources(self) -> List[BandwidthSource]:
    @bandwidthSources.setter
    def bandwidthSources(self, value: List[BandwidthSource]) -> None:

OcioConfig.guiOutputTransform

    @property
    def guiOutputTransform(self) -> OcioColourSpace:
    @guiOutputTransform.setter
    def guiOutputTransform(self, value: OcioColourSpace) -> None:

OcioConfig.guiSpaceGamma

    @property
    def guiSpaceGamma(self) -> float:

SuperLayer.anchored

    @property
    def anchored(self) -> bool:

TrackPlayer.speed

    @property
    def speed(self) -> float:

Class.methods

FifoDataSeries.samples

    def samples(self) -> List[float]:

FifoDataSeries.capacity

    def capacity(self) -> int:

LayerColourRuleSet.getColourInfo

    def getColourInfo(self, layer: Layer) -> LayerColourInfo:

Machine.hasHDMICapture

    def hasHDMICapture(self) -> bool:

NetworkBandwidthDomain.adapterCaps

    def adapterCaps(self) -> List[BandwidthNetworkAdapterExport]:

NetworkBandwidthDomain.entries

    def entries(self) -> List[BandwidthEntryExport]:

NetworkBandwidthDomain.trackPlayheads

    def trackPlayheads(self) -> List[BandwidthPlayheadExport]:

OcioColourSpace.getMenuItems

    def getMenuItems(self) -> int:

SuperLayer.anchorAndUpdateRelatedLayers

    def anchorAndUpdateRelatedLayers(self, anchored: bool) -> None:

Removed

Class.constructors

RI.__init__

    @overload
    def __init__(self, rp: Type1) -> None:

Class.properties

DmxScreen.fixture_type

    @property
    def fixture_type(self) -> int:
    @fixture_type.setter
    def fixture_type(self, value: int) -> None:

Class.methods

LayerColourRuleSet.getColour

    def getColour(self, layer: Layer) -> Colour:

Modified

Class.methods

NetworkBandwidthDomain.getBandwidth

-    def getBandwidth(self, machine: str, adaptor: str, atTime: float, onTrack: SuperTrack) -> BandwidthUsage:
+    def getBandwidth(self, machine: str, adaptor: str, atTime: float, onTrack: SuperTrack, activeOnly: bool) -> BandwidthUsage: