summaryrefslogtreecommitdiff
path: root/opcodes/pvsgain.xml
diff options
context:
space:
mode:
Diffstat (limited to 'opcodes/pvsgain.xml')
-rw-r--r--opcodes/pvsgain.xml81
1 files changed, 81 insertions, 0 deletions
diff --git a/opcodes/pvsgain.xml b/opcodes/pvsgain.xml
new file mode 100644
index 0000000..e04ad7d
--- /dev/null
+++ b/opcodes/pvsgain.xml
@@ -0,0 +1,81 @@
+
+<refentry id="pvsgain">
+<indexterm id="IndexPvsgain"><primary>pvsgain</primary></indexterm>
+ <refentryinfo><title>Spectral Processing:Streaming</title></refentryinfo>
+ <refmeta>
+ <refentrytitle>pvsgain</refentrytitle>
+ </refmeta>
+
+ <refnamediv>
+ <refname>pvsgain</refname>
+ <refpurpose>
+ Scale the amplitude of a pv stream.
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ Scale the amplitude of a pv stream.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Syntax</title>
+ <synopsis>fsig <command>pvsgain</command> fsigin, kgain </synopsis>
+ </refsect1>
+
+ <refsect1>
+ <title>Performance</title>
+ <para>
+ <emphasis>fsig</emphasis> -- output pv stream
+ </para>
+
+ <para>
+ <emphasis>fsigin</emphasis> -- input pv stream
+ </para>
+
+ <para>
+ <emphasis>kgain</emphasis> -- amplitude scaling (defaults to 1).
+ </para>
+ <warning>
+ <para>
+ It is unsafe to use the same f-variable for both input and output of pvs opcodes. Using the same one might lead to undefined behavior on some opcodes. Use a different one on the left and right sides of the opcode.
+ </para>
+ </warning>
+ </refsect1>
+
+ <refsect1>
+ <title>Examples</title>
+ <para>
+ Here is an example of the use of the <emphasis>pvsgain</emphasis> opcode. It uses the file <ulink url="examples/pvsgain.csd"><citetitle>pvsgain.csd</citetitle></ulink>.
+ <example>
+ <title>Example of the <emphasis>pvsgain</emphasis> 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/pvsgain.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <link linkend="pvsanal"><citetitle>pvsanal</citetitle></link>,
+ <link linkend="pvsynth"><citetitle>pvsynth</citetitle></link>,
+ <link linkend="pvsadsyn"><citetitle>pvsadsyn</citetitle></link>
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Credits</title>
+ <para>
+ <simplelist>
+ <member>Author: &namevictor;</member>
+ <member>2011 </member>
+ </simplelist>
+ </para>
+
+ <para>New plugin in version 5</para>
+ <para>2011</para>
+ </refsect1>
+</refentry>