1
.TH "ecasound-iam" "1" "06\&.12\&.2006" "" "Multimedia software"
5
ecasound-iam \- ecasound interactive mode
12
Ecasound library contains an interpreter module that understands
13
a set of commands aimed at controlling various library services\&.
14
This is called the ecasound interactive mode (EIAM)\&. All programs
15
linked to ecasound library can use this facility\&.
17
.SH "ECI API and return types"
18
A special case of EIAM use is ecasound\&'s control interface (ECI),
19
which is a small library providing easy access to the EIAM
20
commands from outside of libecasound\&. When issuing EIAM commands using
21
ECI, it\&'s possible that commands also return information\&. Currently
22
supported return value types are: string [s], list of strings [S]
23
(elements separated by commas; escaped if necessary), integer [i],
24
long integer [li] and floating-point number [f]\&. These definitions are
25
used throughout this document\&. Commands that return nothing (void) are
26
marked with [-]\&. Additionally, return type [e] marks an error condition\&.
27
When an EIAM results in an error, a error string explaining the
28
condition is returned\&.
30
.SH "Real-time commands"
31
It\&'s not possible to use all EIAM commands to modify and control
32
objects that belong to a connected chainsetup\&. Commands that
33
do support this are: \&'start\&', \&'stop\&', \&'setpos\&', \&'rewind\&', \&'forward\&',
34
\&'c-select\&', \&'c-muting\&', \&'c-bypass\&', \&'cop-select\&', \&'copp-select\&',
35
\&'copp-value\&', \&'ctrlp-select\&' and \&'ctrlp-value\&'\&.
37
Another set of commands are those which can be used with connected
38
chainsetups, but not without an audible break\&. These are: \&'cop-add\&',
39
\&'cop-remove\&', \&'ctrl-add\&', \&'ctrl-select\&', \&'ctrl-remove\&'
41
In addition, most non-modifying (const) commands work with
46
Quit ecasound session\&. What this means in practice depends on the
47
client (library throws an exception)\&. \fI[-]\fP
50
Processing is started (play)\&. Error string is return if any errors upon
51
startup are encountered\&. \fI[e]\fP
54
Stop processing\&. \fI[-]\fP
57
Like \&'start\&' but blocks until processing is finished\&. Error string
58
is return if any errors upon startup, or during process, are
59
encountered\&. \fI[e]\fP
61
.IP "debug \&'debug-level\&'"
62
Set debug level to \&'debug-level\&'\&. Notice that client programs can
63
reimplement the debug routines\&. \fI[-]\fP
66
.IP "help\&', \&'h\&'"
73
Returns a string describing the engine status (running, stopped,
74
finished, error, not ready)\&. See also \fIcs-status\fP\&. \fI[s]\fP
77
Initializes and starts the engine\&. Doesn\&'t start the actual
78
processing\&. See also \fIstart\fP\&. \fI[-]\fP
81
Stops the engine\&. Does not disconnect the chainsetup that
82
was running\&. See also \fIstop\fP\&. \fI[-]\fP
85
Chainsetup is the central data object\&. All other objects (inputs,
86
outputs, chains, etc) are connected to some chainsetup\&. There can be
87
many chainsetups but only one can be connected\&. Similarly only
88
one chainsetup can be selected\&. If not otherwise specified operations
89
are done on the selected chainsetup\&. Some operations also require
90
that selected chainsetup is not connected\&.
92
.IP "cs-add \&'name\&'"
93
Adds a new chainsetup with name \&'name\&'\&. \&'name\&' is now
94
the selected chainsetup\&. \fI[-]\fP
97
Removes currently selected chainsetup\&. \fI[-]\fP
100
Returns a list of all chainsetups\&. \fI[S]\fP
102
.IP "cs-select \&'name\&'"
103
Selects chainsetup \&'name\&'\&. \fI[-]\fP
106
Returns the name of currently selected chainsetup\&. \fI[s]\fP
108
.IP "cs-index-select \&'cs_index\&', cs-iselect \&'cs_index\&'"
109
Selects a chainsetup based on a short index string\&. Chainsetup names
110
can be rather long\&. This command can be used to avoid typing
111
these long names\&. \&'cs_index\&' is an integer value, where \&'1\&' refers to
112
the first audio input/output\&. You can use \&'cs-list\&' and \&'cs-status\&'
113
to get a full list of currently available chainsetups\&. \fI[-]\fP
115
.IP "cs-load \&'filename\&'"
116
Adds a new chainsetup by loading it from file \&'filename\&'\&.
117
\&'filename\&' is now the selected chainsetup\&. \fI[-]\fP
120
Saves the currently selected chainsetup to file\&. If chainsetup was loaded
121
from a file, the saved version will replace the original\&. If it doesn\&'t
122
have a default filename, it\&'s saved to "chainsetup_name\&.ecs"\&. \fI[-]\fP
124
.IP "cs-save-as \&'filename\&'"
125
Saves currently selected chainsetup to file \&'filename\&'\&. \fI[-]\fP
128
Currently selected chainsetup is saved to a temporary file\&. This
129
file is loaded to an external editor (see ecasoundrc(5))\&. After
130
editing, the chainsetup is loaded back to ecasound\&. \fI[-]\fP
133
Whether currently selected chainsetup is valid (=can be connected)? \fI[i]\fP
136
Connect currently selected chainsetup to engine\&. Only one chainsetup
137
can be connected at a time\&. Error string is returned if connection
141
Disconnect currently connected chainsetup\&. \fI[-]\fP
144
Returns the name of currently connected chainsetup\&. \fI[s]\fP
146
.IP "cs-rewind \&'time-in-seconds\&', rewind \&'time-in-seconds\&', rw \&'time-in-seconds\&'"
147
Rewinds the current chainsetup position by \&'time-in-seconds\&' seconds\&.
148
Position of all inputs and outputs attached to the selected chainsetup
149
is also affected\&. \fI[-]\fP
151
.IP "cs-forward \&'time-in-seconds\&', forward \&'time-in-seconds\&', fw \&'ttime-in-seconds\&'"
152
The current chainsetup position is forwarded by \&'time-in-seconds\&'
153
seconds\&. Position of all inputs and outputs attached to the selected chainsetup
154
is also affected\&. \fI[-]\fP
156
.IP "cs-set-position \&'time-in-seconds\&', cs-setpos \&'time-in-seconds\&', setpos \&'time-in-seconds\&', set-position \&'time-in-seconds\&'"
157
Sets the chainsetup position to \&'time-in-seconds\&' seconds from the
158
beginning\&. Position of all inputs and outputs attached to the selected
159
chainsetup is also affected\&. \fI[-]\fP
161
.IP "cs-set-position-samples \&'time-in-samples\&'"
162
Sets the chainsetup position to \&'time-in-samples\&' samples from the
163
beginning\&. Position of all inputs and outputs attached to the selected
164
chainsetup is also affected\&. \fI[-]\fP
166
.IP "cs-get-position, cs-getpos, getpos, get-position"
167
Returns the current chainsetup position in seconds\&. \fI[f]\fP
169
.IP "cs-get-position-samples"
170
Returns the current chainsetup position in samples\&. \fI[li]\fP
172
.IP "cs-get-length, get-length"
173
Returns the chainsetup length in seconds (if known)\&. \fI[f]\fP
175
.IP "cs-get-length-samples, get-length-samples"
176
Returns the chainsetup length in samples (if known)\&. \fI[li]\fP
178
.IP "cs-set-length \&'seconds\&'"
179
Sets processing time in seconds (doesn\&'t have to be an integer value)\&.
180
A special-case value of \&'-1\&' will set the chainsetup length
181
according to the longest input object\&. \fI[-]\fP
183
.IP "cs-set-length-samples \&'samples\&'"
184
Sets processing time in samples\&. \fI[-]\fP
187
Toggle looping\&. When processing is finished, engine will start
188
again from the initial position\&. It\&'s not always possible to enable looping
189
(for instance all inputs and outputs have infinite length and
190
chainsetup length is not explicitly set with \&'cs-set-length\&')\&. \fI[-]\fP
193
Interpret general chainsetup parameters like for example
194
"-b" (buffersize), "-n" (name), etc\&. See ecasound(1) for
195
more info\&. \fI[-]\fP
197
.IP "cs-set-audio-format \&'bits,channels,sample_rate\&'"
198
Set the default sample parameters for currently selected chainsetup\&.
199
For example cd-quality audio would be "16,2,44100"\&. This does the
200
same as command-line argument "-f" (see ecasound(1))\&. \fI[-]\fP
202
.IP "cs-status, status, st"
203
Print status info about all chainsetups\&. \fI[s]\fP
205
.IP "cs-option \&'-prefix:arg1,\&.\&.\&.,argN\&'"
206
One powerful feature of the interactive-mode is that it
207
provides full access to ecasound\&'s command-line syntax\&.
208
For instance, command "cs-option -efb:400,200" means that
209
a bandpass filter is added to the currently selected
210
chain, with initial parameters 400 (center frequency)
211
and 200 (width in Hz)\&.
213
Note! EIAM implicitly interprets all strings beginning
214
with a \&'-\&' as "cs-option string"\&.
218
Chain is a simple signal flow abstraction\&. Every chain has one input
219
and one output\&. All chain operators and their controllers are attached
220
to chains\&. Chains can be muted, unmuted and be bypassed\&. If not
221
otherwise stated, all operations are done to currently selected
224
.IP "c-add \&'cname1,\&.\&.\&.,cnameN\&'"
225
Adds a set of chains\&. Added chains are automatically selected\&. Note
226
that commas in chain names are not allowed\&. \fI[-]\fP
229
Removes selected chains\&. \fI[-]\fP
232
Returns a list of all chains\&. \fI[S]\fP
234
.IP "c-select \&'cname1,\&.\&.\&.,cnameN\&'"
235
Selects chains\&. Other chains are automatically deselected\&. \fI[-]\fP
237
.IP "c-index-select \&'index1,\&.\&.\&.,indexN\&', c-iselect \&'index1,\&.\&.\&.,indexN\&'"
238
Selects a set of chains based on the list of indixes\&. Each index is
239
an integer value, where \&'1\&' refers to the first chain\&. You can use
240
\&'c-list\&' and \&'c-status\&' to get a full list of currently available
244
Selects all chains\&. \fI[-]\fP
246
.IP "c-select-add \&'cname1,\&.\&.\&.,cnameN\&'"
247
Selects more chains\&. \fI[-]\fP
249
.IP "c-deselect \&'cname1,\&.\&.\&.,cnameN\&'"
250
Deselects chains\&. \fI[-]\fP
253
Returns a list of selected chains\&. \fI[S]\fP
256
Clear selected chains by removing all chain operators and controllers\&.
257
Doesn\&'t change how chains are connected to inputs and outputs\&. \fI[-]\fP
259
.IP "c-rename \&'new_name\&'"
260
Renames the selected chain\&. When using this command, exactly one chain must
261
be selected\&. \fI[-]\fP
264
Toggle chain muting\&. When chain is muted, all data that goes through
265
is muted\&. \fI[-]\fP
268
Toggle chain muting\&. Note! Deprecated, use \fIc-muting\fP instead\&. \fI[-]\fP
271
Toggle chain bypassing\&. When chain is bypassed, sample data is passed
272
through untouched\&. \fI[-]\fP
275
Print status info about all chains\&. \fI[s]\fP
277
.SH "AUDIO INPUT/OUTPUT OBJECTS"
278
If not otherwise stated, all operations are done to currently selected
279
object\&. All commands with \fIai-\fP prefix operate on audio inputs,
280
while commands with \fIao-\fP operate on outputs\&.
282
.IP "ai-add \&'input_format_string\&'"
283
Adds a new input object\&. See ecasound(1) man page for more info about
284
the argument format (\&'-i\&' option)\&. Note on syntax: if any of
285
the parameters (such as a filename) contains commas, the parameter
286
should be enclosed in double-quotes\&. \fI[-]\fP
288
.IP "ao-add \&'output_format_string\&'"
289
Adds a new output object\&. See ecasound(1) man page for more info about
290
the argument format (\&'-o\&' option)\&. If argument is omitted,
291
a default output device is added (see ecasoundrc(5))\&. Note on syntax: if any
292
of the parameters (such as a filename) contains commas, the parameter
293
should be enclosed in double-quotes\&. \fI[-]\fP
296
Adds the default output device (see ecasoundrc(5))\&. \fI[-]\fP
298
.IP "ai-describe, ao-describe"
299
Returns a Ecasound Option Syntax (EOS) compliant string
300
describing the input/output\&. See the Ecasound User\&'s Guide
301
for more information about EOS\&. This command was introduced in
302
ecasound 2\&.4\&.4\&. \fI[s]\fP
304
.IP "ai-select \&'aobject_name\&', ao-select \&'aobject_name\&'"
305
Selects an audio object\&. \&'aobject_name\&' refers to the string
306
used when creating the object (the first argument given to ai-add/ao-add)\&.
307
Note that as a important difference to ai-add/ao-add, one should not
308
enclose the object name in double quotes for ai-select/ao-select\&. In the
309
case a chainsetup contains multiple inputs, or outputs, with
310
identical name, \&'ai-select\&' and \&'ao-select\&' will select
311
the first matching instance\&. In order to select a specific
312
instance, the \&'ai-iselect\&' and \&'ao-iselect\&' commands need to
315
.IP "ai-index-select \&'aobject_index\&', ai-iselect \&'aobject_index\&', ao-index-select \&'aobject_index\&', ao-iselect \&'aobject_index\&'"
316
Select some audio object based on a short index string\&. Especially file
317
names can be rather long\&. This command can be used to avoid typing
318
these long names when selecting audio objects\&. \&'aobject_index\&' is
319
an integer value, where \&'1\&' refers to the first audio input/output\&.
320
You can use \&'ai-list\&' and \&'ao-list\&' to get a full list of currently
321
available inputs/outputs\&. \fI[-]\fP
323
.IP "ai-selected, ao-selected"
324
Returns the name of the currently selected audio object\&. \fI[s]\fP
326
.IP "ai-attach, ao-attach"
327
Attaches the currently selected audio object to all selected chains\&. \fI[-]\fP
329
.IP "ai-remove, ao-remove"
330
Removes the currently selected audio object from the chainsetup\&. \fI[-]\fP
332
.IP "ai-forward \&'time_in_seconds\&', ai-fw \&'time_in_seconds\&', ao-forward \&'time_in_seconds\&', ao-fw \&'time_in_seconds\&'"
333
Selected audio object is forwarded by \&'time-in-seconds\&' seconds\&.
334
Time should be given as a floating point value (eg\&. 0\&.001 is the
335
same as 1ms)\&. \fI[-]\fP
337
.IP "ai-rewind \&'time_in_seconds\&', ai-rw \&'time_in_seconds\&', ao-rewind \&'time_in_seconds\&', ao-rw \&'time_in_seconds\&'"
338
Selected audio object is rewinded by \&'time-in-seconds\&' seconds\&.
339
Time should be given as a floating point value (eg\&. 0\&.001 is the
340
same as 1ms)\&. \fI[-]\fP
342
.IP "ai-setpos \&'time_in_seconds\&', ai-set-position \&'time_in_seconds\&', ao-setpos \&'time_in_seconds\&', ao-set-position \&'time_in_seconds\&'"
343
Set audio object position to \&'time_in_seconds\&'\&. \fI[-]\fP
345
.IP "ai-set-position-samples \&'time_in_samples\&', ao-set-position-samples \&'time_in_samples\&'"
346
Set audio object position to \&'time_in_samples\&'\&. \fI[-]\fP
348
.IP "ai-getpos, ai-get-position, ao-getpos, ao-get-position"
349
Returns the audio object position in seconds\&. \fI[f]\fP
351
.IP "ai-get-position-samples, ao-get-position-samples"
352
Returns the audio object position in samples\&. \fI[li]\fP
354
.IP "ai-get-length, ao-get-length"
355
Returns the audio object length in seconds\&. \fI[f]\fP
357
.IP "ai-get-length-samples, ao-get-length-samples"
358
Returns the audio object length in samples\&. \fI[li]\fP
360
.IP "ai-get-format, ao-get-format"
361
Returns the audio format of the selected audio input/output as a
362
formatted string\&. See documentation for \&'-f\&' command-line option\&. \fI[s]\fP
364
.IP "ai-wave-edit, ao-wave-edit"
365
The currently selected audio object is loaded into an external
366
wave editor (see ecasoundrc(5))\&. \fI[-]\fP
368
.IP "ai-list, ao-list"
369
Returns a list of all input/output objects\&. \fI[S]\fP
372
Prints a list of registered audio object types\&. \fI[s]\fP
375
Audio object status (index strings, position, length, etc)\&. \fI[s]\fP
377
.SH "CHAIN OPERATORS"
378
Chain operators are used to process and analyze sample data\&.
379
They are attached to chains\&. If not otherwise stated,
380
currently selected chainsetup and chain are used\&. Also,
381
\&'chainop_id\&' and \&'param_id\&' are used to select chain operators
382
and their parameters\&. First valid value for these parameters
385
.IP "cop-add \&'cop_format_string\&'"
386
Adds a new chain operator\&. In addition to normal chain operators,
387
this commmand can also be used to add effect presets and various
388
plugins\&. Note; it is not possible to add operators to multiple
389
chains at once\&. In other words only one chain should be selected
390
when issuing \&'cop-add\&'\&. Argument format is
391
"-<id_string>:par1,\&.\&.\&.,parN" (if parameter itself contains commas,
392
the parameter should be enclosed in double-quotes)\&. See
393
ecasound(1) man page for more info\&. \fI[-]\fP
396
Returns a Ecasound Option Syntax (EOS) compliant string
397
describing the chain operator\&. See the Ecasound User\&'s Guide
398
for more information about EOS\&. This command was introduced in
399
ecasound 2\&.4\&.4\&. \fI[s]\fP
402
Removes the selected chain operator\&. \fI[-]\fP
405
Returns a list of all chain operators attached to the currently
406
selected chain\&. \fI[S]\fP
408
.IP "cop-select \&'param_id\&', cop-index-select \&'param_id\&', cop-iselect \&'param_id\&'"
409
Selects a chain operator\&. \fI[-]\fP
412
Returns the index number of currently selected chain operator\&. \fI[i]\fP
414
.IP "cop-set \&'chainop_id, param_id, value\&'"
415
Changes the value of a single chain operator parameter\&. Unlike other
416
chain operator commands, this can also be used during processing\&. \fI[-]\fP
419
Returns info about chain operator status\&. \fI[s]\fP
422
Returns a list of selected chain operator\&'s parameters\&. \fI[S]\fP
424
.IP "copp-select \&'param_id\&', copp-index-select \&'param_id\&', copp-iselect \&'param_id\&'"
425
Selects a chain operator parameter\&. \fI[-]\fP
428
Returns the index number of currently selected chain operator parameter\&. \fI[i]\fP
430
.IP "copp-set \&'value\&'"
431
Sets the selected parameter value to \&'value\&'\&. \fI[-]\fP
434
Returns the selected parameter value\&. \fI[f]\fP
437
Prints a list of registered chain operators\&. \fI[s]\fP
439
.IP "preset-register"
440
Prints a list of registered effect presets\&. \fI[s]\fP
442
.IP "ladspa-register"
443
Prints a list of registered LADSPA plugins\&. \fI[s]\fP
446
Controllers are used to control individual chain operator parameters\&.
447
They are attached to chains\&. If not otherwise stated, currently
448
selected chainsetup and chains are used\&.
450
.IP "ctrl-add \&'copc_format_string\&'"
451
Adds a new controller and attach it to currently selected chain
452
operator\&. Argument format is "-<id_string>:<param_id>,<range_low>,
453
<range_high>,par1,\&.\&.\&.,parN" (if parameter itself contains commas,
454
the parameter should be enclosed in double-quotes)\&. See ecasound(1)
455
man page for more info\&. \fI[-]\fP
458
Returns a Ecasound Option Syntax (EOS) compliant string
459
describing the controller\&. See the Ecasound User\&'s Guide
460
for more information about EOS\&. This command was introduced in
461
ecasound 2\&.4\&.4\&. \fI[s]\fP
464
Removes the selected controller\&. \fI[-]\fP
467
Returns a list of all controllers attached to the currently
468
selected chain\&. \fI[S]\fP
470
.IP "ctrl-select \&'param_id\&', ctrl-index-select \&'param_id\&', ctrl-iselect \&'param_id\&'"
471
Selects a controller\&. \fI[-]\fP
474
Returns the index number of currently selected controller\&. \fI[i]\fP
477
Returns info about controller status\&. \fI[s]\fP
480
Prints a list of registered controllers\&. \fI[s]\fP
482
.IP "ctrl-get-target"
483
Returns the index number of the chain operator that is
484
connected to the selected controller\&. The returned index
485
refers to the currently selected chain (see \&'cop-list\&')\&. \fI[i]\fP
488
Returns a list of all controller parameters\&. This command was introduced in
489
ecasound 2\&.4\&.2\&. \fI[S]\fP
492
Selects a controller parameter\&. This command was introduced in
493
ecasound 2\&.4\&.2\&. \fI[-]\fP
496
Returns the index number of currently selected controller parameter\&. This command
497
was introduced in ecasound 2\&.4\&.2\&. \fI[i]\fP
500
Returns the selected controller parameter value\&. This command was introduced in
501
ecasound 2\&.4\&.2\&. \fI[f]\fP
504
Sets the selected controller parameter value to \&'value\&'\&. This command was introduced in
505
ecasound 2\&.4\&.2\&. \fI[-]\fP
507
.SH "INTERNAL COMMANDS"
508
Internal commands are not directly aimed at normal use\&. They
509
are primarily meant for use in scripting and frontends\&.
512
Returns a list of all registered EIAM commands\&. \fI[S]\fP
514
.IP "int-log-history"
515
Returns recent log messages sent by libecasound modules\&. This
516
is a good tool for debugging ECI/EIAM scripts and applications\&. This
517
command was introduced in ecasound 2\&.4\&.0\&. \fI[s]\fP
519
.IP "int-output-mode-wellformed"
520
Select the well-format output format for log messages\&. \fI[-]\fP
522
.IP "int-set-float-to-string-precision"
523
Sets precision used in float to text conversions\&. Note that
524
this can be used to control the precision of float return values
525
for ECI commands\&. \fI[-]\fP
527
.IP "int-set-log-history-length"
528
Sets the log history length\&. Defaults to 0 items\&.
529
This command was introduced in ecasound 2\&.4\&.0\&. \fI[-]\fP
531
.IP "int-cmd-version-string"
532
Returns EIAM parser version string\&. \fI[s]\fP
534
.IP "int-cmd-version-lib-current"
535
Returns EIAM library interface version (libtool)\&. \fI[i]\fP
537
.IP "int-cmd-version-lib-revision"
538
Returns EIAM library interface revision (libtool)\&. \fI[i]\fP
540
.IP "int-cmd-version-lib-age"
541
Returns EIAM library interface age (libtool)\&. \fI[i]\fP
544
Object maps are central repositories for commonly used object types\&.
545
By querying the maps, applications can get a list of all registered
546
object types and their properties\&.
549
Prints a list of registered chain operators using
550
the format specified in section \fIOPERATOR DESCRIPTIONS\fP\&. \fI[s]\fP
552
.IP "map-preset-list"
553
Prints a list of registered effect presets using
554
the format specified in section \fIOPERATOR DESCRIPTIONS\fP\&. \fI[s]\fP
556
.IP "map-ladspa-list"
557
Prints a list of registered LADSPA plugins using
558
the format specified in section \fIOPERATOR DESCRIPTIONS\fP\&. \fI[s]\fP
560
.IP "map-ladspa-id-list"
561
Prints a list of registered LADSPA plugins using
562
the format specified in section \fIOPERATOR DESCRIPTIONS\fP\&.
563
Numerical LADPSA plugin identifiers are used\&. \fI[s]\fP
566
Prints a list of registered controllers using
567
the format specified in section \fIOPERATOR DESCRIPTIONS\fP\&. \fI[s]\fP
570
The following dump commands are not meant for normal use\&.
571
Their primary purpose is to provide an easy way to get
572
internal state information from libecasound\&. All dump
573
commands output a single line with syntax "key value"
574
to the selected output stream (defaults to stdout)\&.
576
.IP "dump-target \&'filename\&'"
577
Set target stream for dumping\&. \fI[-]\fP
580
Dumps engine status - \&'running\&', \&'stopped\&', \&'finished\&' or \&'notready\&'\&. \fI[-]\fP
583
Dumps the global position\&. Printed in seconds using a floating-point
584
representation\&. \fI[-]\fP
587
Dumps the overall processing length\&. Printed in seconds using a floating-point
588
representation\&. \fI[-]\fP
591
Dumps status string for the currently selected chainsetup - \&'connected\&',
592
\&'selected\&' or an empty string\&. \fI[-]\fP
594
.IP "dump-c-selected"
595
Dumps the name of currently selected chain\&. \fI[-]\fP
597
.IP "dump-ai-selected"
598
Dumps label of currently selected audio input\&. If no input is
599
selected, dumps an empty string\&. \fI[-]\fP
601
.IP "dump-ai-position"
602
Dumps position of currently selected audio inputs\&. Printed in
603
seconds, using a floating-point representation\&. \fI[-]\fP
606
Dumps length of currently selected audio input\&. Printed in seconds,
607
using a floating-point representation\&. \fI[-]\fP
609
.IP "dump-ai-open-state"
610
Dumps audio input state info\&. Either \&'open\&' or \&'closed\&'\&. \fI[-]\fP
612
.IP "dump-ao-selected"
613
Dumps label of currently selected audio output\&. If no output is
614
selected, dumps an empty string\&. \fI[-]\fP
616
.IP "dump-ao-position"
617
Dumps position of currently selected audio outputs\&. Printed in
618
seconds, using a floating-point representation\&. \fI[-]\fP
621
Dumps length of currently selected audio output\&. Printed in seconds,
622
using a floating-point representation\&. \fI[-]\fP
624
.IP "dump-ao-open-state"
625
Dumps audio output state info\&. Either \&'open\&' or \&'closed\&'\&. \fI[-]\fP
627
.IP "dump-cop-value \&'chainop,param\&'"
628
Dumps chain operator parameter value\&. \&'chainop\&' and \&'param\&' are
629
operator and parameter index values (1\&.\&.\&.n)\&. \fI[-]\fP
631
.SH "OPERATOR DESCRIPTIONS"
634
The \fImap-xxx-list\fP commands return a string containing all registered
635
objects of the given type \fIxxx\fP\&. Each line of the output describes
636
one registered type\&. The used syntax is:
638
\&'keyword,name,description,num_of_params,par1_def,par2_def,\&.\&.\&.\&'
640
\fIparX_def\fP describes one object parameter\&. This definition
641
is present for all parameters of the described object type\&.
644
\&'name,description,defaultvalue,upper_bound_flag,upper_bound,
645
lower_bound_flag,lower_bound,toggled_flag,integer_flag,
646
logarithmic_flag,output_flag\&'
648
For exact descriptions of these fields, please see
649
the header file emph(ecasound/libecasound/eca-operator\&.h)\&.
654
ecasound(1), ecatools (1), ecasoundrc(5)
659
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>
added
removed
Documentation/ecasound-iam_manpage.man
