File: Application_ControlPlayback.html

package info (click to toggle)
asterisk 1%3A1.8.13.1~dfsg1-3%2Bdeb7u3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 49,336 kB
  • sloc: ansic: 497,975; sh: 11,763; cpp: 5,934; makefile: 3,065; perl: 3,019; yacc: 2,147; xml: 498; sql: 387; tcl: 113; php: 62; python: 42
file content (92 lines) | stat: -rw-r--r-- 3,598 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
    <head>
        <title>Asterisk Project : Application_ControlPlayback</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_ControlPlayback
                                                    </span>
				    </div>
				    <div class="pagesubheading">
					    This page last changed on Mar 30, 2011 by <font color="#0050B2">wikibot</font>.
				    </div>

				    <h1><a name="Application_ControlPlayback-ControlPlayback%28%29"></a>ControlPlayback()</h1>

<h3><a name="Application_ControlPlayback-Synopsis"></a>Synopsis</h3>
<p>Play a file with fast forward and rewind.</p>

<h3><a name="Application_ControlPlayback-Description"></a>Description</h3>
<p>This application will play back the given <em>filename</em>. </p>

<p>It sets the following channel variables upon completion: </p>
<ul>
	<li><tt>CPLAYBACKSTATUS</tt> - Contains the status of the attempt as a text string
	<ul>
		<li><tt>SUCCESS</tt></li>
		<li><tt>USERSTOPPED</tt></li>
		<li><tt>ERROR</tt></li>
	</ul>
	</li>
	<li><tt>CPLAYBACKOFFSET</tt> - Contains the offset in ms into the file where playback was at when it stopped. <tt>-1</tt> is end of file.</li>
	<li><tt>CPLAYBACKSTOPKEY</tt> - If the playback is stopped by the user this variable contains the key that was pressed.</li>
</ul>


<h3><a name="Application_ControlPlayback-Syntax"></a>Syntax</h3>
<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>ControlPlayback(filename[,skipms[,ff[,rew[,stop[,pause[,restart[,options]]]]]]])</pre>
</div></div>

<h5><a name="Application_ControlPlayback-Arguments"></a>Arguments</h5>

<ul>
	<li><tt>filename</tt></li>
	<li><tt>skipms</tt> - This is number of milliseconds to skip when rewinding or fast-forwarding.</li>
	<li><tt>ff</tt> - Fast-forward when this DTMF digit is received. (defaults to <tt>#</tt> )</li>
	<li><tt>rew</tt> - Rewind when this DTMF digit is received. (defaults to <tt>*</tt> )</li>
	<li><tt>stop</tt> - Stop playback when this DTMF digit is received.</li>
	<li><tt>pause</tt> - Pause playback when this DTMF digit is received.</li>
	<li><tt>restart</tt> - Restart playback when this DTMF digit is received.</li>
	<li><tt>options</tt>
	<ul>
		<li><tt>o</tt>
		<ul>
			<li><tt>time</tt> - Start at <em>time</em> ms from the beginning of the file.</li>
		</ul>
		</li>
	</ul>
	</li>
</ul>



<h3><a name="Application_ControlPlayback-SeeAlso"></a>See Also</h3>



<h3><a name="Application_ControlPlayback-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>