1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Asterisk Project : Application_BackGround</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
Asterisk Project : Application_BackGround
</span>
</div>
<div class="pagesubheading">
This page last changed on Mar 30, 2011 by <font color="#0050B2">wikibot</font>.
</div>
<h1><a name="Application_BackGround-BackGround%28%29"></a>BackGround()</h1>
<h3><a name="Application_BackGround-Synopsis"></a>Synopsis</h3>
<p>Play an audio file while waiting for digits of an extension to go to.</p>
<h3><a name="Application_BackGround-Description"></a>Description</h3>
<p>This application will play the given list of files <b>(do not put extension)</b> while waiting for an extension to be dialed by the calling channel. To continue waiting for digits after this application has finished playing files, the <tt>WaitExten</tt> application should be used. </p>
<p>If one of the requested sound files does not exist, call processing will be terminated. </p>
<p>This application sets the following channel variable upon completion: </p>
<ul>
<li><tt>BACKGROUNDSTATUS</tt> - The status of the background attempt as a text string.
<ul>
<li><tt>SUCCESS</tt></li>
<li><tt>FAILED</tt></li>
</ul>
</li>
</ul>
<h3><a name="Application_BackGround-Syntax"></a>Syntax</h3>
<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>BackGround(filename1[&filename2[&...]][,options[,langoverride[,context]]])</pre>
</div></div>
<h5><a name="Application_BackGround-Arguments"></a>Arguments</h5>
<ul>
<li><tt>filenames</tt>
<ul>
<li><tt>filename1</tt></li>
<li><tt>filename2</tt></li>
</ul>
</li>
<li><tt>options</tt>
<ul>
<li><tt>s</tt> - Causes the playback of the message to be skipped if the channel is not in the <tt>up</tt> state (i.e. it hasn't been answered yet). If this happens, the application will return immediately.</li>
<li><tt>n</tt> - Don't answer the channel before playing the files.</li>
<li><tt>m</tt> - Only break if a digit hit matches a one digit extension in the destination context.</li>
</ul>
</li>
<li><tt>langoverride</tt> - Explicitly specifies which language to attempt to use for the requested sound files.</li>
<li><tt>context</tt> - This is the dialplan context that this application will use when exiting to a dialed extension.</li>
</ul>
<h3><a name="Application_BackGround-SeeAlso"></a>See Also</h3>
<p><a href="Application_ControlPlayback.html" title="Application_ControlPlayback">Application_ControlPlayback</a><br/>
<a href="Application_WaitExten.html" title="Application_WaitExten">Application_WaitExten</a><br/>
<a href="Application_BackgroundDetect.html" title="Application_BackgroundDetect">Application_BackgroundDetect</a><br/>
<a href="Function_TIMEOUT.html" title="Function_TIMEOUT">Function_TIMEOUT</a></p>
<h3><a name="Application_BackGround-ImportVersion"></a>Import Version</h3>
<p>This documentation was imported from Asterisk version SVN-branch-1.8-r311874.</p>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.asterisk.org/wiki/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Oct 04, 2011 12:42</font></td>
</tr>
</table>
</body>
</html>
|