This section describes automation commands and statuses for the Audio Expert observer:
-
Automation commands are sent from the client to the analyzer for the observer.
-
Automation status of the observer is sent from the analyzer to the client.
Commands
The command format is:
"Plugin Command;plugin name=Audio Expert;command=<command>[;parameters=<parameters>]”
Responses
A command response has the following formats:
“PLUGIN COMMAND;Plugin Name=<name>;<status>;<error code>;description=<description>
Status values are “FAILED” or “SUCCEEDED”
A status message is sent immediately after the command is received. If the command will take time to execute, one or more additional status messages are sent later.
The “error code” and “description” fields indicate the meaning of each SUCCEEDED or FAILED message respectively.
|
Status |
Result |
Description |
|
SUCCEEDED |
10 |
Command completed |
|
SUCCEEDED |
11 |
Command accepted |
|
SUCCEEDED |
30 |
Extraction completed |
|
SUCCEEDED |
40 |
File opened |
|
SUCCEEDED |
41 |
File closed |
|
SUCCEEDED |
60 |
In live mode |
|
SUCCEEDED |
63 |
In standby mode |
|
FAILED |
9010 |
Invalid syntax (explanation) |
|
FAILED |
9011 |
Unknown command |
|
FAILED |
9012 |
Missing parameter (explanation) |
|
FAILED |
9013 |
Invalid parameter (explanation) |
|
FAILED |
9014 |
Too many parameters |
|
FAILED |
9020 |
Path does not exist |
|
FAILED |
9021 |
Invalid basename |
|
FAILED |
9030 |
No data found to extract |
|
FAILED |
9040 |
File open error |
|
FAILED |
9041 |
File close error |
|
FAILED |
9042 |
File write error |
|
FAILED |
9043 |
File does not exist |
|
FAILED |
9044 |
File not open |
|
FAILED |
9060 |
Already in live mode |
|
FAILED |
9061 |
Already not in live mode |
|
FAILED |
9062 |
Unable to enter live mode |
|
FAILED |
9063 |
Unable to exit live mode |
|
FAILED |
9998 |
Still executing previous user command |
|
FAILED |
9999 |
Still executing previous automation command |
Supported Commands
Get Available Streams
This command is a request for available stream settings where the valid parameters values are:
-
“no” – description would contain a list of available stream IDs.
-
“yes”- description would contain formatted information for each available stream ID; however, if the response would exceed the automation buffer length of 500 bytes, it would instead be treated as if the parameter value was “no”.
AES Export
This command is a request to export audio data for specific streams where the valid parameter field is in the format:
“streams=<stream value>,requestTypes=<types value>,time=<time value>,file=<path>”
For parameter “streams” the valid values are one of
-
“id0&id1&…idN” – List of stream IDs separated by ‘&’ “idN” – A single stream ID.
-
“all” – All streams.
The streams parameter is optional and if omitted the default value will be “all”
For parameter “requestTypes” the valid values are case-sensitive and are one of
-
"CSV” – Export an event data table that contains event, mode, stream, event type, frame #, severity, description, and time values for the specified times.
-
"RAW” – Export encoded audio data.
-
"WAV" – Export decoded audio data.
-
“all” – Export all types.
where the types may be combined like:
“t0&t1&t2”
The requestTypes parameter is optional and if omitted the default value will be “all”
For parameter “time” the valid values are case-sensitive and are one of
-
"selected” – Export data for only the selected times.
-
“all” – Export data for all times.
The time parameter is optional and if omitted the default value will be “all”.
For parameter “file”, a valid value is a properly formed path that does not represent a directory and is not read-only. The file parameter is required.