frame~

Output a list as an FFT frame or a signal vector

Description

The frame~ object is similar to the MSP sig~ object, but it provides a way to output lists inside a patcher loaded by the pfft~ object or to provide signal vector information outside of the pfft~ domain.

Arguments

None.

Attributes

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]

Text Justification

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

Arguments

signal-vector-value [int]
An integer sent to the frame~ object will cause a signal vector containing that value to be sent out the object's outlet.

float

Arguments

signal-vector-value [float]
A floating point number sent to the frame~ object will cause a signal vector containing that value to be sent out the object's outlet.

list

Arguments

signal-vector-value [list]
A list of integers or floating point numbers sent to the frame~ object will cause a signal vector containing those values to be sent out the object's outlet.

anything

Arguments

signal-vector-value [list]
Any integer, floating point number, or list sent to the frame~ object will cause a signal vector containing the value(s) to be sent out the object's outlet.

fill

Arguments

frame-value [list]
By default, the frame~ object sets all unspecified frame values to 0. The word fill, followed by an integer or floating point value, will set all unspecified frame values to that amount.

mirror

Arguments

mirroring [int]
By default, the frame~ object sets all frame values above the Nyquist frequency to 0. When used in conjunction with a pfft~ object set to full spectrum mode, the message mirror 1 will enable mirroring all frame values.

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~
frameaccum~ Compute "running phase" of successive phase deviation frames
framedelta~ Compute phase deviation between successive FFT frames
framesnap~ Output an FFT frame or signal vector as a list
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~