15
15
linked to ecasound library can use this facility\&.
17
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]
18
A special case of interactive mode use is ecasound\&'s control interface (ECI),
19
which is a small library providing easy access to the interactive
20
mode commands from outside of libecasound\&. When issuing inter commands using
21
the control interface, it\&'s possible that commands also return information\&.
22
Currently supported return value types are: string [s], list of strings [S]
23
23
(elements separated by commas; escaped if necessary), integer [i],
24
24
long integer [li] and floating-point number [f]\&. These definitions are
25
25
used throughout this document\&. Commands that return nothing (void) are
26
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\&.
27
When an interactive mode command results in an error, an error string
28
explaining the condition is returned\&.
30
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\&'
31
It\&'s not possible to use all interactive mode commands to modify and
32
control objects that belong to a connected chainsetup\&. Commands that
33
do NOT support this are:
36
cs-remove, cs-set-length, cs-set-length-samples, cs-toggle-loop,
37
cs-set-param, cs-option,
38
c-add, c-remove, c-rename, c-clear,
39
ai-add, ai-remove, ai-attach, ai-forward, ai-rewind, ai-set-position,
40
ai-set-position-samples,
41
ao-add, ao-add-default, ao-remove, ao-attach, ao-forward, ao-rewind,
42
ao-set-position, ao-set-position-samples\&.
46
If one of these commands is issued when a chainsetup is connected,
47
ecasound will first stop and disconnect the chainsetup, process
48
the command, and the reconnect\&.
41
50
In addition, most non-modifying (const) commands work with
42
51
connected setups\&.
531
533
Sets the selected controller parameter value to \&'value\&'\&. This command was introduced in
532
534
ecasound 2\&.4\&.2\&. \fI[-]\fP
536
.SH "JACK CONNECTION MANAGEMENT"
537
If Ecasound is compiled with support for JACK audio server,
538
the following set of commands is provided for controlling connections
539
between JACK ports\&.
541
.IP "jack-connect \&'src-port\&' \&'dest-port\&'"
542
Make a connection between the two ports given as parameters\&. This command
543
is similar to the \&'jack_connect\&' command line tool that is distributed
544
with JACK package\&. \fI[-]\fP
546
.IP "jack-disconnect \&'src-port\&' \&'dest-port\&'"
547
Disconnect the two ports given as parameters\&. This command is similar
548
to the \&'jack_disconnect\&' command line tool that is distributed
549
with JACK package\&. \fI[-]\fP
551
.IP "jack-list-connections"
552
Returns a list of all JACK ports and a list of connections
553
for each port\&. This command is similar to the \&'jack_lsp\&' command
554
line tool (e\&.g\&. \&'jack_lsp -c\&') that is distributed with JACK package\&. \fI[s]\fP
534
556
.SH "INTERNAL COMMANDS"
535
557
Internal commands are not directly aimed at normal use\&. They
536
558
are primarily meant for use in scripting and frontends\&.
538
560
.IP "int-cmd-list"
539
Returns a list of all registered EIAM commands\&. \fI[S]\fP
561
Returns a list of all registered interactive mode commands\&. \fI[S]\fP
541
563
.IP "int-log-history"
542
564
Returns recent log messages sent by libecasound modules\&. This
556
578
This command was introduced in ecasound 2\&.4\&.0\&. \fI[-]\fP
558
580
.IP "int-cmd-version-string"
559
Returns EIAM parser version string\&. \fI[s]\fP
581
Returns ecasound interactive mode parser version string\&. \fI[s]\fP
561
583
.IP "int-cmd-version-lib-current"
562
Returns EIAM library interface version (libtool)\&. \fI[i]\fP
584
Returns ecasound interactive mode library interface version (libtool)\&. \fI[i]\fP
564
586
.IP "int-cmd-version-lib-revision"
565
Returns EIAM library interface revision (libtool)\&. \fI[i]\fP
587
Returns ecasound interactive mode library interface revision (libtool)\&. \fI[i]\fP
567
589
.IP "int-cmd-version-lib-age"
568
Returns EIAM library interface age (libtool)\&. \fI[i]\fP
590
Returns ecasound interactive mode library interface age (libtool)\&. \fI[i]\fP
570
592
.SH "OBJECT MAPS"
571
593
Object maps are central repositories for commonly used object types\&.
673
693
logarithmic_flag,output_flag\&'
675
695
For exact descriptions of these fields, please see
676
the header file emph(ecasound/libecasound/eca-operator\&.h)\&.
696
the header file \fIecasound/libecasound/eca-operator\&.h\fP\&.
698
.SH "DEPRECATED COMMANDS"
699
Use of following commands is deprecated\&. They still work in
700
current version of Ecasound, but will be dropped in
704
ai-wave-edit, ao-wave-edit
681
709
ecasound (1), ecatools (1), ecasoundrc (5)
686
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>
713
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>
added
removed
Documentation/ecasound-iam.1
