mc.voiceallocator~

Manage voice numbers for events

Description

The mc.voiceallocator~ object assigns voice numbers to incoming messages using an optional multichannel signal to determine voice busy state. It also maintains a voice busy map used by other MC objects to avoid unnecessary processing for channels that are not actively producing audio in response to events.

Examples

Arguments

voice count [int]

Optional

An optional argument can set a maximum number of voice numbers the mc.voiceallocator~ object will use. If no argument is supplied, the default voice count is 0, meaning that mc.voiceallocator~ will set its maximum voice count by the number of channels in a connected multichannel input. If there is no connected multichannel input, the default voice count is 16.

Attributes

name [symbol]

The name attribute assigns a global name to the object's busy map. By default, mc.voiceallocator~ 's busy map does not have a name and is available only to MC objects within the same patcher. A named busy map is accessible to all MC objects (in any patcher) that refer to it using the busymapname attribute.

steal [int]

When set to 1, the steal attribute allows messages to pass through mc.voiceallocator~ and are assigned to voice numbers when all voices have been allocated. When set to 0, messages are not passed through and are not assigned to voice numbers if all voices are already allocated.

voices [int]

The voices attribute sets the maximum voice number mc.voiceallocator~ will allocate and output. When voices is 0 (the default), the active voice count is determined by the number of channels in the connected multichannel signal. If there is no connected signal, mc.voiceallocator~ defaults to 16 voices.

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic

Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points).

Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [float]

Sets the color for the object's text in RGBA format.

textjustification [int]

Sets the justification for the object's text.

Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

bang

The bang message is repeated to the left outlet preceded by a new voice number sent out the right outlet.

int

The number is repeated to the left outlet preceded by a new voice number sent out the right outlet.

float

The number is repeated to the left outlet preceded by a new voice number sent out the right outlet.

list

The list is repeated to the left outlet preceded by a new voice number sent out the right outlet.

anything

The message is repeated to the left outlet preceded by a new voice number sent out the right outlet.

endevent

Arguments

event name [list]
The word endevent, followed by an event name defined by the event message, releases the voice associated with the event. The entire endevent message is repeated to the left outlet.

event

Arguments

event-name [list]
The word event, followed by an event name and a message, sends the entire event message out the left outlet preceded by a newly allocated voice number. The name can later be used with the endevent message to release the voice that became associated with the event.

holdevent

Arguments

event-name [list]
The word holdevent, followed by an event name and a message, sends the entire holdevent message out the left outlet preceded by a newly allocated voice number. The name can later be used with the endevent message to release the voice that became associated with the event. Unlike the event message, holdevent explicitly holds the named event until connected audio reaches zero.

printbusymap

Prints the current state of the mc.voiceallocator~ busy map to the Max Console as a list.

release

Arguments

voice number [list]
The word release, followed by a voice number, releases that voice number (sets to a non-busy state). Without an argument, release sets all voices to a non-busy state.

releaseevent

Arguments

event-name [list]
The word releaseevent, followed by an event name defined by an event message, releases the voice number associated with the named event but unlike endevent, does not produce a message out the left outlet.

signal

Connect an optional multichannel signal to prevent mc.voiceallocator~ from reallocating a voice until the corresponding channel's signal level goes to zero.

See Also

Name Description
mc.noteallocator~ Manage voice numbers for MIDI note events
MC Wrapper Polyphony MC Wrapper Polyphony
MC and Polyphony MC and Polyphony