enums¶

Enumerations.

class AddAction(*values)¶

Bases: IntEnumeration

An enumeration of scsynth node add actions.

__format__(format_spec, /)¶

Convert to a string according to format_spec.

ADD_AFTER = 3¶

ADD_BEFORE = 2¶

ADD_TO_HEAD = 0¶

ADD_TO_TAIL = 1¶

REPLACE = 4¶

class BinaryOperator(*values)¶

Bases: IntEnumeration

__format__(format_spec, /)¶

Convert to a string according to format_spec.

ABSOLUTE_DIFFERENCE = 38¶

ADDITION = 0¶

AMCLIP = 40¶

ATAN2 = 22¶

BITWISE_AND = 14¶

BITWISE_OR = 15¶

BITWISE_XOR = 16¶

CLIP2 = 42¶

DIFFERENCE_OF_SQUARES = 34¶

EQUAL = 6¶

EXCESS = 43¶

EXPRANDRANGE = 48¶

FILL = 29¶

FIRST_ARG = 46¶

FLOAT_DIVISION = 4¶

FOLD2 = 44¶

GREATER_THAN = 9¶

GREATER_THAN_OR_EQUAL = 11¶

GREATEST_COMMON_DIVISOR = 18¶

HYPOT = 23¶

HYPOTX = 24¶

INTEGER_DIVISION = 3¶

LEAST_COMMON_MULTIPLE = 17¶

LESS_THAN = 8¶

LESS_THAN_OR_EQUAL = 10¶

MAXIMUM = 13¶

MINIMUM = 12¶

MODULO = 5¶

MULTIPLICATION = 2¶

NOT_EQUAL = 7¶

POWER = 25¶

RANDRANGE = 47¶

RING1 = 30¶

RING2 = 31¶

RING3 = 32¶

RING4 = 33¶

ROUND = 19¶

ROUND_UP = 20¶

SCALE_NEG = 41¶

SHIFT_LEFT = 26¶

SHIFT_RIGHT = 27¶

SQUARE_OF_DIFFERENCE = 37¶

SQUARE_OF_SUM = 36¶

SUBTRACTION = 1¶

SUM_OF_SQUARES = 35¶

THRESHOLD = 39¶

TRUNCATION = 21¶

UNSIGNED_SHIFT = 28¶

WRAP2 = 45¶

class BootStatus(*values)¶

Bases: IntEnum

__format__(format_spec, /)¶

Convert to a string according to format_spec.

BOOTING = 1¶

OFFLINE = 0¶

ONLINE = 2¶

QUITTING = 3¶

class CalculationRate(*values)¶

Bases: IntEnumeration

An enumeration of scsynth calculation-rates.

__format__(format_spec, /)¶

Convert to a string according to format_spec.

AR = 2¶

AUDIO = 2¶

CONTROL = 1¶

DEMAND = 3¶

DR = 3¶

IR = 0¶

KR = 1¶

SCALAR = 0¶

classmethod from_expr(expr) → CalculationRate¶

Gets calculation-rate.

>>> import supriya.ugens

>>> supriya.CalculationRate.from_expr(1)
CalculationRate.SCALAR

>>> supriya.CalculationRate.from_expr("demand")
CalculationRate.DEMAND

>>> collection = []
>>> collection.append(supriya.ugens.DC.ar(source=0))
>>> collection.append(supriya.ugens.DC.kr(source=1))
>>> collection.append(2.0)
>>> supriya.CalculationRate.from_expr(collection)
CalculationRate.AUDIO

>>> collection = []
>>> collection.append(supriya.ugens.DC.kr(source=1))
>>> collection.append(2.0)
>>> supriya.CalculationRate.from_expr(collection)
CalculationRate.CONTROL

Return calculation-rate.

property token : str¶

class DoneAction(*values)¶

Bases: IntEnumeration

An enumeration of scsynth UGen “done” actions.

__format__(format_spec, /)¶

Convert to a string according to format_spec.

FREE_SYNTH = 2¶

FREE_SYNTH_AND_ALL_FOLLOWING_NODES_IN_GROUP = 8¶

FREE_SYNTH_AND_ALL_PRECEDING_NODES_IN_GROUP = 7¶

FREE_SYNTH_AND_ALL_SIBLING_NODES = 13¶

FREE_SYNTH_AND_DEEPFREE_FOLLOWING_NODE = 12¶

FREE_SYNTH_AND_DEEPFREE_PRECEDING_NODE = 11¶

FREE_SYNTH_AND_ENCLOSING_GROUP = 14¶

FREE_SYNTH_AND_FOLLOWING_NODE = 4¶

FREE_SYNTH_AND_FREEALL_FOLLOWING_NODE = 6¶

FREE_SYNTH_AND_FREEALL_PRECEDING_NODE = 5¶

FREE_SYNTH_AND_PAUSE_FOLLOWING_NODE = 10¶

FREE_SYNTH_AND_PAUSE_PRECEDING_NODE = 9¶

FREE_SYNTH_AND_PRECEDING_NODE = 3¶

NOTHING = 0¶

PAUSE_SYNTH = 1¶

class EnvelopeShape(*values)¶

Bases: IntEnumeration

__format__(format_spec, /)¶

Convert to a string according to format_spec.

CUBED = 7¶

CUSTOM = 5¶

EXPONENTIAL = 2¶

HOLD = 8¶

LINEAR = 1¶

SINE = 3¶

SQUARED = 6¶

STEP = 0¶

WELCH = 4¶

class HeaderFormat(*values)¶

Bases: IntEnumeration

An enumeration of soundfile header formats.

__format__(format_spec, /)¶

Convert to a string according to format_spec.

AIFF = 0¶

IRCAM = 1¶

NEXT = 2¶

RAW = 3¶

WAV = 4¶

class NodeAction(*values)¶

Bases: IntEnumeration

__format__(format_spec, /)¶

Convert to a string according to format_spec.

NODE_ACTIVATED = 2¶

NODE_CREATED = 0¶

NODE_DEACTIVATED = 3¶

NODE_MOVED = 4¶

NODE_QUERIED = 5¶

NODE_REMOVED = 1¶

classmethod from_expr(address) → NodeAction¶

Convenience constructor for enumerations.

>>> import uqbar.enums
>>> class MyEnum(uqbar.enums.IntEnumeration):
...     A_B = -1
...     B_C_D = 0
...     E = 1
... 

>>> MyEnum.from_expr("a b")
MyEnum.A_B

>>> MyEnum.from_expr(None)
MyEnum.B_C_D

>>> MyEnum.from_expr(1)
MyEnum.E

Returns new enumeration item.

class ParameterRate(*values)¶

Bases: IntEnumeration

An enumeration of synthdef control rates.

__format__(format_spec, /)¶

Convert to a string according to format_spec.

AR = 2¶

AUDIO = 2¶

CONTROL = 3¶

IR = 0¶

KR = 3¶

SCALAR = 0¶

TR = 1¶

TRIGGER = 1¶

class RequestId(*values)¶

Bases: IntEnumeration

An enumeration of scsynth request ids.

__format__(format_spec, /)¶

Convert to a string according to format_spec.

BUFFER_ALLOCATE = 28¶

BUFFER_ALLOCATE_READ = 29¶

BUFFER_ALLOCATE_READ_CHANNEL = 54¶

BUFFER_CLOSE = 33¶

BUFFER_FILL = 37¶

BUFFER_FREE = 32¶

BUFFER_GENERATE = 38¶

BUFFER_GET = 42¶

BUFFER_GET_CONTIGUOUS = 43¶

BUFFER_QUERY = 47¶

BUFFER_READ = 30¶

BUFFER_READ_CHANNEL = 55¶

BUFFER_SET = 35¶

BUFFER_SET_CONTIGUOUS = 36¶

BUFFER_WRITE = 31¶

BUFFER_ZERO = 34¶

CLEAR_SCHEDULE = 51¶

COMMAND = 4¶

CONTROL_BUS_FILL = 27¶

CONTROL_BUS_GET = 40¶

CONTROL_BUS_GET_CONTIGUOUS = 41¶

CONTROL_BUS_SET = 25¶

CONTROL_BUS_SET_CONTIGUOUS = 26¶

DUMP_OSC = 39¶

ERROR = 58¶

GROUP_DEEP_FREE = 50¶

GROUP_DUMP_TREE = 56¶

GROUP_FREE_ALL = 24¶

GROUP_HEAD = 22¶

GROUP_NEW = 21¶

GROUP_QUERY_TREE = 57¶

GROUP_TAIL = 23¶

NODE_AFTER = 19¶

NODE_BEFORE = 18¶

NODE_COMMAND = 13¶

NODE_FILL = 17¶

NODE_FREE = 11¶

NODE_MAP_TO_AUDIO_BUS = 60¶

NODE_MAP_TO_AUDIO_BUS_CONTIGUOUS = 61¶

NODE_MAP_TO_CONTROL_BUS = 14¶

NODE_MAP_TO_CONTROL_BUS_CONTIGUOUS = 48¶

NODE_ORDER = 62¶

NODE_QUERY = 46¶

NODE_RUN = 12¶

NODE_SET = 15¶

NODE_SET_CONTIGUOUS = 16¶

NODE_TRACE = 10¶

NOTHING = 0¶

NOTIFY = 1¶

PARALLEL_GROUP_NEW = 63¶

QUIT = 3¶

STATUS = 2¶

SYNC = 52¶

SYNTHDEF_FREE = 53¶

SYNTHDEF_FREE_ALL = 8¶

SYNTHDEF_LOAD = 6¶

SYNTHDEF_LOAD_DIR = 7¶

SYNTHDEF_RECEIVE = 5¶

SYNTH_GET = 44¶

SYNTH_GET_CONTIGUOUS = 45¶

SYNTH_NEW = 9¶

SYNTH_NEWARGS = 59¶

SYNTH_NOID = 49¶

UGEN_COMMAND = 20¶

VERSION = 64¶

property request_name : str¶

class RequestName(*values)¶

Bases: StrictEnumeration

An enumeration of scsynth request names.

BUFFER_ALLOCATE = '/b_alloc'¶

BUFFER_ALLOCATE_READ = '/b_allocRead'¶

BUFFER_ALLOCATE_READ_CHANNEL = '/b_allocReadChannel'¶

BUFFER_CLOSE = '/b_close'¶

BUFFER_FILL = '/b_fill'¶

BUFFER_FREE = '/b_free'¶

BUFFER_GENERATE = '/b_gen'¶

BUFFER_GET = '/b_get'¶

BUFFER_GET_CONTIGUOUS = '/b_getn'¶

BUFFER_QUERY = '/b_query'¶

BUFFER_READ = '/b_read'¶

BUFFER_READ_CHANNEL = '/b_readChannel'¶

BUFFER_SET = '/b_set'¶

BUFFER_SET_CONTIGUOUS = '/b_setn'¶

BUFFER_WRITE = '/b_write'¶

BUFFER_ZERO = '/b_zero'¶

CLEAR_SCHEDULE = '/clearSched'¶

COMMAND = '/cmd'¶

CONTROL_BUS_FILL = '/c_fill'¶

CONTROL_BUS_GET = '/c_get'¶

CONTROL_BUS_GET_CONTIGUOUS = '/c_getn'¶

CONTROL_BUS_SET = '/c_set'¶

CONTROL_BUS_SET_CONTIGUOUS = '/c_setn'¶

DUMP_OSC = '/dumpOSC'¶

ERROR = '/error'¶

GROUP_DEEP_FREE = '/g_deepFree'¶

GROUP_DUMP_TREE = '/g_dumpTree'¶

GROUP_FREE_ALL = '/g_freeAll'¶

GROUP_HEAD = '/g_head'¶

GROUP_NEW = '/g_new'¶

GROUP_QUERY_TREE = '/g_queryTree'¶

GROUP_TAIL = '/g_tail'¶

NODE_AFTER = '/n_after'¶

NODE_BEFORE = '/n_before'¶

NODE_FILL = '/n_fill'¶

NODE_FREE = '/n_free'¶

NODE_MAP_TO_AUDIO_BUS = '/n_mapa'¶

NODE_MAP_TO_AUDIO_BUS_CONTIGUOUS = '/n_mapan'¶

NODE_MAP_TO_CONTROL_BUS = '/n_map'¶

NODE_MAP_TO_CONTROL_BUS_CONTIGUOUS = '/n_mapn'¶

NODE_ORDER = '/n_order'¶

NODE_QUERY = '/n_query'¶

NODE_RUN = '/n_run'¶

NODE_SET = '/n_set'¶

NODE_SET_CONTIGUOUS = '/n_setn'¶

NODE_TRACE = '/n_trace'¶

NOTHING = None¶

NOTIFY = '/notify'¶

PARALLEL_GROUP_NEW = '/p_new'¶

QUIT = '/quit'¶

STATUS = '/status'¶

SYNC = '/sync'¶

SYNTHDEF_FREE = '/d_free'¶

SYNTHDEF_FREE_ALL = '/d_freeAll'¶

SYNTHDEF_LOAD = '/d_load'¶

SYNTHDEF_LOAD_DIR = '/d_loadDir'¶

SYNTHDEF_RECEIVE = '/d_recv'¶

SYNTH_GET = '/s_get'¶

SYNTH_GET_CONTIGUOUS = '/s_getn'¶

SYNTH_NEW = '/s_new'¶

SYNTH_NOID = '/s_noid'¶

UGEN_COMMAND = '/u_cmd'¶

VERSION = '/version'¶

property request_id : str¶

class SampleFormat(*values)¶

Bases: IntEnumeration

An enumeration of soundfile sample formats.

__format__(format_spec, /)¶

Convert to a string according to format_spec.

ALAW = 1¶

DOUBLE = 2¶

FLOAT = 3¶

INT16 = 5¶

INT24 = 0¶

INT32 = 6¶

INT8 = 4¶

MULAW = 7¶

class ServerLifecycleEvent(*values)¶

Bases: IntEnumeration

__format__(format_spec, /)¶

Convert to a string according to format_spec.

BOOTED = 6¶

BOOTING = 1¶

CONNECTED = 5¶

CONNECTING = 3¶

DISCONNECTED = 12¶

DISCONNECTING = 10¶

OSC_CONNECTED = 4¶

OSC_DISCONNECTED = 11¶

OSC_PANICKED = 7¶

PROCESS_BOOTED = 2¶

PROCESS_PANICKED = 8¶

PROCESS_QUIT = 13¶

QUIT = 14¶

QUITTING = 9¶

class ServerShutdownEvent(*values)¶

Bases: IntEnumeration

__format__(format_spec, /)¶

Convert to a string according to format_spec.

DISCONNECT = 2¶

OSC_PANIC = 3¶

PROCESS_PANIC = 4¶

QUIT = 1¶

TOO_MANY_CLIENTS = 5¶

class SignalRange(*values)¶

Bases: IntEnumeration

An enumeration of scsynth UGen signal ranges.

__format__(format_spec, /)¶

Convert to a string according to format_spec.

BIPOLAR = 1¶

UNIPOLAR = 0¶

class UnaryOperator(*values)¶

Bases: IntEnumeration

__format__(format_spec, /)¶

Convert to a string according to format_spec.

ABSOLUTE_VALUE = 5¶

AMPLITUDE_TO_DB = 22¶

ARCCOS = 32¶

ARCSIN = 31¶

ARCTAN = 33¶

AS_FLOAT = 6¶

AS_INT = 7¶

BILINRAND = 40¶

BIT_NOT = 4¶

CEILING = 8¶

COIN = 44¶

COS = 29¶

COSH = 35¶

CUBED = 13¶

DB_TO_AMPLITUDE = 21¶

DIGIT_VALUE = 45¶

DISTORT = 42¶

EXPONENTIAL = 15¶

FLOOR = 9¶

FRACTIONAL_PART = 10¶

HANNING_WINDOW = 49¶

HZ_TO_MIDI = 18¶

HZ_TO_OCTAVE = 24¶

IS_NIL = 2¶

LINRAND = 39¶

LOG = 25¶

LOG10 = 27¶

LOG2 = 26¶

MIDI_TO_HZ = 17¶

NEGATIVE = 0¶

NOT = 1¶

NOT_NIL = 3¶

OCTAVE_TO_HZ = 23¶

RAMP = 52¶

RAND = 37¶

RAND2 = 38¶

RATIO_TO_SEMITONES = 20¶

RECIPROCAL = 16¶

RECTANGLE_WINDOW = 48¶

SEMITONES_TO_RATIO = 19¶

SIGN = 11¶

SILENCE = 46¶

SIN = 28¶

SINH = 34¶

SOFTCLIP = 43¶

SQUARED = 12¶

SQUARE_ROOT = 14¶

SUM3RAND = 41¶

S_CURVE = 53¶

TAN = 30¶

TANH = 36¶

THRU = 47¶

TRIANGLE_WINDOW = 51¶

WELCH_WINDOW = 50¶