docs/libs/html/GstLFOControlSource.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GstLFOControlSource</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer 0.10 Library Reference Manual">
   8 <link rel="up" href="gstreamer-control.html" title="GStreamer Dynamic Parameter Control">
   9 <link rel="prev" href="GstInterpolationControlSource.html" title="GstInterpolationControlSource">
  10 <link rel="next" href="gstreamer-libs-GstControllerGObject.html" title="GstControllerGObject">
  11 <meta name="generator" content="GTK-Doc V1.17 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GstInterpolationControlSource.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="gstreamer-control.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer 0.10 Library Reference Manual</th>
  21 <td><a accesskey="n" href="gstreamer-libs-GstControllerGObject.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#GstLFOControlSource.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GstLFOControlSource.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GstLFOControlSource.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#GstLFOControlSource.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="GstLFOControlSource"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="GstLFOControlSource.top_of_page"></a>GstLFOControlSource</span></h2>
  38 <p>GstLFOControlSource — LFO control source</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="GstLFOControlSource.synopsis"></a><h2>Synopsis</h2>
  44 <pre class="synopsis">
  45 #include &lt;libs/controller/gstlfocontrolsource.h&gt;
  46
  47 struct              <a class="link" href="GstLFOControlSource.html#GstLFOControlSource-struct" title="struct GstLFOControlSource">GstLFOControlSource</a>;
  48 enum                <a class="link" href="GstLFOControlSource.html#GstLFOWaveform" title="enum GstLFOWaveform">GstLFOWaveform</a>;
  49 <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="returnvalue">GstLFOControlSource</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>);
  50 </pre>
  51 </div>
  52 <div class="refsect1">
  53 <a name="GstLFOControlSource.object-hierarchy"></a><h2>Object Hierarchy</h2>
  54 <pre class="synopsis">
  55   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  56    +----<a class="link" href="GstControlSource.html" title="GstControlSource">GstControlSource</a>
  57          +----GstLFOControlSource
  58 </pre>
  59 </div>
  60 <div class="refsect1">
  61 <a name="GstLFOControlSource.properties"></a><h2>Properties</h2>
  62 <pre class="synopsis">
  63   "<a class="link" href="GstLFOControlSource.html#GstLFOControlSource--amplitude" title='The "amplitude" property'>amplitude</a>"                <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>*               : Read / Write
  64   "<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
  65   "<a class="link" href="GstLFOControlSource.html#GstLFOControlSource--offset" title='The "offset" property'>offset</a>"                   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>*               : Read / Write
  66   "<a class="link" href="GstLFOControlSource.html#GstLFOControlSource--timeshift" title='The "timeshift" property'>timeshift</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write
  67   "<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
  68 </pre>
  69 </div>
  70 <div class="refsect1">
  71 <a name="GstLFOControlSource.description"></a><h2>Description</h2>
  72 <p>
  73 <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a> is a <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a>, that provides several periodic waveforms
  74 as control values. It supports all fundamental, numeric GValue types as property.
  75 </p>
  76 <p>
  77 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>,
  78 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 or use
  79 gst_lfo_control_source_set_waveform.
  80 </p>
  81 <p>
  82 All functions are MT-safe.
  83 </p>
  84 </div>
  85 <div class="refsect1">
  86 <a name="GstLFOControlSource.details"></a><h2>Details</h2>
  87 <div class="refsect2">
  88 <a name="GstLFOControlSource-struct"></a><h3>struct GstLFOControlSource</h3>
  89 <pre class="programlisting">struct GstLFOControlSource;</pre>
  90 <p>
  91 The instance structure of <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a>.
  92 </p>
  93 </div>
  94 <hr>
  95 <div class="refsect2">
  96 <a name="GstLFOWaveform"></a><h3>enum GstLFOWaveform</h3>
  97 <pre class="programlisting">typedef enum
  98 {
  99   GST_LFO_WAVEFORM_SINE,
 100   GST_LFO_WAVEFORM_SQUARE,
 101   GST_LFO_WAVEFORM_SAW,
 102   GST_LFO_WAVEFORM_REVERSE_SAW,
 103   GST_LFO_WAVEFORM_TRIANGLE
 104 } GstLFOWaveform;
 105 </pre>
 106 <p>
 107 The various waveform modes available.
 108 </p>
 109 <div class="variablelist"><table border="0">
 110 <col align="left" valign="top">
 111 <tbody>
 112 <tr>
 113 <td><p><a name="GST-LFO-WAVEFORM-SINE:CAPS"></a><span class="term"><code class="literal">GST_LFO_WAVEFORM_SINE</code></span></p></td>
 114 <td>sine waveform
 115 </td>
 116 </tr>
 117 <tr>
 118 <td><p><a name="GST-LFO-WAVEFORM-SQUARE:CAPS"></a><span class="term"><code class="literal">GST_LFO_WAVEFORM_SQUARE</code></span></p></td>
 119 <td>square waveform
 120 </td>
 121 </tr>
 122 <tr>
 123 <td><p><a name="GST-LFO-WAVEFORM-SAW:CAPS"></a><span class="term"><code class="literal">GST_LFO_WAVEFORM_SAW</code></span></p></td>
 124 <td>saw waveform
 125 </td>
 126 </tr>
 127 <tr>
 128 <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>
 129 <td>reverse saw waveform
 130 </td>
 131 </tr>
 132 <tr>
 133 <td><p><a name="GST-LFO-WAVEFORM-TRIANGLE:CAPS"></a><span class="term"><code class="literal">GST_LFO_WAVEFORM_TRIANGLE</code></span></p></td>
 134 <td>triangle waveform
 135 </td>
 136 </tr>
 137 </tbody>
 138 </table></div>
 139 </div>
 140 <hr>
 141 <div class="refsect2">
 142 <a name="gst-lfo-control-source-new"></a><h3>gst_lfo_control_source_new ()</h3>
 143 <pre class="programlisting"><a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="returnvalue">GstLFOControlSource</span></a> * gst_lfo_control_source_new        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 144 <p>
 145 This returns a new, unbound <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a>.
 146 </p>
 147 <div class="variablelist"><table border="0">
 148 <col align="left" valign="top">
 149 <tbody><tr>
 150 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 151 <td>a new, unbound <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a>.</td>
 152 </tr></tbody>
 153 </table></div>
 154 </div>
 155 </div>
 156 <div class="refsect1">
 157 <a name="GstLFOControlSource.property-details"></a><h2>Property Details</h2>
 158 <div class="refsect2">
 159 <a name="GstLFOControlSource--amplitude"></a><h3>The <code class="literal">"amplitude"</code> property</h3>
 160 <pre class="programlisting">  "amplitude"                <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>*               : Read / Write</pre>
 161 <p>
 162 Specifies the amplitude for the waveform of this <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a>.
 163 </p>
 164 <p>
 165 It should be given as a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> with a type that can be transformed
 166 to the type of the bound property.
 167 </p>
 168 </div>
 169 <hr>
 170 <div class="refsect2">
 171 <a name="GstLFOControlSource--frequency"></a><h3>The <code class="literal">"frequency"</code> property</h3>
 172 <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>
 173 <p>
 174 Specifies the frequency that should be used for the waveform
 175 of this <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a>. It should be large enough
 176 so that the period is longer than one nanosecond.
 177 </p>
 178 <p>Allowed values: &gt;= 0</p>
 179 <p>Default value: 1</p>
 180 </div>
 181 <hr>
 182 <div class="refsect2">
 183 <a name="GstLFOControlSource--offset"></a><h3>The <code class="literal">"offset"</code> property</h3>
 184 <pre class="programlisting">  "offset"                   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>*               : Read / Write</pre>
 185 <p>
 186 Specifies the offset for the waveform of this <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a>.
 187 </p>
 188 <p>
 189 It should be given as a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> with a type that can be transformed
 190 to the type of the bound property.
 191 </p>
 192 </div>
 193 <hr>
 194 <div class="refsect2">
 195 <a name="GstLFOControlSource--timeshift"></a><h3>The <code class="literal">"timeshift"</code> property</h3>
 196 <pre class="programlisting">  "timeshift"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write</pre>
 197 <p>
 198 Specifies the timeshift to the right that should be used for the waveform
 199 of this <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a> in nanoseconds.
 200 </p>
 201 <p>
 202 To get a n nanosecond shift to the left use
 203 "(GST_SECOND / frequency) - n".
 204 </p>
 205 <p>Default value: 0</p>
 206 </div>
 207 <hr>
 208 <div class="refsect2">
 209 <a name="GstLFOControlSource--waveform"></a><h3>The <code class="literal">"waveform"</code> property</h3>
 210 <pre class="programlisting">  "waveform"                 <a class="link" href="GstLFOControlSource.html#GstLFOWaveform" title="enum GstLFOWaveform"><span class="type">GstLFOWaveform</span></a>        : Read / Write</pre>
 211 <p>
 212 Specifies the waveform that should be used for this <a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource"><span class="type">GstLFOControlSource</span></a>.
 213 </p>
 214 <p>Default value: GST_LFO_WAVEFORM_SINE</p>
 215 </div>
 216 </div>
 217 </div>
 218 <div class="footer">
 219 <hr>
 220           Generated by GTK-Doc V1.17</div>
 221 </body>
 222 </html>