sc3nb.sc_objects.bus

Python representation of the scsynth Bus.

Module Contents

Class List

ControlBusCommand	OSC Commands for Control Buses
BusRate	Calculation rate of Buses
Bus	Represenation of Control or Audio Bus(es) on the SuperCollider Server

Content

class sc3nb.sc_objects.bus.ControlBusCommand

Bases: str, enum.Enum

OSC Commands for Control Buses

Initialize self. See help(type(self)) for accurate signature.

FILL = '/c_fill'

SET = '/c_set'

SETN = '/c_setn'

GET = '/c_get'

GETN = '/c_getn'

class sc3nb.sc_objects.bus.BusRate

Bases: str, enum.Enum

Calculation rate of Buses

Initialize self. See help(type(self)) for accurate signature.

AUDIO = 'audio'

CONTROL = 'control'

class sc3nb.sc_objects.bus.Bus(rate: Union[BusRate, str], num_channels: int = 1, index: Optional[int] = None, server: Optional[sc3nb.sc_objects.server.SCServer] = None)

Represenation of Control or Audio Bus(es) on the SuperCollider Server

If num_channels > 1 this will be represent muliple Buses in a row.

Parameters:

rateUnion[BusRate, str]

Rate of the Bus, either control or audio

num_channelsint, optional

How many channels to allocate, by default 1

indexint, optional

Starting Bus index this Bus, by default this will be handled by the servers Bus allocator.

serverSCServer, optional

Server instance for this Bus, by default the default SC server instance.

Overview:

is_audio_bus	Rate check
is_control_bus	Rate check
set	Set ranges of bus values.
fill	Fill bus(es) to one value.
get	Get bus value(s).
free	Mark this Buses ids as free again
__del__
__repr__	Return repr(self).

is_audio_bus() → bool

Rate check

Returns:

bool

True if this is a audio bus

is_control_bus() → bool

Rate check

Returns:

bool

True if this is a control bus

set(*values: Sequence[Union[int, float]], return_msg=False) → Union[Bus, sc3nb.osc.osc_communication.OSCMessage]

Set ranges of bus values.

Parameters:

valuessequence of int or float

Values that should be set

return_msgbool, optional

If True return msg else send it directly, by default False

Raises:

RuntimeError

If trying to setn an Audio Bus

fill(value: Union[int, float], return_msg=False) → Union[Bus, sc3nb.osc.osc_communication.OSCMessage]

Fill bus(es) to one value.

Parameters:

valueUnion[int, float]

value for the buses

return_msgbool, optional

If True return msg else send it directly, by default False

Raises:

RuntimeError

If fill is used on a Audio Bus

get() → Union[Union[int, float], Sequence[Union[int, float]]]

Get bus value(s).

Returns:

bus value or sequence of bus values

The current value of this bus Multiple values if this bus has num_channels > 1

Raises:

RuntimeError

If get is used on an Audio Bus

free(clear: bool = True) → None

Mark this Buses ids as free again

Parameters:

clearbool, optional

Reset bus value(s) to 0, by default True

__del__() → None

__repr__() → str

Return repr(self).