Ports

OscIn

OscIn(listener_ip_port: str | int)

Bases: Input

Open Sound Control input port. Produces OscMsg objects.

Parameters:

• listener_ip_port (str | int) –

  'ip:port' or local port to listen for incoming OSC messages

is_enabled

is_enabled: bool

True if port is listening and generating messages

calls

calls: list[None | tuple[tuple, dict], list[SubscribedCall]]

Message match arguments and callables that will be called with matching incoming messages. None conditions matches any message.

subscribe

subscribe(call: Callable[[OscMsg], None]) -> Callable

subscribe(
    address: None | Container | str = None,
    data: (
        None | Container | str | bytes | bool | int | float | list | tuple
    ) = None,
) -> Callable

subscribe(
    address: None | Container | str = None,
    data: (
        None | Container | str | bytes | bool | int | float | list | tuple
    ) = None,
) -> Callable

Decorator to subscribe a callable to the input's messages.

Decorator without arguments subscribes a callable to all the input's messages.

Decorator with arguments subscribes a callable to the input's messages that match conditions set by arguments. It works the same way as message's matches method:

1. If condition is None or omitted it matches anything.

2. If condition equals attribute it matches the attribute.

3. If condition is a container and contains the attribute it matches the attribute.

Examples

1. Calls function for all MIDI port's messages:

   @midi_input_instance.subscribe
   def function(msg: MidiMsg) -> None:
       pass
   

2. Calls function for OSC messages from specific address:

   @osc_input_instance.subscribe(address='/live/song/get/track_data')
   def function(msg: OscMsg) -> None:
       pass
   

3. Call object instance method for MIDI port's "note on" and "note off" messages:

   midi_input_instance.subscribe((MidiType.NOTE_ON, MidiType.NOTE_OFF))(object.method)
   

Returns:

• Callable –

  Subscribed callable.

OscOut

OscOut(target_ip_port: str | int)

Bases: Output

Open Sound Control output port. Sends OscMsg objects.

Parameters:

• target_ip_port (str | int) –

  'ip:port' or local port to send output OSC messages to

is_enabled

is_enabled = True

True if port is ready to send messages

send

send(msg: OscMsg) -> None

Send the OSC message

Parameters:

• msg (OscMsg) –

  object to send