snapshot~
Description
Use the snapshot~ object to convert a signal value into a float message when a bang is received or according to a specified interval. The interval can be set to a fixed or tempo-relative rate using the Max time format syntax.
Examples
Arguments
reporting-interval [list]
Set the reporting interval in ms or using the Max time format syntax. If the interval is 0 snapshot~ will only output data when it receives a bang message.
Attributes
active [int]
Reporting by interval enable
interval [10 atoms]
Reporting interval
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.
jspainterfile [symbol]
JS Painter File
patching_rect [4 floats] (default: 0. 0. 100. 0.)
Sets the position and size of the object in the patcher window.
position [2 floats]
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]
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]
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
bang
int
Arguments
In right inlet: Set the reporting interval in ms. If the interval is 0, automatic reporting stops.
float
Arguments
In right inlet: Set the reporting interval in ms. If the interval is 0, automatic reporting stops.
offset
Arguments
sampleinterval
Arguments
signal
In mc mode (mc.snapshot~), left outlet outputs float message for each channel in sequence. The right outlet outputs a corresponding voice message in the format: voice channel-number.
start
stop
Output
float
When snapshot~ receives a bang, or its internal clock is on, sample values from the input signal are sent out its outlet.
See Also
| Name | Description |
|---|---|
| capture~ | Store a signal to view as text |
| number~ | Signal monitor and constant generator |
| sig~ | Convert numbers into audio signals |
| MSP Analysis Tutorial 1: Signals and Meters | MSP Analysis Tutorial 1: Signals and Meters |