← Back to branch summary

~ubuntu-branches/ubuntu/natty/ecasound2.2/natty

« back to all changes in this revision

Viewing changes to Documentation/ecasound-iam_manpage.html

  • Committer: Bazaar Package Importer
  • Author(s): Junichi Uekawa
  • Date: 2007-02-04 11:32:59 UTC
  • mfrom: (2.1.7 feisty)
  • Revision ID: james.westby@ubuntu.com-20070204113259-uthtjkh4t90fyukk
Tags: 2.4.4-6
http://bugs.debian.org/409438
Bug fix: "libecasound2.2-dev: missing dependency on libasound2-dev",
thanks to Steve Langasek (Closes: #409438).

Show diffs side-by-side

added added

removed removed

Lines of Context:
Documentation/ecasound-iam_manpage.html
13
13
<hr>
14
14
 
15
15
<h1>ecasound-iam</h1>
16
 
<h2>21.03.2005</h2>
 
16
<h2>31.08.2005</h2>
17
17
 
18
18
 
19
19
    
40
40
marked with [-]. Additionally, return type [e] marks an error condition. 
41
41
When an EIAM results in an error, a error string explaining the 
42
42
condition is returned.
43
 
<p><h2>Realtime commands</h2>
 
43
<p><h2>Real-time commands</h2>
44
44
    
45
45
It's not possible to use all EIAM commands to modify and control 
46
46
objects that belong to a connected chainsetup. Commands that
47
47
do support this are: 'start', 'stop', 'setpos', 'rewind', 'forward',
48
 
'c-select', 'c-muting', 'c-bypass', 'cop-select', 'copp-select' 
49
 
and 'copp-value'.
 
48
'c-select', 'c-muting', 'c-bypass', 'cop-select', 'copp-select',
 
49
'copp-value', 'ctrlp-select' and 'ctrlp-value'.
50
50
<p>Another set of commands are those which can be used with connected
51
51
chainsetups, but not without an audible break. These are: 'cop-add', 
52
52
'cop-remove', 'ctrl-add', 'ctrl-select', 'ctrl-remove'
249
249
a default output device is added (see ecasoundrc(5)). <em>[-]</em>
250
250
<p><p></p><dt><strong>ao-add-default</strong><dd>
251
251
Adds the default output device (see ecasoundrc(5)). <em>[-]</em>
 
252
<p><p></p><dt><strong>ai-describe, ao-describe</strong><dd>
 
253
Returns a Ecasound Option Syntax (EOS) compliant string
 
254
describing the input/output. See the Ecasound User's Guide
 
255
for more information about EOS. <em>[s]</em>
252
256
<p><p></p><dt><strong>ai-select 'aobject_name', ao-select 'aobject_name'</strong><dd>
253
257
Selects an audio object. 'aobject_name' refers to the string
254
258
used when creating the object (see above). Note! All input
318
322
chains at once. In other words only one chain should be selected
319
323
when issuing 'cop-add'. See ecasound(1) man page for more 
320
324
info. <em>[-]</em>
 
325
<p><p></p><dt><strong>cop-describe</strong><dd>
 
326
Returns a Ecasound Option Syntax (EOS) compliant string
 
327
describing the chain operator. See the Ecasound User's Guide
 
328
for more information about EOS. <em>[s]</em>
321
329
<p><p></p><dt><strong>cop-remove</strong><dd> 
322
330
Removes the selected chain operator. <em>[-]</em>
323
331
<p><p></p><dt><strong>cop-list</strong><dd>
359
367
operator. Argument format is "-&lt;id_string&gt;:&lt;param_id&gt;,&lt;range_low&gt;,
360
368
&lt;range_high&gt;,par1,...,parN".  See ecasound(1) man page for more 
361
369
info. <em>[-]</em>
 
370
<p><p></p><dt><strong>ctrl-describe</strong><dd>
 
371
Returns a Ecasound Option Syntax (EOS) compliant string
 
372
describing the controller. See the Ecasound User's Guide
 
373
for more information about EOS. <em>[s]</em>
362
374
<p><p></p><dt><strong>ctrl-remove</strong><dd>
363
375
Removes the selected controller. <em>[-]</em>
364
376
<p><p></p><dt><strong>ctrl-list</strong><dd>
372
384
Returns info about controller status. <em>[s]</em>
373
385
<p><p></p><dt><strong>ctrl-register</strong><dd>
374
386
Prints a list of registered controllers. <em>[s]</em>
 
387
<p><p></p><dt><strong>ctrl-get-target</strong><dd>
 
388
Returns the index number of the chain operator that is
 
389
connected to the selected controller. The returned index 
 
390
refers to the currently selected chain (see 'cop-list'). <em>[i]</em>
 
391
<p><p></p><dt><strong>ctrlp-list</strong><dd>
 
392
Returns a list of all controller parameters. <em>[S]</em>
 
393
<p><p></p><dt><strong>ctrlp-select</strong><dd>
 
394
Selects a controller parameter. <em>[-]</em>
 
395
<p><p></p><dt><strong>ctrlp-selected</strong><dd>
 
396
Returns the index number of currently selected controller parameter. <em>[i]</em>
 
397
<p><p></p><dt><strong>ctrlp-get</strong><dd>
 
398
Returns the selected controller parameter value. <em>[f]</em>
 
399
<p><p></p><dt><strong>ctrlp-set</strong><dd>
 
400
Sets the selected controller parameter value to 'value'. <em>[-]</em>
375
401
<p></dl>
376
402
<p><h2>INTERNAL COMMANDS</h2>
377
403