snapshot~ Reference

Convert signal values to numbers

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

See a sample of a signal at a given moment

Arguments

reporting-interval [list]

Optional
Unitstime-value

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

Messages

bang

Report the input signal value

int

Arguments

internal-clock-enable-flag [int]
In left inlet: Any non-zero value turns on interval-based reporting, 0 turns it off. Reporting is on by default if a non-zero interval was specified.
In right inlet: Set the reporting interval in ms. If the interval is 0, automatic reporting stops.

float

Arguments

internal-clock-enable-flag [float]
In left inlet: Any non-zero value turns on interval-based reporting, 0 turns it off. Reporting is on by default if a non-zero interval was specified.
In right inlet: Set the reporting interval in ms. If the interval is 0, automatic reporting stops.

list

Arguments

ITM-time-list [list]
Set interval in Max time format.

anything

Arguments

ITM-time-list [list]
Set interval in Max time format.

offset

Arguments

sample-offset [int]
Set the index of the sample within a signal vector that will be reported. The number is constrained between 0 (least recent, the default) and the current signal vector size minus one (most recent).

sampleinterval

Arguments

internal-clock-interval [int]
Set interval in samples per sampleinterval

signal

In single-channel mode, converts current signal value to a float and outputs as a float message.
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

Start interval-based reporting

stop

Stop interval-based reporting

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~
number~
sig~
MSP Analysis Tutorial 1: Signals and Meters MSP Analysis Tutorial 1: Signals and Meters