← Back to branch summary

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

« back to all changes in this revision

Viewing changes to Documentation/programmers_guide/ecasound_programmers_guide.txt

  • Committer: Bazaar Package Importer
  • Author(s): Junichi Uekawa
  • Date: 2009-11-02 18:22:35 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: james.westby@ubuntu.com-20091102182235-4ngh7699dmkgonyu
Tags: 2.7.0-1
http://bugs.debian.org/553748
* New upstream release.
* Depend on libreadline-dev instead of libreadline5-dev by request of
  Mattias Klose. It's now libreadline6-dev. (closes: #553748)
* Update menu file to use section Applications/ instead of Apps/.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Documentation/programmers_guide/ecasound_programmers_guide.txt
1
1
:editor: -*- mode: fundamental; tab-width: 4; indent-tabs-mode: nil -*-
2
 
:version: 20050821-8
 
2
:version: 20090419-9
3
3
:syntax: loosely follows restructured text, http://docutils.sourceforge.net/rst.html
4
4
:author: Kai Vehmanen
5
5
 
34
34
 
35
35
::
36
36
 
 
37
| 19.04.2009 - Minor updates to NetECI and ECA_CONTROL.
37
38
| 21.08.2005 - Typos fixed, removed duplicated section on audio
38
39
|              routing. Minor updates to various sections.
39
40
| 25.04.2005 - Minor updates.
603
604
interpreting EOS (Ecasound Option Syntax) and EAIM (Ecasound 
604
605
Interactive Mode) commands.
605
606
 
 
607
ECA_CONTROL_MAIN (eca-control-main.h) is an abstract base class that 
 
608
defines a subset of core ECA_CONTROL functionality. This interface
 
609
is implemented by e.g. ECA_CONTROL (the default implementation)
 
610
and ECA_CONTROL_MT (a thread-safe variant that allows simultaneous
 
611
use from multiple threads). 
 
612
 
 
613
It is recommended that applications use the subset defined
 
614
by ECA_CONTROL_MAIN.
 
615
 
606
616
ECA_CONTROL_INTERFACE - eca-control-interface.h
607
617
-----------------------------------------------
608
618
 
639
649
 
640
650
ECA_CHAINSETUP is the central class for storing user-visible 
641
651
objects. All inputs, output, chain operator and controller 
642
 
objects belonging to one logical setup are attributes of on
643
 
ECA_CHAINSETUP object.
 
652
objects are attached to some ECA_CHAINSETUP object.
644
653
 
645
654
ECA_ENGINE - eca-engine.h 
646
655
-------------------------
1085
1094
 
1086
1095
 
1087
1096
NetECI - [various]
1088
 
======================
 
1097
==================
1089
1098
 
1090
1099
NetECI is a network version of the ECI API. When Ecasound is
1091
 
started in daemon mode (the --daemon option), it creates 
1092
 
a server for incoming TCP connections. Client applications
1093
 
can connect to this socket and use the connection to 
 
1100
started in server mode (see ecasound(1) for the related options), it 
 
1101
listens for incoming NetECI commands on a TCP socket. Client 
 
1102
applications can connect to this socket and use the connection to 
1094
1103
control and observe the active session. Multiple clients
1095
1104
can connect to the same session.
1096
1105
 
1097
 
The protocol is identical to one used in ECI. Clients 
1098
 
write EIAM commands to the socket, followed by a CRLF pair.
1099
 
The server will reply using the well-formed output mode 
1100
 
syntax.
 
1106
The protocol is identical to one used in ECI (see section "Ecasound
 
1107
Interactive Mode - Well-Formed Output Mode" below). Clients write EIAM
 
1108
commands to the socket, followed by a CRLF pair. The server will reply
 
1109
using the well-formed output mode syntax.
1101
1110
 
1102
1111
See implementation of ecamonitor (part of ecatools), 
1103
1112
for a working example.