1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
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.76.1">
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.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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">
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>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-base-libs-gstaudio.synopsis" class="shortcut">Top</a>
26 <a href="#gst-plugins-base-libs-gstaudio.description" class="shortcut">Description</a>
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>
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>
36 <td valign="top" align="right"></td>
38 <div class="refsynopsisdiv">
39 <a name="gst-plugins-base-libs-gstaudio.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">
41 #include <gst/audio/audio.h>
43 enum <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFlags" title="enum GstAudioFlags">GstAudioFlags</a>;
44 enum <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormat" title="enum GstAudioFormat">GstAudioFormat</a>;
45 enum <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormatFlags" title="enum GstAudioFormatFlags">GstAudioFormatFlags</a>;
46 struct <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormatInfo" title="struct GstAudioFormatInfo">GstAudioFormatInfo</a>;
47 struct <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo">GstAudioInfo</a>;
48 <span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-info-init" title="gst_audio_info_init ()">gst_audio_info_init</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);
49 <span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-info-clear" title="gst_audio_info_clear ()">gst_audio_info_clear</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);
50 <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="returnvalue">GstAudioInfo</span></a> * <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-info-copy" title="gst_audio_info_copy ()">gst_audio_info_copy</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);
51 <span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-info-free" title="gst_audio_info_free ()">gst_audio_info_free</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);
52 <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-info-from-caps" title="gst_audio_info_from_caps ()">gst_audio_info_from_caps</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>,
53 <em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);
54 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> * <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-info-to-caps" title="gst_audio_info_to_caps ()">gst_audio_info_to_caps</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);
55 <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-info-convert" title="gst_audio_info_convert ()">gst_audio_info_convert</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>,
56 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> src_fmt</code></em>,
57 <em class="parameter"><code><span class="type">gint64</span> src_val</code></em>,
58 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> dest_fmt</code></em>,
59 <em class="parameter"><code><span class="type">gint64</span> *dest_val</code></em>);
60 const <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormatInfo" title="struct GstAudioFormatInfo"><span class="returnvalue">GstAudioFormatInfo</span></a> * <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-format-get-info" title="gst_audio_format_get_info ()">gst_audio_format_get_info</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="type">GstAudioFormat</span></a> format</code></em>);
61 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-DEPTH:CAPS" title="GST_AUDIO_FORMAT_INFO_DEPTH()">GST_AUDIO_FORMAT_INFO_DEPTH</a> (info)
62 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-ENDIANNESS:CAPS" title="GST_AUDIO_FORMAT_INFO_ENDIANNESS()">GST_AUDIO_FORMAT_INFO_ENDIANNESS</a> (info)
63 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-FLAGS:CAPS" title="GST_AUDIO_FORMAT_INFO_FLAGS()">GST_AUDIO_FORMAT_INFO_FLAGS</a> (info)
64 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-FORMAT:CAPS" title="GST_AUDIO_FORMAT_INFO_FORMAT()">GST_AUDIO_FORMAT_INFO_FORMAT</a> (info)
65 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-IS-FLOAT:CAPS" title="GST_AUDIO_FORMAT_INFO_IS_FLOAT()">GST_AUDIO_FORMAT_INFO_IS_FLOAT</a> (info)
66 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-IS-INTEGER:CAPS" title="GST_AUDIO_FORMAT_INFO_IS_INTEGER()">GST_AUDIO_FORMAT_INFO_IS_INTEGER</a> (info)
67 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-IS-BIG-ENDIAN:CAPS" title="GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN()">GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN</a> (info)
68 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-IS-LITTLE-ENDIAN:CAPS" title="GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN()">GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN</a>(info)
69 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-IS-SIGNED:CAPS" title="GST_AUDIO_FORMAT_INFO_IS_SIGNED()">GST_AUDIO_FORMAT_INFO_IS_SIGNED</a> (info)
70 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-NAME:CAPS" title="GST_AUDIO_FORMAT_INFO_NAME()">GST_AUDIO_FORMAT_INFO_NAME</a> (info)
71 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-WIDTH:CAPS" title="GST_AUDIO_FORMAT_INFO_WIDTH()">GST_AUDIO_FORMAT_INFO_WIDTH</a> (info)
72 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-BPF:CAPS" title="GST_AUDIO_INFO_BPF()">GST_AUDIO_INFO_BPF</a> (info)
73 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-BPS:CAPS" title="GST_AUDIO_INFO_BPS()">GST_AUDIO_INFO_BPS</a> (info)
74 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-CHANNELS:CAPS" title="GST_AUDIO_INFO_CHANNELS()">GST_AUDIO_INFO_CHANNELS</a> (info)
75 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-DEPTH:CAPS" title="GST_AUDIO_INFO_DEPTH()">GST_AUDIO_INFO_DEPTH</a> (i)
76 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-FLAGS:CAPS" title="GST_AUDIO_INFO_FLAGS()">GST_AUDIO_INFO_FLAGS</a> (info)
77 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-FORMAT:CAPS" title="GST_AUDIO_INFO_FORMAT()">GST_AUDIO_INFO_FORMAT</a> (i)
78 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-HAS-DEFAULT-POSITIONS:CAPS" title="GST_AUDIO_INFO_HAS_DEFAULT_POSITIONS()">GST_AUDIO_INFO_HAS_DEFAULT_POSITIONS</a>(info)
79 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-NAME:CAPS" title="GST_AUDIO_INFO_NAME()">GST_AUDIO_INFO_NAME</a> (i)
80 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-POSITION:CAPS" title="GST_AUDIO_INFO_POSITION()">GST_AUDIO_INFO_POSITION</a> (info,
82 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-RATE:CAPS" title="GST_AUDIO_INFO_RATE()">GST_AUDIO_INFO_RATE</a> (info)
83 #define <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-WIDTH:CAPS" title="GST_AUDIO_INFO_WIDTH()">GST_AUDIO_INFO_WIDTH</a> (i)
84 enum <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFieldFlag" title="enum GstAudioFieldFlag">GstAudioFieldFlag</a>;
85 #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,
87 #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,
89 #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>
90 #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>
91 #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>
92 #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>
93 #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>
94 <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>);
95 <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>,
96 <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>);
97 <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>,
98 <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>);
99 <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>,
100 <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>);
101 <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>,
102 <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>);
103 <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>,
104 <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>,
105 <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>,
106 <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>);
109 <div class="refsect1">
110 <a name="gst-plugins-base-libs-gstaudio.description"></a><h2>Description</h2>
112 This library contains some helper functions for audio elements.
115 <div class="refsect1">
116 <a name="gst-plugins-base-libs-gstaudio.details"></a><h2>Details</h2>
117 <div class="refsect2">
118 <a name="GstAudioFlags"></a><h3>enum GstAudioFlags</h3>
119 <pre class="programlisting">typedef enum {
120 GST_AUDIO_FLAG_NONE = 0,
121 GST_AUDIO_FLAG_DEFAULT_POSITIONS = (1 << 0)
127 <div class="variablelist"><table border="0">
128 <col align="left" valign="top">
131 <td><p><a name="GST-AUDIO-FLAG-NONE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FLAG_NONE</code></span></p></td>
136 <td><p><a name="GST-AUDIO-FLAG-DEFAULT-POSITIONS:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FLAG_DEFAULT_POSITIONS</code></span></p></td>
137 <td>unpositioned audio layout, position array
138 contains the default layout (meaning that the channel layout was not
139 explicitly specified in the caps)
144 <p class="since">Since 0.10.36</p>
147 <div class="refsect2">
148 <a name="GstAudioFormat"></a><h3>enum GstAudioFormat</h3>
149 <pre class="programlisting">typedef enum {
150 GST_AUDIO_FORMAT_UNKNOWN,
155 GST_AUDIO_FORMAT_S16LE,
156 GST_AUDIO_FORMAT_S16BE,
157 GST_AUDIO_FORMAT_U16LE,
158 GST_AUDIO_FORMAT_U16BE,
159 /* 24 bit in low 3 bytes of 32 bits*/
160 GST_AUDIO_FORMAT_S24_32LE,
161 GST_AUDIO_FORMAT_S24_32BE,
162 GST_AUDIO_FORMAT_U24_32LE,
163 GST_AUDIO_FORMAT_U24_32BE,
165 GST_AUDIO_FORMAT_S32LE,
166 GST_AUDIO_FORMAT_S32BE,
167 GST_AUDIO_FORMAT_U32LE,
168 GST_AUDIO_FORMAT_U32BE,
169 /* 24 bit in 3 bytes*/
170 GST_AUDIO_FORMAT_S24LE,
171 GST_AUDIO_FORMAT_S24BE,
172 GST_AUDIO_FORMAT_U24LE,
173 GST_AUDIO_FORMAT_U24BE,
174 /* 20 bit in 3 bytes*/
175 GST_AUDIO_FORMAT_S20LE,
176 GST_AUDIO_FORMAT_S20BE,
177 GST_AUDIO_FORMAT_U20LE,
178 GST_AUDIO_FORMAT_U20BE,
179 /* 18 bit in 3 bytes*/
180 GST_AUDIO_FORMAT_S18LE,
181 GST_AUDIO_FORMAT_S18BE,
182 GST_AUDIO_FORMAT_U18LE,
183 GST_AUDIO_FORMAT_U18BE,
185 GST_AUDIO_FORMAT_F32LE,
186 GST_AUDIO_FORMAT_F32BE,
187 GST_AUDIO_FORMAT_F64LE,
188 GST_AUDIO_FORMAT_F64BE,
189 /* native endianness equivalents */
190 GST_AUDIO_FORMAT_S16 = _GST_AUDIO_FORMAT_NE(S16),
191 GST_AUDIO_FORMAT_U16 = _GST_AUDIO_FORMAT_NE(U16),
192 GST_AUDIO_FORMAT_S24_32 = _GST_AUDIO_FORMAT_NE(S24_32),
193 GST_AUDIO_FORMAT_U24_32 = _GST_AUDIO_FORMAT_NE(U24_32),
194 GST_AUDIO_FORMAT_S32 = _GST_AUDIO_FORMAT_NE(S32),
195 GST_AUDIO_FORMAT_U32 = _GST_AUDIO_FORMAT_NE(U32),
196 GST_AUDIO_FORMAT_S24 = _GST_AUDIO_FORMAT_NE(S24),
197 GST_AUDIO_FORMAT_U24 = _GST_AUDIO_FORMAT_NE(U24),
198 GST_AUDIO_FORMAT_S20 = _GST_AUDIO_FORMAT_NE(S20),
199 GST_AUDIO_FORMAT_U20 = _GST_AUDIO_FORMAT_NE(U20),
200 GST_AUDIO_FORMAT_S18 = _GST_AUDIO_FORMAT_NE(S18),
201 GST_AUDIO_FORMAT_U18 = _GST_AUDIO_FORMAT_NE(U18),
202 GST_AUDIO_FORMAT_F32 = _GST_AUDIO_FORMAT_NE(F32),
203 GST_AUDIO_FORMAT_F64 = _GST_AUDIO_FORMAT_NE(F64)
207 Enum value describing the most common audio formats.
209 <div class="variablelist"><table border="0">
210 <col align="left" valign="top">
213 <td><p><a name="GST-AUDIO-FORMAT-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_UNKNOWN</code></span></p></td>
214 <td>unknown audio format
218 <td><p><a name="GST-AUDIO-FORMAT-S8:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S8</code></span></p></td>
219 <td>8 bits in 8 bits, signed
223 <td><p><a name="GST-AUDIO-FORMAT-U8:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U8</code></span></p></td>
224 <td>8 bits in 8 bits, unsigned
228 <td><p><a name="GST-AUDIO-FORMAT-S16LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S16LE</code></span></p></td>
229 <td>16 bits in 16 bits, signed, little endian
233 <td><p><a name="GST-AUDIO-FORMAT-S16BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S16BE</code></span></p></td>
234 <td>16 bits in 16 bits, signed, big endian
238 <td><p><a name="GST-AUDIO-FORMAT-U16LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U16LE</code></span></p></td>
239 <td>16 bits in 16 bits, unsigned, little endian
243 <td><p><a name="GST-AUDIO-FORMAT-U16BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U16BE</code></span></p></td>
244 <td>16 bits in 16 bits, unsigned, big endian
248 <td><p><a name="GST-AUDIO-FORMAT-S24-32LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S24_32LE</code></span></p></td>
249 <td>24 bits in 32 bits, signed, little endian
253 <td><p><a name="GST-AUDIO-FORMAT-S24-32BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S24_32BE</code></span></p></td>
254 <td>24 bits in 32 bits, signed, big endian
258 <td><p><a name="GST-AUDIO-FORMAT-U24-32LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U24_32LE</code></span></p></td>
259 <td>24 bits in 32 bits, unsigned, little endian
263 <td><p><a name="GST-AUDIO-FORMAT-U24-32BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U24_32BE</code></span></p></td>
264 <td>24 bits in 32 bits, unsigned, big endian
268 <td><p><a name="GST-AUDIO-FORMAT-S32LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S32LE</code></span></p></td>
269 <td>32 bits in 32 bits, signed, little endian
273 <td><p><a name="GST-AUDIO-FORMAT-S32BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S32BE</code></span></p></td>
274 <td>32 bits in 32 bits, signed, big endian
278 <td><p><a name="GST-AUDIO-FORMAT-U32LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U32LE</code></span></p></td>
279 <td>32 bits in 32 bits, unsigned, little endian
283 <td><p><a name="GST-AUDIO-FORMAT-U32BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U32BE</code></span></p></td>
284 <td>32 bits in 32 bits, unsigned, big endian
288 <td><p><a name="GST-AUDIO-FORMAT-S24LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S24LE</code></span></p></td>
289 <td>24 bits in 24 bits, signed, little endian
293 <td><p><a name="GST-AUDIO-FORMAT-S24BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S24BE</code></span></p></td>
294 <td>24 bits in 24 bits, signed, big endian
298 <td><p><a name="GST-AUDIO-FORMAT-U24LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U24LE</code></span></p></td>
299 <td>24 bits in 24 bits, unsigned, little endian
303 <td><p><a name="GST-AUDIO-FORMAT-U24BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U24BE</code></span></p></td>
304 <td>24 bits in 24 bits, unsigned, big endian
308 <td><p><a name="GST-AUDIO-FORMAT-S20LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S20LE</code></span></p></td>
309 <td>20 bits in 24 bits, signed, little endian
313 <td><p><a name="GST-AUDIO-FORMAT-S20BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S20BE</code></span></p></td>
314 <td>20 bits in 24 bits, signed, big endian
318 <td><p><a name="GST-AUDIO-FORMAT-U20LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U20LE</code></span></p></td>
319 <td>20 bits in 24 bits, unsigned, little endian
323 <td><p><a name="GST-AUDIO-FORMAT-U20BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U20BE</code></span></p></td>
324 <td>20 bits in 24 bits, unsigned, big endian
328 <td><p><a name="GST-AUDIO-FORMAT-S18LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S18LE</code></span></p></td>
329 <td>18 bits in 24 bits, signed, little endian
333 <td><p><a name="GST-AUDIO-FORMAT-S18BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S18BE</code></span></p></td>
334 <td>18 bits in 24 bits, signed, big endian
338 <td><p><a name="GST-AUDIO-FORMAT-U18LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U18LE</code></span></p></td>
339 <td>18 bits in 24 bits, unsigned, little endian
343 <td><p><a name="GST-AUDIO-FORMAT-U18BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U18BE</code></span></p></td>
344 <td>18 bits in 24 bits, unsigned, big endian
348 <td><p><a name="GST-AUDIO-FORMAT-F32LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_F32LE</code></span></p></td>
349 <td>32-bit floating point samples, little endian
353 <td><p><a name="GST-AUDIO-FORMAT-F32BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_F32BE</code></span></p></td>
354 <td>32-bit floating point samples, big endian
358 <td><p><a name="GST-AUDIO-FORMAT-F64LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_F64LE</code></span></p></td>
359 <td>64-bit floating point samples, little endian
363 <td><p><a name="GST-AUDIO-FORMAT-F64BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_F64BE</code></span></p></td>
364 <td>64-bit floating point samples, big endian
368 <td><p><a name="GST-AUDIO-FORMAT-S16:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S16</code></span></p></td>
369 <td>16 bits in 16 bits, signed, native endianness
373 <td><p><a name="GST-AUDIO-FORMAT-U16:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U16</code></span></p></td>
374 <td>16 bits in 16 bits, unsigned, native endianness
378 <td><p><a name="GST-AUDIO-FORMAT-S24-32:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S24_32</code></span></p></td>
379 <td>24 bits in 32 bits, signed, native endianness
383 <td><p><a name="GST-AUDIO-FORMAT-U24-32:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U24_32</code></span></p></td>
384 <td>24 bits in 32 bits, unsigned, native endianness
388 <td><p><a name="GST-AUDIO-FORMAT-S32:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S32</code></span></p></td>
389 <td>32 bits in 32 bits, signed, native endianness
393 <td><p><a name="GST-AUDIO-FORMAT-U32:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U32</code></span></p></td>
394 <td>32 bits in 32 bits, unsigned, native endianness
398 <td><p><a name="GST-AUDIO-FORMAT-S24:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S24</code></span></p></td>
399 <td>24 bits in 24 bits, signed, native endianness
403 <td><p><a name="GST-AUDIO-FORMAT-U24:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U24</code></span></p></td>
404 <td>24 bits in 24 bits, unsigned, native endianness
408 <td><p><a name="GST-AUDIO-FORMAT-S20:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S20</code></span></p></td>
409 <td>20 bits in 24 bits, signed, native endianness
413 <td><p><a name="GST-AUDIO-FORMAT-U20:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U20</code></span></p></td>
414 <td>20 bits in 24 bits, unsigned, native endianness
418 <td><p><a name="GST-AUDIO-FORMAT-S18:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S18</code></span></p></td>
419 <td>18 bits in 24 bits, signed, native endianness
423 <td><p><a name="GST-AUDIO-FORMAT-U18:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U18</code></span></p></td>
424 <td>18 bits in 24 bits, unsigned, native endianness
428 <td><p><a name="GST-AUDIO-FORMAT-F32:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_F32</code></span></p></td>
429 <td>32-bit floating point samples, native endianness
433 <td><p><a name="GST-AUDIO-FORMAT-F64:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_F64</code></span></p></td>
434 <td>64-bit floating point samples, native endianness
439 <p class="since">Since 0.10.36</p>
442 <div class="refsect2">
443 <a name="GstAudioFormatFlags"></a><h3>enum GstAudioFormatFlags</h3>
444 <pre class="programlisting">typedef enum {
445 GST_AUDIO_FORMAT_FLAG_INTEGER = (1 << 0),
446 GST_AUDIO_FORMAT_FLAG_FLOAT = (1 << 1),
447 GST_AUDIO_FORMAT_FLAG_SIGNED = (1 << 2),
448 GST_AUDIO_FORMAT_FLAG_COMPLEX = (1 << 4)
449 } GstAudioFormatFlags;
452 The different audio flags that a format info can have.
454 <div class="variablelist"><table border="0">
455 <col align="left" valign="top">
458 <td><p><a name="GST-AUDIO-FORMAT-FLAG-INTEGER:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_FLAG_INTEGER</code></span></p></td>
463 <td><p><a name="GST-AUDIO-FORMAT-FLAG-FLOAT:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_FLAG_FLOAT</code></span></p></td>
468 <td><p><a name="GST-AUDIO-FORMAT-FLAG-SIGNED:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_FLAG_SIGNED</code></span></p></td>
473 <td><p><a name="GST-AUDIO-FORMAT-FLAG-COMPLEX:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_FLAG_COMPLEX</code></span></p></td>
479 <p class="since">Since 0.10.36</p>
482 <div class="refsect2">
483 <a name="GstAudioFormatInfo"></a><h3>struct GstAudioFormatInfo</h3>
484 <pre class="programlisting">struct GstAudioFormatInfo {
485 GstAudioFormat format;
487 GstAudioFormatFlags flags;
495 Information for an audio format.
497 <div class="variablelist"><table border="0">
498 <col align="left" valign="top">
501 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="type">GstAudioFormat</span></a> <em class="structfield"><code><a name="GstAudioFormatInfo.format"></a>format</code></em>;</span></p></td>
502 <td><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="type">GstAudioFormat</span></a></td>
505 <td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstAudioFormatInfo.name"></a>name</code></em>;</span></p></td>
506 <td>string representation of the format</td>
509 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormatFlags" title="enum GstAudioFormatFlags"><span class="type">GstAudioFormatFlags</span></a> <em class="structfield"><code><a name="GstAudioFormatInfo.flags"></a>flags</code></em>;</span></p></td>
510 <td><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormatFlags" title="enum GstAudioFormatFlags"><span class="type">GstAudioFormatFlags</span></a></td>
513 <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="GstAudioFormatInfo.endianness"></a>endianness</code></em>;</span></p></td>
514 <td>the endianness</td>
517 <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="GstAudioFormatInfo.width"></a>width</code></em>;</span></p></td>
518 <td>amount of bits used for one sample</td>
521 <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="GstAudioFormatInfo.depth"></a>depth</code></em>;</span></p></td>
522 <td>amount of valid bits in <em class="parameter"><code>width</code></em>
526 <td><p><span class="term"><span class="type">guint8</span> <em class="structfield"><code><a name="GstAudioFormatInfo.silence"></a>silence</code></em>[8];</span></p></td>
528 <em class="parameter"><code>width</code></em>/8 bytes with 1 silent sample</td>
532 <p class="since">Since 0.10.36</p>
535 <div class="refsect2">
536 <a name="GstAudioInfo"></a><h3>struct GstAudioInfo</h3>
537 <pre class="programlisting">struct GstAudioInfo {
538 const GstAudioFormatInfo *finfo;
543 GstAudioChannelPosition position[64];
547 Information describing audio properties. This information can be filled
548 in from GstCaps with <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-info-from-caps" title="gst_audio_info_from_caps ()"><code class="function">gst_audio_info_from_caps()</code></a>.
551 Use the provided macros to access the info in this structure.
553 <div class="variablelist"><table border="0">
554 <col align="left" valign="top">
557 <td><p><span class="term">const <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormatInfo" title="struct GstAudioFormatInfo"><span class="type">GstAudioFormatInfo</span></a> *<em class="structfield"><code><a name="GstAudioInfo.finfo"></a>finfo</code></em>;</span></p></td>
558 <td>the format info of the audio</td>
561 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFlags" title="enum GstAudioFlags"><span class="type">GstAudioFlags</span></a> <em class="structfield"><code><a name="GstAudioInfo.flags"></a>flags</code></em>;</span></p></td>
562 <td>additional audio flags</td>
565 <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="GstAudioInfo.rate"></a>rate</code></em>;</span></p></td>
566 <td>the audio sample rate</td>
569 <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="GstAudioInfo.channels"></a>channels</code></em>;</span></p></td>
570 <td>the number of channels</td>
573 <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="GstAudioInfo.bpf"></a>bpf</code></em>;</span></p></td>
574 <td>the number of bytes for one frame, this is the size of one
575 sample * <em class="parameter"><code>channels</code></em>
579 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstmultichannel.html#GstAudioChannelPosition" title="enum GstAudioChannelPosition"><span class="type">GstAudioChannelPosition</span></a> <em class="structfield"><code><a name="GstAudioInfo.position"></a>position</code></em>[64];</span></p></td>
580 <td>the position for each channel (assume all NONE for >64 channels)</td>
584 <p class="since">Since 0.10.36</p>
587 <div class="refsect2">
588 <a name="gst-audio-info-init"></a><h3>gst_audio_info_init ()</h3>
589 <pre class="programlisting"><span class="returnvalue">void</span> gst_audio_info_init (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);</pre>
592 <div class="refsect2">
593 <a name="gst-audio-info-clear"></a><h3>gst_audio_info_clear ()</h3>
594 <pre class="programlisting"><span class="returnvalue">void</span> gst_audio_info_clear (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);</pre>
597 <div class="refsect2">
598 <a name="gst-audio-info-copy"></a><h3>gst_audio_info_copy ()</h3>
599 <pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="returnvalue">GstAudioInfo</span></a> * gst_audio_info_copy (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);</pre>
602 <div class="refsect2">
603 <a name="gst-audio-info-free"></a><h3>gst_audio_info_free ()</h3>
604 <pre class="programlisting"><span class="returnvalue">void</span> gst_audio_info_free (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);</pre>
607 <div class="refsect2">
608 <a name="gst-audio-info-from-caps"></a><h3>gst_audio_info_from_caps ()</h3>
609 <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_info_from_caps (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>,
610 <em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
612 Parse <em class="parameter"><code>caps</code></em> and update <em class="parameter"><code>info</code></em>.
614 <div class="variablelist"><table border="0">
615 <col align="left" valign="top">
618 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
619 <td>a <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a>
623 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
624 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>
628 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
629 <td>TRUE if <em class="parameter"><code>caps</code></em> could be parsed</td>
633 <p class="since">Since 0.10.36</p>
636 <div class="refsect2">
637 <a name="gst-audio-info-to-caps"></a><h3>gst_audio_info_to_caps ()</h3>
638 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> * gst_audio_info_to_caps (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);</pre>
640 Convert the values of <em class="parameter"><code>info</code></em> into a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>.
642 <div class="variablelist"><table border="0">
643 <col align="left" valign="top">
646 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
647 <td>a <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a>
651 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
652 <td>the new <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> containing the
653 info of <em class="parameter"><code>info</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
658 <p class="since">Since 0.10.36</p>
661 <div class="refsect2">
662 <a name="gst-audio-info-convert"></a><h3>gst_audio_info_convert ()</h3>
663 <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_info_convert (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>,
664 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> src_fmt</code></em>,
665 <em class="parameter"><code><span class="type">gint64</span> src_val</code></em>,
666 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> dest_fmt</code></em>,
667 <em class="parameter"><code><span class="type">gint64</span> *dest_val</code></em>);</pre>
670 <div class="refsect2">
671 <a name="gst-audio-format-get-info"></a><h3>gst_audio_format_get_info ()</h3>
672 <pre class="programlisting">const <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormatInfo" title="struct GstAudioFormatInfo"><span class="returnvalue">GstAudioFormatInfo</span></a> * gst_audio_format_get_info (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="type">GstAudioFormat</span></a> format</code></em>);</pre>
675 <div class="refsect2">
676 <a name="GST-AUDIO-FORMAT-INFO-DEPTH:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_DEPTH()</h3>
677 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_DEPTH(info) ((info)->depth)
681 <div class="refsect2">
682 <a name="GST-AUDIO-FORMAT-INFO-ENDIANNESS:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_ENDIANNESS()</h3>
683 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_ENDIANNESS(info) ((info)->endianness)
687 <div class="refsect2">
688 <a name="GST-AUDIO-FORMAT-INFO-FLAGS:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_FLAGS()</h3>
689 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_FLAGS(info) ((info)->flags)
693 <div class="refsect2">
694 <a name="GST-AUDIO-FORMAT-INFO-FORMAT:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_FORMAT()</h3>
695 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_FORMAT(info) ((info)->format)
699 <div class="refsect2">
700 <a name="GST-AUDIO-FORMAT-INFO-IS-FLOAT:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_IS_FLOAT()</h3>
701 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_IS_FLOAT(info) !!((info)->flags & GST_AUDIO_FORMAT_FLAG_FLOAT)
705 <div class="refsect2">
706 <a name="GST-AUDIO-FORMAT-INFO-IS-INTEGER:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_IS_INTEGER()</h3>
707 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_IS_INTEGER(info) !!((info)->flags & GST_AUDIO_FORMAT_FLAG_INTEGER)
711 <div class="refsect2">
712 <a name="GST-AUDIO-FORMAT-INFO-IS-BIG-ENDIAN:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN()</h3>
713 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN(info) ((info)->endianness == G_BIG_ENDIAN)
717 <div class="refsect2">
718 <a name="GST-AUDIO-FORMAT-INFO-IS-LITTLE-ENDIAN:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN()</h3>
719 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN(info) ((info)->endianness == G_LITTLE_ENDIAN)
723 <div class="refsect2">
724 <a name="GST-AUDIO-FORMAT-INFO-IS-SIGNED:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_IS_SIGNED()</h3>
725 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_IS_SIGNED(info) !!((info)->flags & GST_AUDIO_FORMAT_FLAG_SIGNED)
729 <div class="refsect2">
730 <a name="GST-AUDIO-FORMAT-INFO-NAME:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_NAME()</h3>
731 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_NAME(info) ((info)->name)
735 <div class="refsect2">
736 <a name="GST-AUDIO-FORMAT-INFO-WIDTH:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_WIDTH()</h3>
737 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_WIDTH(info) ((info)->width)
741 <div class="refsect2">
742 <a name="GST-AUDIO-INFO-BPF:CAPS"></a><h3>GST_AUDIO_INFO_BPF()</h3>
743 <pre class="programlisting">#define GST_AUDIO_INFO_BPF(info) ((info)->bpf)
747 <div class="refsect2">
748 <a name="GST-AUDIO-INFO-BPS:CAPS"></a><h3>GST_AUDIO_INFO_BPS()</h3>
749 <pre class="programlisting">#define GST_AUDIO_INFO_BPS(info) (GST_AUDIO_INFO_DEPTH(info) >> 3)
753 <div class="refsect2">
754 <a name="GST-AUDIO-INFO-CHANNELS:CAPS"></a><h3>GST_AUDIO_INFO_CHANNELS()</h3>
755 <pre class="programlisting">#define GST_AUDIO_INFO_CHANNELS(info) ((info)->channels)
759 <div class="refsect2">
760 <a name="GST-AUDIO-INFO-DEPTH:CAPS"></a><h3>GST_AUDIO_INFO_DEPTH()</h3>
761 <pre class="programlisting">#define GST_AUDIO_INFO_DEPTH(i) (GST_AUDIO_FORMAT_INFO_DEPTH((i)->finfo))
765 <div class="refsect2">
766 <a name="GST-AUDIO-INFO-FLAGS:CAPS"></a><h3>GST_AUDIO_INFO_FLAGS()</h3>
767 <pre class="programlisting">#define GST_AUDIO_INFO_FLAGS(info) ((info)->flags)
771 <div class="refsect2">
772 <a name="GST-AUDIO-INFO-FORMAT:CAPS"></a><h3>GST_AUDIO_INFO_FORMAT()</h3>
773 <pre class="programlisting">#define GST_AUDIO_INFO_FORMAT(i) (GST_AUDIO_FORMAT_INFO_FORMAT((i)->finfo))
777 <div class="refsect2">
778 <a name="GST-AUDIO-INFO-HAS-DEFAULT-POSITIONS:CAPS"></a><h3>GST_AUDIO_INFO_HAS_DEFAULT_POSITIONS()</h3>
779 <pre class="programlisting">#define GST_AUDIO_INFO_HAS_DEFAULT_POSITIONS(info) ((info)->flags & GST_AUDIO_FLAG_DEFAULT_POSITIONS)
783 <div class="refsect2">
784 <a name="GST-AUDIO-INFO-NAME:CAPS"></a><h3>GST_AUDIO_INFO_NAME()</h3>
785 <pre class="programlisting">#define GST_AUDIO_INFO_NAME(i) (GST_AUDIO_FORMAT_INFO_NAME((i)->finfo))
789 <div class="refsect2">
790 <a name="GST-AUDIO-INFO-POSITION:CAPS"></a><h3>GST_AUDIO_INFO_POSITION()</h3>
791 <pre class="programlisting">#define GST_AUDIO_INFO_POSITION(info,c) ((info)->position[c])
795 <div class="refsect2">
796 <a name="GST-AUDIO-INFO-RATE:CAPS"></a><h3>GST_AUDIO_INFO_RATE()</h3>
797 <pre class="programlisting">#define GST_AUDIO_INFO_RATE(info) ((info)->rate)
801 <div class="refsect2">
802 <a name="GST-AUDIO-INFO-WIDTH:CAPS"></a><h3>GST_AUDIO_INFO_WIDTH()</h3>
803 <pre class="programlisting">#define GST_AUDIO_INFO_WIDTH(i) (GST_AUDIO_FORMAT_INFO_WIDTH((i)->finfo))
807 <div class="refsect2">
808 <a name="GstAudioFieldFlag"></a><h3>enum GstAudioFieldFlag</h3>
809 <pre class="programlisting">typedef enum {
810 GST_AUDIO_FIELD_RATE = (1 << 0),
811 GST_AUDIO_FIELD_CHANNELS = (1 << 1),
812 GST_AUDIO_FIELD_ENDIANNESS = (1 << 2),
813 GST_AUDIO_FIELD_WIDTH = (1 << 3),
814 GST_AUDIO_FIELD_DEPTH = (1 << 4),
815 GST_AUDIO_FIELD_SIGNED = (1 << 5)
818 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
819 <h3 class="title">Warning</h3>
820 <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>
825 <div class="variablelist"><table border="0">
826 <col align="left" valign="top">
829 <td><p><a name="GST-AUDIO-FIELD-RATE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_RATE</code></span></p></td>
830 <td>add rate field to caps
834 <td><p><a name="GST-AUDIO-FIELD-CHANNELS:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_CHANNELS</code></span></p></td>
835 <td>add channels field to caps
839 <td><p><a name="GST-AUDIO-FIELD-ENDIANNESS:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_ENDIANNESS</code></span></p></td>
840 <td>add endianness field to caps
844 <td><p><a name="GST-AUDIO-FIELD-WIDTH:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_WIDTH</code></span></p></td>
845 <td>add width field to caps
849 <td><p><a name="GST-AUDIO-FIELD-DEPTH:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_DEPTH</code></span></p></td>
850 <td>add depth field to caps
854 <td><p><a name="GST-AUDIO-FIELD-SIGNED:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_SIGNED</code></span></p></td>
855 <td>add signed field to caps
862 <div class="refsect2">
863 <a name="GST-FRAMES-TO-CLOCK-TIME:CAPS"></a><h3>GST_FRAMES_TO_CLOCK_TIME()</h3>
864 <pre class="programlisting">#define GST_FRAMES_TO_CLOCK_TIME(frames, rate)</pre>
866 Calculate clocktime from sample <em class="parameter"><code>frames</code></em> and <em class="parameter"><code>rate</code></em>.
868 <div class="variablelist"><table border="0">
869 <col align="left" valign="top">
872 <td><p><span class="term"><em class="parameter"><code>frames</code></em> :</span></p></td>
873 <td>sample frames</td>
876 <td><p><span class="term"><em class="parameter"><code>rate</code></em> :</span></p></td>
877 <td>sampling rate</td>
883 <div class="refsect2">
884 <a name="GST-CLOCK-TIME-TO-FRAMES:CAPS"></a><h3>GST_CLOCK_TIME_TO_FRAMES()</h3>
885 <pre class="programlisting">#define GST_CLOCK_TIME_TO_FRAMES(clocktime, rate)</pre>
887 Calculate frames from <em class="parameter"><code>clocktime</code></em> and sample <em class="parameter"><code>rate</code></em>.
889 <div class="variablelist"><table border="0">
890 <col align="left" valign="top">
893 <td><p><span class="term"><em class="parameter"><code>clocktime</code></em> :</span></p></td>
897 <td><p><span class="term"><em class="parameter"><code>rate</code></em> :</span></p></td>
898 <td>sampling rate</td>
904 <div class="refsect2">
905 <a name="GST-AUDIO-DEF-RATE:CAPS"></a><h3>GST_AUDIO_DEF_RATE</h3>
906 <pre class="programlisting">#define GST_AUDIO_DEF_RATE 44100
909 Standard sampling rate used in consumer audio.
913 <div class="refsect2">
914 <a name="GST-AUDIO-FLOAT-PAD-TEMPLATE-CAPS"></a><h3>GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS</h3>
915 <pre class="programlisting">#define GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS</pre>
917 Template caps for float audio. Can be used when defining a
918 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a>
922 <div class="refsect2">
923 <a name="GST-AUDIO-FLOAT-STANDARD-PAD-TEMPLATE-CAPS"></a><h3>GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS</h3>
924 <pre class="programlisting">#define GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS</pre>
926 Template caps for 32bit float mono audio in native byte-order.
927 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>
931 <div class="refsect2">
932 <a name="GST-AUDIO-INT-PAD-TEMPLATE-CAPS"></a><h3>GST_AUDIO_INT_PAD_TEMPLATE_CAPS</h3>
933 <pre class="programlisting">#define GST_AUDIO_INT_PAD_TEMPLATE_CAPS</pre>
935 Template caps for integer audio. Can be used when defining a
936 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a>
940 <div class="refsect2">
941 <a name="GST-AUDIO-INT-STANDARD-PAD-TEMPLATE-CAPS"></a><h3>GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS</h3>
942 <pre class="programlisting">#define GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS</pre>
944 Template caps for 16bit integer stereo audio in native byte-order.
945 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>
949 <div class="refsect2">
950 <a name="gst-audio-frame-byte-size"></a><h3>gst_audio_frame_byte_size ()</h3>
951 <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>
953 Calculate byte size of an audio frame.
955 <div class="variablelist"><table border="0">
956 <col align="left" valign="top">
959 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
960 <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>
963 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
964 <td>the byte size, or 0 if there was an error</td>
970 <div class="refsect2">
971 <a name="gst-audio-frame-length"></a><h3>gst_audio_frame_length ()</h3>
972 <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>,
973 <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>
975 Calculate length of buffer in frames.
977 <div class="variablelist"><table border="0">
978 <col align="left" valign="top">
981 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
982 <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>
985 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
986 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
990 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
991 <td>0 if there's an error, or the number of frames if everything's ok</td>
997 <div class="refsect2">
998 <a name="gst-audio-duration-from-pad-buffer"></a><h3>gst_audio_duration_from_pad_buffer ()</h3>
999 <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>,
1000 <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>
1002 Calculate length in nanoseconds of audio buffer <em class="parameter"><code>buf</code></em> based on capabilities of
1003 <em class="parameter"><code>pad</code></em>.
1005 <div class="variablelist"><table border="0">
1006 <col align="left" valign="top">
1009 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
1010 <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>
1013 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
1014 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
1018 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1019 <td>the length.</td>
1025 <div class="refsect2">
1026 <a name="gst-audio-is-buffer-framed"></a><h3>gst_audio_is_buffer_framed ()</h3>
1027 <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>,
1028 <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>
1030 Check if the buffer size is a whole multiple of the frame size.
1032 <div class="variablelist"><table border="0">
1033 <col align="left" valign="top">
1036 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
1037 <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>
1040 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
1041 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
1045 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1047 <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>
1053 <div class="refsect2">
1054 <a name="gst-audio-structure-set-int"></a><h3>gst_audio_structure_set_int ()</h3>
1055 <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>,
1056 <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>
1057 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1058 <h3 class="title">Warning</h3>
1059 <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>
1064 <div class="variablelist"><table border="0">
1065 <col align="left" valign="top">
1068 <td><p><span class="term"><em class="parameter"><code>structure</code></em> :</span></p></td>
1069 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#GstStructure"><span class="type">GstStructure</span></a>
1073 <td><p><span class="term"><em class="parameter"><code>flag</code></em> :</span></p></td>
1074 <td>a set of <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFieldFlag" title="enum GstAudioFieldFlag"><span class="type">GstAudioFieldFlag</span></a>
1081 <div class="refsect2">
1082 <a name="gst-audio-buffer-clip"></a><h3>gst_audio_buffer_clip ()</h3>
1083 <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>,
1084 <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>,
1085 <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>,
1086 <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>
1088 Clip 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>.
1091 After calling this function the caller does not own a reference to
1092 <em class="parameter"><code>buffer</code></em> anymore.
1094 <div class="variablelist"><table border="0">
1095 <col align="left" valign="top">
1098 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
1099 <td>The buffer to clip.</td>
1102 <td><p><span class="term"><em class="parameter"><code>segment</code></em> :</span></p></td>
1103 <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>
1106 <td><p><span class="term"><em class="parameter"><code>rate</code></em> :</span></p></td>
1107 <td>sample rate.</td>
1110 <td><p><span class="term"><em class="parameter"><code>frame_size</code></em> :</span></p></td>
1111 <td>size of one audio frame in bytes.</td>
1114 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1116 <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,
1117 otherwise the clipped buffer is returned.
1118 If the buffer has no timestamp, it is assumed to be inside the segment and
1123 <p class="since">Since 0.10.14</p>
1127 <div class="footer">
1129 Generated by GTK-Doc V1.18</div>