framesnap~

Output an FFT frame or signal vector as a list

Description

The framenap~ object is similar to snapshot~ but outputs a list with the contents of a signal vector convenient for capturing an FFT frame when used inside a pfft~ object.

Arguments

interval [int]

Optional

An optional number argument sets the internal sampling interval in milliseconds. If the argument is 0 or not present, framesnap~ will not generate output automatically. In this case, you will need to send a bang message to output a frame of signal data.

Attributes

active [int]

Enables/disables output of the framesnap~ object.

interval [10 atoms]

Sets the output interval. The interval can be specified in any Max time format.

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

bang message produces a list containing the contents of the current signal vector.

int

See float message below.

float

(In left inlet) Sending a non-zero number to the left inlet starts the object's automatic reporting of signal values. A zero received in the left inlet stops automatic reporting.
(In right inlet) A number sent to the right inlet of the framesnap~ object sets the internal sampling interval in milliseconds. If the interval is set to 0, framesnap~ will not generate output automatically. In this case, you will need to send a bang message to output a frame of signal data.

list

Any message that conforms to the Max time format (ms, hh:mm:ss, ticks bars.beats.units, notevalues, hz, or samples) can be used to specify the internal sampling interval used by the framesnap~ object.

anything

Any message that conforms to a Max time format message (e.g. ms, hh:mm:ss, ticks bars.beats.units, notevalues, hz, or samples,) can be used to specify the internal sampling interval used by the framesnap~ object.

sampleinterval

The word sampleinterval, followed by an integer, sets the internal sampling interval in milliseconds.

signal

A signal connected to the framesnap~ object's left inlet will used to output a list when the object receives a bang or its internal sample interval clock fires.

start

The message start starts the framesnap~ object's automatic output if the sample interval is non-zero. If the sample output is zero, the start message is equivalent to the bang message, causing a single signal vector output.

stop

The message stop stops the framesnap~ object from automatic output if its sample interval is non-zero.

See Also

Name Description
cartopol Convert cartesian to polar coordinates
cartopol~ Signal Cartesian to Polar coordinate conversion
fft~ Fast Fourier transform
fftin~ Input for a patcher loaded by pfft~
fftinfo~ Report information about a patcher loaded by pfft~
fftout~ Output for a patcher loaded by pfft~
frame~ Output a list as an FFT frame or a signal vector
frameaccum~ Compute "running phase" of successive phase deviation frames
framedelta~ Compute phase deviation between successive FFT frames
ifft~ Inverse fast Fourier transform
in Message input for a patcher loaded by poly~ or pfft~
out Message output for a patcher loaded by poly~ or pfft~
poltocar Convert polar to cartesian coordinates
poltocar~ Signal Polar to Cartesian coordinate conversion
vectral~ Vector-based envelope follower
MSP Analysis Tutorial 3: Using the FFT MSP Analysis Tutorial 3: Using the FFT
MSP Analysis Tutorial 4: Signal Processing with pfft~ MSP Analysis Tutorial 4: Signal Processing with pfft~