<html>
<head>
<base href="https://wiki.asterisk.org/wiki">
<link rel="stylesheet" href="/wiki/s/en/2172/18/9/_/styles/combined.css?spaceKey=AST&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+Application_ControlPlayback">Asterisk 11 Application_ControlPlayback</a></h2>
<h4>Page <b>added</b> by <a href="https://wiki.asterisk.org/wiki/display/~wikibot">Wiki Bot</a>
</h4>
<br/>
<div class="notificationGreySide">
<h1><a name="Asterisk11Application_ControlPlayback-ControlPlayback%28%29"></a>ControlPlayback()</h1>
<h3><a name="Asterisk11Application_ControlPlayback-Synopsis"></a>Synopsis</h3>
<p>Play a file with fast forward and rewind.</p>
<h3><a name="Asterisk11Application_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>CPLAYBACKSTATUS - Contains the status of the attempt as a text string
<ul>
<li>SUCCESS</li>
<li>USERSTOPPED</li>
<li>ERROR</li>
</ul>
</li>
<li>CPLAYBACKOFFSET - Contains the offset in ms into the file where playback was at when it stopped. <tt>-1</tt> is end of file.</li>
<li>CPLAYBACKSTOPKEY - If the playback is stopped by the user this variable contains the key that was pressed.</li>
</ul>
<h3><a name="Asterisk11Application_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="Asterisk11Application_ControlPlayback-Arguments"></a>Arguments</h5>
<ul>
<li>filename</li>
<li>skipms - This is number of milliseconds to skip when rewinding or fast-forwarding.</li>
<li>ff - Fast-forward when this DTMF digit is received. (defaults to <tt>#</tt>)</li>
<li>rew - Rewind when this DTMF digit is received. (defaults to <tt>*</tt>)</li>
<li>stop - Stop playback when this DTMF digit is received.</li>
<li>pause - Pause playback when this DTMF digit is received.</li>
<li>restart - Restart playback when this DTMF digit is received.</li>
<li>options
<ul>
<li>o
<ul>
<li>time - Start at <em>time</em> ms from the beginning of the file.</li>
</ul>
</li>
</ul>
</li>
</ul>
<h3><a name="Asterisk11Application_ControlPlayback-ImportVersion"></a>Import Version</h3>
<p>This documentation was imported from Asterisk Version SVN-trunk-r370322</p>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://wiki.asterisk.org/wiki/users/removespacenotification.action?spaceKey=AST">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://wiki.asterisk.org/wiki/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+Application_ControlPlayback">View Online</a>
|
<a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+Application_ControlPlayback?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>