Asterisk-13-ManagerAction_ControlPlayback_29394521.html 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Asterisk Project : Asterisk 13 ManagerAction_ControlPlayback</title>
  5. <link rel="stylesheet" href="styles/site.css" type="text/css" />
  6. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. </head>
  8. <body class="theme-default aui-theme-default">
  9. <div id="page">
  10. <div id="main" class="aui-page-panel">
  11. <div id="main-header">
  12. <div id="breadcrumb-section">
  13. <ol id="breadcrumbs">
  14. <li class="first">
  15. <span><a href="index.html">Asterisk Project</a></span>
  16. </li>
  17. <li>
  18. <span><a href="Asterisk-13-Command-Reference_29394274.html">Asterisk 13 Command Reference</a></span>
  19. </li>
  20. <li>
  21. <span><a href="Asterisk-13-AMI-Actions_29394279.html">Asterisk 13 AMI Actions</a></span>
  22. </li>
  23. </ol>
  24. </div>
  25. <h1 id="title-heading" class="pagetitle">
  26. <span id="title-text">
  27. Asterisk Project : Asterisk 13 ManagerAction_ControlPlayback
  28. </span>
  29. </h1>
  30. </div>
  31. <div id="content" class="view">
  32. <div class="page-metadata">
  33. Created by <span class='author'> wikibot</span> on Aug 08, 2014
  34. </div>
  35. <div id="main-content" class="wiki-content group">
  36. <h1 id="Asterisk13ManagerAction_ControlPlayback-ControlPlayback">ControlPlayback</h1>
  37. <h3 id="Asterisk13ManagerAction_ControlPlayback-Synopsis">Synopsis</h3>
  38. <p>Control the playback of a file being played to a channel.</p>
  39. <h3 id="Asterisk13ManagerAction_ControlPlayback-Description">Description</h3>
  40. <p>Control the operation of a media file being played back to a channel. Note that this AMI action does not initiate playback of media to channel, but rather controls the operation of a media operation that was already initiated on the channel.</p>
  41. <div class="aui-message hint shadowed information-macro">
  42. <p class="title">Note</p>
  43. <span class="aui-icon icon-hint">Icon</span>
  44. <div class="message-content">
  45. <p>The <code>pause</code> and <code>restart</code> <em>Control</em> options will stop a playback operation if that operation was not initiated from the <em>ControlPlayback</em> application or the <em>control stream file</em> AGI command.</p>
  46. </div>
  47. </div>
  48. <h3 id="Asterisk13ManagerAction_ControlPlayback-Syntax">Syntax</h3>
  49. <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
  50. <pre>Action: ControlPlayback
  51. ActionID: &lt;value&gt;
  52. Channel: &lt;value&gt;
  53. Control: &lt;value&gt;
  54. </pre>
  55. </div></div>
  56. <h5 id="Asterisk13ManagerAction_ControlPlayback-Arguments">Arguments</h5>
  57. <ul>
  58. <li><code>ActionID</code> - ActionID for this transaction. Will be returned.</li>
  59. <li><code>Channel</code> - The name of the channel that currently has a file being played back to it.</li>
  60. <li><code>Control</code>
  61. <ul>
  62. <li><code>stop</code> - Stop the playback operation.</li>
  63. <li><code>forward</code> - Move the current position in the media forward. The amount of time that the stream moves forward is determined by the <em>skipms</em> value passed to the application that initiated the playback.
  64. <div class="aui-message hint shadowed information-macro">
  65. <p class="title">Note</p>
  66. <span class="aui-icon icon-hint">Icon</span>
  67. <div class="message-content">
  68. <p>The default skipms value is <code>3000</code> ms.</p>
  69. </div>
  70. </div>
  71. </li>
  72. <li><code>reverse</code> - Move the current position in the media backward. The amount of time that the stream moves backward is determined by the <em>skipms</em> value passed to the application that initiated the playback.
  73. <div class="aui-message hint shadowed information-macro">
  74. <p class="title">Note</p>
  75. <span class="aui-icon icon-hint">Icon</span>
  76. <div class="message-content">
  77. <p>The default skipms value is <code>3000</code> ms.</p>
  78. </div>
  79. </div>
  80. </li>
  81. <li><code>pause</code> - Pause/unpause the playback operation, if supported. If not supported, stop the playback.</li>
  82. <li><code>restart</code> - Restart the playback operation, if supported. If not supported, stop the playback.</li>
  83. </ul>
  84. </li>
  85. </ul>
  86. <h3 id="Asterisk13ManagerAction_ControlPlayback-SeeAlso">See Also</h3>
  87. <ul>
  88. <li><a href="Asterisk-13-Application_Playback_29394522.html">Asterisk 13 Application_Playback</a></li>
  89. <li><a href="Asterisk-13-Application_ControlPlayback_29394520.html">Asterisk 13 Application_ControlPlayback</a></li>
  90. <li><a href="Asterisk-13-AGICommand_stream-file_29394842.html">Asterisk 13 AGICommand_stream file</a></li>
  91. <li><a href="Asterisk-13-AGICommand_control-stream-file_29394811.html">Asterisk 13 AGICommand_control stream file</a></li>
  92. </ul>
  93. <h3 id="Asterisk13ManagerAction_ControlPlayback-ImportVersion">Import Version</h3>
  94. <p>This documentation was imported from Asterisk Version SVN-branch-13-r420538</p>
  95. </div>
  96. </div> </div>
  97. <div id="footer">
  98. <section class="footer-body">
  99. <p>Document generated by Confluence on Aug 11, 2014 13:39</p>
  100. </section>
  101. </div>
  102. </div> </body>
  103. </html>