18
18
linked to ecasound library can use this facility.
20
20
manpagesection(ECI API and return types)
21
A special case of EIAM use is ecasound's control interface (ECI),
22
which is a small library providing easy access to the EIAM
23
commands from outside of libecasound. When issuing EIAM commands using
24
ECI, it's possible that commands also return information. Currently
25
supported return value types are: string [s], list of strings [S]
21
A special case of interactive mode use is ecasound's control interface (ECI),
22
which is a small library providing easy access to the interactive
23
mode commands from outside of libecasound. When issuing inter commands using
24
the control interface, it's possible that commands also return information.
25
Currently supported return value types are: string [s], list of strings [S]
26
26
(elements separated by commas; escaped if necessary), integer [i],
27
27
long integer [li] and floating-point number [f]. These definitions are
28
28
used throughout this document. Commands that return nothing (void) are
29
29
marked with [-]. Additionally, return type [e] marks an error condition.
30
When an EIAM results in an error, a error string explaining the
31
condition is returned.
30
When an interactive mode command results in an error, an error string
31
explaining the condition is returned.
33
33
manpagesection(Real-time commands)
34
It's not possible to use all EIAM commands to modify and control
35
objects that belong to a connected chainsetup. Commands that
36
do support this are: 'start', 'stop', 'setpos', 'rewind', 'forward',
37
'c-select', 'c-muting', 'c-bypass', 'cop-select', 'copp-select',
38
'copp-value', 'ctrlp-select' and 'ctrlp-value'.
40
Another set of commands are those which can be used with connected
41
chainsetups, but not without an audible break. These are: 'cop-add',
42
'cop-remove', 'ctrl-add', 'ctrl-select', 'ctrl-remove'
34
It's not possible to use all interactive mode commands to modify and
35
control objects that belong to a connected chainsetup. Commands that
36
do NOT support this are:
39
cs-remove, cs-set-length, cs-set-length-samples, cs-toggle-loop,
40
cs-set-param, cs-option,
41
c-add, c-remove, c-rename, c-clear,
42
ai-add, ai-remove, ai-attach, ai-forward, ai-rewind, ai-set-position,
43
ai-set-position-samples,
44
ao-add, ao-add-default, ao-remove, ao-attach, ao-forward, ao-rewind,
45
ao-set-position, ao-set-position-samples.
48
If one of these commands is issued when a chainsetup is connected,
49
ecasound will first stop and disconnect the chainsetup, process
50
the command, and the reconnect.
44
52
In addition, most non-modifying (const) commands work with
557
manpagesection(JACK CONNECTION MANAGEMENT)
558
If Ecasound is compiled with support for url(JACK audio server)(http://jackaudio.org/),
559
the following set of commands is provided for controlling connections
564
dit(jack-connect 'src-port' 'dest-port')
565
Make a connection between the two ports given as parameters. This command
566
is similar to the 'jack_connect' command line tool that is distributed
567
with JACK package. em([-])
569
dit(jack-disconnect 'src-port' 'dest-port')
570
Disconnect the two ports given as parameters. This command is similar
571
to the 'jack_disconnect' command line tool that is distributed
572
with JACK package. em([-])
574
dit(jack-list-connections)
575
Returns a list of all JACK ports and a list of connections
576
for each port. This command is similar to the 'jack_lsp' command
577
line tool (e.g. 'jack_lsp -c') that is distributed with JACK package. em([s])
556
581
manpagesection(INTERNAL COMMANDS)
557
582
Internal commands are not directly aimed at normal use. They
558
583
are primarily meant for use in scripting and frontends.
561
586
dit(int-cmd-list)
562
Returns a list of all registered EIAM commands. em([S])
587
Returns a list of all registered interactive mode commands. em([S])
564
589
dit(int-log-history)
565
590
Returns recent log messages sent by libecasound modules. This
579
604
This command was introduced in ecasound 2.4.0. em([-])
581
606
dit(int-cmd-version-string)
582
Returns EIAM parser version string. em([s])
607
Returns ecasound interactive mode parser version string. em([s])
584
609
dit(int-cmd-version-lib-current)
585
Returns EIAM library interface version (libtool). em([i])
610
Returns ecasound interactive mode library interface version (libtool). em([i])
587
612
dit(int-cmd-version-lib-revision)
588
Returns EIAM library interface revision (libtool). em([i])
613
Returns ecasound interactive mode library interface revision (libtool). em([i])
590
615
dit(int-cmd-version-lib-age)
591
Returns EIAM library interface age (libtool). em([i])
616
Returns ecasound interactive mode library interface age (libtool). em([i])
705
729
logarithmic_flag,output_flag'
707
731
For exact descriptions of these fields, please see
708
the header file emph(ecasound/libecasound/eca-operator.h).
732
the header file em(ecasound/libecasound/eca-operator.h).
734
manpagesection(DEPRECATED COMMANDS)
735
Use of following commands is deprecated. They still work in
736
current version of Ecasound, but will be dropped in
740
ai-wave-edit, ao-wave-edit
712
744
ecasound (1), ecatools (1), ecasoundrc (5)
716
747
Kai Vehmanen, <email(kvehmanen -at- eca -dot- cx)>
added
removed
Documentation/ecasound-iam_manpage.yo
