Ecasound library contains an interpreter module that understands
a set of commands aimed at controlling various library services.
This is called the ecasound interactive mode (EIAM). All programs
linked to ecasound library can use this facility.
Another set of commands are those which can be used with connected
chainsetups, but not without an audible break. These are: 'cop-add',
'cop-remove', 'ctrl-add', 'ctrl-select', 'ctrl-remove'
In addition, most non-modifying (const) commands work with
connected setups.
Sets the selected controller parameter value to 'value'. This command was introduced in
ecasound 2.4.2. [-]
INTERNAL COMMANDS
Internal commands are not directly aimed at normal use. They
are primarily meant for use in scripting and frontends.
- int-cmd-list
-
Returns a list of all registered EIAM commands. [S]
- int-log-history
-
Returns recent log messages sent by libecasound modules. This
is a good tool for debugging ECI/EIAM scripts and applications. This
command was introduced in ecasound 2.4.0. [s]
- int-output-mode-wellformed
-
Select the well-format output format for log messages. [-]
- int-set-float-to-string-precision
-
Sets precision used in float to text conversions. Note that
this can be used to control the precision of float return values
for ECI commands. [-]
- int-set-log-history-length
-
Sets the log history length. Defaults to 0 items.
This command was introduced in ecasound 2.4.0. [-]
- int-cmd-version-string
-
Returns EIAM parser version string. [s]
- int-cmd-version-lib-current
-
Returns EIAM library interface version (libtool). [i]
- int-cmd-version-lib-revision
-
Returns EIAM library interface revision (libtool). [i]
- int-cmd-version-lib-age
-
Returns EIAM library interface age (libtool). [i]
OBJECT MAPS
Object maps are central repositories for commonly used object types.
By querying the maps, applications can get a list of all registered
object types and their properties.
- map-cop-list
-
Prints a list of registered chain operators using
the format specified in section OPERATOR DESCRIPTIONS. [s]
- map-preset-list
-
Prints a list of registered effect presets using
the format specified in section OPERATOR DESCRIPTIONS. [s]
- map-ladspa-list
-
Prints a list of registered LADSPA plugins using
the format specified in section OPERATOR DESCRIPTIONS. [s]
- map-ladspa-id-list
-
Prints a list of registered LADSPA plugins using
the format specified in section OPERATOR DESCRIPTIONS.
Numerical LADPSA plugin identifiers are used. [s]
- map-ctrl-list
-
Prints a list of registered controllers using
the format specified in section OPERATOR DESCRIPTIONS. [s]
DUMP COMMANDS
The following dump commands are not meant for normal use.
Their primary purpose is to provide an easy way to get
internal state information from libecasound. All dump
commands output a single line with syntax "key value"
to the selected output stream (defaults to stdout).
- dump-target 'filename'
-
Set target stream for dumping. [-]
- dump-status
-
Dumps engine status - 'running', 'stopped', 'finished' or 'notready'. [-]
- dump-position
-
Dumps the global position. Printed in seconds using a floating-point
representation. [-]
- dump-length
-
Dumps the overall processing length. Printed in seconds using a floating-point
representation. [-]
- dump-cs-status
-
Dumps status string for the currently selected chainsetup - 'connected',
'selected' or an empty string. [-]
- dump-c-selected
-
Dumps the name of currently selected chain. [-]
- dump-ai-selected
-
Dumps label of currently selected audio input. If no input is
selected, dumps an empty string. [-]
- dump-ai-position
-
Dumps position of currently selected audio inputs. Printed in
seconds, using a floating-point representation. [-]
- dump-ai-length
-
Dumps length of currently selected audio input. Printed in seconds,
using a floating-point representation. [-]
- dump-ai-open-state
-
Dumps audio input state info. Either 'open' or 'closed'. [-]
- dump-ao-selected
-
Dumps label of currently selected audio output. If no output is
selected, dumps an empty string. [-]
- dump-ao-position
-
Dumps position of currently selected audio outputs. Printed in
seconds, using a floating-point representation. [-]
- dump-ao-length
-
Dumps length of currently selected audio output. Printed in seconds,
using a floating-point representation. [-]
- dump-ao-open-state
-
Dumps audio output state info. Either 'open' or 'closed'. [-]
- dump-cop-value 'chainop,param'
-
Dumps chain operator parameter value. 'chainop' and 'param' are
operator and parameter index values (1...n). [-]
OPERATOR DESCRIPTIONS
The map-xxx-list commands return a string containing all registered
objects of the given type xxx. Each line of the output describes
one registered type. The used syntax is:
'keyword,name,description,num_of_params,par1_def,par2_def,...'
parX_def describes one object parameter. This definition
is present for all parameters of the described object type.
The used syntax is:
'name,description,defaultvalue,upper_bound_flag,upper_bound,
lower_bound_flag,lower_bound,toggled_flag,integer_flag,
logarithmic_flag,output_flag'
For exact descriptions of these fields, please see
the header file emph(ecasound/libecasound/eca-operator.h).
SEE ALSO
ecasound (1), ecatools (1), ecasoundrc (5)
AUTHOR
Kai Vehmanen, <kvehmanen -at- eca -dot- cx>