peakamp~
Report the maximum amplitude of a signal
Description
Use the peakamp~ object to monitor an incoming signal and reports the absolute value of the peak amplitude of the signal it has received since the last time it was reported.
Discussion
The peakamp~ object is sample-accurate when Scheduler in Audio Interrupt is enabled. More details here.
Arguments
ms-output-interval[int]ms
optional
Attributes
interval[float]
Sets the reporting interval, in milliseconds. This is the same functionality as the ms-output-interval argument. If the interval is 0, the internal clock is not used, so peakamp~ will only output data when it receives a bang message. If it is non-zero, peakamp~ will repeatedly send out the peak amplitude received in that interval of time. By default, the interval is 0.
signed[int]
When the signed attribute is set to 1, the peak amplitude of the incoming signal in the specified interval is reported, rather than the absolute value of the peak amplitude.
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]: 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'
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]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
JS Painter File
patching_rect[4 floats]: 0. 0. 100. 0.
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
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]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 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]
write-only
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]
write-only
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
In left inlet: Sends out a report of the greatest (absolute value) signal amplitude received since the previous report.
signal
In left inlet: Signal to be evaluated for its peak amplitude.
Output
float
When peakamp~ receives a bang or its internal clock is on, the absolute value of the peak signal value from the input signal is sent out its outlet.
See Also
| Name | Description |
|---|---|
| meter~ | Visual peak level indicator |
| levelmeter~ | RMS level meter |
| snapshot~ | Convert signal values to numbers |
| loudness~ | Report loudness of a signal |
| average~ | Multi-mode signal average |
| avg~ | Signal average |