84
89
are done on the selected chainsetup\&. Some operations also require
85
90
that selected chainsetup is not connected\&.
87
.IP "cs-add \&'name\&'"
92
.IP "cs-add \&'name\&'"
88
93
Adds a new chainsetup with name \&'name\&'\&. \&'name\&' is now
89
94
the selected chainsetup\&. \fI[-]\fP
92
97
Removes currently selected chainsetup\&. \fI[-]\fP
95
100
Returns a list of all chainsetups\&. \fI[S]\fP
97
.IP "cs-select \&'name\&'"
102
.IP "cs-select \&'name\&'"
98
103
Selects chainsetup \&'name\&'\&. \fI[-]\fP
101
106
Returns the name of currently selected chainsetup\&. \fI[s]\fP
103
.IP "cs-index-select \&'cs_index\&', cs-iselect \&'cs_index\&'"
108
.IP "cs-index-select \&'cs_index\&', cs-iselect \&'cs_index\&'"
104
109
Selects a chainsetup based on a short index string\&. Chainsetup names
105
110
can be rather long\&. This command can be used to avoid typing
106
111
these long names\&. \&'cs_index\&' is an integer value, where \&'1\&' refers to
107
112
the first audio input/output\&. You can use \&'cs-list\&' and \&'cs-status\&'
108
113
to get a full list of currently available chainsetups\&. \fI[-]\fP
110
.IP "cs-load \&'filename\&'"
115
.IP "cs-load \&'filename\&'"
111
116
Adds a new chainsetup by loading it from file \&'filename\&'\&.
112
117
\&'filename\&' is now the selected chainsetup\&. \fI[-]\fP
115
120
Saves the currently selected chainsetup to file\&. If chainsetup was loaded
116
121
from a file, the saved version will replace the original\&. If it doesn\&'t
117
122
have a default filename, it\&'s saved to "chainsetup_name\&.ecs"\&. \fI[-]\fP
119
.IP "cs-save-as \&'filename\&'"
124
.IP "cs-save-as \&'filename\&'"
120
125
Saves currently selected chainsetup to file \&'filename\&'\&. \fI[-]\fP
123
128
Currently selected chainsetup is saved to a temporary file\&. This
124
129
file is loaded to an external editor (see ecasoundrc(5))\&. After
125
130
editing, the chainsetup is loaded back to ecasound\&. \fI[-]\fP
128
133
Whether currently selected chainsetup is valid (=can be connected)? \fI[i]\fP
131
136
Connect currently selected chainsetup to engine\&. Only one chainsetup
132
can be connected at a time\&. \fI[-]\fP
137
can be connected at a time\&. Error string is returned if connection
135
141
Disconnect currently connected chainsetup\&. \fI[-]\fP
138
144
Returns the name of currently connected chainsetup\&. \fI[s]\fP
140
.IP "cs-rewind \&'time-in-seconds\&', rewind \&'time-in-seconds\&', rw \&'time-in-seconds\&'"
146
.IP "cs-rewind \&'time-in-seconds\&', rewind \&'time-in-seconds\&', rw \&'time-in-seconds\&'"
141
147
Rewinds the current chainsetup position by \&'time-in-seconds\&' seconds\&.
142
148
Position of all inputs and outputs attached to the selected chainsetup
143
149
is also affected\&. \fI[-]\fP
145
.IP "cs-forward \&'time-in-seconds\&', forward \&'time-in-seconds\&', fw \&'ttime-in-seconds\&'"
151
.IP "cs-forward \&'time-in-seconds\&', forward \&'time-in-seconds\&', fw \&'ttime-in-seconds\&'"
146
152
The current chainsetup position is forwarded by \&'time-in-seconds\&'
147
153
seconds\&. Position of all inputs and outputs attached to the selected chainsetup
148
154
is also affected\&. \fI[-]\fP
150
.IP "cs-set-position \&'time-in-seconds\&', cs-setpos \&'time-in-seconds\&', setpos \&'time-in-seconds\&', set-position \&'time-in-seconds\&'"
156
.IP "cs-set-position \&'time-in-seconds\&', cs-setpos \&'time-in-seconds\&', setpos \&'time-in-seconds\&', set-position \&'time-in-seconds\&'"
151
157
Sets the chainsetup position to \&'time-in-seconds\&' seconds from the
152
158
beginning\&. Position of all inputs and outputs attached to the selected
153
159
chainsetup is also affected\&. \fI[-]\fP
155
.IP "cs-set-position-samples \&'time-in-samples\&'"
161
.IP "cs-set-position-samples \&'time-in-samples\&'"
156
162
Sets the chainsetup position to \&'time-in-samples\&' samples from the
157
163
beginning\&. Position of all inputs and outputs attached to the selected
158
164
chainsetup is also affected\&. \fI[-]\fP
160
.IP "cs-get-position, cs-getpos, getpos, get-position"
166
.IP "cs-get-position, cs-getpos, getpos, get-position"
161
167
Returns the current chainsetup position in seconds\&. \fI[f]\fP
163
.IP "cs-get-position-samples"
169
.IP "cs-get-position-samples"
164
170
Returns the current chainsetup position in samples\&. \fI[li]\fP
166
.IP "cs-get-length, get-length"
172
.IP "cs-get-length, get-length"
167
173
Returns the chainsetup length in seconds (if known)\&. \fI[f]\fP
169
.IP "cs-get-length-samples, get-length-samples"
175
.IP "cs-get-length-samples, get-length-samples"
170
176
Returns the chainsetup length in samples (if known)\&. \fI[li]\fP
172
.IP "cs-set-length \&'seconds\&'"
178
.IP "cs-set-length \&'seconds\&'"
173
179
Sets processing time in seconds (doesn\&'t have to be an integer value)\&.
174
180
A special-case value of \&'-1\&' will set the chainsetup length
175
181
according to the longest input object\&. \fI[-]\fP
177
.IP "cs-set-length-samples \&'samples\&'"
183
.IP "cs-set-length-samples \&'samples\&'"
178
184
Sets processing time in samples\&. \fI[-]\fP
181
187
Toggle looping\&. When processing is finished, engine will start
182
188
again from the initial position\&. It\&'s not always possible to enable looping
183
189
(for instance all inputs and outputs have infinite length and
184
190
chainsetup length is not explicitly set with \&'cs-set-length\&')\&. \fI[-]\fP
187
193
Interpret general chainsetup parameters like for example
188
194
"-b" (buffersize), "-n" (name), etc\&. See ecasound(1) for
189
195
more info\&. \fI[-]\fP
191
.IP "cs-set-audio-format \&'bits,channels,sample_rate\&'"
197
.IP "cs-set-audio-format \&'bits,channels,sample_rate\&'"
192
198
Set the default sample parameters for currently selected chainsetup\&.
193
199
For example cd-quality audio would be "16,2,44100"\&. This does the
194
200
same as command-line argument "-f" (see ecasound(1))\&. \fI[-]\fP
196
.IP "cs-status, status, st"
202
.IP "cs-status, status, st"
197
203
Print status info about all chainsetups\&. \fI[s]\fP
199
.IP "cs-option \&'-prefix:arg1,\&.\&.\&.,argN\&'"
205
.IP "cs-option \&'-prefix:arg1,\&.\&.\&.,argN\&'"
200
206
One powerful feature of the interactive-mode is that it
201
207
provides full access to ecasound\&'s command-line syntax\&.
202
208
For instance, command "cs-option -efb:400,200" means that
207
213
Note! EIAM implicitly interprets all strings beginning
208
214
with a \&'-\&' as "cs-option string"\&.
211
218
Chain is a simple signal flow abstraction\&. Every chain has one input
212
219
and one output\&. All chain operators and their controllers are attached
213
220
to chains\&. Chains can be muted, unmuted and be bypassed\&. If not
214
221
otherwise stated, all operations are done to currently selected
217
.IP "c-add \&'cname1,\&.\&.\&.,cnameN\&'"
224
.IP "c-add \&'cname1,\&.\&.\&.,cnameN\&'"
218
225
Adds a set of chains\&. Added chains are automatically selected\&. Note
219
226
that commas in chain names are not allowed\&. \fI[-]\fP
222
229
Removes selected chains\&. \fI[-]\fP
225
232
Returns a list of all chains\&. \fI[S]\fP
227
.IP "c-select \&'cname1,\&.\&.\&.,cnameN\&'"
234
.IP "c-select \&'cname1,\&.\&.\&.,cnameN\&'"
228
235
Selects chains\&. Other chains are automatically deselected\&. \fI[-]\fP
230
.IP "c-index-select \&'index1,\&.\&.\&.,indexN\&', c-iselect \&'index1,\&.\&.\&.,indexN\&'"
237
.IP "c-index-select \&'index1,\&.\&.\&.,indexN\&', c-iselect \&'index1,\&.\&.\&.,indexN\&'"
231
238
Selects a set of chains based on the list of indixes\&. Each index is
232
239
an integer value, where \&'1\&' refers to the first chain\&. You can use
233
240
\&'c-list\&' and \&'c-status\&' to get a full list of currently available
234
241
chains\&. \fI[-]\fP
237
244
Selects all chains\&. \fI[-]\fP
239
.IP "c-select-add \&'cname1,\&.\&.\&.,cnameN\&'"
246
.IP "c-select-add \&'cname1,\&.\&.\&.,cnameN\&'"
240
247
Selects more chains\&. \fI[-]\fP
242
.IP "c-deselect \&'cname1,\&.\&.\&.,cnameN\&'"
249
.IP "c-deselect \&'cname1,\&.\&.\&.,cnameN\&'"
243
250
Deselects chains\&. \fI[-]\fP
246
253
Returns a list of selected chains\&. \fI[S]\fP
249
256
Clear selected chains by removing all chain operators and controllers\&.
250
257
Doesn\&'t change how chains are connected to inputs and outputs\&. \fI[-]\fP
252
.IP "c-rename \&'new_name\&'"
259
.IP "c-rename \&'new_name\&'"
253
260
Renames the selected chain\&. When using this command, exactly one chain must
254
261
be selected\&. \fI[-]\fP
257
264
Toggle chain muting\&. When chain is muted, all data that goes through
258
265
is muted\&. \fI[-]\fP
261
268
Toggle chain muting\&. Note! Deprecated, use \fIc-muting\fP instead\&. \fI[-]\fP
264
271
Toggle chain bypassing\&. When chain is bypassed, sample data is passed
265
272
through untouched\&. \fI[-]\fP
268
275
Print status info about all chains\&. \fI[s]\fP
271
.SH "AUDIO INPUT/OUTPUT OBJECTS"
277
.SH "AUDIO INPUT/OUTPUT OBJECTS"
272
278
If not otherwise stated, all operations are done to currently selected
273
279
object\&. All commands with \fIai-\fP prefix operate on audio inputs,
274
280
while commands with \fIao-\fP operate on outputs\&.
277
.IP "ai-add \&'input_format_string\&'"
282
.IP "ai-add \&'input_format_string\&'"
278
283
Adds a new input object\&. See ecasound(1) man page for more info about
279
the argument format (\&'-i\&' option)\&. \fI[-]\fP
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
281
.IP "ao-add \&'output_format_string\&'"
288
.IP "ao-add \&'output_format_string\&'"
282
289
Adds a new output object\&. See ecasound(1) man page for more info about
283
290
the argument format (\&'-o\&' option)\&. If argument is omitted,
284
a default output device is added (see ecasoundrc(5))\&. \fI[-]\fP
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
287
296
Adds the default output device (see ecasoundrc(5))\&. \fI[-]\fP
289
.IP "ai-describe, ao-describe"
298
.IP "ai-describe, ao-describe"
290
299
Returns a Ecasound Option Syntax (EOS) compliant string
291
300
describing the input/output\&. See the Ecasound User\&'s Guide
292
for more information about EOS\&. \fI[s]\fP
301
for more information about EOS\&. This command was introduced in
302
ecasound 2\&.4\&.4\&. \fI[s]\fP
294
.IP "ai-select \&'aobject_name\&', ao-select \&'aobject_name\&'"
304
.IP "ai-select \&'aobject_name\&', ao-select \&'aobject_name\&'"
295
305
Selects an audio object\&. \&'aobject_name\&' refers to the string
296
used when creating the object (see above)\&. Note! All input
297
object names are required to be unique\&. Similarly all output
298
names need to be unique\&. However, it\&'s possible that the same
299
object name exists both as an input and as an output\&. \fI[-]\fP
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
301
.IP "ai-index-select \&'aobject_index\&', ai-iselect \&'aobject_index\&', ao-index-select \&'aobject_index\&', ao-iselect \&'aobject_index\&'"
315
.IP "ai-index-select \&'aobject_index\&', ai-iselect \&'aobject_index\&', ao-index-select \&'aobject_index\&', ao-iselect \&'aobject_index\&'"
302
316
Select some audio object based on a short index string\&. Especially file
303
317
names can be rather long\&. This command can be used to avoid typing
304
318
these long names when selecting audio objects\&. \&'aobject_index\&' is
306
320
You can use \&'ai-list\&' and \&'ao-list\&' to get a full list of currently
307
321
available inputs/outputs\&. \fI[-]\fP
309
.IP "ai-selected, ao-selected"
323
.IP "ai-selected, ao-selected"
310
324
Returns the name of the currently selected audio object\&. \fI[s]\fP
312
.IP "ai-attach, ao-attach"
326
.IP "ai-attach, ao-attach"
313
327
Attaches the currently selected audio object to all selected chains\&. \fI[-]\fP
315
.IP "ai-remove, ao-remove"
329
.IP "ai-remove, ao-remove"
316
330
Removes the currently selected audio object from the chainsetup\&. \fI[-]\fP
318
.IP "ai-forward \&'time_in_seconds\&', ai-fw \&'time_in_seconds\&', ao-forward \&'time_in_seconds\&', ao-fw \&'time_in_seconds\&'"
332
.IP "ai-forward \&'time_in_seconds\&', ai-fw \&'time_in_seconds\&', ao-forward \&'time_in_seconds\&', ao-fw \&'time_in_seconds\&'"
319
333
Selected audio object is forwarded by \&'time-in-seconds\&' seconds\&.
320
334
Time should be given as a floating point value (eg\&. 0\&.001 is the
321
335
same as 1ms)\&. \fI[-]\fP
323
.IP "ai-rewind \&'time_in_seconds\&', ai-rw \&'time_in_seconds\&', ao-rewind \&'time_in_seconds\&', ao-rw \&'time_in_seconds\&'"
337
.IP "ai-rewind \&'time_in_seconds\&', ai-rw \&'time_in_seconds\&', ao-rewind \&'time_in_seconds\&', ao-rw \&'time_in_seconds\&'"
324
338
Selected audio object is rewinded by \&'time-in-seconds\&' seconds\&.
325
339
Time should be given as a floating point value (eg\&. 0\&.001 is the
326
340
same as 1ms)\&. \fI[-]\fP
328
.IP "ai-setpos \&'time_in_seconds\&', ai-set-position \&'time_in_seconds\&', ao-setpos \&'time_in_seconds\&', ao-set-position \&'time_in_seconds\&'"
342
.IP "ai-setpos \&'time_in_seconds\&', ai-set-position \&'time_in_seconds\&', ao-setpos \&'time_in_seconds\&', ao-set-position \&'time_in_seconds\&'"
329
343
Set audio object position to \&'time_in_seconds\&'\&. \fI[-]\fP
331
.IP "ai-set-position-samples \&'time_in_samples\&', ao-set-position-samples \&'time_in_samples\&'"
345
.IP "ai-set-position-samples \&'time_in_samples\&', ao-set-position-samples \&'time_in_samples\&'"
332
346
Set audio object position to \&'time_in_samples\&'\&. \fI[-]\fP
334
.IP "ai-getpos, ai-get-position, ao-getpos, ao-get-position"
348
.IP "ai-getpos, ai-get-position, ao-getpos, ao-get-position"
335
349
Returns the audio object position in seconds\&. \fI[f]\fP
337
.IP "ai-get-position-samples, ao-get-position-samples"
351
.IP "ai-get-position-samples, ao-get-position-samples"
338
352
Returns the audio object position in samples\&. \fI[li]\fP
340
.IP "ai-get-length, ao-get-length"
354
.IP "ai-get-length, ao-get-length"
341
355
Returns the audio object length in seconds\&. \fI[f]\fP
343
.IP "ai-get-length-samples, ao-get-length-samples"
357
.IP "ai-get-length-samples, ao-get-length-samples"
344
358
Returns the audio object length in samples\&. \fI[li]\fP
346
.IP "ai-get-format, ao-get-format"
360
.IP "ai-get-format, ao-get-format"
347
361
Returns the audio format of the selected audio input/output as a
348
362
formatted string\&. See documentation for \&'-f\&' command-line option\&. \fI[s]\fP
350
.IP "ai-wave-edit, ao-wave-edit"
364
.IP "ai-wave-edit, ao-wave-edit"
351
365
The currently selected audio object is loaded into an external
352
366
wave editor (see ecasoundrc(5))\&. \fI[-]\fP
354
.IP "ai-list, ao-list"
368
.IP "ai-list, ao-list"
355
369
Returns a list of all input/output objects\&. \fI[S]\fP
358
372
Prints a list of registered audio object types\&. \fI[s]\fP
361
375
Audio object status (index strings, position, length, etc)\&. \fI[s]\fP
364
.SH "CHAIN OPERATORS"
377
.SH "CHAIN OPERATORS"
365
378
Chain operators are used to process and analyze sample data\&.
366
379
They are attached to chains\&. If not otherwise stated,
367
380
currently selected chainsetup and chain are used\&. Also,
369
382
and their parameters\&. First valid value for these parameters
372
.IP "cop-add \&'cop_format_string\&'"
373
Adds a new chain operator\&. Argument format is
374
"-<id_string>:par1,\&.\&.\&.,parN"\&. In addition to normal chain operators,
385
.IP "cop-add \&'cop_format_string\&'"
386
Adds a new chain operator\&. In addition to normal chain operators,
375
387
this commmand can also be used to add effect presets and various
376
388
plugins\&. Note; it is not possible to add operators to multiple
377
389
chains at once\&. In other words only one chain should be selected
378
when issuing \&'cop-add\&'\&. See ecasound(1) man page for more
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
382
396
Returns a Ecasound Option Syntax (EOS) compliant string
383
397
describing the chain operator\&. See the Ecasound User\&'s Guide
384
for more information about EOS\&. \fI[s]\fP
398
for more information about EOS\&. This command was introduced in
399
ecasound 2\&.4\&.4\&. \fI[s]\fP
387
402
Removes the selected chain operator\&. \fI[-]\fP
390
405
Returns a list of all chain operators attached to the currently
391
406
selected chain\&. \fI[S]\fP
393
.IP "cop-select \&'param_id\&', cop-index-select \&'param_id\&', cop-iselect \&'param_id\&'"
408
.IP "cop-select \&'param_id\&', cop-index-select \&'param_id\&', cop-iselect \&'param_id\&'"
394
409
Selects a chain operator\&. \fI[-]\fP
397
412
Returns the index number of currently selected chain operator\&. \fI[i]\fP
399
.IP "cop-set \&'chainop_id, param_id, value\&'"
414
.IP "cop-set \&'chainop_id, param_id, value\&'"
400
415
Changes the value of a single chain operator parameter\&. Unlike other
401
416
chain operator commands, this can also be used during processing\&. \fI[-]\fP
404
419
Returns info about chain operator status\&. \fI[s]\fP
407
422
Returns a list of selected chain operator\&'s parameters\&. \fI[S]\fP
409
.IP "copp-select \&'param_id\&', copp-index-select \&'param_id\&', copp-iselect \&'param_id\&'"
424
.IP "copp-select \&'param_id\&', copp-index-select \&'param_id\&', copp-iselect \&'param_id\&'"
410
425
Selects a chain operator parameter\&. \fI[-]\fP
413
428
Returns the index number of currently selected chain operator parameter\&. \fI[i]\fP
415
.IP "copp-set \&'value\&'"
430
.IP "copp-set \&'value\&'"
416
431
Sets the selected parameter value to \&'value\&'\&. \fI[-]\fP
419
434
Returns the selected parameter value\&. \fI[f]\fP
422
437
Prints a list of registered chain operators\&. \fI[s]\fP
424
.IP "preset-register"
439
.IP "preset-register"
425
440
Prints a list of registered effect presets\&. \fI[s]\fP
427
.IP "ladspa-register"
442
.IP "ladspa-register"
428
443
Prints a list of registered LADSPA plugins\&. \fI[s]\fP
432
446
Controllers are used to control individual chain operator parameters\&.
433
447
They are attached to chains\&. If not otherwise stated, currently
434
448
selected chainsetup and chains are used\&.
436
.IP "ctrl-add \&'copc_format_string\&'"
450
.IP "ctrl-add \&'copc_format_string\&'"
437
451
Adds a new controller and attach it to currently selected chain
438
452
operator\&. Argument format is "-<id_string>:<param_id>,<range_low>,
439
<range_high>,par1,\&.\&.\&.,parN"\&. See ecasound(1) man page for more
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
443
458
Returns a Ecasound Option Syntax (EOS) compliant string
444
459
describing the controller\&. See the Ecasound User\&'s Guide
445
for more information about EOS\&. \fI[s]\fP
460
for more information about EOS\&. This command was introduced in
461
ecasound 2\&.4\&.4\&. \fI[s]\fP
448
464
Removes the selected controller\&. \fI[-]\fP
451
467
Returns a list of all controllers attached to the currently
452
468
selected chain\&. \fI[S]\fP
454
.IP "ctrl-select \&'param_id\&', ctrl-index-select \&'param_id\&', ctrl-iselect \&'param_id\&'"
470
.IP "ctrl-select \&'param_id\&', ctrl-index-select \&'param_id\&', ctrl-iselect \&'param_id\&'"
455
471
Selects a controller\&. \fI[-]\fP
458
474
Returns the index number of currently selected controller\&. \fI[i]\fP
461
477
Returns info about controller status\&. \fI[s]\fP
464
480
Prints a list of registered controllers\&. \fI[s]\fP
466
.IP "ctrl-get-target"
482
.IP "ctrl-get-target"
467
483
Returns the index number of the chain operator that is
468
484
connected to the selected controller\&. The returned index
469
485
refers to the currently selected chain (see \&'cop-list\&')\&. \fI[i]\fP
472
Returns a list of all controller parameters\&. \fI[S]\fP
475
Selects a controller parameter\&. \fI[-]\fP
478
Returns the index number of currently selected controller parameter\&. \fI[i]\fP
481
Returns the selected controller parameter value\&. \fI[f]\fP
484
Sets the selected controller parameter value to \&'value\&'\&. \fI[-]\fP
487
.SH "INTERNAL COMMANDS"
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"
488
508
Internal commands are not directly aimed at normal use\&. They
489
509
are primarily meant for use in scripting and frontends\&.
492
512
Returns a list of all registered EIAM commands\&. \fI[S]\fP
494
.IP "int-log-history"
514
.IP "int-log-history"
495
515
Returns recent log messages sent by libecasound modules\&. This
496
is a good tool for debugging ECI/EIAM scripts and applications\&. \fI[s]\fP
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
498
.IP "int-output-mode-wellformed"
519
.IP "int-output-mode-wellformed"
499
520
Select the well-format output format for log messages\&. \fI[-]\fP
501
.IP "int-set-float-to-string-precision"
522
.IP "int-set-float-to-string-precision"
502
523
Sets precision used in float to text conversions\&. Note that
503
524
this can be used to control the precision of float return values
504
525
for ECI commands\&. \fI[-]\fP
506
.IP "int-set-log-history-length"
507
Sets the log history length\&. Defaults to 5 items\&. \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
509
.IP "int-cmd-version-string"
531
.IP "int-cmd-version-string"
510
532
Returns EIAM parser version string\&. \fI[s]\fP
512
.IP "int-cmd-version-lib-current"
534
.IP "int-cmd-version-lib-current"
513
535
Returns EIAM library interface version (libtool)\&. \fI[i]\fP
515
.IP "int-cmd-version-lib-revision"
537
.IP "int-cmd-version-lib-revision"
516
538
Returns EIAM library interface revision (libtool)\&. \fI[i]\fP
518
.IP "int-cmd-version-lib-age"
540
.IP "int-cmd-version-lib-age"
519
541
Returns EIAM library interface age (libtool)\&. \fI[i]\fP
523
544
Object maps are central repositories for commonly used object types\&.
524
545
By querying the maps, applications can get a list of all registered
525
546
object types and their properties\&.
529
549
Prints a list of registered chain operators using
530
550
the format specified in section \fIOPERATOR DESCRIPTIONS\fP\&. \fI[s]\fP
532
.IP "map-preset-list"
552
.IP "map-preset-list"
533
553
Prints a list of registered effect presets using
534
554
the format specified in section \fIOPERATOR DESCRIPTIONS\fP\&. \fI[s]\fP
536
.IP "map-ladspa-list"
556
.IP "map-ladspa-list"
537
557
Prints a list of registered LADSPA plugins using
538
558
the format specified in section \fIOPERATOR DESCRIPTIONS\fP\&. \fI[s]\fP
540
.IP "map-ladspa-id-list"
560
.IP "map-ladspa-id-list"
541
561
Prints a list of registered LADSPA plugins using
542
562
the format specified in section \fIOPERATOR DESCRIPTIONS\fP\&.
543
563
Numerical LADPSA plugin identifiers are used\&. \fI[s]\fP
546
566
Prints a list of registered controllers using
547
567
the format specified in section \fIOPERATOR DESCRIPTIONS\fP\&. \fI[s]\fP
551
570
The following dump commands are not meant for normal use\&.
552
571
Their primary purpose is to provide an easy way to get
553
572
internal state information from libecasound\&. All dump
554
573
commands output a single line with syntax "key value"
555
574
to the selected output stream (defaults to stdout)\&.
558
.IP "dump-target \&'filename\&'"
576
.IP "dump-target \&'filename\&'"
559
577
Set target stream for dumping\&. \fI[-]\fP
562
580
Dumps engine status - \&'running\&', \&'stopped\&', \&'finished\&' or \&'notready\&'\&. \fI[-]\fP
565
583
Dumps the global position\&. Printed in seconds using a floating-point
566
584
representation\&. \fI[-]\fP
569
587
Dumps the overall processing length\&. Printed in seconds using a floating-point
570
588
representation\&. \fI[-]\fP
573
591
Dumps status string for the currently selected chainsetup - \&'connected\&',
574
592
\&'selected\&' or an empty string\&. \fI[-]\fP
576
.IP "dump-c-selected"
594
.IP "dump-c-selected"
577
595
Dumps the name of currently selected chain\&. \fI[-]\fP
579
.IP "dump-ai-selected"
597
.IP "dump-ai-selected"
580
598
Dumps label of currently selected audio input\&. If no input is
581
599
selected, dumps an empty string\&. \fI[-]\fP
583
.IP "dump-ai-position"
601
.IP "dump-ai-position"
584
602
Dumps position of currently selected audio inputs\&. Printed in
585
603
seconds, using a floating-point representation\&. \fI[-]\fP
588
606
Dumps length of currently selected audio input\&. Printed in seconds,
589
607
using a floating-point representation\&. \fI[-]\fP
591
.IP "dump-ai-open-state"
609
.IP "dump-ai-open-state"
592
610
Dumps audio input state info\&. Either \&'open\&' or \&'closed\&'\&. \fI[-]\fP
594
.IP "dump-ao-selected"
612
.IP "dump-ao-selected"
595
613
Dumps label of currently selected audio output\&. If no output is
596
614
selected, dumps an empty string\&. \fI[-]\fP
598
.IP "dump-ao-position"
616
.IP "dump-ao-position"
599
617
Dumps position of currently selected audio outputs\&. Printed in
600
618
seconds, using a floating-point representation\&. \fI[-]\fP
603
621
Dumps length of currently selected audio output\&. Printed in seconds,
604
622
using a floating-point representation\&. \fI[-]\fP
606
.IP "dump-ao-open-state"
624
.IP "dump-ao-open-state"
607
625
Dumps audio output state info\&. Either \&'open\&' or \&'closed\&'\&. \fI[-]\fP
609
.IP "dump-cop-value \&'chainop,param\&'"
627
.IP "dump-cop-value \&'chainop,param\&'"
610
628
Dumps chain operator parameter value\&. \&'chainop\&' and \&'param\&' are
611
629
operator and parameter index values (1\&.\&.\&.n)\&. \fI[-]\fP
614
.SH "OPERATOR DESCRIPTIONS"
631
.SH "OPERATOR DESCRIPTIONS"
616
634
The \fImap-xxx-list\fP commands return a string containing all registered
617
635
objects of the given type \fIxxx\fP\&. Each line of the output describes
added
removed
Documentation/ecasound-iam_manpage.man
