mirror of
https://github.com/signalwire/freeswitch.git
synced 2026-07-05 03:41:53 +00:00
Anthony Minessale
39a9e94305
This updates mod_portaudio to use the new v19 api and also contains
major behavioural changes. This initial check-in should be tested to find
any obscure use cases that lead to crashes etc...
All of the old api interface commands are now depricated and any attempt to
use them should cause a polite warning asking you to try the new single "pa" command.
New Features:
*) Mulitiple calls with hold/call switching.
*) Inbound calls can play a ring file on specified device. (global and per call)
*) Optional hold music for backgrounded calls. (global and per call)
Example dialplan usage:
<extension name="2000">
<condition field="destination_number" expression="^2000$">
<!--if the next 3 lines are omitted the defaults will be used from portaudio.conf-->
<action application="set" data="pa_ring_file=/sounds/myring.wav"/>
<action application="set" data="pa_hold_file=/sounds/myhold.wav"/>
<action application="set" data="export_vars=pa_ring_file,pa_hold_file"/>
<action application="bridge" data="portaudio"/>
</condition>
</extension>
Example API interface usage:
call extension 1000
> pa call 1000
call extension 1001 putting the other call on hold
> pa call 1001
swap the calls between hold and active
> pa switch
view the current calls
> pa list
forground the call with id 1
> pa switch 1
background all calls
> pa switch none
send a dtmf string (1234) to the current call
> pa dtmf 1234
answer the oldest unanswered inbound call
> pa answer
answer the call with id 1
> pa answer 1
hangup the active call
> pa hangup
hangup the call with id 1
> pa hangup 1
get device info
> pa dump
print usage summary
> pa help
USAGE:
--------------------------------------------------------------------------------
pa help
pa dump
pa call <dest> [<dialplan> <cid_name> <cid_num> <rate>]
pa answer [<call_id>]
pa hangup [<call_id>]
pa list
pa switch [<call_id>|none]
pa_dtmf <digit string>
--------------------------------------------------------------------------------
The source of the portaudio v19 library will also be checked in for the
sake of the build system.
git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@3981 d0543943-73ff-0310-b7d9-9358b9ac24b2
GNU/Linux: ---------- 1) Download and install a recent version of Doxygen (preferably version 1.3.3 or later). See http://www.doxygen.org/. 2) Download and install a recent version of GraphViz. See http://www.research.att.com/sw/tools/graphviz/. 3) Run ``doxygen config.doxy.linux'' in this directory or load and generate the file config.doxy.linux from the Doxywizard application. Or alternatively ``make docs'' can be run from the build/gnu folder. The generated html documentation will be placed in /doc/api_reference/. To open the main page of the documentation, open the file /doc/api_reference/index.html in an html browser. Windows: -------- 1) Download and install a recent Doxygen (preferably version 1.3.4 or later). See http://www.doxygen.org/. 2) Download and install a recent version of GraphViz. See http://www.research.att.com/sw/tools/graphviz/. 3) If needed, edit the config.doxy file in an ascii text editor so that ``DOT_PATH'' variable points to the folder where GraphViz is installed. 4) Run ``doxygen config.doxy'' in this directory or load and generate the file config.doxy from the Doxywizard application. The generated html documentation will be placed in /doc/api_reference/. To open the main page of the documentation, open the file /doc/api_reference/index.html in an html browser.