daniel.cogo
/
pabx-app
forked from bruno/pabx-app
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
48 Commits
19 Branches
6 Tags
94 MiB
 
 
 
 
 
 
Tree: c87cfdbbfe
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'c87cfdbbfe'
${ noResults }
pabx-app/include/phpagi/api-docs/phpAGI/AGI.html

2894 lines
146 KiB
Raw Blame History

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class AGI</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name"><img src="../media/images/Class_logo.png"
alt=" Class"
title=" Class"
style="vertical-align: middle"> AGI</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-descendents">Descendents</a>
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">AGI class</p>
<ul class="tags">
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-Asterisk+agi">http://www.voip-info.org/wiki-Asterisk+agi</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_ping.php_a8afcfe0902072cc636965d2b445e3fc.html">Ping an IP address</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_dtmf.php_eb30ab5fd2d98b4b41f251416fc7ed37.html">Get DTMF tones from the user and say the digits</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_input.php_2a77295d6494c9179dee4f5b0e65eac4.html">Get text input from the user and say it back</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_phpagi.php.html">/phpagi.php</a> (line <span class="field"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a65">65</a></span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-descendents"></a>
<div class="info-box">
<div class="info-box-title">Direct descendents</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Descendents</span>
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em; white-space: nowrap">
<img src="../media/images/Class.png"
alt=" class"
title=" class"
style="vertical-align: center"/>
<a href="../phpAGI/AGI_1.html">AGI_1</a>
</td>
<td>
Asterisk Manager class
</td>
</tr>
</table>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendants</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<img src="../media/images/Variable.png" alt=" " />
<span class="var-type"><a href="../phpAGI/AGI_AsteriskManager.html">AGI_AsteriskManager</a></span>
<a href="#$asmanager" title="details" class="var-name">$asmanager</a>
</div>
<div class="var-title">
<img src="../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$audio" title="details" class="var-name">$audio</a>
</div>
<div class="var-title">
<img src="../media/images/Variable.png" alt=" " />
<span class="var-type">array</span>
<a href="#$config" title="details" class="var-name">$config</a>
</div>
<div class="var-title">
<img src="../media/images/PrivateVariable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$in" title="details" class="var-name">$in</a>
</div>
<div class="var-title">
<img src="../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$option_delim" title="details" class="var-name">$option_delim</a>
</div>
<div class="var-title">
<img src="../media/images/PrivateVariable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$out" title="details" class="var-name">$out</a>
</div>
<div class="var-title">
<img src="../media/images/Variable.png" alt=" " />
<span class="var-type">array</span>
<a href="#$request" title="details" class="var-name">$request</a>
</div>
</div>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendants</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<img src="../media/images/Constructor.png" alt=" "/>
<span class="method-result">AGI</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$config</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$optconfig</span> = <span class="var-default">array()</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#answer" title="details" class="method-name">answer</a>
()
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#channel_status" title="details" class="method-name">channel_status</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$channel</span> = <span class="var-default">''</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#conlog" title="details" class="method-name">conlog</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$vbl</span> = <span class="var-default">1</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#database_del" title="details" class="method-name">database_del</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$family</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#database_deltree" title="details" class="method-name">database_deltree</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$family</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$keytree</span> = <span class="var-default">''</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#database_get" title="details" class="method-name">database_get</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$family</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#database_put" title="details" class="method-name">database_put</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$family</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
<img src="../media/images/PrivateMethod.png" alt=" "/>
<span class="method-result">array</span>
<a href="#evaluate" title="details" class="method-name">evaluate</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$command</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#exec" title="details" class="method-name">exec</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$application</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$options</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#exec_absolutetimeout" title="details" class="method-name">exec_absolutetimeout</a>
([<span class="var-type">$seconds</span>&nbsp;<span class="var-name">$seconds</span> = <span class="var-default">0</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#exec_agi" title="details" class="method-name">exec_agi</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$command</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$args</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#exec_dial" title="details" class="method-name">exec_dial</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$identifier</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">NULL</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#exec_enumlookup" title="details" class="method-name">exec_enumlookup</a>
(<span class="var-type">$exten</span>&nbsp;<span class="var-name">$exten</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#exec_goto" title="details" class="method-name">exec_goto</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$a</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$b</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$c</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$b;</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$c;</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#exec_setlanguage" title="details" class="method-name">exec_setlanguage</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$language</span> = <span class="var-default">'en'</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#fastpass_get_data" title="details" class="method-name">fastpass_get_data</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">NULL</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$max_digits</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#fastpass_say_digits" title="details" class="method-name">fastpass_say_digits</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$digits</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#fastpass_say_number" title="details" class="method-name">fastpass_say_number</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$number</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#fastpass_say_phonetic" title="details" class="method-name">fastpass_say_phonetic</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#fastpass_say_punctuation" title="details" class="method-name">fastpass_say_punctuation</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$frequency</span> = <span class="var-default">8000</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#fastpass_say_time" title="details" class="method-name">fastpass_say_time</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$time</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#fastpass_stream_file" title="details" class="method-name">fastpass_stream_file</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$offset</span> = <span class="var-default">0</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#fastpass_swift" title="details" class="method-name">fastpass_swift</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$frequency</span> = <span class="var-default">8000</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$voice</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#fastpass_text2wav" title="details" class="method-name">fastpass_text2wav</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$frequency</span> = <span class="var-default">8000</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#get_data" title="details" class="method-name">get_data</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">NULL</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$max_digits</span> = <span class="var-default">NULL</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#get_fullvariable" title="details" class="method-name">get_fullvariable</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$variable</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$channel</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$getvalue</span> = <span class="var-default">FALSE</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#get_variable" title="details" class="method-name">get_variable</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$variable</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$getvalue</span> = <span class="var-default">FALSE</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#hangup" title="details" class="method-name">hangup</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$channel</span> = <span class="var-default">''</span>])
</div>
<div class="method-definition">
<img src="../media/images/PrivateMethod.png" alt=" "/>
<span class="method-result">boolean</span>
<a href="#make_folder" title="details" class="method-name">make_folder</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$folder</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$perms</span> = <span class="var-default">0755</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">mixed</span>
<a href="#menu" title="details" class="method-name">menu</a>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$choices</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">2000</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#new_AsteriskManager" title="details" class="method-name">&amp;new_AsteriskManager</a>
()
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#noop" title="details" class="method-name">noop</a>
([<span class="var-type"></span>&nbsp;<span class="var-name">$string</span> = <span class="var-default">&quot;&quot;</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array('Name'=>$name,</span>
<a href="#parse_callerid" title="details" class="method-name">parse_callerid</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$callerid</span> = <span class="var-default">NULL</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#receive_char" title="details" class="method-name">receive_char</a>
([<span class="var-type">integer</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">-1</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#record_file" title="details" class="method-name">record_file</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$format</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">-1</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$offset</span> = <span class="var-default">NULL</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$beep</span> = <span class="var-default">false</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$silence</span> = <span class="var-default">NULL</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#say_digits" title="details" class="method-name">say_digits</a>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$digits</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#say_number" title="details" class="method-name">say_number</a>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$number</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#say_phonetic" title="details" class="method-name">say_phonetic</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#say_punctuation" title="details" class="method-name">say_punctuation</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$frequency</span> = <span class="var-default">8000</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#say_time" title="details" class="method-name">say_time</a>
([<span class="var-type">integer</span>&nbsp;<span class="var-name">$time</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#send_image" title="details" class="method-name">send_image</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$image</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#send_text" title="details" class="method-name">send_text</a>
(<span class="var-type">$text</span>&nbsp;<span class="var-name">$text</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#setContext" title="details" class="method-name">setContext</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$context</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$extension</span> = <span class="var-default">'s'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$priority</span> = <span class="var-default">1</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#set_autohangup" title="details" class="method-name">set_autohangup</a>
([<span class="var-type">integer</span>&nbsp;<span class="var-name">$time</span> = <span class="var-default">0</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#set_callerid" title="details" class="method-name">set_callerid</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$cid</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#set_context" title="details" class="method-name">set_context</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$context</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#set_extension" title="details" class="method-name">set_extension</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$extension</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#set_global_var" title="details" class="method-name">set_global_var</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$pVariable</span>, <span class="var-type">string|int|float</span>&nbsp;<span class="var-name">$pValue</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#set_music" title="details" class="method-name">set_music</a>
([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$enabled</span> = <span class="var-default">true</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">''</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#set_priority" title="details" class="method-name">set_priority</a>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$priority</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#set_var" title="details" class="method-name">set_var</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$pVariable</span>, <span class="var-type">string|int|float</span>&nbsp;<span class="var-name">$pValue</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#set_variable" title="details" class="method-name">set_variable</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$variable</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#stream_file" title="details" class="method-name">stream_file</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$offset</span> = <span class="var-default">0</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#swift" title="details" class="method-name">swift</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$frequency</span> = <span class="var-default">8000</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$voice</span> = <span class="var-default">NULL</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#tdd_mode" title="details" class="method-name">tdd_mode</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$setting</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#text2wav" title="details" class="method-name">text2wav</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$frequency</span> = <span class="var-default">8000</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#text_input" title="details" class="method-name">text_input</a>
([<span class="var-type"></span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">'NUMERIC'</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#verbose" title="details" class="method-name">verbose</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$level</span> = <span class="var-default">1</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array,</span>
<a href="#wait_for_digit" title="details" class="method-name">wait_for_digit</a>
([<span class="var-type">integer</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">-1</span>])
</div>
<div class="method-definition">
<img src="../media/images/PrivateMethod.png" alt=" "/>
<span class="method-result">string</span>
<a href="#which" title="details" class="method-name">which</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$cmd</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$checkpath</span> = <span class="var-default">NULL</span>])
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$asmanager" id="$asmanager"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../media/images/Variable.png" />
<span class="var-title">
<span class="var-type"><a href="../phpAGI/AGI_AsteriskManager.html">AGI_AsteriskManager</a></span>
<span class="var-name">$asmanager</span>
(line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a108">108</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Asterisk Manager</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$audio" id="$audio"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<img src="../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$audio</span>
= <span class="var-default"> NULL</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a129">129</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Audio Stream</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$config" id="$config"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$config</span>
(line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a100">100</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Config variables</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$in" id="$in"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<img src="../media/images/PrivateVariable.png" />
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$in</span>
= <span class="var-default"> NULL</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a115">115</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Input Stream</p>
<ul class="tags">
<li><span class="field">access:</span> private</li>
</ul>
</div>
<a name="var$option_delim" id="$option_delim"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$option_delim</span>
= <span class="var-default"> &quot;,&quot;</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a137">137</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Application option delimiter</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$out" id="$out"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<img src="../media/images/PrivateVariable.png" />
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$out</span>
= <span class="var-default"> NULL</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a122">122</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Output Stream</p>
<ul class="tags">
<li><span class="field">access:</span> private</li>
</ul>
</div>
<a name="var$request" id="$request"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$request</span>
(line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a92">92</a></span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Request variables read in on initialization.</p>
<p class="description"><p>Often contains any/all of the following: agi_request - name of agi script agi_channel - current channel agi_language - current language agi_type - channel type (SIP, ZAP, IAX, ...) agi_uniqueid - unique id based on unix time agi_callerid - callerID string agi_dnid - dialed number id agi_rdnis - referring DNIS number agi_context - current context agi_extension - extension dialed agi_priority - current priority agi_enhanced - value is 1.0 if started as an EAGI script agi_accountcode - set by SetAccount in the dialplan agi_network - value is yes if this is a fastagi agi_network_script - name of the script to execute</p><p>NOTE: program arguments are still in $_SERVER['argv'].</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Constructor.png" />
<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a145">145</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<div class="method-signature">
<span class="method-result">AGI</span>
<span class="method-name">
__construct
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$config</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$optconfig</span> = <span class="var-default">array()</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$config</span><span class="var-description">: is the name of the config file to parse</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$optconfig</span><span class="var-description">: is an array of configuration vars and vals, stuffed into $this-&gt;config['phpagi']</span> </li>
</ul>
</div>
<a name="methodanswer" id="answer"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">answer</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a231">231</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Answer channel if not already in answer state.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is 0 on success, -1 on failure.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-answer">http://www.voip-info.org/wiki-answer</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_ping.php_a8afcfe0902072cc636965d2b445e3fc.html">Ping an IP address</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_dtmf.php_eb30ab5fd2d98b4b41f251416fc7ed37.html">Get DTMF tones from the user and say the digits</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_input.php_2a77295d6494c9179dee4f5b0e65eac4.html">Get text input from the user and say it back</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
answer
</span>
()
</div>
</div>
<a name="methodchannel_status" id="channel_status"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">channel_status</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a243">243</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the status of the specified channel. If no channel name is specified, return the status of the current channel.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['data'] contains description.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-channel+status">http://www.voip-info.org/wiki-channel+status</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
channel_status
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$channel</span> = <span class="var-default">''</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$channel</span> </li>
</ul>
</div>
<a name="methodconlog" id="conlog"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">conlog</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1667">1667</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log to console if debug mode.</p>
<ul class="tags">
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_ping.php_a8afcfe0902072cc636965d2b445e3fc.html">Ping an IP address</a></li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
conlog
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$vbl</span> = <span class="var-default">1</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$str</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$vbl</span><span class="var-description">: verbose level</span> </li>
</ul>
</div>
<a name="methoddatabase_del" id="database_del"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">database_del</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a272">272</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deletes an entry in the Asterisk database for a given family and key.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is 1 on sucess, 0 otherwise.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-database+del">http://www.voip-info.org/wiki-database+del</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
database_del
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$family</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$family</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span> </li>
</ul>
</div>
<a name="methoddatabase_deltree" id="database_deltree"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">database_deltree</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a285">285</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deletes a family or specific keytree within a family in the Asterisk database.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is 1 on sucess, 0 otherwise.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-database+deltree">http://www.voip-info.org/wiki-database+deltree</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
database_deltree
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$family</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$keytree</span> = <span class="var-default">''</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$family</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$keytree</span> </li>
</ul>
</div>
<a name="methoddatabase_get" id="database_get"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">database_get</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a300">300</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retrieves an entry in the Asterisk database for a given family and key.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is 1 on sucess, 0 failure. ['data'] holds the value</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-database+get">http://www.voip-info.org/wiki-database+get</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
database_get
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$family</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$family</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span> </li>
</ul>
</div>
<a name="methoddatabase_put" id="database_put"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">database_put</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a313">313</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds or updates an entry in the Asterisk database for a given family, key, and value.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is 1 on sucess, 0 otherwise</li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
database_put
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$family</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$family</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodevaluate" id="evaluate"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/PrivateMethod.png" />
<span class="method-title">evaluate</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1571">1571</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Evaluate an AGI command.</p>
<ul class="tags">
<li><span class="field">return:</span> ('code'=&gt;$code, 'result'=&gt;$result, 'data'=&gt;$data)</li>
<li><span class="field">access:</span> private</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
evaluate
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$command</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$command</span> </li>
</ul>
</div>
<a name="methodexec" id="exec"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">exec</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a365">365</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Executes the specified Asterisk application with given options.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is whatever the application returns, or -2 on failure to find application</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-Asterisk+-+documentation+of+application+commands">http://www.voip-info.org/wiki-Asterisk+-+documentation+of+application+commands</a></li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-exec">http://www.voip-info.org/wiki-exec</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
exec
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$application</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$options</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$application</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$options</span> </li>
</ul>
</div>
<a name="methodexec_absolutetimeout" id="exec_absolutetimeout"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">exec_absolutetimeout</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a821">821</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set absolute maximum time of call.</p>
<p class="description"><p>Note that the timeout is set from the current time forward, not counting the number of seconds the call has already been up. Each time you call AbsoluteTimeout(), all previous absolute timeouts are cancelled. Will return the call to the T extension so that you can playback an explanatory note to the calling party (the called party will not hear that)</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
<li><span class="field">link:</span> <a href="http://www.dynx.net/ASTERISK/AGI/ccard/agi-ccard.agi">http://www.dynx.net/ASTERISK/AGI/ccard/agi-ccard.agi</a></li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-Asterisk+-+documentation+of+application+commands">http://www.voip-info.org/wiki-Asterisk+-+documentation+of+application+commands</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
exec_absolutetimeout
</span>
([<span class="var-type">$seconds</span>&nbsp;<span class="var-name">$seconds</span> = <span class="var-default">0</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">$seconds</span>
<span class="var-name">$seconds</span><span class="var-description">: allowed, 0 disables timeout</span> </li>
</ul>
</div>
<a name="methodexec_agi" id="exec_agi"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">exec_agi</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a833">833</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Executes an AGI compliant application.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is -1 on hangup or if application requested hangup, or 0 on non-hangup exit.</li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
exec_agi
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$command</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$args</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$command</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$args</span> </li>
</ul>
</div>
<a name="methodexec_dial" id="exec_dial"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">exec_dial</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a879">879</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Dial.</p>
<p class="description"><p>Dial takes input from ${VXML_URL} to send XML Url to Cisco 7960 Dial takes input from ${ALERT_INFO} to set ring cadence for Cisco phones Dial returns ${CAUSECODE}: If the dial failed, this is the errormessage. Dial returns ${DIALSTATUS}: Text code returning status of last dial attempt.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-Asterisk+cmd+Dial">http://www.voip-info.org/wiki-Asterisk+cmd+Dial</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
exec_dial
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$identifier</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">NULL</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$type</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$identifier</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$timeout</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$options</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$url</span> </li>
</ul>
</div>
<a name="methodexec_enumlookup" id="exec_enumlookup"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">exec_enumlookup</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a858">858</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Do ENUM Lookup.</p>
<p class="description"><p>Note: to retrieve the result, use get_variable('ENUM');</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
exec_enumlookup
</span>
(<span class="var-type">$exten</span>&nbsp;<span class="var-name">$exten</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">$exten</span>
<span class="var-name">$exten</span> </li>
</ul>
</div>
<a name="methodexec_goto" id="exec_goto"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">exec_goto</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a895">895</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Goto.</p>
<p class="description"><p>This function takes three arguments: context,extension, and priority, but the leading arguments are optional, not the trailing arguments. Thuse goto($z) sets the priority to $z.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
exec_goto
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$a</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$b</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$c</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$b;</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$c;</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$a</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$b;</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$c;</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$b</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$c</span> </li>
</ul>
</div>
<a name="methodexec_setlanguage" id="exec_setlanguage"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">exec_setlanguage</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a844">844</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Language.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
exec_setlanguage
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$language</span> = <span class="var-default">'en'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$language</span><span class="var-description">: code</span> </li>
</ul>
</div>
<a name="methodfastpass_get_data" id="fastpass_get_data"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">fastpass_get_data</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1176">1176</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Plays the given file and receives DTMF data.</p>
<p class="description"><p>Return early if $buffer is adequate for request.</p><p>This is similar to STREAM FILE, but this command can accept and return many DTMF digits, while STREAM FILE returns immediately after the first DTMF digit is detected.</p><p>Asterisk looks for the file to play in /var/lib/asterisk/sounds by default.</p><p>If the user doesn't press any keys when the message plays, there is $timeout milliseconds of silence then the command ends.</p><p>The user has the opportunity to press a key at any time during the message or the post-message silence. If the user presses a key while the message is playing, the message stops playing. When the first key is pressed a timer starts counting for $timeout milliseconds. Every time the user presses another key the timer is restarted. The command ends when the counter goes to zero or the maximum number of digits is entered, whichever happens first.</p><p>If you don't specify a time out then a default timeout of 2000 is used following a pressed digit. If no digits are pressed then 6 seconds of silence follow the message.</p><p>If you don't specify $max_digits then the user can enter as many digits as they want.</p><p>Pressing the # key has the same effect as the timer running out: the command ends and any previously keyed digits are returned. A side effect of this is that there is no way to read a # key using this command.</p></p>
<ul class="tags">
<li><span class="field">return:</span> <p>see evaluate for return information. ['result'] holds the digits and ['data'] holds the timeout if present.</p><p>This differs from other commands with return DTMF as numbers representing ASCII characters.</p></li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-get+data">http://www.voip-info.org/wiki-get+data</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
fastpass_get_data
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">NULL</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$max_digits</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$buffer</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$filename</span><span class="var-description">: file to play. Do not include file extension.</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$timeout</span><span class="var-description">: milliseconds</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$max_digits</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$buffer</span> </li>
</ul>
</div>
<a name="methodfastpass_say_digits" id="fastpass_say_digits"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">fastpass_say_digits</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a916">916</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Say the given digit string, returning early if any of the given DTMF escape digits are received on the channel.</p>
<p class="description"><p>Return early if $buffer is adequate for request.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is -1 on hangup or error, 0 if playback completes with no digit received, otherwise a decimal value of the DTMF tone. Use chr() to convert to ASCII.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-say+digits">http://www.voip-info.org/wiki-say+digits</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
fastpass_say_digits
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$digits</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$buffer</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$digits</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$buffer</span> </li>
</ul>
</div>
<a name="methodfastpass_say_number" id="fastpass_say_number"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">fastpass_say_number</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a945">945</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Say the given number, returning early if any of the given DTMF escape digits are received on the channel.</p>
<p class="description"><p>Return early if $buffer is adequate for request.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is -1 on hangup or error, 0 if playback completes with no digit received, otherwise a decimal value of the DTMF tone. Use chr() to convert to ASCII.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-say+number">http://www.voip-info.org/wiki-say+number</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
fastpass_say_number
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$number</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$buffer</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$number</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$buffer</span> </li>
</ul>
</div>
<a name="methodfastpass_say_phonetic" id="fastpass_say_phonetic"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">fastpass_say_phonetic</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a974">974</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Say the given character string, returning early if any of the given DTMF escape digits are received on the channel.</p>
<p class="description"><p>Return early if $buffer is adequate for request.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is -1 on hangup or error, 0 if playback completes with no digit received, otherwise a decimal value of the DTMF tone. Use chr() to convert to ASCII.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-say+phonetic">http://www.voip-info.org/wiki-say+phonetic</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
fastpass_say_phonetic
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$buffer</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$text</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$buffer</span> </li>
</ul>
</div>
<a name="methodfastpass_say_punctuation" id="fastpass_say_punctuation"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">fastpass_say_punctuation</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1121">1121</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Say Puncutation in a string.</p>
<p class="description"><p>Return early if $buffer is adequate for request.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
fastpass_say_punctuation
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$frequency</span> = <span class="var-default">8000</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$buffer</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$text</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$frequency</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$buffer</span> </li>
</ul>
</div>
<a name="methodfastpass_say_time" id="fastpass_say_time"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">fastpass_say_time</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1003">1003</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Say a given time, returning early if any of the given DTMF escape digits are received on the channel.</p>
<p class="description"><p>Return early if $buffer is adequate for request.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is -1 on hangup or error, 0 if playback completes with no digit received, otherwise a decimal value of the DTMF tone. Use chr() to convert to ASCII.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-say+time">http://www.voip-info.org/wiki-say+time</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
fastpass_say_time
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$time</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$buffer</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$time</span><span class="var-description">: number of seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC).</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$buffer</span> </li>
</ul>
</div>
<a name="methodfastpass_stream_file" id="fastpass_stream_file"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">fastpass_stream_file</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1035">1035</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Play the given audio file, allowing playback to be interrupted by a DTMF digit. This command is similar to the GET DATA command but this command returns after the first DTMF digit has been pressed while GET DATA can accumulated any number of digits before returning.</p>
<p class="description"><p>Return early if $buffer is adequate for request.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is -1 on hangup or error, 0 if playback completes with no digit received, otherwise a decimal value of the DTMF tone. Use chr() to convert to ASCII.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-stream+file">http://www.voip-info.org/wiki-stream+file</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
fastpass_stream_file
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$offset</span> = <span class="var-default">0</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$buffer</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$filename</span><span class="var-description">: without extension, often in /var/lib/asterisk/sounds</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$offset</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$buffer</span> </li>
</ul>
</div>
<a name="methodfastpass_swift" id="fastpass_swift"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">fastpass_swift</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1093">1093</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Use Cepstral Swift to read text.</p>
<p class="description"><p>Return early if $buffer is adequate for request.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
<li><span class="field">link:</span> <a href="http://www.cepstral.com/">http://www.cepstral.com/</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
fastpass_swift
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$frequency</span> = <span class="var-default">8000</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$voice</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$buffer</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$text</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$frequency</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$buffer</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$voice</span> </li>
</ul>
</div>
<a name="methodfastpass_text2wav" id="fastpass_text2wav"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">fastpass_text2wav</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1064">1064</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Use festival to read text.</p>
<p class="description"><p>Return early if $buffer is adequate for request.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
<li><span class="field">link:</span> <a href="http://www.cstr.ed.ac.uk/projects/festival/">http://www.cstr.ed.ac.uk/projects/festival/</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
fastpass_text2wav
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$buffer</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$frequency</span> = <span class="var-default">8000</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$buffer</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$buffer</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$text</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$frequency</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$buffer</span> </li>
</ul>
</div>
<a name="methodget_data" id="get_data"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">get_data</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a408">408</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Plays the given file and receives DTMF data.</p>
<p class="description"><p>This is similar to STREAM FILE, but this command can accept and return many DTMF digits, while STREAM FILE returns immediately after the first DTMF digit is detected.</p><p>Asterisk looks for the file to play in /var/lib/asterisk/sounds by default.</p><p>If the user doesn't press any keys when the message plays, there is $timeout milliseconds of silence then the command ends.</p><p>The user has the opportunity to press a key at any time during the message or the post-message silence. If the user presses a key while the message is playing, the message stops playing. When the first key is pressed a timer starts counting for $timeout milliseconds. Every time the user presses another key the timer is restarted. The command ends when the counter goes to zero or the maximum number of digits is entered, whichever happens first.</p><p>If you don't specify a time out then a default timeout of 2000 is used following a pressed digit. If no digits are pressed then 6 seconds of silence follow the message.</p><p>If you don't specify $max_digits then the user can enter as many digits as they want.</p><p>Pressing the # key has the same effect as the timer running out: the command ends and any previously keyed digits are returned. A side effect of this is that there is no way to read a # key using this command.</p></p>
<ul class="tags">
<li><span class="field">return:</span> <p>see evaluate for return information. ['result'] holds the digits and ['data'] holds the timeout if present.</p><p>This differs from other commands with return DTMF as numbers representing ASCII characters.</p></li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-get+data">http://www.voip-info.org/wiki-get+data</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_ping.php_a8afcfe0902072cc636965d2b445e3fc.html">Ping an IP address</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
get_data
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">NULL</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$max_digits</span> = <span class="var-default">NULL</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$filename</span><span class="var-description">: file to play. Do not include file extension.</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$timeout</span><span class="var-description">: milliseconds</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$max_digits</span> </li>
</ul>
</div>
<a name="methodget_fullvariable" id="get_fullvariable"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">get_fullvariable</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a446">446</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fetch the value of a full variable.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is 0 if variable hasn't been set, 1 if it has. ['data'] holds the value. returns value if $getvalue is TRUE</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-Asterisk+variables">http://www.voip-info.org/wiki-Asterisk+variables</a></li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki/view/get+full+variable">http://www.voip-info.org/wiki/view/get+full+variable</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
get_fullvariable
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$variable</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$channel</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$getvalue</span> = <span class="var-default">FALSE</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$variable</span><span class="var-description">: name</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$channel</span><span class="var-description">: channel</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$getvalue</span><span class="var-description">: return the value only</span> </li>
</ul>
</div>
<a name="methodget_variable" id="get_variable"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">get_variable</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a424">424</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fetch the value of a variable.</p>
<p class="description"><p>Does not work with global variables. Does not work with some variables that are generated by modules.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is 0 if variable hasn't been set, 1 if it has. ['data'] holds the value. returns value if $getvalue is TRUE</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-Asterisk+variables">http://www.voip-info.org/wiki-Asterisk+variables</a></li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-get+variable">http://www.voip-info.org/wiki-get+variable</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
get_variable
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$variable</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$getvalue</span> = <span class="var-default">FALSE</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$variable</span><span class="var-description">: name</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$getvalue</span><span class="var-description">: return the value only</span> </li>
</ul>
</div>
<a name="methodhangup" id="hangup"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">hangup</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a477">477</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Hangup the specified channel. If no channel name is given, hang up the current channel.</p>
<p class="description"><p>With power comes responsibility. Hanging up channels other than your own isn't something that is done routinely. If you are not sure why you are doing so, then don't.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is 1 on success, -1 on failure.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-hangup">http://www.voip-info.org/wiki-hangup</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_ping.php_a8afcfe0902072cc636965d2b445e3fc.html">Ping an IP address</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_dtmf.php_eb30ab5fd2d98b4b41f251416fc7ed37.html">Get DTMF tones from the user and say the digits</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_input.php_2a77295d6494c9179dee4f5b0e65eac4.html">Get text input from the user and say it back</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
hangup
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$channel</span> = <span class="var-default">''</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$channel</span> </li>
</ul>
</div>
<a name="methodmake_folder" id="make_folder"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/PrivateMethod.png" />
<span class="method-title">make_folder</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1713">1713</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Make a folder recursively.</p>
<ul class="tags">
<li><span class="field">access:</span> private</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
make_folder
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$folder</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$perms</span> = <span class="var-default">0755</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$folder</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$perms</span> </li>
</ul>
</div>
<a name="methodmenu" id="menu"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">menu</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1216">1216</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Menu.</p>
<p class="description"><p>This function presents the user with a menu and reads the response</p></p>
<ul class="tags">
<li><span class="field">return:</span> key pressed on sucess, -1 on failure</li>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<span class="method-name">
menu
</span>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$choices</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">2000</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$choices</span><span class="var-description">: has the following structure: array('1'=&gt;'*Press 1 for this', // festival reads if prompt starts with * '2'=&gt;'some-gsm-without-extension', '*'=&gt;'*Press star for help');</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$timeout</span> </li>
</ul>
</div>
<a name="methodnew_AsteriskManager" id="new_AsteriskManager"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">new_AsteriskManager</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1550">1550</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Create a new AGI_AsteriskManager.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
&amp;new_AsteriskManager
</span>
()
</div>
</div>
<a name="methodnoop" id="noop"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">noop</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a488">488</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Does nothing.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-noop">http://www.voip-info.org/wiki-noop</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
noop
</span>
([<span class="var-type"></span>&nbsp;<span class="var-name">$string</span> = <span class="var-default">&quot;&quot;</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$string</span> </li>
</ul>
</div>
<a name="methodparse_callerid" id="parse_callerid"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">parse_callerid</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1279">1279</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parse caller id.</p>
<ul class="tags">
<li><span class="field">return:</span> 'Number'=&gt;$number)</li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_input.php_2a77295d6494c9179dee4f5b0e65eac4.html">Get text input from the user and say it back</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_dtmf.php_eb30ab5fd2d98b4b41f251416fc7ed37.html">Get DTMF tones from the user and say the digits</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array('Name'=>$name,</span>
<span class="method-name">
parse_callerid
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$callerid</span> = <span class="var-default">NULL</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$callerid</span> </li>
</ul>
</div>
<a name="methodreceive_char" id="receive_char"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">receive_char</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a502">502</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Receive a character of text from a connected channel. Waits up to $timeout milliseconds for a character to arrive, or infinitely if $timeout is zero.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is 0 on timeout or not supported, -1 on failure. Otherwise it is the decimal value of the DTMF tone. Use chr() to convert to ASCII.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-receive+char">http://www.voip-info.org/wiki-receive+char</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
receive_char
</span>
([<span class="var-type">integer</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">-1</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$timeout</span><span class="var-description">: milliseconds</span> </li>
</ul>
</div>
<a name="methodrecord_file" id="record_file"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">record_file</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a523">523</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Record sound to a file until an acceptable DTMF digit is received or a specified amount of time has passed. Optionally the file BEEP is played before recording begins.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is -1 on error, 0 on hangup, otherwise a decimal value of the DTMF tone. Use chr() to convert to ASCII.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-record+file">http://www.voip-info.org/wiki-record+file</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
record_file
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$format</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">-1</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$offset</span> = <span class="var-default">NULL</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$beep</span> = <span class="var-default">false</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$silence</span> = <span class="var-default">NULL</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$file</span><span class="var-description">: to record, without extension, often created in /var/lib/asterisk/sounds</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$format</span><span class="var-description">: of the file. GSM and WAV are commonly used formats. MP3 is read-only and thus cannot be used.</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$timeout</span><span class="var-description">: is the maximum record time in milliseconds, or -1 for no timeout.</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$offset</span><span class="var-description">: to seek to without exceeding the end of the file.</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$beep</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$silence</span><span class="var-description">: number of seconds of silence allowed before the function returns despite the lack of dtmf digits or reaching timeout.</span> </li>
</ul>
</div>
<a name="methodsay_digits" id="say_digits"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">say_digits</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a540">540</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Say the given digit string, returning early if any of the given DTMF escape digits are received on the channel.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is -1 on hangup or error, 0 if playback completes with no digit received, otherwise a decimal value of the DTMF tone. Use chr() to convert to ASCII.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-say+digits">http://www.voip-info.org/wiki-say+digits</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
say_digits
</span>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$digits</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$digits</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
</ul>
</div>
<a name="methodsay_number" id="say_number"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">say_number</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a554">554</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Say the given number, returning early if any of the given DTMF escape digits are received on the channel.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is -1 on hangup or error, 0 if playback completes with no digit received, otherwise a decimal value of the DTMF tone. Use chr() to convert to ASCII.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-say+number">http://www.voip-info.org/wiki-say+number</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
say_number
</span>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$number</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$number</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
</ul>
</div>
<a name="methodsay_phonetic" id="say_phonetic"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">say_phonetic</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a568">568</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Say the given character string, returning early if any of the given DTMF escape digits are received on the channel.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is -1 on hangup or error, 0 if playback completes with no digit received, otherwise a decimal value of the DTMF tone. Use chr() to convert to ASCII.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-say+phonetic">http://www.voip-info.org/wiki-say+phonetic</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
say_phonetic
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$text</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
</ul>
</div>
<a name="methodsay_punctuation" id="say_punctuation"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">say_punctuation</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1501">1501</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Say Puncutation in a string.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
say_punctuation
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$frequency</span> = <span class="var-default">8000</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$text</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$frequency</span> </li>
</ul>
</div>
<a name="methodsay_time" id="say_time"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">say_time</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a582">582</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Say a given time, returning early if any of the given DTMF escape digits are received on the channel.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is -1 on hangup or error, 0 if playback completes with no digit received, otherwise a decimal value of the DTMF tone. Use chr() to convert to ASCII.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-say+time">http://www.voip-info.org/wiki-say+time</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
say_time
</span>
([<span class="var-type">integer</span>&nbsp;<span class="var-name">$time</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$time</span><span class="var-description">: number of seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC).</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
</ul>
</div>
<a name="methodsend_image" id="send_image"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">send_image</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a598">598</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Send the specified image on a channel.</p>
<p class="description"><p>Most channels do not support the transmission of images.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is -1 on hangup or error, 0 if the image is sent or channel does not support image transmission.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-send+image">http://www.voip-info.org/wiki-send+image</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
send_image
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$image</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$image</span><span class="var-description">: without extension, often in /var/lib/asterisk/images</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../phpAGI/AGI_1.html#methodsend_image">AGI_1::send_image()</a>
: Send the specified image on a channel.
</li>
</ul>
</div>
<a name="methodsend_text" id="send_text"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">send_text</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a613">613</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Send the given text to the connected channel.</p>
<p class="description"><p>Most channels do not support transmission of text.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is -1 on hangup or error, 0 if the text is sent or channel does not support text transmission.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-send+text">http://www.voip-info.org/wiki-send+text</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
send_text
</span>
(<span class="var-type">$text</span>&nbsp;<span class="var-name">$text</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">$text</span>
<span class="var-name">$text</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../phpAGI/AGI_1.html#methodsend_text">AGI_1::send_text()</a>
: Send the given text to the connected channel.
</li>
</ul>
</div>
<a name="methodsetContext" id="setContext"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">setContext</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1261">1261</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">setContext - Set context, extension and priority.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setContext
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$context</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$extension</span> = <span class="var-default">'s'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$priority</span> = <span class="var-default">1</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$context</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$extension</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$priority</span> </li>
</ul>
</div>
<a name="methodset_autohangup" id="set_autohangup"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">set_autohangup</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a628">628</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Cause the channel to automatically hangup at $time seconds in the future.</p>
<p class="description"><p>If $time is 0 then the autohangup feature is disabled on this channel.</p><p>If the channel is hungup prior to $time seconds, this setting has no effect.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-set+autohangup">http://www.voip-info.org/wiki-set+autohangup</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
set_autohangup
</span>
([<span class="var-type">integer</span>&nbsp;<span class="var-name">$time</span> = <span class="var-default">0</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$time</span><span class="var-description">: until automatic hangup</span> </li>
</ul>
</div>
<a name="methodset_callerid" id="set_callerid"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">set_callerid</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a645">645</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Changes the caller ID of the current channel.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-set+callerid">http://www.voip-info.org/wiki-set+callerid</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
set_callerid
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$cid</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$cid</span><span class="var-description">: example: &quot;John Smith&quot;&lt;1234567&gt; This command will let you take liberties with the &lt;caller ID specification&gt; but the format shown in the example above works well: the name enclosed in double quotes followed immediately by the number inside angle brackets. If there is no name then you can omit it. If the name contains no spaces you can omit the double quotes around it. The number must follow the name immediately; don't put a space between them. The angle brackets around the number are necessary; if you omit them the number will be considered to be part of the name.</span> </li>
</ul>
</div>
<a name="methodset_context" id="set_context"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">set_context</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a663">663</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the context for continuation upon exiting the application.</p>
<p class="description"><p>Setting the context does NOT automatically reset the extension and the priority; if you want to start at the top of the new context you should set extension and priority yourself.</p><p>If you specify a non-existent context you receive no error indication (['result'] is still 0) but you do get a warning message on the Asterisk console.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-set+context">http://www.voip-info.org/wiki-set+context</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
set_context
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$context</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$context</span> </li>
</ul>
</div>
<a name="methodset_extension" id="set_extension"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">set_extension</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a681">681</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the extension to be used for continuation upon exiting the application.</p>
<p class="description"><p>Setting the extension does NOT automatically reset the priority. If you want to start with the first priority of the extension you should set the priority yourself.</p><p>If you specify a non-existent extension you receive no error indication (['result'] is still 0) but you do get a warning message on the Asterisk console.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-set+extension">http://www.voip-info.org/wiki-set+extension</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
set_extension
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$extension</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$extension</span> </li>
</ul>
</div>
<a name="methodset_global_var" id="set_global_var"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">set_global_var</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a329">329</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets a global variable, using Asterisk 1.6 syntax.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is 1 on sucess, 0 otherwise</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki/view/Asterisk+cmd+Set">http://www.voip-info.org/wiki/view/Asterisk+cmd+Set</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
set_global_var
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$pVariable</span>, <span class="var-type">string|int|float</span>&nbsp;<span class="var-name">$pValue</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$pVariable</span> </li>
<li>
<span class="var-type">string|int|float</span>
<span class="var-name">$pValue</span> </li>
</ul>
</div>
<a name="methodset_music" id="set_music"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">set_music</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a694">694</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Enable/Disable Music on hold generator.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-set+music">http://www.voip-info.org/wiki-set+music</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
set_music
</span>
([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$enabled</span> = <span class="var-default">true</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">''</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">boolean</span>
<span class="var-name">$enabled</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$class</span> </li>
</ul>
</div>
<a name="methodset_priority" id="set_priority"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">set_priority</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a710">710</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the priority to be used for continuation upon exiting the application.</p>
<p class="description"><p>If you specify a non-existent priority you receive no error indication (['result'] is still 0) and no warning is issued on the Asterisk console.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-set+priority">http://www.voip-info.org/wiki-set+priority</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
set_priority
</span>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$priority</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$priority</span> </li>
</ul>
</div>
<a name="methodset_var" id="set_var"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">set_var</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a347">347</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets a variable, using Asterisk 1.6 syntax.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is 1 on sucess, 0 otherwise</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki/view/Asterisk+cmd+Set">http://www.voip-info.org/wiki/view/Asterisk+cmd+Set</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
set_var
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$pVariable</span>, <span class="var-type">string|int|float</span>&nbsp;<span class="var-name">$pValue</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$pVariable</span> </li>
<li>
<span class="var-type">string|int|float</span>
<span class="var-name">$pValue</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../phpAGI/AGI_1.html#methodset_var">AGI_1::set_var()</a>
: Sets a variable to the specified value. The variables so created can later be used by later using ${&lt;variablename&gt;} in the dialplan.
</li>
</ul>
</div>
<a name="methodset_variable" id="set_variable"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">set_variable</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a728">728</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets a variable to the specified value. The variables so created can later be used by later using ${&lt;variablename&gt;} in the dialplan.</p>
<p class="description"><p>These variables live in the channel Asterisk creates when you pickup a phone and as such they are both local and temporary. Variables created in one channel can not be accessed by another channel. When you hang up the phone, the channel is deleted and any variables in that channel are deleted as well.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-set+variable">http://www.voip-info.org/wiki-set+variable</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
set_variable
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$variable</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$variable</span><span class="var-description">: is case sensitive</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodstream_file" id="stream_file"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">stream_file</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a748">748</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Play the given audio file, allowing playback to be interrupted by a DTMF digit. This command is similar to the GET DATA command but this command returns after the first DTMF digit has been pressed while GET DATA can accumulated any number of digits before returning.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is -1 on hangup or error, 0 if playback completes with no digit received, otherwise a decimal value of the DTMF tone. Use chr() to convert to ASCII.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-stream+file">http://www.voip-info.org/wiki-stream+file</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_ping.php_a8afcfe0902072cc636965d2b445e3fc.html">Ping an IP address</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
stream_file
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$offset</span> = <span class="var-default">0</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$filename</span><span class="var-description">: without extension, often in /var/lib/asterisk/sounds</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$offset</span> </li>
</ul>
</div>
<a name="methodswift" id="swift"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">swift</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1380">1380</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Use Cepstral Swift to read text.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
<li><span class="field">link:</span> <a href="http://www.cepstral.com/">http://www.cepstral.com/</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
swift
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$frequency</span> = <span class="var-default">8000</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$voice</span> = <span class="var-default">NULL</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$text</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$frequency</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$voice</span> </li>
</ul>
</div>
<a name="methodtdd_mode" id="tdd_mode"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">tdd_mode</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a760">760</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Enable or disable TDD transmission/reception on the current channel.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is 1 on sucess, 0 if the channel is not TDD capable.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-tdd+mode">http://www.voip-info.org/wiki-tdd+mode</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
tdd_mode
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$setting</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$setting</span><span class="var-description">: can be on, off or mate</span> </li>
</ul>
</div>
<a name="methodtext2wav" id="text2wav"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">text2wav</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1331">1331</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Use festival to read text.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
<li><span class="field">link:</span> <a href="http://www.cstr.ed.ac.uk/projects/festival/">http://www.cstr.ed.ac.uk/projects/festival/</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_ping.php_a8afcfe0902072cc636965d2b445e3fc.html">Ping an IP address</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_input.php_2a77295d6494c9179dee4f5b0e65eac4.html">Get text input from the user and say it back</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_dtmf.php_eb30ab5fd2d98b4b41f251416fc7ed37.html">Get DTMF tones from the user and say the digits</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
text2wav
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$escape_digits</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$frequency</span> = <span class="var-default">8000</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$text</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$escape_digits</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$frequency</span> </li>
</ul>
</div>
<a name="methodtext_input" id="text_input"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">text_input</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1434">1434</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Text Input.</p>
<p class="description"><p>Based on ideas found at http://www.voip-info.org/wiki-Asterisk+cmd+DTMFToText</p><p>Example: UC H LC i , SP h o w SP a r e SP y o u ? $string = '*8'.'44*'.'*5'.'444*'.'00*'.'0*'.'44*'.'666*'.'9*'.'0*'.'2*'.'777*'.'33*'.'0*'.'999*'.'666*'.'88*'.'0000*';</p></p>
<ul class="tags">
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-Asterisk+cmd+DTMFToText">http://www.voip-info.org/wiki-Asterisk+cmd+DTMFToText</a></li>
<li><span class="field">example:</span> <a href="../__examplesource/exsource__home_phpagi_devel_phpagi_examples_input.php_2a77295d6494c9179dee4f5b0e65eac4.html">Get text input from the user and say it back</a></li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
text_input
</span>
([<span class="var-type"></span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">'NUMERIC'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$mode</span> </li>
</ul>
</div>
<a name="methodverbose" id="verbose"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">verbose</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a780">780</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sends $message to the Asterisk console via the 'verbose' message system.</p>
<p class="description"><p>If the Asterisk verbosity level is $level or greater, send $message to the console.</p><p>The Asterisk verbosity system works as follows. The Asterisk user gets to set the desired verbosity at startup time or later using the console 'set verbose' command. Messages are displayed on the console if their verbose level is less than or equal to desired verbosity set by the user. More important messages should have a low verbose level; less important messages should have a high verbose level.</p></p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-verbose">http://www.voip-info.org/wiki-verbose</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
verbose
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$level</span> = <span class="var-default">1</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$message</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$level</span><span class="var-description">: from 1 to 4</span> </li>
</ul>
</div>
<a name="methodwait_for_digit" id="wait_for_digit"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">wait_for_digit</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a798">798</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Waits up to $timeout milliseconds for channel to receive a DTMF digit.</p>
<ul class="tags">
<li><span class="field">return:</span> see evaluate for return information. ['result'] is 0 if wait completes with no digit received, otherwise a decimal value of the DTMF tone. Use chr() to convert to ASCII.</li>
<li><span class="field">link:</span> <a href="http://www.voip-info.org/wiki-wait+for+digit">http://www.voip-info.org/wiki-wait+for+digit</a></li>
</ul>
<div class="method-signature">
<span class="method-result">array,</span>
<span class="method-name">
wait_for_digit
</span>
([<span class="var-type">integer</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">-1</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$timeout</span><span class="var-description">: in millisecons. Use -1 for the timeout value if you want the call to wait indefinitely.</span> </li>
</ul>
</div>
<a name="methodwhich" id="which"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/PrivateMethod.png" />
<span class="method-title">which</span> (line <span class="line-number"><a href="../__filesource/fsource_phpAGI__phpagi.php.html#a1690">1690</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Find an execuable in the path.</p>
<ul class="tags">
<li><span class="field">return:</span> the path to the command</li>
<li><span class="field">access:</span> private</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
which
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$cmd</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$checkpath</span> = <span class="var-default">NULL</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$cmd</span><span class="var-description">: command to find</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$checkpath</span><span class="var-description">: path to check</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Thu, 30 Sep 2010 02:21:59 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>