Author: derek Date: Tue Nov 14 17:20:10 2006 New Revision: 200 Added: sofaswitch/trunk/callflow/docs/current/EndCall.png (contents, props changed) Removed: sofaswitch/trunk/callflow/docs/current/endcall.png sofaswitch/trunk/callflow/docs/current/makecall.png Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy Log: Rename a file, to remove name clash with bitmaps/endcall.png Added: sofaswitch/trunk/callflow/docs/current/EndCall.png ============================================================================== Binary file. No diff available. Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/current/eachicon.dxy (original) +++ sofaswitch/trunk/callflow/docs/current/eachicon.dxy Tue Nov 14 17:20:10 2006 @@ -6,6 +6,27 @@ area. We describe each of them in this page of the manual. Also described is how one would use each structure within a call flow diagram. +The control structures described in this page are +\li \ref subsecConditional +\li \ref subsecEndEverything +\li \ref subsecEndProcessing +\li \ref subsecEventer +\li \ref subsecJoinObjects +\li \ref subsecMakeCall +\li \ref subsecReadFromFile +\li \ref subsecRequestNode +\li \ref subsecStartFlow +\li \ref subsecWriteToFile + +All of the control structures in this application have optional parameters. +Usually, these are string, with no quotes required, and this is the case for +parameters such as tool tips. +Sometimes, the parameters are labelled as being python code. In this case, you +can specifiy a python variable, so a possible value could be self.amNode +(where self.amNode has been previously set to some value). Alternatively, you +can specify a string, which is indicated by placing double quotes at either +end. Which makes (for example) "voip" a valid string Python code. + \subsection subsecStartFlow Initiate graph processing Start of graph processing is indicated by the toolbar icon and drawing area image of @@ -202,6 +223,103 @@ </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 condition, which is evaluated is a Python +expression. Should this expression not be valid, a message will be printed to +the display when the compiled code is executed. + +On evaluation of the compiled code, execution switches to the bottom (True +result) or right output (False result). + +\subsection subsecMakeCall Make a call +Make a call to some external entity is indicated by the toolbar icon and drawing area +image of +<CENTER><TABLE frame=void border=0><TR><TD> +\image html makecall.png +</TD><TD> +           +</TD><TD> +\image html MakeCall.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 worker node is a preexisting node on some external application that was +created in response to a "Request Node" operation. + +The call destination is somewhere capable of receiving a call. For a voip +call, one possible destination is the H323 test site set up by Craig +Southeren, which is given as "h323:h323.voxgratia.org" + +One possible call destination that was used during testing is the voip node +itself. I setup multiple concurrent incoming and outgoing calls, simply by +getting the voip node to make a call to "h323:127.0.0.1". + + +\subsection subsecReadFromFile Read from file +Read from file is an answering machine specific function, and is indicated by +the toolbar icon and drawing area image of +<CENTER><TABLE frame=void border=0><TR><TD> +\image html readfromfile.png +</TD><TD> +           +</TD><TD> +\image html playfromfile.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 worker node is a preexisting node on some external application that was +created in response to a "Request Node" operation. + +This control structure causes the designated answering machine node to read +audio from the wave file (format S16_LE). The answering machine node will send +this audio to worker connected to it. + +You may switch an answering machine node to read from a different file at any time. +Multiple answering machine node may read from the same file at the same time. + +Should you specify an invalid file to read from no audio will be sent by this +worker node. + +You may specify the file to read from at any time after the creation of the +answering machine worker node. + + +\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 +<CENTER><TABLE frame=void border=0><TR><TD> +\image html writetofile.png +</TD><TD> +           +</TD><TD> +\image html playfromfile.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 worker node is a preexisting node on some external application that was +created in response to a "Request Node" operation. + +This control structure causes the designated answering machine node to write +audio to the wave file (format S16_LE). + +You may switch an answering machine node to write to a different file at any +time. On switching files, the answering machine node will close the current +file and attempt to use the new file. + +Should you specify an invalid file to write to, no audio will be written. + +You may specify the file in which to write audio to at any time after the creation of the +answering machine worker node. */ \ No newline at end of file