Parameters
| Param |
Type |
Default |
Description |
| name |
string |
|
Name of the element |
| value |
string |
|
Data field containing path or a URL to the audio. |
| [defaultspeed] |
string |
1 |
Default speed level (from 0.5 to 2). |
| [defaultscale] |
string |
1 |
Audio pane default y-scale for waveform. |
| [defaultzoom] |
string |
1 |
Default zoom level for waveform. (from 1 to 1500). |
| [defaultvolume] |
string |
1 |
Default volume level (from 0 to 1). |
| [hotkey] |
string |
|
Hotkey used to play or pause audio. |
| [sync] |
string |
|
Object name to sync with. |
| [height] |
string |
96 |
Total height of the audio player. |
| [waveheight] |
string |
32 |
Minimum height of a waveform when in splitchannels mode with multiple channels to display. |
| [splitchannels] |
boolean |
false |
Display multiple audio channels separately, if the audio file has more than one channel. (NOTE: Requires more memory to operate.) |
| [decoder] |
string |
"webaudio" |
Decoder type to use to decode audio data. ("webaudio" or "ffmpeg") |
| [player] |
string |
"html5" |
Player type to use to play audio data. ("html5" or "webaudio") |
Result parameters
| Name |
Type |
Description |
| original_length |
number |
length of the original audio (seconds) |
| value |
Object |
|
| value.start |
number |
start time of the fragment (seconds) |
| value.end |
number |
end time of the fragment (seconds) |
| value.channel |
number |
channel identifier which was targeted |
Example JSON
{
"original_length": 18,
"value": {
"start": 3.1,
"end": 8.2,
"channel": 0,
"labels": ["Voice"]
}
}