Asterisk-13-Application_MixMonitor_29394449.html 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Asterisk Project : Asterisk 13 Application_MixMonitor</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-Dialplan-Applications_29394285.html">Asterisk 13 Dialplan Applications</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 Application_MixMonitor
  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="Asterisk13Application_MixMonitor-MixMonitor()">MixMonitor()</h1>
  37. <h3 id="Asterisk13Application_MixMonitor-Synopsis">Synopsis</h3>
  38. <p>Record a call and mix the audio during the recording. Use of StopMixMonitor is required to guarantee the audio file is available for processing during dialplan execution.</p>
  39. <h3 id="Asterisk13Application_MixMonitor-Description">Description</h3>
  40. <p>Records the audio on the current channel to the specified file.</p>
  41. <p>This application does not automatically answer and should be preceeded by an application such as Answer or Progress().</p>
  42. <div class="aui-message hint shadowed information-macro">
  43. <p class="title">Note</p>
  44. <span class="aui-icon icon-hint">Icon</span>
  45. <div class="message-content">
  46. <p>MixMonitor runs as an audiohook.</p>
  47. </div>
  48. </div>
  49. <ul>
  50. <li><code>MIXMONITOR_FILENAME</code> - Will contain the filename used to record.</li>
  51. </ul>
  52. <h3 id="Asterisk13Application_MixMonitor-Syntax">Syntax</h3>
  53. <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
  54. <pre>MixMonitor(filename.extension,[options,[command]])</pre>
  55. </div></div>
  56. <h5 id="Asterisk13Application_MixMonitor-Arguments">Arguments</h5>
  57. <ul>
  58. <li><code>file</code>
  59. <ul>
  60. <li><code>filename</code> - If <em>filename</em> is an absolute path, uses that path, otherwise creates the file in the configured monitoring directory from <code>asterisk.conf.</code></li>
  61. <li><code>extension</code></li>
  62. </ul>
  63. </li>
  64. <li><code>options</code>
  65. <ul>
  66. <li><code>a</code> - Append to the file instead of overwriting it.</li>
  67. <li><code>b</code> - Only save audio to the file while the channel is bridged.</li>
  68. <li><code>B</code> - Play a periodic beep while this call is being recorded.
  69. <ul>
  70. <li><code>interval</code> - Interval, in seconds. Default is 15.</li>
  71. </ul>
  72. </li>
  73. <li><code>v</code> - Adjust the <strong>heard</strong> volume by a factor of <em>x</em> (range <code>-4</code> to <code>4</code>)
  74. <ul>
  75. <li><code>x</code></li>
  76. </ul>
  77. </li>
  78. <li><code>V</code> - Adjust the <strong>spoken</strong> volume by a factor of <em>x</em> (range <code>-4</code> to <code>4</code>)
  79. <ul>
  80. <li><code>x</code></li>
  81. </ul>
  82. </li>
  83. <li><code>W</code> - Adjust both, <strong>heard and spoken</strong> volumes by a factor of <em>x</em> (range <code>-4</code> to <code>4</code>)
  84. <ul>
  85. <li><code>x</code></li>
  86. </ul>
  87. </li>
  88. <li><code>r</code> - Use the specified file to record the <strong>receive</strong> audio feed. Like with the basic filename argument, if an absolute path isn't given, it will create the file in the configured monitoring directory.
  89. <ul>
  90. <li><code>file</code></li>
  91. </ul>
  92. </li>
  93. <li><code>t</code> - Use the specified file to record the <strong>transmit</strong> audio feed. Like with the basic filename argument, if an absolute path isn't given, it will create the file in the configured monitoring directory.
  94. <ul>
  95. <li><code>file</code></li>
  96. </ul>
  97. </li>
  98. <li><code>i</code> - Stores the MixMonitor's ID on this channel variable.
  99. <ul>
  100. <li><code>chanvar</code></li>
  101. </ul>
  102. </li>
  103. <li><code>p</code> - Play a beep on the channel that starts the recording.</li>
  104. <li><code>P</code> - Play a beep on the channel that stops the recording.</li>
  105. <li><at:declarations><at:string at:name="default,2222" /></at:declarations><code>m</code> - Create a copy of the recording as a voicemail in the indicated <strong>mailbox</strong>(es) separated by commas eg. m(1111<at:var at:name="default,2222" />default,...). Folders can be optionally specified using the syntax: mailbox@context/folder
  106. <ul>
  107. <li><code>mailbox</code></li>
  108. </ul>
  109. </li>
  110. </ul>
  111. </li>
  112. <li><code>command</code> - Will be executed when the recording is over.<br />
  113. Any strings matching <code>^{X</code>} will be unescaped to <code>X</code>.<br />
  114. All variables will be evaluated at the time MixMonitor is called.</li>
  115. </ul>
  116. <h3 id="Asterisk13Application_MixMonitor-SeeAlso">See Also</h3>
  117. <ul>
  118. <li><a href="Asterisk-13-Application_Monitor_29394908.html">Asterisk 13 Application_Monitor</a></li>
  119. <li><a href="Asterisk-13-Application_StopMixMonitor_29394450.html">Asterisk 13 Application_StopMixMonitor</a></li>
  120. <li><a href="Asterisk-13-Application_PauseMonitor_29394911.html">Asterisk 13 Application_PauseMonitor</a></li>
  121. <li><a href="Asterisk-13-Application_UnpauseMonitor_29394912.html">Asterisk 13 Application_UnpauseMonitor</a></li>
  122. <li><a href="Asterisk-13-Function_AUDIOHOOK_INHERIT_29394681.html">Asterisk 13 Function_AUDIOHOOK_INHERIT</a></li>
  123. </ul>
  124. <h3 id="Asterisk13Application_MixMonitor-ImportVersion">Import Version</h3>
  125. <p>This documentation was imported from Asterisk Version SVN-branch-13-r420538</p>
  126. </div>
  127. </div> </div>
  128. <div id="footer">
  129. <section class="footer-body">
  130. <p>Document generated by Confluence on Aug 11, 2014 13:45</p>
  131. </section>
  132. </div>
  133. </div> </body>
  134. </html>