summaryrefslogtreecommitdiff
path: root/opcodes/mp3in.xml
diff options
context:
space:
mode:
Diffstat (limited to 'opcodes/mp3in.xml')
-rw-r--r--opcodes/mp3in.xml18
1 files changed, 16 insertions, 2 deletions
diff --git a/opcodes/mp3in.xml b/opcodes/mp3in.xml
index bbe62f2..b79b53f 100644
--- a/opcodes/mp3in.xml
+++ b/opcodes/mp3in.xml
@@ -22,7 +22,7 @@
<refsect1>
<title>Syntax</title>
- <synopsis>ar1, ar2 <command>mp3in</command> ifilcod, iskptim, iformat, iskipinit, ibufsize</synopsis>
+ <synopsis>ar1, ar2 <command>mp3in</command> ifilcod[, iskptim, iformat, iskipinit, ibufsize]</synopsis>
</refsect1>
<refsect1>
@@ -54,7 +54,7 @@
<para>
<emphasis>ibuffersize</emphasis> (optional) -- sets the internal buffer size
- for reading. If the value is zero or negative it defaults to
+ for reading. If the value is omitted, zero or negative it defaults to
4096 bytes.
</para>
</refsect1>
@@ -67,6 +67,19 @@
</refsect1>
<refsect1>
+ <title>Examples</title>
+ <para>
+ Here is an example of the mp3in opcode. It uses the file <ulink url="examples/mp3in.csd"><citetitle>mp3in.csd</citetitle></ulink>.
+
+ <example>
+ <title>Example of the mp3in opcode.</title>
+ <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
+ <xi:include href="examples-xml/mp3in.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1>
<title>See Also</title>
<para>
<link linkend="diskin"><citetitle>diskin</citetitle></link>,
@@ -76,6 +89,7 @@
<link linkend="inh"><citetitle>inh</citetitle></link>,
<link linkend="ino"><citetitle>ino</citetitle></link>,
<link linkend="inq"><citetitle>inq</citetitle></link>,
+ <link linkend="mp3len"><citetitle>mp3len</citetitle></link>,
<link linkend="soundin"><citetitle>soundin</citetitle></link>
</para>
</refsect1>