SOX-ANALYSIS
[GENERIC-FUNCTION]
|

OM-SoX Function Reference
|
ARGUMENTS:
|
- sox-input
|
Audio input to be analyzed [sound, path, string/pipe, sox-input] |
|
|
- sox-statistic
|
Sox-statistic to be analyzed for [string] |
[default = ""] |
&key
|
|
|
- outpath
|
Outpath type (directory, filename, filepath) [path] |
|
|
- channel
|
Channel of input audio on which to run the analysis [string] |
[default = 1] |
|
- clipping
|
Specify region (start and endpoint in seconds) of input audio to be analyzed [list] |
|
|
- recursive
|
recursive (when 'on' applies analysis recursively to audio) [symbol] |
|
|
- batch-mode
|
Mode for batch-processing (break, repeat, cycle) [symbol] |
[default = "break"] |
|
Description:
Main audio analysis function for OM-SoX. Takes audio provided in <sox-input> and returns value for a sox-statistic provided in <sox-effect>.
<output> specifies a filename, directory, or path for a (temporary) textfile into which the analysis results are written before being returned by sox-analysis.
<channel> allows to specify a channel of the input audio on which the analysis will be performed. NB: Ignored when the input is a sox-input class.
<clipping> allows to apply the analysis on a selected region of the audio input, specified by start and end time (in seconds).
<recursive> is an experimental option allowing to apply a sox-analysis recursively to audio input (e.g. trimming).
<batch-mode> determines the behaviour when processing lists of sox-inputs and sox-statistics that differ in length.
Amplitudes are linear (between -1 1), levels are in dBFS.
NB: If 'Delete Temporary Files' is checked in OM's Audio Preferences, the temporary file will be deleted after the value has been returned.
|
Auto doc generation by OpenMusic 6.7 © 2011 IRCAM
|