docs/libs/html/gst-plugins-base-libs-gstaudio.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>gstaudio</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
   8 <link rel="up" href="gstreamer-audio.html" title="Audio Library">
   9 <link rel="prev" href="gstreamer-audio.html" title="Audio Library">
  10 <link rel="next" href="gst-plugins-base-libs-gstaudioclock.html" title="gstaudioclock">
  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="gstreamer-audio.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="gstreamer-audio.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 Base Plugins 0.10 Library Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-libs-gstaudioclock.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="#gst-plugins-base-libs-gstaudio.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-libs-gstaudio.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gst-plugins-base-libs-gstaudio"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstaudio.top_of_page"></a>gstaudio</span></h2>
  34 <p>gstaudio — Support library for audio elements</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gst-plugins-base-libs-gstaudio.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;gst/audio/audio.h&gt;
  42
  43 enum                <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFieldFlag" title="enum GstAudioFieldFlag">GstAudioFieldFlag</a>;
  44 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-FRAMES-TO-CLOCK-TIME:CAPS" title="GST_FRAMES_TO_CLOCK_TIME()">GST_FRAMES_TO_CLOCK_TIME</a>            (frames,
  45                                                          rate)
  46 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-CLOCK-TIME-TO-FRAMES:CAPS" title="GST_CLOCK_TIME_TO_FRAMES()">GST_CLOCK_TIME_TO_FRAMES</a>            (clocktime,
  47                                                          rate)
  48 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-DEF-RATE:CAPS" title="GST_AUDIO_DEF_RATE">GST_AUDIO_DEF_RATE</a>
  49 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FLOAT-PAD-TEMPLATE-CAPS" title="GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS">GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS</a>
  50 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FLOAT-STANDARD-PAD-TEMPLATE-CAPS" title="GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS">GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS</a>
  51 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INT-PAD-TEMPLATE-CAPS" title="GST_AUDIO_INT_PAD_TEMPLATE_CAPS">GST_AUDIO_INT_PAD_TEMPLATE_CAPS</a>
  52 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INT-STANDARD-PAD-TEMPLATE-CAPS" title="GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS">GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS</a>
  53 <span class="returnvalue">int</span>                 <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-frame-byte-size" title="gst_audio_frame_byte_size ()">gst_audio_frame_byte_size</a>           (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>);
  54 <span class="returnvalue">long</span>                <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-frame-length" title="gst_audio_frame_length ()">gst_audio_frame_length</a>              (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>,
  55                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>);
  56 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a>        <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-duration-from-pad-buffer" title="gst_audio_duration_from_pad_buffer ()">gst_audio_duration_from_pad_buffer</a>  (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>,
  57                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>);
  58 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-is-buffer-framed" title="gst_audio_is_buffer_framed ()">gst_audio_is_buffer_framed</a>          (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>,
  59                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>);
  60 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-structure-set-int" title="gst_audio_structure_set_int ()">gst_audio_structure_set_int</a>         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>,
  61                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFieldFlag" title="enum GstAudioFieldFlag"><span class="type">GstAudioFieldFlag</span></a> flag</code></em>);
  62 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-buffer-clip" title="gst_audio_buffer_clip ()">gst_audio_buffer_clip</a>               (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>,
  63                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSegment.html#GstSegment"><span class="type">GstSegment</span></a> *segment</code></em>,
  64                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> rate</code></em>,
  65                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> frame_size</code></em>);
  66 </pre>
  67 </div>
  68 <div class="refsect1">
  69 <a name="gst-plugins-base-libs-gstaudio.description"></a><h2>Description</h2>
  70 <p>
  71 This library contains some helper functions for audio elements.
  72 </p>
  73 </div>
  74 <div class="refsect1">
  75 <a name="gst-plugins-base-libs-gstaudio.details"></a><h2>Details</h2>
  76 <div class="refsect2">
  77 <a name="GstAudioFieldFlag"></a><h3>enum GstAudioFieldFlag</h3>
  78 <pre class="programlisting">typedef enum {
  79   GST_AUDIO_FIELD_RATE          = (1 &lt;&lt; 0),
  80   GST_AUDIO_FIELD_CHANNELS      = (1 &lt;&lt; 1),
  81   GST_AUDIO_FIELD_ENDIANNESS    = (1 &lt;&lt; 2),
  82   GST_AUDIO_FIELD_WIDTH         = (1 &lt;&lt; 3),
  83   GST_AUDIO_FIELD_DEPTH         = (1 &lt;&lt; 4),
  84   GST_AUDIO_FIELD_SIGNED        = (1 &lt;&lt; 5)
  85 } GstAudioFieldFlag;
  86 </pre>
  87 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
  88 <h3 class="title">Warning</h3>
  89 <p><code class="literal">GstAudioFieldFlag</code> is deprecated and should not be used in newly-written code. use <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#gst-structure-set"><code class="function">gst_structure_set()</code></a> directly</p>
  90 </div>
  91 <p>
  92 Do not use anymore.
  93 </p>
  94 <div class="variablelist"><table border="0">
  95 <col align="left" valign="top">
  96 <tbody>
  97 <tr>
  98 <td><p><a name="GST-AUDIO-FIELD-RATE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_RATE</code></span></p></td>
  99 <td>add rate field to caps
 100 </td>
 101 </tr>
 102 <tr>
 103 <td><p><a name="GST-AUDIO-FIELD-CHANNELS:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_CHANNELS</code></span></p></td>
 104 <td>add channels field to caps
 105 </td>
 106 </tr>
 107 <tr>
 108 <td><p><a name="GST-AUDIO-FIELD-ENDIANNESS:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_ENDIANNESS</code></span></p></td>
 109 <td>add endianness field to caps
 110 </td>
 111 </tr>
 112 <tr>
 113 <td><p><a name="GST-AUDIO-FIELD-WIDTH:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_WIDTH</code></span></p></td>
 114 <td>add width field to caps
 115 </td>
 116 </tr>
 117 <tr>
 118 <td><p><a name="GST-AUDIO-FIELD-DEPTH:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_DEPTH</code></span></p></td>
 119 <td>add depth field to caps
 120 </td>
 121 </tr>
 122 <tr>
 123 <td><p><a name="GST-AUDIO-FIELD-SIGNED:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_SIGNED</code></span></p></td>
 124 <td>add signed field to caps
 125 </td>
 126 </tr>
 127 </tbody>
 128 </table></div>
 129 </div>
 130 <hr>
 131 <div class="refsect2">
 132 <a name="GST-FRAMES-TO-CLOCK-TIME:CAPS"></a><h3>GST_FRAMES_TO_CLOCK_TIME()</h3>
 133 <pre class="programlisting">#define             GST_FRAMES_TO_CLOCK_TIME(frames, rate)</pre>
 134 <p>
 135 Calculate clocktime from sample <em class="parameter"><code>frames</code></em> and <em class="parameter"><code>rate</code></em>.
 136 </p>
 137 <div class="variablelist"><table border="0">
 138 <col align="left" valign="top">
 139 <tbody>
 140 <tr>
 141 <td><p><span class="term"><em class="parameter"><code>frames</code></em> :</span></p></td>
 142 <td>sample frames</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term"><em class="parameter"><code>rate</code></em> :</span></p></td>
 146 <td>sampling rate</td>
 147 </tr>
 148 </tbody>
 149 </table></div>
 150 </div>
 151 <hr>
 152 <div class="refsect2">
 153 <a name="GST-CLOCK-TIME-TO-FRAMES:CAPS"></a><h3>GST_CLOCK_TIME_TO_FRAMES()</h3>
 154 <pre class="programlisting">#define             GST_CLOCK_TIME_TO_FRAMES(clocktime, rate)</pre>
 155 <p>
 156 Calculate frames from <em class="parameter"><code>clocktime</code></em> and sample <em class="parameter"><code>rate</code></em>.
 157 </p>
 158 <div class="variablelist"><table border="0">
 159 <col align="left" valign="top">
 160 <tbody>
 161 <tr>
 162 <td><p><span class="term"><em class="parameter"><code>clocktime</code></em> :</span></p></td>
 163 <td>clock time</td>
 164 </tr>
 165 <tr>
 166 <td><p><span class="term"><em class="parameter"><code>rate</code></em> :</span></p></td>
 167 <td>sampling rate</td>
 168 </tr>
 169 </tbody>
 170 </table></div>
 171 </div>
 172 <hr>
 173 <div class="refsect2">
 174 <a name="GST-AUDIO-DEF-RATE:CAPS"></a><h3>GST_AUDIO_DEF_RATE</h3>
 175 <pre class="programlisting">#define GST_AUDIO_DEF_RATE 44100
 176 </pre>
 177 <p>
 178 Standard sampling rate used in consumer audio.
 179 </p>
 180 </div>
 181 <hr>
 182 <div class="refsect2">
 183 <a name="GST-AUDIO-FLOAT-PAD-TEMPLATE-CAPS"></a><h3>GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS</h3>
 184 <pre class="programlisting">#define             GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS</pre>
 185 <p>
 186 Template caps for float audio. Can be used when defining a
 187 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a>
 188 </p>
 189 </div>
 190 <hr>
 191 <div class="refsect2">
 192 <a name="GST-AUDIO-FLOAT-STANDARD-PAD-TEMPLATE-CAPS"></a><h3>GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS</h3>
 193 <pre class="programlisting">#define             GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS</pre>
 194 <p>
 195 Template caps for 32bit float mono audio in native byte-order.
 196 Can be used when defining a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a>
 197 </p>
 198 </div>
 199 <hr>
 200 <div class="refsect2">
 201 <a name="GST-AUDIO-INT-PAD-TEMPLATE-CAPS"></a><h3>GST_AUDIO_INT_PAD_TEMPLATE_CAPS</h3>
 202 <pre class="programlisting">#define             GST_AUDIO_INT_PAD_TEMPLATE_CAPS</pre>
 203 <p>
 204 Template caps for integer audio. Can be used when defining a
 205 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a>
 206 </p>
 207 </div>
 208 <hr>
 209 <div class="refsect2">
 210 <a name="GST-AUDIO-INT-STANDARD-PAD-TEMPLATE-CAPS"></a><h3>GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS</h3>
 211 <pre class="programlisting">#define             GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS</pre>
 212 <p>
 213 Template caps for 16bit integer stereo audio in native byte-order.
 214 Can be used when defining a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a>
 215 </p>
 216 </div>
 217 <hr>
 218 <div class="refsect2">
 219 <a name="gst-audio-frame-byte-size"></a><h3>gst_audio_frame_byte_size ()</h3>
 220 <pre class="programlisting"><span class="returnvalue">int</span>                 gst_audio_frame_byte_size           (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>);</pre>
 221 <p>
 222 Calculate byte size of an audio frame.
 223 </p>
 224 <div class="variablelist"><table border="0">
 225 <col align="left" valign="top">
 226 <tbody>
 227 <tr>
 228 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
 229 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> to get the caps from</td>
 230 </tr>
 231 <tr>
 232 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 233 <td>the byte size, or 0 if there was an error</td>
 234 </tr>
 235 </tbody>
 236 </table></div>
 237 </div>
 238 <hr>
 239 <div class="refsect2">
 240 <a name="gst-audio-frame-length"></a><h3>gst_audio_frame_length ()</h3>
 241 <pre class="programlisting"><span class="returnvalue">long</span>                gst_audio_frame_length              (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>,
 242                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>);</pre>
 243 <p>
 244 Calculate length of buffer in frames.
 245 </p>
 246 <div class="variablelist"><table border="0">
 247 <col align="left" valign="top">
 248 <tbody>
 249 <tr>
 250 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
 251 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> to get the caps from</td>
 252 </tr>
 253 <tr>
 254 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
 255 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
 256 </td>
 257 </tr>
 258 <tr>
 259 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 260 <td>0 if there's an error, or the number of frames if everything's ok</td>
 261 </tr>
 262 </tbody>
 263 </table></div>
 264 </div>
 265 <hr>
 266 <div class="refsect2">
 267 <a name="gst-audio-duration-from-pad-buffer"></a><h3>gst_audio_duration_from_pad_buffer ()</h3>
 268 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a>        gst_audio_duration_from_pad_buffer  (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>,
 269                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>);</pre>
 270 <p>
 271 Calculate length in nanoseconds of audio buffer <em class="parameter"><code>buf</code></em> based on capabilities of
 272 <em class="parameter"><code>pad</code></em>.
 273 </p>
 274 <div class="variablelist"><table border="0">
 275 <col align="left" valign="top">
 276 <tbody>
 277 <tr>
 278 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
 279 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> to get the caps from</td>
 280 </tr>
 281 <tr>
 282 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
 283 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
 284 </td>
 285 </tr>
 286 <tr>
 287 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 288 <td>the length.</td>
 289 </tr>
 290 </tbody>
 291 </table></div>
 292 </div>
 293 <hr>
 294 <div class="refsect2">
 295 <a name="gst-audio-is-buffer-framed"></a><h3>gst_audio_is_buffer_framed ()</h3>
 296 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_audio_is_buffer_framed          (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>,
 297                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>);</pre>
 298 <p>
 299 Check if the buffer size is a whole multiple of the frame size.
 300 </p>
 301 <div class="variablelist"><table border="0">
 302 <col align="left" valign="top">
 303 <tbody>
 304 <tr>
 305 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
 306 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> to get the caps from</td>
 307 </tr>
 308 <tr>
 309 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
 310 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
 311 </td>
 312 </tr>
 313 <tr>
 314 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 315 <td>
 316 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if buffer size is multiple.</td>
 317 </tr>
 318 </tbody>
 319 </table></div>
 320 </div>
 321 <hr>
 322 <div class="refsect2">
 323 <a name="gst-audio-structure-set-int"></a><h3>gst_audio_structure_set_int ()</h3>
 324 <pre class="programlisting"><span class="returnvalue">void</span>                gst_audio_structure_set_int         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>,
 325                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFieldFlag" title="enum GstAudioFieldFlag"><span class="type">GstAudioFieldFlag</span></a> flag</code></em>);</pre>
 326 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 327 <h3 class="title">Warning</h3>
 328 <p><code class="literal">gst_audio_structure_set_int</code> is deprecated and should not be used in newly-written code. use <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#gst-structure-set"><code class="function">gst_structure_set()</code></a></p>
 329 </div>
 330 <p>
 331 Do not use anymore.
 332 </p>
 333 <div class="variablelist"><table border="0">
 334 <col align="left" valign="top">
 335 <tbody>
 336 <tr>
 337 <td><p><span class="term"><em class="parameter"><code>structure</code></em> :</span></p></td>
 338 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#GstStructure"><span class="type">GstStructure</span></a>
 339 </td>
 340 </tr>
 341 <tr>
 342 <td><p><span class="term"><em class="parameter"><code>flag</code></em> :</span></p></td>
 343 <td>a set of <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFieldFlag" title="enum GstAudioFieldFlag"><span class="type">GstAudioFieldFlag</span></a>
 344 </td>
 345 </tr>
 346 </tbody>
 347 </table></div>
 348 </div>
 349 <hr>
 350 <div class="refsect2">
 351 <a name="gst-audio-buffer-clip"></a><h3>gst_audio_buffer_clip ()</h3>
 352 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         gst_audio_buffer_clip               (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>,
 353                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSegment.html#GstSegment"><span class="type">GstSegment</span></a> *segment</code></em>,
 354                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> rate</code></em>,
 355                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> frame_size</code></em>);</pre>
 356 <p>
 357 Clip the the buffer to the given <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSegment.html#GstSegment"><code class="literal">GstSegment</code></a>.
 358 </p>
 359 <p>
 360 After calling this function the caller does not own a reference to
 361 <em class="parameter"><code>buffer</code></em> anymore.
 362 </p>
 363 <div class="variablelist"><table border="0">
 364 <col align="left" valign="top">
 365 <tbody>
 366 <tr>
 367 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
 368 <td>The buffer to clip.</td>
 369 </tr>
 370 <tr>
 371 <td><p><span class="term"><em class="parameter"><code>segment</code></em> :</span></p></td>
 372 <td>Segment in <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GST-FORMAT-TIME:CAPS"><code class="literal">GST_FORMAT_TIME</code></a> or <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GST-FORMAT-DEFAULT:CAPS"><code class="literal">GST_FORMAT_DEFAULT</code></a> to which the buffer should be clipped.</td>
 373 </tr>
 374 <tr>
 375 <td><p><span class="term"><em class="parameter"><code>rate</code></em> :</span></p></td>
 376 <td>sample rate.</td>
 377 </tr>
 378 <tr>
 379 <td><p><span class="term"><em class="parameter"><code>frame_size</code></em> :</span></p></td>
 380 <td>size of one audio frame in bytes.</td>
 381 </tr>
 382 <tr>
 383 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 384 <td>
 385 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the buffer is completely outside the configured segment,
 386 otherwise the clipped buffer is returned.
 387 If the buffer has no timestamp, it is assumed to be inside the segment and
 388 is not clipped</td>
 389 </tr>
 390 </tbody>
 391 </table></div>
 392 <p class="since">Since 0.10.14</p>
 393 </div>
 394 </div>
 395 </div>
 396 <div class="footer">
 397 <hr>
 398           Generated by GTK-Doc V1.17</div>
 399 </body>
 400 </html>