docs/gst/html/gstreamer-GstParamSpec.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>GstParamSpec</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer 0.10 Core Reference Manual">
   8 <link rel="up" href="libgstreamer.html" title="GStreamer Core Library">
   9 <link rel="prev" href="GstPadTemplate.html" title="GstPadTemplate">
  10 <link rel="next" href="gstreamer-GstParse.html" title="GstParse">
  11 <meta name="generator" content="GTK-Doc V1.18 (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="GstPadTemplate.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="libgstreamer.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 Core Reference Manual</th>
  21 <td><a accesskey="n" href="gstreamer-GstParse.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="#gstreamer-GstParamSpec.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gstreamer-GstParamSpec.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gstreamer-GstParamSpec"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gstreamer-GstParamSpec.top_of_page"></a>GstParamSpec</span></h2>
  34 <p>GstParamSpec — GParamSpec implementations specific
  35 to GStreamer</p>
  36 </td>
  37 <td valign="top" align="right"></td>
  38 </tr></table></div>
  39 <div class="refsynopsisdiv">
  40 <a name="gstreamer-GstParamSpec.synopsis"></a><h2>Synopsis</h2>
  41 <pre class="synopsis">
  42 #include &lt;gst/gst.h&gt;
  43
  44 #define             <a class="link" href="gstreamer-GstParamSpec.html#GST-PARAM-CONTROLLABLE:CAPS" title="GST_PARAM_CONTROLLABLE">GST_PARAM_CONTROLLABLE</a>
  45 #define             <a class="link" href="gstreamer-GstParamSpec.html#GST-PARAM-USER-SHIFT:CAPS" title="GST_PARAM_USER_SHIFT">GST_PARAM_USER_SHIFT</a>
  46 #define             <a class="link" href="gstreamer-GstParamSpec.html#GST-PARAM-MUTABLE-PAUSED:CAPS" title="GST_PARAM_MUTABLE_PAUSED">GST_PARAM_MUTABLE_PAUSED</a>
  47 #define             <a class="link" href="gstreamer-GstParamSpec.html#GST-PARAM-MUTABLE-PLAYING:CAPS" title="GST_PARAM_MUTABLE_PLAYING">GST_PARAM_MUTABLE_PLAYING</a>
  48 #define             <a class="link" href="gstreamer-GstParamSpec.html#GST-PARAM-MUTABLE-READY:CAPS" title="GST_PARAM_MUTABLE_READY">GST_PARAM_MUTABLE_READY</a>
  49
  50 struct              <a class="link" href="gstreamer-GstParamSpec.html#GstParamSpecFraction" title="struct GstParamSpecFraction">GstParamSpecFraction</a>;
  51 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> *        <a class="link" href="gstreamer-GstParamSpec.html#gst-param-spec-fraction" title="gst_param_spec_fraction ()">gst_param_spec_fraction</a>             (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
  52                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *nick</code></em>,
  53                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *blurb</code></em>,
  54                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> min_num</code></em>,
  55                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> min_denom</code></em>,
  56                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> max_num</code></em>,
  57                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> max_denom</code></em>,
  58                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> default_num</code></em>,
  59                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> default_denom</code></em>,
  60                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"><span class="type">GParamFlags</span></a> flags</code></em>);
  61 </pre>
  62 </div>
  63 <div class="refsect1">
  64 <a name="gstreamer-GstParamSpec.description"></a><h2>Description</h2>
  65 <p>
  66 GParamSpec implementations specific to GStreamer.
  67 </p>
  68 <p>
  69 Last reviewed on 2008-03-11 (0.10.18)
  70 </p>
  71 </div>
  72 <div class="refsect1">
  73 <a name="gstreamer-GstParamSpec.details"></a><h2>Details</h2>
  74 <div class="refsect2">
  75 <a name="GST-PARAM-CONTROLLABLE:CAPS"></a><h3>GST_PARAM_CONTROLLABLE</h3>
  76 <pre class="programlisting">#define GST_PARAM_CONTROLLABLE (1 &lt;&lt; (G_PARAM_USER_SHIFT + 1))
  77 </pre>
  78 <p>
  79 Use this flag on GObject properties to signal they can make sense to be.
  80 controlled over time. This hint is used by the GstController.
  81 </p>
  82 </div>
  83 <hr>
  84 <div class="refsect2">
  85 <a name="GST-PARAM-USER-SHIFT:CAPS"></a><h3>GST_PARAM_USER_SHIFT</h3>
  86 <pre class="programlisting">#define GST_PARAM_USER_SHIFT (1 &lt;&lt; (G_PARAM_USER_SHIFT + 8))
  87 </pre>
  88 <p>
  89 Bits based on GST_PARAM_USER_SHIFT can be used by 3rd party applications.
  90 </p>
  91 </div>
  92 <hr>
  93 <div class="refsect2">
  94 <a name="GST-PARAM-MUTABLE-PAUSED:CAPS"></a><h3>GST_PARAM_MUTABLE_PAUSED</h3>
  95 <pre class="programlisting">#define GST_PARAM_MUTABLE_PAUSED  (1 &lt;&lt; (G_PARAM_USER_SHIFT + 3))
  96 </pre>
  97 <p>
  98 Use this flag on GObject properties of GstElements to indicate that
  99 they can be changed when the element is in the PAUSED or lower state.
 100 This flag implies GST_PARAM_MUTABLE_READY.
 101 </p>
 102 <p class="since">Since 0.10.23</p>
 103 </div>
 104 <hr>
 105 <div class="refsect2">
 106 <a name="GST-PARAM-MUTABLE-PLAYING:CAPS"></a><h3>GST_PARAM_MUTABLE_PLAYING</h3>
 107 <pre class="programlisting">#define GST_PARAM_MUTABLE_PLAYING  (1 &lt;&lt; (G_PARAM_USER_SHIFT + 4))
 108 </pre>
 109 <p>
 110 Use this flag on GObject properties of GstElements to indicate that
 111 they can be changed when the element is in the PLAYING or lower state.
 112 This flag implies GST_PARAM_MUTABLE_PAUSED.
 113 </p>
 114 <p class="since">Since 0.10.23</p>
 115 </div>
 116 <hr>
 117 <div class="refsect2">
 118 <a name="GST-PARAM-MUTABLE-READY:CAPS"></a><h3>GST_PARAM_MUTABLE_READY</h3>
 119 <pre class="programlisting">#define GST_PARAM_MUTABLE_READY  (1 &lt;&lt; (G_PARAM_USER_SHIFT + 2))
 120 </pre>
 121 <p>
 122 Use this flag on GObject properties of GstElements to indicate that
 123 they can be changed when the element is in the READY or lower state.
 124 </p>
 125 <p class="since">Since 0.10.23</p>
 126 </div>
 127 <hr>
 128 <div class="refsect2">
 129 <a name="GstParamSpecFraction"></a><h3>struct GstParamSpecFraction</h3>
 130 <pre class="programlisting">struct GstParamSpecFraction {
 131   GParamSpec    parent_instance;
 132
 133   gint          min_num, min_den;
 134   gint          max_num, max_den;
 135   gint          def_num, def_den;
 136 };
 137 </pre>
 138 <p>
 139 A GParamSpec derived structure that contains the meta data for fractional
 140 properties.
 141 </p>
 142 <div class="variablelist"><table border="0">
 143 <col align="left" valign="top">
 144 <tbody>
 145 <tr>
 146 <td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> <em class="structfield"><code><a name="GstParamSpecFraction.parent-instance"></a>parent_instance</code></em>;</span></p></td>
 147 <td>super class</td>
 148 </tr>
 149 <tr>
 150 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstParamSpecFraction.min-num"></a>min_num</code></em>;</span></p></td>
 151 <td>minimal numerator</td>
 152 </tr>
 153 <tr>
 154 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstParamSpecFraction.min-den"></a>min_den</code></em>;</span></p></td>
 155 <td>minimal denominator</td>
 156 </tr>
 157 <tr>
 158 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstParamSpecFraction.max-num"></a>max_num</code></em>;</span></p></td>
 159 <td>maximal numerator</td>
 160 </tr>
 161 <tr>
 162 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstParamSpecFraction.max-den"></a>max_den</code></em>;</span></p></td>
 163 <td>maximal denominator</td>
 164 </tr>
 165 <tr>
 166 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstParamSpecFraction.def-num"></a>def_num</code></em>;</span></p></td>
 167 <td>default numerator</td>
 168 </tr>
 169 <tr>
 170 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstParamSpecFraction.def-den"></a>def_den</code></em>;</span></p></td>
 171 <td>default denominator</td>
 172 </tr>
 173 </tbody>
 174 </table></div>
 175 </div>
 176 <hr>
 177 <div class="refsect2">
 178 <a name="gst-param-spec-fraction"></a><h3>gst_param_spec_fraction ()</h3>
 179 <pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> *        gst_param_spec_fraction             (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
 180                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *nick</code></em>,
 181                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *blurb</code></em>,
 182                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> min_num</code></em>,
 183                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> min_denom</code></em>,
 184                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> max_num</code></em>,
 185                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> max_denom</code></em>,
 186                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> default_num</code></em>,
 187                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> default_denom</code></em>,
 188                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"><span class="type">GParamFlags</span></a> flags</code></em>);</pre>
 189 <p>
 190 This function creates a fraction GParamSpec for use by objects/elements
 191 that want to expose properties of fraction type. This function is typically
 192 used in connection with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-class-install-property"><code class="function">g_object_class_install_property()</code></a> in a GObjects's
 193 instance_init function.
 194 </p>
 195 <div class="variablelist"><table border="0">
 196 <col align="left" valign="top">
 197 <tbody>
 198 <tr>
 199 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 200 <td>canonical name of the property specified</td>
 201 </tr>
 202 <tr>
 203 <td><p><span class="term"><em class="parameter"><code>nick</code></em> :</span></p></td>
 204 <td>nick name for the property specified</td>
 205 </tr>
 206 <tr>
 207 <td><p><span class="term"><em class="parameter"><code>blurb</code></em> :</span></p></td>
 208 <td>description of the property specified</td>
 209 </tr>
 210 <tr>
 211 <td><p><span class="term"><em class="parameter"><code>min_num</code></em> :</span></p></td>
 212 <td>minimum value (fraction numerator)</td>
 213 </tr>
 214 <tr>
 215 <td><p><span class="term"><em class="parameter"><code>min_denom</code></em> :</span></p></td>
 216 <td>minimum value (fraction denominator)</td>
 217 </tr>
 218 <tr>
 219 <td><p><span class="term"><em class="parameter"><code>max_num</code></em> :</span></p></td>
 220 <td>maximum value (fraction numerator)</td>
 221 </tr>
 222 <tr>
 223 <td><p><span class="term"><em class="parameter"><code>max_denom</code></em> :</span></p></td>
 224 <td>maximum value (fraction denominator)</td>
 225 </tr>
 226 <tr>
 227 <td><p><span class="term"><em class="parameter"><code>default_num</code></em> :</span></p></td>
 228 <td>default value (fraction numerator)</td>
 229 </tr>
 230 <tr>
 231 <td><p><span class="term"><em class="parameter"><code>default_denom</code></em> :</span></p></td>
 232 <td>default value (fraction denominator)</td>
 233 </tr>
 234 <tr>
 235 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
 236 <td>flags for the property specified</td>
 237 </tr>
 238 <tr>
 239 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 240 <td>a newly created parameter specification</td>
 241 </tr>
 242 </tbody>
 243 </table></div>
 244 <p class="since">Since 0.10.14</p>
 245 </div>
 246 </div>
 247 </div>
 248 <div class="footer">
 249 <hr>
 250           Generated by GTK-Doc V1.18</div>
 251 </body>
 252 </html>