capture~

Store a signal to view as text

Description

Use the capture object to collect signal values for signal debugging or investigation. To record signal values, use the record~ or sfrecord~ object.

Examples

Capture a portion of a signal as text, to view, save, copy and paste, etc.

Arguments

behavioral-flag (f) [symbol]

Optional

If the first argument is the letter f, capture~ stores the first signal samples it receives, and then ignores subsequent samples once its storage buffer is full. If the letter f is not present, capture~ stores the most recent signal samples it has received, discarding earlier samples if necessary.

maximum-samples [int]

Optional

Limits the number of samples (and thus the length of the excerpt) that can be held by capture~. If no number is typed in, capture~ stores 4096 samples. The maximum possible number of samples is limited only by the amount of memory available to the Max application. A second number argument may be typed in to set the precision (the number of digits to the right of the decimal point) with which samples will be shown in the editing window. When set to mc mode (mc.capture~), the maximum-samples value applies to each channel. Captured values are displayed in sequence by channel number.

signal-vector-indices (up to 10 ints) [list]

Optional

A list of up to 10 indices within a signal vector. If no indices present, capture~ records the entire vector.

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 [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

clear

Erases the contents of capture~.

(mouse)

Double-clicking on capture~ opens a window for viewing and editing its contents. The numbers in the editing window can be copied and pasted into a graphic buffer~ editing window.

open

Causes an editing and viewing window for the capture~ object to become visible. The window is also brought to the front.

signal

An excerpt of the signal is stored as text for viewing, editing, or saving to a file. (The length of the excerpt can be specified as a typed-in argument to the object.)

wclose

Closes the window associated with the capture~ object.

write

Arguments

filename [symbol]
Saves the contents of capture~ into a text file. A standard file dialog is opened for naming the file. The word write, followed by a symbol, saves the file, using the symbol as the filename, in the same folder as the patch containing the capture~. If the patch has not yet been saved, the capture~ file is saved in the same folder as the Max application.

Output

(text)

capture~ outputs nothing and has no outlet but the signal which it captures into text can be saved to a file or copied and pasted elsewhere for editing.

See Also

Name Description
scope~ Visualize an audio signal
MSP Analysis Tutorial 1: Signals and Meters MSP Analysis Tutorial 1: Signals and Meters
MSP Analysis Tutorial 3: Using the FFT MSP Analysis Tutorial 3: Using the FFT