| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>GstLFOControlSource</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> |
| <link rel="home" href="index.html" title="GStreamer 1.0 Library Reference Manual"> |
| <link rel="up" href="gstreamer-control.html" title="GStreamer Dynamic Parameter Control"> |
| <link rel="prev" href="GstInterpolationControlSource.html" title="GstInterpolationControlSource"> |
| <link rel="next" href="GstTriggerControlSource.html" title="GstTriggerControlSource"> |
| <meta name="generator" content="GTK-Doc V1.19 (XML mode)"> |
| <link rel="stylesheet" href="style.css" type="text/css"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> |
| <tr valign="middle"> |
| <td><a accesskey="p" href="GstInterpolationControlSource.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> |
| <td><a accesskey="u" href="gstreamer-control.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> |
| <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> |
| <th width="100%" align="center">GStreamer 1.0 Library Reference Manual</th> |
| <td><a accesskey="n" href="GstTriggerControlSource.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> |
| </tr> |
| <tr><td colspan="5" class="shortcuts"> |
| <a href="#GstLFOControlSource.synopsis" class="shortcut">Top</a> |
| | |
| <a href="#GstLFOControlSource.description" class="shortcut">Description</a> |
| | |
| <a href="#GstLFOControlSource.object-hierarchy" class="shortcut">Object Hierarchy</a> |
| | |
| <a href="#GstLFOControlSource.properties" class="shortcut">Properties</a> |
| </td></tr> |
| </table> |
| <div class="refentry"> |
| <a name="GstLFOControlSource"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="GstLFOControlSource.top_of_page"></a>GstLFOControlSource</span></h2> |
| <p>GstLFOControlSource — LFO control source</p> |
| </td> |
| <td valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsynopsisdiv"> |
| <a name="GstLFOControlSource.synopsis"></a><h2>Synopsis</h2> |
| <pre class="synopsis"> |
| #include <libs/controller/gstlfocontrolsource.h> |
| |
| struct <a class="link" href="GstLFOControlSource.html#GstLFOControlSource-struct" title="struct GstLFOControlSource">GstLFOControlSource</a>; |
| enum <a class="link" href="GstLFOControlSource.html#GstLFOWaveform" title="enum GstLFOWaveform">GstLFOWaveform</a>; |
| <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstControlSource.html"><span class="returnvalue">GstControlSource</span></a> * <a class="link" href="GstLFOControlSource.html#gst-lfo-control-source-new" title="gst_lfo_control_source_new ()">gst_lfo_control_source_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GstLFOControlSource.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| <pre class="synopsis"> |
| <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> |
| +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> |
| +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a> |
| +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstControlSource.html">GstControlSource</a> |
| +----GstLFOControlSource |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GstLFOControlSource.properties"></a><h2>Properties</h2> |
| <pre class="synopsis"> |
| "<a class="link" href="GstLFOControlSource.html#GstLFOControlSource--amplitude" title='The "amplitude" property'>amplitude</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write |
| "<a class="link" href="GstLFOControlSource.html#GstLFOControlSource--frequency" title='The "frequency" property'>frequency</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write |
| "<a class="link" href="GstLFOControlSource.html#GstLFOControlSource--offset" title='The "offset" property'>offset</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write |
| "<a class="link" href="GstLFOControlSource.html#GstLFOControlSource--timeshift" title='The "timeshift" property'>timeshift</a>" <span class="type">guint64</span> : Read / Write |
| "<a class="link" href="GstLFOControlSource.html#GstLFOControlSource--waveform" title='The "waveform" property'>waveform</a>" <a class="link" href="GstLFOControlSource.html#GstLFOWaveform" title="enum GstLFOWaveform"><span class="type">GstLFOWaveform</span></a> : Read / Write |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GstLFOControlSource.description"></a><h2>Description</h2> |
| <p> |
| <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a> is a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstControlSource.html"><span class="type">GstControlSource</span></a>, that provides several periodic |
| waveforms as control values. |
| </p> |
| <p> |
| To use <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a> get a new instance by calling |
| <a class="link" href="GstLFOControlSource.html#gst-lfo-control-source-new" title="gst_lfo_control_source_new ()"><code class="function">gst_lfo_control_source_new()</code></a>, bind it to a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> and set the relevant |
| properties. |
| </p> |
| <p> |
| All functions are MT-safe. |
| </p> |
| </div> |
| <div class="refsect1"> |
| <a name="GstLFOControlSource.details"></a><h2>Details</h2> |
| <div class="refsect2"> |
| <a name="GstLFOControlSource-struct"></a><h3>struct GstLFOControlSource</h3> |
| <pre class="programlisting">struct GstLFOControlSource;</pre> |
| <p> |
| The instance structure of <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstControlSource.html"><span class="type">GstControlSource</span></a>. |
| </p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstLFOWaveform"></a><h3>enum GstLFOWaveform</h3> |
| <pre class="programlisting">typedef enum { |
| GST_LFO_WAVEFORM_SINE, |
| GST_LFO_WAVEFORM_SQUARE, |
| GST_LFO_WAVEFORM_SAW, |
| GST_LFO_WAVEFORM_REVERSE_SAW, |
| GST_LFO_WAVEFORM_TRIANGLE |
| } GstLFOWaveform; |
| </pre> |
| <p> |
| The various waveform modes available. |
| </p> |
| <div class="variablelist"><table border="0" class="variablelist"> |
| <colgroup> |
| <col align="left" valign="top"> |
| <col> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td><p><a name="GST-LFO-WAVEFORM-SINE:CAPS"></a><span class="term"><code class="literal">GST_LFO_WAVEFORM_SINE</code></span></p></td> |
| <td>sine waveform |
| </td> |
| </tr> |
| <tr> |
| <td><p><a name="GST-LFO-WAVEFORM-SQUARE:CAPS"></a><span class="term"><code class="literal">GST_LFO_WAVEFORM_SQUARE</code></span></p></td> |
| <td>square waveform |
| </td> |
| </tr> |
| <tr> |
| <td><p><a name="GST-LFO-WAVEFORM-SAW:CAPS"></a><span class="term"><code class="literal">GST_LFO_WAVEFORM_SAW</code></span></p></td> |
| <td>saw waveform |
| </td> |
| </tr> |
| <tr> |
| <td><p><a name="GST-LFO-WAVEFORM-REVERSE-SAW:CAPS"></a><span class="term"><code class="literal">GST_LFO_WAVEFORM_REVERSE_SAW</code></span></p></td> |
| <td>reverse saw waveform |
| </td> |
| </tr> |
| <tr> |
| <td><p><a name="GST-LFO-WAVEFORM-TRIANGLE:CAPS"></a><span class="term"><code class="literal">GST_LFO_WAVEFORM_TRIANGLE</code></span></p></td> |
| <td>triangle waveform |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="gst-lfo-control-source-new"></a><h3>gst_lfo_control_source_new ()</h3> |
| <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstControlSource.html"><span class="returnvalue">GstControlSource</span></a> * gst_lfo_control_source_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> |
| <p> |
| This returns a new, unbound <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a>. |
| </p> |
| <div class="variablelist"><table border="0" class="variablelist"> |
| <colgroup> |
| <col align="left" valign="top"> |
| <col> |
| </colgroup> |
| <tbody><tr> |
| <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| <td>a new, unbound <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> |
| </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GstLFOControlSource.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GstLFOControlSource--amplitude"></a><h3>The <code class="literal">"amplitude"</code> property</h3> |
| <pre class="programlisting"> "amplitude" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre> |
| <p> |
| Specifies the amplitude for the waveform of this <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a>. |
| </p> |
| <p>Allowed values: [0,1]</p> |
| <p>Default value: 1</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstLFOControlSource--frequency"></a><h3>The <code class="literal">"frequency"</code> property</h3> |
| <pre class="programlisting"> "frequency" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre> |
| <p> |
| Specifies the frequency that should be used for the waveform |
| of this <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a>. It should be large enough |
| so that the period is longer than one nanosecond. |
| </p> |
| <p>Allowed values: >= G_MINDOUBLE</p> |
| <p>Default value: 1</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstLFOControlSource--offset"></a><h3>The <code class="literal">"offset"</code> property</h3> |
| <pre class="programlisting"> "offset" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre> |
| <p> |
| Specifies the value offset for the waveform of this <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a>. |
| </p> |
| <p>Allowed values: [0,1]</p> |
| <p>Default value: 1</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstLFOControlSource--timeshift"></a><h3>The <code class="literal">"timeshift"</code> property</h3> |
| <pre class="programlisting"> "timeshift" <span class="type">guint64</span> : Read / Write</pre> |
| <p> |
| Specifies the timeshift to the right that should be used for the waveform |
| of this <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a> in nanoseconds. |
| </p> |
| <p> |
| To get a n nanosecond shift to the left use |
| "(GST_SECOND / frequency) - n". |
| </p> |
| <p>Default value: 0</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstLFOControlSource--waveform"></a><h3>The <code class="literal">"waveform"</code> property</h3> |
| <pre class="programlisting"> "waveform" <a class="link" href="GstLFOControlSource.html#GstLFOWaveform" title="enum GstLFOWaveform"><span class="type">GstLFOWaveform</span></a> : Read / Write</pre> |
| <p> |
| Specifies the waveform that should be used for this <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a>. |
| </p> |
| <p>Default value: GST_LFO_WAVEFORM_SINE</p> |
| </div> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr> |
| Generated by GTK-Doc V1.19</div> |
| </body> |
| </html> |
