Package MSP

ezadc~

Audio input and on/off button

Description

ezadc~ works as a user interface version of the adc~ object. It appears as a button which can be clicked with the mouse to turn audio on or off.

Arguments

None.

Attributes

bgcolor[4 floats]

Background Color

color[4 floats]
7.0.0

Select the color to show the audio on status.

elementcolor[4 floats]
7.0.0

Select the color to show the audio off status.

local[int]: 0

Switch is Local

style[symbol]:
7.0.0

Sets the style to be applied to the object. Styles can be set using the Format Palette.

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

annotation[symbol]

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

background[int]: 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]: 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]: 0

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

jspainterfile[symbol]

You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.

patching_rect[4 floats]: 0. 0. 100. 0.

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

position[2 floats]
write-only

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]: 0

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

presentation_rect[4 floats]: 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]
write-only

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]
write-only

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[4 floats]

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

int

A non-zero number turns on audio processing in all loaded patches. A value of 0 turns all audio processing off.

Arguments:
  • stop/start-flag [int]

list

list comprised of integers sets the logical input channels for each signal inlet.

Arguments:
  • input-channel-designations [list]

(mouse)

Clicking on ezadc~ toggles audio processing on or off. Audio on is represented by the object being highlighted.

local

The word local , followed by 1 , makes a click to turn on an ezadc~ object equivalent to sending it the startwindow message . The message local 0 returns the ezadc~ object to its default mode where a click to turn it on is equivalent to the start message.

Arguments:
  • behavioral [int]

open

Opens the Audio Status window. The window is also brought to the front.

set

The word set , followed by two numbers, sets the logical input channel for one of the object's signal outlets. The first number specifies the outlet number, where 1 is the leftmost outlet. The second number specifies the logical input channel (from 1 to 512). If the second number is 0 , the outlet sends out the zero signal.

Arguments:
  • logical-output-channel [int]
  • logical-input-channel [int]

start

Turns on audio processing in all loaded patches.

startwindow

Turns on audio processing only in the patch in which this ezadc~ is located, and in subpatches of that patch. Turns off audio processing in all other patches.

stop

Turns off audio processing in all loaded patches.

wclose

Closes the Audio Status window.

Output

signal

Out left outlet: Audio input from channel 1.

Out right outlet: Audio input from channel 2.

See Also

Name Description
adc~ Audio input and on/off
adstatus Report and control audio driver settings
dac~ Audio output and on/off
ezdac~ Audio output and on/off button