disguise developers

Python API

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

OscDevice

Sends OSC messages to one or more targets, and receives them from a single source.

Properties

ipFromFilter : str

Filter by sender IP. Leave blank for any IP.

Category: Receive
UserName: IP Filter

receivePort : int

The IP address that d3 should receive OSC commands from

Category: Receive
UserName: Receive port

sendTargets : List[OscSendTarget]

Addresses to send messages to

UserName: Send Targets

supportsSendingMessageBundles : bool

Does this device support receiving batches of multiple OSC messages in one bundle

Category: Send
UserName: Supports message bundles

verboseSend : int

Output all sent messages to the console

Options: {0: ‘No’, 1: ‘Yes’}
Category: Send
UserName: Verbose Sending

Methods

addSendTarget(self, label: str, address: IPAddress, port: int, enabled: bool)

Append a send target to the list. Every enabled, valid target receives every message sent through this device.

clearSendTargets(self)

Remove all send targets. The device will report “No targets configured” until at least one is added.

removeSendTarget(self, index: int)

Remove the send target at the given zero-based index. No-op if the index is out of range.

send(self, message: OscMessage)

Send an OSC message to all enabled targets. Queued for sending and called via main thread.