From derek@sofaswitch.org Wed Nov 15 16:02:54 2006
From: SofaSWITCH SVN <derek@sofaswitch.org>
To: sofaswitch-svn@lists.freeswitch.org
Subject:
 [Sofaswitch-svn] [commit] r204 -	sofaswitch/trunk/callflow/docs/current
Date: Wed, 15 Nov 2006 16:02:54 -0500
Message-ID: <E1GkRuI-0001Zl-8P@chaos.freeswitch.org>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="===============3505403199964910582=="

--===============3505403199964910582==
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable

Author: derek
Date: Wed Nov 15 16:02:54 2006
New Revision: 204

Modified:
   sofaswitch/trunk/callflow/docs/current/eachicon.dxy

Log:
Add docs on the transfer media command.


Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D
--- sofaswitch/trunk/callflow/docs/current/eachicon.dxy	(original)
+++ sofaswitch/trunk/callflow/docs/current/eachicon.dxy	Wed Nov 15 16:02:54 2=
006
@@ -18,6 +18,7 @@
 \li \ref subsecRequestNode
 \li \ref subsecStartFlow
 \li \ref subsecTimer
+\li \ref subsecTransferMedia
 \li \ref subsecWriteToFile
=20
 All of the control structures in this application have optional parameters.
@@ -484,6 +485,52 @@
=20
=20
=20
+\subsection subsecTransferMedia Transfer Media
+Transfer media is relevant to all worker nodes in a running SofaSwitch
+installation, and is indicated by
+the toolbar icon and drawing area image of
+<CENTER><TABLE frame=3Dvoid border=3D0><TR><TD>
+\image html transfermedia.png=20
+</TD><TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+</TD><TD>
+\image html TransferMedia.png
+</TD></TR>
+</TABLE></CENTER>
+
+On clicking the right mouse button on this shape, a window comes up. The tool
+tip is as described before.
+
+The second and third boxes of the window describe the two sofa switch worker
+nodes which need to send audio between them.
+
+To illustrate, suppose we wish to record an incoming voip call. In this case,
+we will request&create a voip and an answering machine node. Then, issue this
+command to one of the two created nodes. It is not our responsibility to wor=
ry
+abount media format, or ports/addresses. It is our responsibility to issue t=
he
+connect command.
+
+Alternatively, suppose we wish to connect one TDM (standard phone line) call
+to another TDM call. In this case, both TDM worker nodes happen to be on the
+same machine, via the same phone card. On reception of the Transfer Media
+command, the nodes will do a direct bridging of the audio between them.
+
+From the \ref subsecRequestNode subsection, we noted that a worker node will
+exist for two seconds, and if not used in that time is silently deleted. One
+way of preventing that death is to do a Transfer Media command to that node
+just created.
+
+Transfer Media has some peculiar aspects. It is quite acceptable to create a
+voip node, and transfer media back to the same voip node. In this case, the
+remote h.323 endpoint will hear their audio echoed back to them. It is also
+acceptable to specify an incorrect id of the second node.  Thus, create a vo=
ip
+node,and  then issue the transfer media command  to a non existantant id.
+
+It is acceptable to issue multiple Transfer Media commands. Thus, suppose the
+controller is managing an incoming voip call. The voip call can be connected
+to an answering machine, then to a conference room, then to second voip call
+etc. In this way, one can get the controller to replicate an IVR system.
+
 \subsection subsecWriteToFile Write to file
 Write to file is an answering machine specific function, and is indicated by
 the toolbar icon and drawing area image of
@@ -511,7 +558,7 @@
=20
 Should you specify an invalid file to write to, no audio will be written.=20
=20
-You may specify the file in which to write audio to at any time after the cr=
eation of the
-answering machine worker node.=20
+You may specify the file in which to write audio to at any time after the
+creation of the answering machine worker node.
=20
 */
\ No newline at end of file


--===============3505403199964910582==--