Author: derek Date: Tue Jul 3 00:56:27 2007 New Revision: 340 Added: sofaswitch/trunk/get_started/sound.sgml Modified: sofaswitch/trunk/get_started/get_started.xml Log: More docs - on how to use the sound utility. Modified: sofaswitch/trunk/get_started/get_started.xml ============================================================================== --- sofaswitch/trunk/get_started/get_started.xml (original) +++ sofaswitch/trunk/get_started/get_started.xml Tue Jul 3 00:56:27 2007 @@ -11,7 +11,7 @@ <!ENTITY build SYSTEM "build.sgml"> <!ENTITY server SYSTEM "server.sgml"> -<!ENTITY chap3 SYSTEM "chap3.sgml"> +<!ENTITY sound SYSTEM "sound.sgml"> <!ENTITY app1 SYSTEM "app1.sgml"> @@ -50,6 +50,7 @@ &build; &server; +&sound; &app1; </book> Added: sofaswitch/trunk/get_started/sound.sgml ============================================================================== --- (empty file) +++ sofaswitch/trunk/get_started/sound.sgml Tue Jul 3 00:56:27 2007 @@ -0,0 +1,70 @@ +<chapter> +<title>Sound card utility</title> +<titleabbrev>sound</titleabbrev> + +<para> +This is a very simple test, which is designed to get you familiar with +the sound utility, and introduce you to a couple of the commands which +control sofa utiliities. +</para> + +<para> +The server is expected to be running before starting this test. If the +&sofaswitch; server is not running (or cannot be connected to), the sound +utility will exit immediately. +</para> + +<para> +Build and run the sound utility with the commands +<itemizedlist> +<listitem><literal>cd sound</literal></listitem> +<listitem><literal>make both</literal></listitem> +<listitem><literal> + ./obj_linux_x86_r/sound -s machine_running_server -d Ensoniq\ AduioPCI +</literal></listitem> +</itemizedlist> +The options to the sound utility specify the name of the machine running the +sofa message server, and the sound device. If this +utility is unable to open the sound device, it will list the available +(and valid) sound device names and exit. You can see all the available command +options by running the sound utility with the command parameter <literal>-h</literal> +</para> + +<para> +In the <literal>sofaswitch/controller</literal> directory, there is a python +script, <literal>testonesound.py</literal>. +Run this script file with the command +<screen> +python testonesound.py machine_running_server +</screen> +The options for the &python; program specify the name of the machine running the +sofa message server. Again, it is assumed the server is running. +</para> + +<para> +This test simply tells the sound card to echo audio from the microphone +back to the speaker, so you will hear the transmitted audio with a slight +delay. The test enquires of the sound program for status information +every 2 seconds, which is reported to the console. After 40 seconds of +operation, the sound utility is closed, and the <literal>testonesound.py</literal> +script file ends. +</para> + + +<para> +This mode of operation is a bit unusual, in that we have a sofa +utility sending audio to itself. However, we are trying to introduce +things at a gradual and slow rate, so are only describing one +utility at a time. Normally, one sofa utility will send audio to +another sofa utility. The next chapter describes the sending of audio between +&sofaswitch; entities (answering machine and sound card). +</para> + +<para> +Now, you can add to this test. With the <literal>client.py</literal> file +described previously, you can send additional commands to +the sound utility. To see what nodes are connected to the server, +send the command <literal>list</literal>. At this point, you know who you can +send commands to. +</para> +</chapter>