live.scope~

Visualize an audio signal

Examples

Arguments

None.

Attributes

active [long]

Toggles the object's active mode. When the active attribute is set to 0, waveform drawing stops. When the active attribute is set to 1, waveform drawing is enabled and the active colors are used.

line_width [float64]

The width of the waveform line. The defult value is 1.

grid_line_width [float64]

The width of the grid lines. The defult value is 1.

vertical_divisions [long]

The amount of grid divisions on the y-axis. To view these divisions, the grid attribute must be set to either 'vertical' or 'horizontal and vertical'.

grid [long]

Sets which grid lines to display. Possible values are:
0: off
1: horizontal
2: vertical
3: horizontal and vertical

smooth [long]

The smooth attribute allows you to visually smooth a waveform's lines. There are three values for this attribute: off, type 1, and type 2.
Off: No smoothing applied. Without smoothing, low frequency waveforms might look rough. However, for high and complex frequency waveforms, not using any smoothing will show the most accurate results.
Type 1: Improves visual appearance while also retaining as much accuracy as possible.
Type 2: The most visually pleasing at low frequencies, however, at higher frequencies, the accuracy decreases significantely.

trigger_direction [long]

The direction the trigger signal needs to be traveling, when passing the trigger threshold, in order to trigger a new waveform drawing. i.e. if the direction is set to 'up', and the treshold is set to '0', a new waveform will be drawn when the signal passes 0, while moving towards +1. This attribute works in conjunction with the trigger_threshold attribute. mode must be set to 'trigger' for either attribute to function.

trigger_threshold [float64]

Sets the trigger threshold value. This is the value the trigger signal (connected to the second inlet of live.scope~) must pass in order to trigger a new waveform drawing. This attribute works in conjunction with the trigger_direction attribute. mode must be set to 'trigger' for either attribute to function.

samples [float64]

Sets the number of samples to capture.

range [float64]

The minimum and maximum amplitude that is displayed in the live.scope~ object. When the amplitude exceeds the specified range, the visual display is clipped.

decay_time [float64]

Sets the time in milliseconds that the waveform line takes to fade out.

mode [long]

Sets the drawing mode for live.scope~. There are two possible modes: history and trigger. History mode captures and displays the last N samples, whereas trigger mode captures and displays based on an external trigger signal that is sent to the second inlet. When in trigger mode, you can adjust the attributes trigger_direction and trigger_threshold. When the signal in the second inlet passes the trigger_threshold value, live.scope~ will start capturing the signal from the first inlet.

interval [float64]

Sets the time in milliseconds that the waveform drawing is updated.

horizonal_divisions [long]

The amount of grid divisions on the x-axis. To view these divisions, the grid attribute must be set to either 'horizontal' or 'horizontal and vertical'.

rounded [float64]

The amount the corners of the live.scope~ object are rounded. Possible values are 0-10.

bgcolor [4 floats]

Sets the background color in RGBA format, when the active attribute is set to 0.

activebgcolor [4 floats]

Sets the background color in RGBA format, when the active attribute is set to 1.

linecolor [4 floats]

Sets the color of the waveform line in RGBA format, when the active attribute is set to 0.

activelinecolor [4 floats]

Sets the color of the waveform line in RGBA format, when the active attribute is set to 1.

gridcolor [4 floats]

Sets the grid color in RGBA format, when the active attribute is set to 0.

activegridcolor [4 floats]

Sets the grid color in RGBA format, when the active attribute is set to 1.

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]

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

bang

When sent to either inlet of live.scope~, a bang will trigger a new waveform drawing.

signal

Left inlet: signal to display in live.scope~
Right inlet: trigger signal

See Also

Name Description
scope~ Visualize an audio signal
meter~ Visual peak level indicator
live.meter~ Live-style visual peak level indicator