app_mixmonitor: Update the documentation concerning the "D" option.

When using the "D" option to output interleaved audio, the file extension
must be ".raw".  That info wasn't being properly rendered in the markdown
and HTML on the documentation site.  The XML was updated to move the
note in the option section to a warning in the description.

Resolves: #1269
This commit is contained in:
George Joseph
2025-07-16 09:49:22 -06:00
parent f5d2ea75c3
commit a4da66e584

View File

@@ -131,9 +131,11 @@
the file in the configured monitoring directory.</para> the file in the configured monitoring directory.</para>
</option> </option>
<option name="D"> <option name="D">
<para>Interleave the audio coming from the channel and the audio coming to the channel in <para>Interleave the audio coming from the channel and the audio
the output audio as a dual channel stream, rather than mix it.</para> going to the channel and output it as a 2 channel (stereo)
<note><para>Use .raw as the extension.</para></note> raw stream rather than mixing it. You must use the
<literal>.raw</literal> file extension. Any other extension
will produce a corrupted file.</para>
</option> </option>
<option name="n"> <option name="n">
<para>When the <replaceable>r</replaceable> or <replaceable>t</replaceable> option is <para>When the <replaceable>r</replaceable> or <replaceable>t</replaceable> option is
@@ -189,6 +191,9 @@
parameters. You risk a command injection attack executing arbitrary commands parameters. You risk a command injection attack executing arbitrary commands
if the untrusted strings aren't filtered to remove dangerous characters. See if the untrusted strings aren't filtered to remove dangerous characters. See
function <variable>FILTER()</variable>.</para></warning> function <variable>FILTER()</variable>.</para></warning>
<warning><para>When using the <literal>D</literal> option to save
interleaved audio, you MUST use <literal>.raw</literal> as the
file extension. Any other extension will produce a corrupted file.</para></warning>
</description> </description>
<see-also> <see-also>
<ref type="application">StopMixMonitor</ref> <ref type="application">StopMixMonitor</ref>