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: GStreamer Base Plugins 1.0 Library Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 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-GstAudio-meta.html" title="GstAudio meta"> 11<meta name="generator" content="GTK-Doc V1.28 (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="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-base-libs-GstAudio.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-base-libs-GstAudio.object-hierarchy" class="shortcut">Object Hierarchy</a></span> 20</td> 21<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 22<td><a accesskey="u" href="gstreamer-audio.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 23<td><a accesskey="p" href="gstreamer-audio.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 24<td><a accesskey="n" href="gst-plugins-base-libs-GstAudio-meta.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 25</tr></table> 26<div class="refentry"> 27<a name="gst-plugins-base-libs-GstAudio"></a><div class="titlepage"></div> 28<div class="refnamediv"><table width="100%"><tr> 29<td valign="top"> 30<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-GstAudio.top_of_page"></a>GstAudio</span></h2> 31<p>GstAudio — Support library for audio elements</p> 32</td> 33<td class="gallery_image" valign="top" align="right"></td> 34</tr></table></div> 35<div class="refsect1"> 36<a name="gst-plugins-base-libs-GstAudio.functions"></a><h2>Functions</h2> 37<div class="informaltable"><table class="informaltable" width="100%" border="0"> 38<colgroup> 39<col width="150px" class="functions_return"> 40<col class="functions_name"> 41</colgroup> 42<tbody> 43<tr> 44<td class="function_type"> 45<span class="returnvalue">void</span> 46</td> 47<td class="function_name"> 48<span class="c_punctuation">(</span><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatPack" title="GstAudioFormatPack ()">*GstAudioFormatPack</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> 49</td> 50</tr> 51<tr> 52<td class="function_type"> 53<span class="returnvalue">void</span> 54</td> 55<td class="function_name"> 56<span class="c_punctuation">(</span><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatUnpack" title="GstAudioFormatUnpack ()">*GstAudioFormatUnpack</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> 57</td> 58</tr> 59<tr> 60<td class="function_type"> 61<span class="returnvalue">void</span> 62</td> 63<td class="function_name"> 64<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-info-init" title="gst_audio_info_init ()">gst_audio_info_init</a> <span class="c_punctuation">()</span> 65</td> 66</tr> 67<tr> 68<td class="function_type"> 69<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 70</td> 71<td class="function_name"> 72<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> <span class="c_punctuation">()</span> 73</td> 74</tr> 75<tr> 76<td class="function_type"> 77<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="returnvalue">GstCaps</span></a> * 78</td> 79<td class="function_name"> 80<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> <span class="c_punctuation">()</span> 81</td> 82</tr> 83<tr> 84<td class="function_type"> 85<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 86</td> 87<td class="function_name"> 88<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-info-convert" title="gst_audio_info_convert ()">gst_audio_info_convert</a> <span class="c_punctuation">()</span> 89</td> 90</tr> 91<tr> 92<td class="function_type">const <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatInfo"><span class="returnvalue">GstAudioFormatInfo</span></a> * 93</td> 94<td class="function_name"> 95<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> <span class="c_punctuation">()</span> 96</td> 97</tr> 98<tr> 99<td class="function_type"> 100<a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="returnvalue">GstAudioInfo</span></a> * 101</td> 102<td class="function_name"> 103<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-info-copy" title="gst_audio_info_copy ()">gst_audio_info_copy</a> <span class="c_punctuation">()</span> 104</td> 105</tr> 106<tr> 107<td class="function_type"> 108<span class="returnvalue">void</span> 109</td> 110<td class="function_name"> 111<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-info-free" title="gst_audio_info_free ()">gst_audio_info_free</a> <span class="c_punctuation">()</span> 112</td> 113</tr> 114<tr> 115<td class="function_type"> 116<a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="returnvalue">GstAudioInfo</span></a> * 117</td> 118<td class="function_name"> 119<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-info-new" title="gst_audio_info_new ()">gst_audio_info_new</a> <span class="c_punctuation">()</span> 120</td> 121</tr> 122<tr> 123<td class="function_type"> 124<span class="returnvalue">void</span> 125</td> 126<td class="function_name"> 127<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-info-set-format" title="gst_audio_info_set_format ()">gst_audio_info_set_format</a> <span class="c_punctuation">()</span> 128</td> 129</tr> 130<tr> 131<td class="function_type"> 132<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 133</td> 134<td class="function_name"> 135<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-info-is-equal" title="gst_audio_info_is_equal ()">gst_audio_info_is_equal</a> <span class="c_punctuation">()</span> 136</td> 137</tr> 138<tr> 139<td class="function_type"> 140<a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="returnvalue">GstAudioFormat</span></a> 141</td> 142<td class="function_name"> 143<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-format-build-integer" title="gst_audio_format_build_integer ()">gst_audio_format_build_integer</a> <span class="c_punctuation">()</span> 144</td> 145</tr> 146<tr> 147<td class="function_type"> 148<span class="returnvalue">void</span> 149</td> 150<td class="function_name"> 151<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-format-fill-silence" title="gst_audio_format_fill_silence ()">gst_audio_format_fill_silence</a> <span class="c_punctuation">()</span> 152</td> 153</tr> 154<tr> 155<td class="function_type"> 156<a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="returnvalue">GstAudioFormat</span></a> 157</td> 158<td class="function_name"> 159<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-format-from-string" title="gst_audio_format_from_string ()">gst_audio_format_from_string</a> <span class="c_punctuation">()</span> 160</td> 161</tr> 162<tr> 163<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * 164</td> 165<td class="function_name"> 166<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-format-to-string" title="gst_audio_format_to_string ()">gst_audio_format_to_string</a> <span class="c_punctuation">()</span> 167</td> 168</tr> 169<tr> 170<td class="define_keyword">#define</td> 171<td class="function_name"> 172<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><span class="c_punctuation">()</span> 173</td> 174</tr> 175<tr> 176<td class="define_keyword">#define</td> 177<td class="function_name"> 178<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><span class="c_punctuation">()</span> 179</td> 180</tr> 181<tr> 182<td class="define_keyword">#define</td> 183<td class="function_name"> 184<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><span class="c_punctuation">()</span> 185</td> 186</tr> 187<tr> 188<td class="define_keyword">#define</td> 189<td class="function_name"> 190<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><span class="c_punctuation">()</span> 191</td> 192</tr> 193<tr> 194<td class="define_keyword">#define</td> 195<td class="function_name"> 196<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><span class="c_punctuation">()</span> 197</td> 198</tr> 199<tr> 200<td class="define_keyword">#define</td> 201<td class="function_name"> 202<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><span class="c_punctuation">()</span> 203</td> 204</tr> 205<tr> 206<td class="define_keyword">#define</td> 207<td class="function_name"> 208<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><span class="c_punctuation">()</span> 209</td> 210</tr> 211<tr> 212<td class="define_keyword">#define</td> 213<td class="function_name"> 214<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><span class="c_punctuation">()</span> 215</td> 216</tr> 217<tr> 218<td class="define_keyword">#define</td> 219<td class="function_name"> 220<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><span class="c_punctuation">()</span> 221</td> 222</tr> 223<tr> 224<td class="define_keyword">#define</td> 225<td class="function_name"> 226<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><span class="c_punctuation">()</span> 227</td> 228</tr> 229<tr> 230<td class="define_keyword">#define</td> 231<td class="function_name"> 232<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><span class="c_punctuation">()</span> 233</td> 234</tr> 235<tr> 236<td class="define_keyword">#define</td> 237<td class="function_name"> 238<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><span class="c_punctuation">()</span> 239</td> 240</tr> 241<tr> 242<td class="define_keyword">#define</td> 243<td class="function_name"> 244<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><span class="c_punctuation">()</span> 245</td> 246</tr> 247<tr> 248<td class="define_keyword">#define</td> 249<td class="function_name"> 250<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><span class="c_punctuation">()</span> 251</td> 252</tr> 253<tr> 254<td class="define_keyword">#define</td> 255<td class="function_name"> 256<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><span class="c_punctuation">()</span> 257</td> 258</tr> 259<tr> 260<td class="define_keyword">#define</td> 261<td class="function_name"> 262<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><span class="c_punctuation">()</span> 263</td> 264</tr> 265<tr> 266<td class="define_keyword">#define</td> 267<td class="function_name"> 268<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><span class="c_punctuation">()</span> 269</td> 270</tr> 271<tr> 272<td class="define_keyword">#define</td> 273<td class="function_name"> 274<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><span class="c_punctuation">()</span> 275</td> 276</tr> 277<tr> 278<td class="define_keyword">#define</td> 279<td class="function_name"> 280<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><span class="c_punctuation">()</span> 281</td> 282</tr> 283<tr> 284<td class="define_keyword">#define</td> 285<td class="function_name"> 286<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><span class="c_punctuation">()</span> 287</td> 288</tr> 289<tr> 290<td class="define_keyword">#define</td> 291<td class="function_name"> 292<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><span class="c_punctuation">()</span> 293</td> 294</tr> 295<tr> 296<td class="define_keyword">#define</td> 297<td class="function_name"> 298<a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-INFO-ENDIANNESS:CAPS" title="GST_AUDIO_INFO_ENDIANNESS()">GST_AUDIO_INFO_ENDIANNESS</a><span class="c_punctuation">()</span> 299</td> 300</tr> 301<tr> 302<td class="define_keyword">#define</td> 303<td class="function_name"> 304<a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-INFO-IS-BIG-ENDIAN:CAPS" title="GST_AUDIO_INFO_IS_BIG_ENDIAN()">GST_AUDIO_INFO_IS_BIG_ENDIAN</a><span class="c_punctuation">()</span> 305</td> 306</tr> 307<tr> 308<td class="define_keyword">#define</td> 309<td class="function_name"> 310<a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-INFO-IS-FLOAT:CAPS" title="GST_AUDIO_INFO_IS_FLOAT()">GST_AUDIO_INFO_IS_FLOAT</a><span class="c_punctuation">()</span> 311</td> 312</tr> 313<tr> 314<td class="define_keyword">#define</td> 315<td class="function_name"> 316<a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-INFO-IS-INTEGER:CAPS" title="GST_AUDIO_INFO_IS_INTEGER()">GST_AUDIO_INFO_IS_INTEGER</a><span class="c_punctuation">()</span> 317</td> 318</tr> 319<tr> 320<td class="define_keyword">#define</td> 321<td class="function_name"> 322<a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-INFO-IS-LITTLE-ENDIAN:CAPS" title="GST_AUDIO_INFO_IS_LITTLE_ENDIAN()">GST_AUDIO_INFO_IS_LITTLE_ENDIAN</a><span class="c_punctuation">()</span> 323</td> 324</tr> 325<tr> 326<td class="define_keyword">#define</td> 327<td class="function_name"> 328<a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-INFO-IS-SIGNED:CAPS" title="GST_AUDIO_INFO_IS_SIGNED()">GST_AUDIO_INFO_IS_SIGNED</a><span class="c_punctuation">()</span> 329</td> 330</tr> 331<tr> 332<td class="define_keyword">#define</td> 333<td class="function_name"> 334<a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-INFO-IS-UNPOSITIONED:CAPS" title="GST_AUDIO_INFO_IS_UNPOSITIONED()">GST_AUDIO_INFO_IS_UNPOSITIONED</a><span class="c_punctuation">()</span> 335</td> 336</tr> 337<tr> 338<td class="define_keyword">#define</td> 339<td class="function_name"> 340<a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-INFO-IS-VALID:CAPS" title="GST_AUDIO_INFO_IS_VALID()">GST_AUDIO_INFO_IS_VALID</a><span class="c_punctuation">()</span> 341</td> 342</tr> 343<tr> 344<td class="define_keyword">#define</td> 345<td class="function_name"> 346<a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-INFO-LAYOUT:CAPS" title="GST_AUDIO_INFO_LAYOUT()">GST_AUDIO_INFO_LAYOUT</a><span class="c_punctuation">()</span> 347</td> 348</tr> 349<tr> 350<td class="define_keyword">#define</td> 351<td class="function_name"> 352<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><span class="c_punctuation">()</span> 353</td> 354</tr> 355<tr> 356<td class="define_keyword">#define</td> 357<td class="function_name"> 358<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><span class="c_punctuation">()</span> 359</td> 360</tr> 361<tr> 362<td class="define_keyword">#define</td> 363<td class="function_name"> 364<a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-NE:CAPS" title="GST_AUDIO_NE()">GST_AUDIO_NE</a><span class="c_punctuation">()</span> 365</td> 366</tr> 367<tr> 368<td class="define_keyword">#define</td> 369<td class="function_name"> 370<a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-OE:CAPS" title="GST_AUDIO_OE()">GST_AUDIO_OE</a><span class="c_punctuation">()</span> 371</td> 372</tr> 373<tr> 374<td class="define_keyword">#define</td> 375<td class="function_name"> 376<a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-CAPS-MAKE:CAPS" title="GST_AUDIO_CAPS_MAKE()">GST_AUDIO_CAPS_MAKE</a><span class="c_punctuation">()</span> 377</td> 378</tr> 379<tr> 380<td class="function_type"> 381<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="returnvalue">GstBuffer</span></a> * 382</td> 383<td class="function_name"> 384<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-buffer-clip" title="gst_audio_buffer_clip ()">gst_audio_buffer_clip</a> <span class="c_punctuation">()</span> 385</td> 386</tr> 387<tr> 388<td class="function_type"> 389<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 390</td> 391<td class="function_name"> 392<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-buffer-map" title="gst_audio_buffer_map ()">gst_audio_buffer_map</a> <span class="c_punctuation">()</span> 393</td> 394</tr> 395<tr> 396<td class="function_type"> 397<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="returnvalue">GstBuffer</span></a> * 398</td> 399<td class="function_name"> 400<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-buffer-truncate" title="gst_audio_buffer_truncate ()">gst_audio_buffer_truncate</a> <span class="c_punctuation">()</span> 401</td> 402</tr> 403<tr> 404<td class="function_type"> 405<span class="returnvalue">void</span> 406</td> 407<td class="function_name"> 408<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-buffer-unmap" title="gst_audio_buffer_unmap ()">gst_audio_buffer_unmap</a> <span class="c_punctuation">()</span> 409</td> 410</tr> 411<tr> 412<td class="function_type"> 413<span class="returnvalue">void</span> 414</td> 415<td class="function_name"> 416<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-resampler-free" title="gst_audio_resampler_free ()">gst_audio_resampler_free</a> <span class="c_punctuation">()</span> 417</td> 418</tr> 419<tr> 420<td class="function_type"> 421<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> 422</td> 423<td class="function_name"> 424<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-resampler-get-in-frames" title="gst_audio_resampler_get_in_frames ()">gst_audio_resampler_get_in_frames</a> <span class="c_punctuation">()</span> 425</td> 426</tr> 427<tr> 428<td class="function_type"> 429<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> 430</td> 431<td class="function_name"> 432<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-resampler-get-max-latency" title="gst_audio_resampler_get_max_latency ()">gst_audio_resampler_get_max_latency</a> <span class="c_punctuation">()</span> 433</td> 434</tr> 435<tr> 436<td class="function_type"> 437<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> 438</td> 439<td class="function_name"> 440<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-resampler-get-out-frames" title="gst_audio_resampler_get_out_frames ()">gst_audio_resampler_get_out_frames</a> <span class="c_punctuation">()</span> 441</td> 442</tr> 443<tr> 444<td class="function_type"> 445<a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="returnvalue">GstAudioResampler</span></a> * 446</td> 447<td class="function_name"> 448<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-resampler-new" title="gst_audio_resampler_new ()">gst_audio_resampler_new</a> <span class="c_punctuation">()</span> 449</td> 450</tr> 451<tr> 452<td class="function_type"> 453<span class="returnvalue">void</span> 454</td> 455<td class="function_name"> 456<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-resampler-options-set-quality" title="gst_audio_resampler_options_set_quality ()">gst_audio_resampler_options_set_quality</a> <span class="c_punctuation">()</span> 457</td> 458</tr> 459<tr> 460<td class="function_type"> 461<span class="returnvalue">void</span> 462</td> 463<td class="function_name"> 464<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-resampler-resample" title="gst_audio_resampler_resample ()">gst_audio_resampler_resample</a> <span class="c_punctuation">()</span> 465</td> 466</tr> 467<tr> 468<td class="function_type"> 469<span class="returnvalue">void</span> 470</td> 471<td class="function_name"> 472<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-resampler-reset" title="gst_audio_resampler_reset ()">gst_audio_resampler_reset</a> <span class="c_punctuation">()</span> 473</td> 474</tr> 475<tr> 476<td class="function_type"> 477<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 478</td> 479<td class="function_name"> 480<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-resampler-update" title="gst_audio_resampler_update ()">gst_audio_resampler_update</a> <span class="c_punctuation">()</span> 481</td> 482</tr> 483<tr> 484<td class="function_type"> 485<a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="returnvalue">GstAudioStreamAlign</span></a> * 486</td> 487<td class="function_name"> 488<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-new" title="gst_audio_stream_align_new ()">gst_audio_stream_align_new</a> <span class="c_punctuation">()</span> 489</td> 490</tr> 491<tr> 492<td class="function_type"> 493<a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="returnvalue">GstAudioStreamAlign</span></a> * 494</td> 495<td class="function_name"> 496<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-copy" title="gst_audio_stream_align_copy ()">gst_audio_stream_align_copy</a> <span class="c_punctuation">()</span> 497</td> 498</tr> 499<tr> 500<td class="function_type"> 501<span class="returnvalue">void</span> 502</td> 503<td class="function_name"> 504<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-free" title="gst_audio_stream_align_free ()">gst_audio_stream_align_free</a> <span class="c_punctuation">()</span> 505</td> 506</tr> 507<tr> 508<td class="function_type"> 509<span class="returnvalue">void</span> 510</td> 511<td class="function_name"> 512<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-mark-discont" title="gst_audio_stream_align_mark_discont ()">gst_audio_stream_align_mark_discont</a> <span class="c_punctuation">()</span> 513</td> 514</tr> 515<tr> 516<td class="function_type"> 517<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 518</td> 519<td class="function_name"> 520<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-process" title="gst_audio_stream_align_process ()">gst_audio_stream_align_process</a> <span class="c_punctuation">()</span> 521</td> 522</tr> 523<tr> 524<td class="function_type"> 525<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> 526</td> 527<td class="function_name"> 528<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-get-samples-since-discont" title="gst_audio_stream_align_get_samples_since_discont ()">gst_audio_stream_align_get_samples_since_discont</a> <span class="c_punctuation">()</span> 529</td> 530</tr> 531<tr> 532<td class="function_type"> 533<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a> 534</td> 535<td class="function_name"> 536<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-get-timestamp-at-discont" title="gst_audio_stream_align_get_timestamp_at_discont ()">gst_audio_stream_align_get_timestamp_at_discont</a> <span class="c_punctuation">()</span> 537</td> 538</tr> 539<tr> 540<td class="function_type"> 541<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a> 542</td> 543<td class="function_name"> 544<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-get-alignment-threshold" title="gst_audio_stream_align_get_alignment_threshold ()">gst_audio_stream_align_get_alignment_threshold</a> <span class="c_punctuation">()</span> 545</td> 546</tr> 547<tr> 548<td class="function_type"> 549<span class="returnvalue">void</span> 550</td> 551<td class="function_name"> 552<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-set-alignment-threshold" title="gst_audio_stream_align_set_alignment_threshold ()">gst_audio_stream_align_set_alignment_threshold</a> <span class="c_punctuation">()</span> 553</td> 554</tr> 555<tr> 556<td class="function_type"> 557<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a> 558</td> 559<td class="function_name"> 560<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-get-discont-wait" title="gst_audio_stream_align_get_discont_wait ()">gst_audio_stream_align_get_discont_wait</a> <span class="c_punctuation">()</span> 561</td> 562</tr> 563<tr> 564<td class="function_type"> 565<span class="returnvalue">void</span> 566</td> 567<td class="function_name"> 568<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-set-discont-wait" title="gst_audio_stream_align_set_discont_wait ()">gst_audio_stream_align_set_discont_wait</a> <span class="c_punctuation">()</span> 569</td> 570</tr> 571<tr> 572<td class="function_type"> 573<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> 574</td> 575<td class="function_name"> 576<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-get-rate" title="gst_audio_stream_align_get_rate ()">gst_audio_stream_align_get_rate</a> <span class="c_punctuation">()</span> 577</td> 578</tr> 579<tr> 580<td class="function_type"> 581<span class="returnvalue">void</span> 582</td> 583<td class="function_name"> 584<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-set-rate" title="gst_audio_stream_align_set_rate ()">gst_audio_stream_align_set_rate</a> <span class="c_punctuation">()</span> 585</td> 586</tr> 587</tbody> 588</table></div> 589</div> 590<a name="GstAudioFormatInfo"></a><a name="GstAudioInfo"></a><a name="GstAudioStreamAlign"></a><div class="refsect1"> 591<a name="gst-plugins-base-libs-GstAudio.other"></a><h2>Types and Values</h2> 592<div class="informaltable"><table class="informaltable" width="100%" border="0"> 593<colgroup> 594<col width="150px" class="name"> 595<col class="description"> 596</colgroup> 597<tbody> 598<tr> 599<td class="datatype_keyword">enum</td> 600<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFlags" title="enum GstAudioFlags">GstAudioFlags</a></td> 601</tr> 602<tr> 603<td class="datatype_keyword">enum</td> 604<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormat" title="enum GstAudioFormat">GstAudioFormat</a></td> 605</tr> 606<tr> 607<td class="datatype_keyword">enum</td> 608<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatFlags" title="enum GstAudioFormatFlags">GstAudioFormatFlags</a></td> 609</tr> 610<tr> 611<td class="datatype_keyword">struct</td> 612<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatInfo-struct" title="struct GstAudioFormatInfo">GstAudioFormatInfo</a></td> 613</tr> 614<tr> 615<td class="datatype_keyword">struct</td> 616<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo-struct" title="struct GstAudioInfo">GstAudioInfo</a></td> 617</tr> 618<tr> 619<td class="datatype_keyword">enum</td> 620<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioLayout" title="enum GstAudioLayout">GstAudioLayout</a></td> 621</tr> 622<tr> 623<td class="datatype_keyword">enum</td> 624<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioPackFlags" title="enum GstAudioPackFlags">GstAudioPackFlags</a></td> 625</tr> 626<tr> 627<td class="define_keyword">#define</td> 628<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-META-TAG-AUDIO-STR:CAPS" title="GST_META_TAG_AUDIO_STR">GST_META_TAG_AUDIO_STR</a></td> 629</tr> 630<tr> 631<td class="define_keyword">#define</td> 632<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-META-TAG-AUDIO-CHANNELS-STR:CAPS" title="GST_META_TAG_AUDIO_CHANNELS_STR">GST_META_TAG_AUDIO_CHANNELS_STR</a></td> 633</tr> 634<tr> 635<td class="define_keyword">#define</td> 636<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-META-TAG-AUDIO-RATE-STR:CAPS" title="GST_META_TAG_AUDIO_RATE_STR">GST_META_TAG_AUDIO_RATE_STR</a></td> 637</tr> 638<tr> 639<td class="define_keyword">#define</td> 640<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RATE-RANGE:CAPS" title="GST_AUDIO_RATE_RANGE">GST_AUDIO_RATE_RANGE</a></td> 641</tr> 642<tr> 643<td class="define_keyword">#define</td> 644<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-CHANNELS-RANGE:CAPS" title="GST_AUDIO_CHANNELS_RANGE">GST_AUDIO_CHANNELS_RANGE</a></td> 645</tr> 646<tr> 647<td class="define_keyword">#define</td> 648<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-FORMATS-ALL:CAPS" title="GST_AUDIO_FORMATS_ALL">GST_AUDIO_FORMATS_ALL</a></td> 649</tr> 650<tr> 651<td class="define_keyword">#define</td> 652<td class="function_name"><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></td> 653</tr> 654<tr> 655<td class="define_keyword">#define</td> 656<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-DEF-CHANNELS:CAPS" title="GST_AUDIO_DEF_CHANNELS">GST_AUDIO_DEF_CHANNELS</a></td> 657</tr> 658<tr> 659<td class="define_keyword">#define</td> 660<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-DEF-FORMAT:CAPS" title="GST_AUDIO_DEF_FORMAT">GST_AUDIO_DEF_FORMAT</a></td> 661</tr> 662<tr> 663<td class="datatype_keyword"> </td> 664<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioBuffer" title="GstAudioBuffer">GstAudioBuffer</a></td> 665</tr> 666<tr> 667<td class="datatype_keyword"> </td> 668<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler">GstAudioResampler</a></td> 669</tr> 670<tr> 671<td class="datatype_keyword">enum</td> 672<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResamplerFilterInterpolation" title="enum GstAudioResamplerFilterInterpolation">GstAudioResamplerFilterInterpolation</a></td> 673</tr> 674<tr> 675<td class="datatype_keyword">enum</td> 676<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResamplerFilterMode" title="enum GstAudioResamplerFilterMode">GstAudioResamplerFilterMode</a></td> 677</tr> 678<tr> 679<td class="datatype_keyword">enum</td> 680<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResamplerFlags" title="enum GstAudioResamplerFlags">GstAudioResamplerFlags</a></td> 681</tr> 682<tr> 683<td class="datatype_keyword">enum</td> 684<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResamplerMethod" title="enum GstAudioResamplerMethod">GstAudioResamplerMethod</a></td> 685</tr> 686<tr> 687<td class="define_keyword">#define</td> 688<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-OPT-CUBIC-B:CAPS" title="GST_AUDIO_RESAMPLER_OPT_CUBIC_B">GST_AUDIO_RESAMPLER_OPT_CUBIC_B</a></td> 689</tr> 690<tr> 691<td class="define_keyword">#define</td> 692<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-OPT-CUBIC-C:CAPS" title="GST_AUDIO_RESAMPLER_OPT_CUBIC_C">GST_AUDIO_RESAMPLER_OPT_CUBIC_C</a></td> 693</tr> 694<tr> 695<td class="define_keyword">#define</td> 696<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-OPT-CUTOFF:CAPS" title="GST_AUDIO_RESAMPLER_OPT_CUTOFF">GST_AUDIO_RESAMPLER_OPT_CUTOFF</a></td> 697</tr> 698<tr> 699<td class="define_keyword">#define</td> 700<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-OPT-FILTER-INTERPOLATION:CAPS" title="GST_AUDIO_RESAMPLER_OPT_FILTER_INTERPOLATION">GST_AUDIO_RESAMPLER_OPT_FILTER_INTERPOLATION</a></td> 701</tr> 702<tr> 703<td class="define_keyword">#define</td> 704<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-OPT-FILTER-MODE:CAPS" title="GST_AUDIO_RESAMPLER_OPT_FILTER_MODE">GST_AUDIO_RESAMPLER_OPT_FILTER_MODE</a></td> 705</tr> 706<tr> 707<td class="define_keyword">#define</td> 708<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-OPT-FILTER-MODE-THRESHOLD:CAPS" title="GST_AUDIO_RESAMPLER_OPT_FILTER_MODE_THRESHOLD">GST_AUDIO_RESAMPLER_OPT_FILTER_MODE_THRESHOLD</a></td> 709</tr> 710<tr> 711<td class="define_keyword">#define</td> 712<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-OPT-FILTER-OVERSAMPLE:CAPS" title="GST_AUDIO_RESAMPLER_OPT_FILTER_OVERSAMPLE">GST_AUDIO_RESAMPLER_OPT_FILTER_OVERSAMPLE</a></td> 713</tr> 714<tr> 715<td class="define_keyword">#define</td> 716<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-OPT-MAX-PHASE-ERROR:CAPS" title="GST_AUDIO_RESAMPLER_OPT_MAX_PHASE_ERROR">GST_AUDIO_RESAMPLER_OPT_MAX_PHASE_ERROR</a></td> 717</tr> 718<tr> 719<td class="define_keyword">#define</td> 720<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-OPT-N-TAPS:CAPS" title="GST_AUDIO_RESAMPLER_OPT_N_TAPS">GST_AUDIO_RESAMPLER_OPT_N_TAPS</a></td> 721</tr> 722<tr> 723<td class="define_keyword">#define</td> 724<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-OPT-STOP-ATTENUATION:CAPS" title="GST_AUDIO_RESAMPLER_OPT_STOP_ATTENUATION">GST_AUDIO_RESAMPLER_OPT_STOP_ATTENUATION</a></td> 725</tr> 726<tr> 727<td class="define_keyword">#define</td> 728<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-OPT-TRANSITION-BANDWIDTH:CAPS" title="GST_AUDIO_RESAMPLER_OPT_TRANSITION_BANDWIDTH">GST_AUDIO_RESAMPLER_OPT_TRANSITION_BANDWIDTH</a></td> 729</tr> 730<tr> 731<td class="define_keyword">#define</td> 732<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-QUALITY-DEFAULT:CAPS" title="GST_AUDIO_RESAMPLER_QUALITY_DEFAULT">GST_AUDIO_RESAMPLER_QUALITY_DEFAULT</a></td> 733</tr> 734<tr> 735<td class="define_keyword">#define</td> 736<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-QUALITY-MAX:CAPS" title="GST_AUDIO_RESAMPLER_QUALITY_MAX">GST_AUDIO_RESAMPLER_QUALITY_MAX</a></td> 737</tr> 738<tr> 739<td class="define_keyword">#define</td> 740<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-QUALITY-MIN:CAPS" title="GST_AUDIO_RESAMPLER_QUALITY_MIN">GST_AUDIO_RESAMPLER_QUALITY_MIN</a></td> 741</tr> 742<tr> 743<td class="datatype_keyword"> </td> 744<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign-struct" title="GstAudioStreamAlign">GstAudioStreamAlign</a></td> 745</tr> 746</tbody> 747</table></div> 748</div> 749<div class="refsect1"> 750<a name="gst-plugins-base-libs-GstAudio.object-hierarchy"></a><h2>Object Hierarchy</h2> 751<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a> 752 <span class="lineart">├──</span> GstAudioInfo 753 <span class="lineart">╰──</span> GstAudioStreamAlign 754 <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a> 755 <span class="lineart">├──</span> GstAudioFormat 756 <span class="lineart">├──</span> GstAudioLayout 757 <span class="lineart">├──</span> GstAudioResamplerFilterInterpolation 758 <span class="lineart">├──</span> GstAudioResamplerFilterMode 759 <span class="lineart">╰──</span> GstAudioResamplerMethod 760 <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a> 761 <span class="lineart">├──</span> GstAudioFlags 762 <span class="lineart">├──</span> GstAudioFormatFlags 763 <span class="lineart">├──</span> GstAudioPackFlags 764 <span class="lineart">╰──</span> GstAudioResamplerFlags 765 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> 766 <span class="lineart">╰──</span> GstAudioFormatInfo 767</pre> 768</div> 769<div class="refsect1"> 770<a name="gst-plugins-base-libs-GstAudio.includes"></a><h2>Includes</h2> 771<pre class="synopsis">#include <gst/audio/audio.h> 772</pre> 773</div> 774<div class="refsect1"> 775<a name="gst-plugins-base-libs-GstAudio.description"></a><h2>Description</h2> 776<p>This library contains some helper functions for audio elements.</p> 777</div> 778<div class="refsect1"> 779<a name="gst-plugins-base-libs-GstAudio.functions_details"></a><h2>Functions</h2> 780<div class="refsect2"> 781<a name="GstAudioFormatPack"></a><h3>GstAudioFormatPack ()</h3> 782<pre class="programlisting"><span class="returnvalue">void</span> 783<span class="c_punctuation">(</span>*GstAudioFormatPack<span class="c_punctuation">)</span> (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatInfo"><span class="type">GstAudioFormatInfo</span></a> *info</code></em>, 784 <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioPackFlags" title="enum GstAudioPackFlags"><span class="type">GstAudioPackFlags</span></a> flags</code></em>, 785 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> src</code></em>, 786 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>, 787 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> length</code></em>);</pre> 788<p>Packs <em class="parameter"><code>length</code></em> 789 samples from <em class="parameter"><code>src</code></em> 790 to the data array in format <em class="parameter"><code>info</code></em> 791. 792The samples from source have each channel interleaved 793and will be packed into <em class="parameter"><code>data</code></em> 794.</p> 795<div class="refsect3"> 796<a name="GstAudioFormatPack.parameters"></a><h4>Parameters</h4> 797<div class="informaltable"><table class="informaltable" width="100%" border="0"> 798<colgroup> 799<col width="150px" class="parameters_name"> 800<col class="parameters_description"> 801<col width="200px" class="parameters_annotations"> 802</colgroup> 803<tbody> 804<tr> 805<td class="parameter_name"><p>info</p></td> 806<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatInfo"><span class="type">GstAudioFormatInfo</span></a></p></td> 807<td class="parameter_annotations"> </td> 808</tr> 809<tr> 810<td class="parameter_name"><p>flags</p></td> 811<td class="parameter_description"><p><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioPackFlags" title="enum GstAudioPackFlags"><span class="type">GstAudioPackFlags</span></a></p></td> 812<td class="parameter_annotations"> </td> 813</tr> 814<tr> 815<td class="parameter_name"><p>src</p></td> 816<td class="parameter_description"><p>a source array. </p></td> 817<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> 818</tr> 819<tr> 820<td class="parameter_name"><p>data</p></td> 821<td class="parameter_description"><p>pointer to the destination 822data. </p></td> 823<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> 824</tr> 825<tr> 826<td class="parameter_name"><p>length</p></td> 827<td class="parameter_description"><p>the amount of samples to pack.</p></td> 828<td class="parameter_annotations"> </td> 829</tr> 830</tbody> 831</table></div> 832</div> 833</div> 834<hr> 835<div class="refsect2"> 836<a name="GstAudioFormatUnpack"></a><h3>GstAudioFormatUnpack ()</h3> 837<pre class="programlisting"><span class="returnvalue">void</span> 838<span class="c_punctuation">(</span>*GstAudioFormatUnpack<span class="c_punctuation">)</span> (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatInfo"><span class="type">GstAudioFormatInfo</span></a> *info</code></em>, 839 <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioPackFlags" title="enum GstAudioPackFlags"><span class="type">GstAudioPackFlags</span></a> flags</code></em>, 840 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> dest</code></em>, 841 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> data</code></em>, 842 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> length</code></em>);</pre> 843<p>Unpacks <em class="parameter"><code>length</code></em> 844 samples from the given data of format <em class="parameter"><code>info</code></em> 845. 846The samples will be unpacked into <em class="parameter"><code>dest</code></em> 847 which each channel 848interleaved. <em class="parameter"><code>dest</code></em> 849 should at least be big enough to hold <em class="parameter"><code>length</code></em> 850 * 851channels * size(unpack_format) bytes.</p> 852<div class="refsect3"> 853<a name="GstAudioFormatUnpack.parameters"></a><h4>Parameters</h4> 854<div class="informaltable"><table class="informaltable" width="100%" border="0"> 855<colgroup> 856<col width="150px" class="parameters_name"> 857<col class="parameters_description"> 858<col width="200px" class="parameters_annotations"> 859</colgroup> 860<tbody> 861<tr> 862<td class="parameter_name"><p>info</p></td> 863<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatInfo"><span class="type">GstAudioFormatInfo</span></a></p></td> 864<td class="parameter_annotations"> </td> 865</tr> 866<tr> 867<td class="parameter_name"><p>flags</p></td> 868<td class="parameter_description"><p><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioPackFlags" title="enum GstAudioPackFlags"><span class="type">GstAudioPackFlags</span></a></p></td> 869<td class="parameter_annotations"> </td> 870</tr> 871<tr> 872<td class="parameter_name"><p>dest</p></td> 873<td class="parameter_description"><p>a destination array. </p></td> 874<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> 875</tr> 876<tr> 877<td class="parameter_name"><p>data</p></td> 878<td class="parameter_description"><p>pointer to the audio data. </p></td> 879<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> 880</tr> 881<tr> 882<td class="parameter_name"><p>length</p></td> 883<td class="parameter_description"><p>the amount of samples to unpack.</p></td> 884<td class="parameter_annotations"> </td> 885</tr> 886</tbody> 887</table></div> 888</div> 889</div> 890<hr> 891<div class="refsect2"> 892<a name="gst-audio-info-init"></a><h3>gst_audio_info_init ()</h3> 893<pre class="programlisting"><span class="returnvalue">void</span> 894gst_audio_info_init (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);</pre> 895<p>Initialize <em class="parameter"><code>info</code></em> 896 with default values.</p> 897<div class="refsect3"> 898<a name="gst-audio-info-init.parameters"></a><h4>Parameters</h4> 899<div class="informaltable"><table class="informaltable" width="100%" border="0"> 900<colgroup> 901<col width="150px" class="parameters_name"> 902<col class="parameters_description"> 903<col width="200px" class="parameters_annotations"> 904</colgroup> 905<tbody><tr> 906<td class="parameter_name"><p>info</p></td> 907<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a></p></td> 908<td class="parameter_annotations"> </td> 909</tr></tbody> 910</table></div> 911</div> 912</div> 913<hr> 914<div class="refsect2"> 915<a name="gst-audio-info-from-caps"></a><h3>gst_audio_info_from_caps ()</h3> 916<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 917gst_audio_info_from_caps (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>, 918 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a> *caps</code></em>);</pre> 919<p>Parse <em class="parameter"><code>caps</code></em> 920 and update <em class="parameter"><code>info</code></em> 921.</p> 922<div class="refsect3"> 923<a name="gst-audio-info-from-caps.parameters"></a><h4>Parameters</h4> 924<div class="informaltable"><table class="informaltable" width="100%" border="0"> 925<colgroup> 926<col width="150px" class="parameters_name"> 927<col class="parameters_description"> 928<col width="200px" class="parameters_annotations"> 929</colgroup> 930<tbody> 931<tr> 932<td class="parameter_name"><p>info</p></td> 933<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a></p></td> 934<td class="parameter_annotations"> </td> 935</tr> 936<tr> 937<td class="parameter_name"><p>caps</p></td> 938<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a></p></td> 939<td class="parameter_annotations"> </td> 940</tr> 941</tbody> 942</table></div> 943</div> 944<div class="refsect3"> 945<a name="gst-audio-info-from-caps.returns"></a><h4>Returns</h4> 946<p> TRUE if <em class="parameter"><code>caps</code></em> 947could be parsed</p> 948</div> 949</div> 950<hr> 951<div class="refsect2"> 952<a name="gst-audio-info-to-caps"></a><h3>gst_audio_info_to_caps ()</h3> 953<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="returnvalue">GstCaps</span></a> * 954gst_audio_info_to_caps (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);</pre> 955<p>Convert the values of <em class="parameter"><code>info</code></em> 956 into a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a>.</p> 957<div class="refsect3"> 958<a name="gst-audio-info-to-caps.parameters"></a><h4>Parameters</h4> 959<div class="informaltable"><table class="informaltable" width="100%" border="0"> 960<colgroup> 961<col width="150px" class="parameters_name"> 962<col class="parameters_description"> 963<col width="200px" class="parameters_annotations"> 964</colgroup> 965<tbody><tr> 966<td class="parameter_name"><p>info</p></td> 967<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a></p></td> 968<td class="parameter_annotations"> </td> 969</tr></tbody> 970</table></div> 971</div> 972<div class="refsect3"> 973<a name="gst-audio-info-to-caps.returns"></a><h4>Returns</h4> 974<p>the new <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a> containing the 975info of <em class="parameter"><code>info</code></em> 976. </p> 977<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> 978</div> 979</div> 980<hr> 981<div class="refsect2"> 982<a name="gst-audio-info-convert"></a><h3>gst_audio_info_convert ()</h3> 983<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 984gst_audio_info_convert (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>, 985 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> src_fmt</code></em>, 986 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> src_val</code></em>, 987 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> dest_fmt</code></em>, 988 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> *dest_val</code></em>);</pre> 989<p>Converts among various <a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> types. This function handles 990GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For 991raw audio, GST_FORMAT_DEFAULT corresponds to audio frames. This 992function can be used to handle pad queries of the type GST_QUERY_CONVERT.</p> 993<div class="refsect3"> 994<a name="gst-audio-info-convert.parameters"></a><h4>Parameters</h4> 995<div class="informaltable"><table class="informaltable" width="100%" border="0"> 996<colgroup> 997<col width="150px" class="parameters_name"> 998<col class="parameters_description"> 999<col width="200px" class="parameters_annotations"> 1000</colgroup> 1001<tbody> 1002<tr> 1003<td class="parameter_name"><p>info</p></td> 1004<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a></p></td> 1005<td class="parameter_annotations"> </td> 1006</tr> 1007<tr> 1008<td class="parameter_name"><p>src_fmt</p></td> 1009<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> of the <em class="parameter"><code>src_val</code></em> 1010</p></td> 1011<td class="parameter_annotations"> </td> 1012</tr> 1013<tr> 1014<td class="parameter_name"><p>src_val</p></td> 1015<td class="parameter_description"><p>value to convert</p></td> 1016<td class="parameter_annotations"> </td> 1017</tr> 1018<tr> 1019<td class="parameter_name"><p>dest_fmt</p></td> 1020<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> of the <em class="parameter"><code>dest_val</code></em> 1021</p></td> 1022<td class="parameter_annotations"> </td> 1023</tr> 1024<tr> 1025<td class="parameter_name"><p>dest_val</p></td> 1026<td class="parameter_description"><p>pointer to destination value. </p></td> 1027<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 1028</tr> 1029</tbody> 1030</table></div> 1031</div> 1032<div class="refsect3"> 1033<a name="gst-audio-info-convert.returns"></a><h4>Returns</h4> 1034<p> TRUE if the conversion was successful.</p> 1035</div> 1036</div> 1037<hr> 1038<div class="refsect2"> 1039<a name="gst-audio-format-get-info"></a><h3>gst_audio_format_get_info ()</h3> 1040<pre class="programlisting">const <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatInfo"><span class="returnvalue">GstAudioFormatInfo</span></a> * 1041gst_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> 1042<p>Get the <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatInfo"><span class="type">GstAudioFormatInfo</span></a> for <em class="parameter"><code>format</code></em> 1043</p> 1044<div class="refsect3"> 1045<a name="gst-audio-format-get-info.parameters"></a><h4>Parameters</h4> 1046<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1047<colgroup> 1048<col width="150px" class="parameters_name"> 1049<col class="parameters_description"> 1050<col width="200px" class="parameters_annotations"> 1051</colgroup> 1052<tbody><tr> 1053<td class="parameter_name"><p>format</p></td> 1054<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="type">GstAudioFormat</span></a></p></td> 1055<td class="parameter_annotations"> </td> 1056</tr></tbody> 1057</table></div> 1058</div> 1059<div class="refsect3"> 1060<a name="gst-audio-format-get-info.returns"></a><h4>Returns</h4> 1061<p> The <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatInfo"><span class="type">GstAudioFormatInfo</span></a> for <em class="parameter"><code>format</code></em> 1062.</p> 1063</div> 1064</div> 1065<hr> 1066<div class="refsect2"> 1067<a name="gst-audio-info-copy"></a><h3>gst_audio_info_copy ()</h3> 1068<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="returnvalue">GstAudioInfo</span></a> * 1069gst_audio_info_copy (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);</pre> 1070<p>Copy a GstAudioInfo structure.</p> 1071<div class="refsect3"> 1072<a name="gst-audio-info-copy.parameters"></a><h4>Parameters</h4> 1073<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1074<colgroup> 1075<col width="150px" class="parameters_name"> 1076<col class="parameters_description"> 1077<col width="200px" class="parameters_annotations"> 1078</colgroup> 1079<tbody><tr> 1080<td class="parameter_name"><p>info</p></td> 1081<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a></p></td> 1082<td class="parameter_annotations"> </td> 1083</tr></tbody> 1084</table></div> 1085</div> 1086<div class="refsect3"> 1087<a name="gst-audio-info-copy.returns"></a><h4>Returns</h4> 1088<p> a new <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a>. free with gst_audio_info_free.</p> 1089</div> 1090</div> 1091<hr> 1092<div class="refsect2"> 1093<a name="gst-audio-info-free"></a><h3>gst_audio_info_free ()</h3> 1094<pre class="programlisting"><span class="returnvalue">void</span> 1095gst_audio_info_free (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);</pre> 1096<p>Free a GstAudioInfo structure previously allocated with <a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-info-new" title="gst_audio_info_new ()"><code class="function">gst_audio_info_new()</code></a> 1097or <a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-info-copy" title="gst_audio_info_copy ()"><code class="function">gst_audio_info_copy()</code></a>.</p> 1098<div class="refsect3"> 1099<a name="gst-audio-info-free.parameters"></a><h4>Parameters</h4> 1100<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1101<colgroup> 1102<col width="150px" class="parameters_name"> 1103<col class="parameters_description"> 1104<col width="200px" class="parameters_annotations"> 1105</colgroup> 1106<tbody><tr> 1107<td class="parameter_name"><p>info</p></td> 1108<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a></p></td> 1109<td class="parameter_annotations"> </td> 1110</tr></tbody> 1111</table></div> 1112</div> 1113</div> 1114<hr> 1115<div class="refsect2"> 1116<a name="gst-audio-info-new"></a><h3>gst_audio_info_new ()</h3> 1117<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="returnvalue">GstAudioInfo</span></a> * 1118gst_audio_info_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> 1119<p>Allocate a new <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> that is also initialized with 1120<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-info-init" title="gst_audio_info_init ()"><code class="function">gst_audio_info_init()</code></a>.</p> 1121<div class="refsect3"> 1122<a name="gst-audio-info-new.returns"></a><h4>Returns</h4> 1123<p> a new <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a>. free with <a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-info-free" title="gst_audio_info_free ()"><code class="function">gst_audio_info_free()</code></a>.</p> 1124</div> 1125</div> 1126<hr> 1127<div class="refsect2"> 1128<a name="gst-audio-info-set-format"></a><h3>gst_audio_info_set_format ()</h3> 1129<pre class="programlisting"><span class="returnvalue">void</span> 1130gst_audio_info_set_format (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>, 1131 <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>, 1132 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> rate</code></em>, 1133 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> channels</code></em>, 1134 <em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-Audio-channels.html#GstAudioChannelPosition" title="enum GstAudioChannelPosition"><span class="type">GstAudioChannelPosition</span></a> *position</code></em>);</pre> 1135<p>Set the default info for the audio info of <em class="parameter"><code>format</code></em> 1136 and <em class="parameter"><code>rate</code></em> 1137 and <em class="parameter"><code>channels</code></em> 1138.</p> 1139<p>Note: This initializes <em class="parameter"><code>info</code></em> 1140 first, no values are preserved.</p> 1141<div class="refsect3"> 1142<a name="gst-audio-info-set-format.parameters"></a><h4>Parameters</h4> 1143<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1144<colgroup> 1145<col width="150px" class="parameters_name"> 1146<col class="parameters_description"> 1147<col width="200px" class="parameters_annotations"> 1148</colgroup> 1149<tbody> 1150<tr> 1151<td class="parameter_name"><p>info</p></td> 1152<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a></p></td> 1153<td class="parameter_annotations"> </td> 1154</tr> 1155<tr> 1156<td class="parameter_name"><p>format</p></td> 1157<td class="parameter_description"><p>the format</p></td> 1158<td class="parameter_annotations"> </td> 1159</tr> 1160<tr> 1161<td class="parameter_name"><p>rate</p></td> 1162<td class="parameter_description"><p>the samplerate</p></td> 1163<td class="parameter_annotations"> </td> 1164</tr> 1165<tr> 1166<td class="parameter_name"><p>channels</p></td> 1167<td class="parameter_description"><p>the number of channels</p></td> 1168<td class="parameter_annotations"> </td> 1169</tr> 1170<tr> 1171<td class="parameter_name"><p>position</p></td> 1172<td class="parameter_description"><p>the channel positions. </p></td> 1173<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> fixed-size=64][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> 1174</tr> 1175</tbody> 1176</table></div> 1177</div> 1178</div> 1179<hr> 1180<div class="refsect2"> 1181<a name="gst-audio-info-is-equal"></a><h3>gst_audio_info_is_equal ()</h3> 1182<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 1183gst_audio_info_is_equal (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>, 1184 <em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> *other</code></em>);</pre> 1185<p>Compares two <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> and returns whether they are equal or not</p> 1186<div class="refsect3"> 1187<a name="gst-audio-info-is-equal.parameters"></a><h4>Parameters</h4> 1188<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1189<colgroup> 1190<col width="150px" class="parameters_name"> 1191<col class="parameters_description"> 1192<col width="200px" class="parameters_annotations"> 1193</colgroup> 1194<tbody> 1195<tr> 1196<td class="parameter_name"><p>info</p></td> 1197<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a></p></td> 1198<td class="parameter_annotations"> </td> 1199</tr> 1200<tr> 1201<td class="parameter_name"><p>other</p></td> 1202<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a></p></td> 1203<td class="parameter_annotations"> </td> 1204</tr> 1205</tbody> 1206</table></div> 1207</div> 1208<div class="refsect3"> 1209<a name="gst-audio-info-is-equal.returns"></a><h4>Returns</h4> 1210<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>info</code></em> 1211and <em class="parameter"><code>other</code></em> 1212are equal, else <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> 1213</div> 1214<p class="since">Since: <a class="link" href="ix14.html#api-index-1.2">1.2</a></p> 1215</div> 1216<hr> 1217<div class="refsect2"> 1218<a name="gst-audio-format-build-integer"></a><h3>gst_audio_format_build_integer ()</h3> 1219<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="returnvalue">GstAudioFormat</span></a> 1220gst_audio_format_build_integer (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> sign</code></em>, 1221 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> endianness</code></em>, 1222 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>, 1223 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> depth</code></em>);</pre> 1224<p>Construct a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="type">GstAudioFormat</span></a> with given parameters.</p> 1225<div class="refsect3"> 1226<a name="gst-audio-format-build-integer.parameters"></a><h4>Parameters</h4> 1227<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1228<colgroup> 1229<col width="150px" class="parameters_name"> 1230<col class="parameters_description"> 1231<col width="200px" class="parameters_annotations"> 1232</colgroup> 1233<tbody> 1234<tr> 1235<td class="parameter_name"><p>sign</p></td> 1236<td class="parameter_description"><p>signed or unsigned format</p></td> 1237<td class="parameter_annotations"> </td> 1238</tr> 1239<tr> 1240<td class="parameter_name"><p>endianness</p></td> 1241<td class="parameter_description"><p>G_LITTLE_ENDIAN or G_BIG_ENDIAN</p></td> 1242<td class="parameter_annotations"> </td> 1243</tr> 1244<tr> 1245<td class="parameter_name"><p>width</p></td> 1246<td class="parameter_description"><p>amount of bits used per sample</p></td> 1247<td class="parameter_annotations"> </td> 1248</tr> 1249<tr> 1250<td class="parameter_name"><p>depth</p></td> 1251<td class="parameter_description"><p>amount of used bits in <em class="parameter"><code>width</code></em> 1252</p></td> 1253<td class="parameter_annotations"> </td> 1254</tr> 1255</tbody> 1256</table></div> 1257</div> 1258<div class="refsect3"> 1259<a name="gst-audio-format-build-integer.returns"></a><h4>Returns</h4> 1260<p> a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="type">GstAudioFormat</span></a> or GST_AUDIO_FORMAT_UNKNOWN when no audio format 1261exists with the given parameters.</p> 1262</div> 1263</div> 1264<hr> 1265<div class="refsect2"> 1266<a name="gst-audio-format-fill-silence"></a><h3>gst_audio_format_fill_silence ()</h3> 1267<pre class="programlisting"><span class="returnvalue">void</span> 1268gst_audio_format_fill_silence (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatInfo"><span class="type">GstAudioFormatInfo</span></a> *info</code></em>, 1269 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> dest</code></em>, 1270 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> length</code></em>);</pre> 1271<p>Fill <em class="parameter"><code>length</code></em> 1272 bytes in <em class="parameter"><code>dest</code></em> 1273 with silence samples for <em class="parameter"><code>info</code></em> 1274.</p> 1275<div class="refsect3"> 1276<a name="gst-audio-format-fill-silence.parameters"></a><h4>Parameters</h4> 1277<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1278<colgroup> 1279<col width="150px" class="parameters_name"> 1280<col class="parameters_description"> 1281<col width="200px" class="parameters_annotations"> 1282</colgroup> 1283<tbody> 1284<tr> 1285<td class="parameter_name"><p>info</p></td> 1286<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatInfo"><span class="type">GstAudioFormatInfo</span></a></p></td> 1287<td class="parameter_annotations"> </td> 1288</tr> 1289<tr> 1290<td class="parameter_name"><p>dest</p></td> 1291<td class="parameter_description"><p>a destination 1292to fill. </p></td> 1293<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> 1294</tr> 1295<tr> 1296<td class="parameter_name"><p>length</p></td> 1297<td class="parameter_description"><p>the length to fill</p></td> 1298<td class="parameter_annotations"> </td> 1299</tr> 1300</tbody> 1301</table></div> 1302</div> 1303</div> 1304<hr> 1305<div class="refsect2"> 1306<a name="gst-audio-format-from-string"></a><h3>gst_audio_format_from_string ()</h3> 1307<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="returnvalue">GstAudioFormat</span></a> 1308gst_audio_format_from_string (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>);</pre> 1309<p>Convert the <em class="parameter"><code>format</code></em> 1310 string to its <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="type">GstAudioFormat</span></a>.</p> 1311<div class="refsect3"> 1312<a name="gst-audio-format-from-string.parameters"></a><h4>Parameters</h4> 1313<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1314<colgroup> 1315<col width="150px" class="parameters_name"> 1316<col class="parameters_description"> 1317<col width="200px" class="parameters_annotations"> 1318</colgroup> 1319<tbody><tr> 1320<td class="parameter_name"><p>format</p></td> 1321<td class="parameter_description"><p>a format string</p></td> 1322<td class="parameter_annotations"> </td> 1323</tr></tbody> 1324</table></div> 1325</div> 1326<div class="refsect3"> 1327<a name="gst-audio-format-from-string.returns"></a><h4>Returns</h4> 1328<p> the <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="type">GstAudioFormat</span></a> for <em class="parameter"><code>format</code></em> 1329or GST_AUDIO_FORMAT_UNKNOWN when the 1330string is not a known format.</p> 1331</div> 1332</div> 1333<hr> 1334<div class="refsect2"> 1335<a name="gst-audio-format-to-string"></a><h3>gst_audio_format_to_string ()</h3> 1336<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * 1337gst_audio_format_to_string (<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> 1338</div> 1339<hr> 1340<div class="refsect2"> 1341<a name="GST-AUDIO-FORMAT-INFO-DEPTH:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_DEPTH()</h3> 1342<pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_DEPTH(info) ((info)->depth) 1343</pre> 1344</div> 1345<hr> 1346<div class="refsect2"> 1347<a name="GST-AUDIO-FORMAT-INFO-ENDIANNESS:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_ENDIANNESS()</h3> 1348<pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_ENDIANNESS(info) ((info)->endianness) 1349</pre> 1350</div> 1351<hr> 1352<div class="refsect2"> 1353<a name="GST-AUDIO-FORMAT-INFO-FLAGS:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_FLAGS()</h3> 1354<pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_FLAGS(info) ((info)->flags) 1355</pre> 1356</div> 1357<hr> 1358<div class="refsect2"> 1359<a name="GST-AUDIO-FORMAT-INFO-FORMAT:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_FORMAT()</h3> 1360<pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_FORMAT(info) ((info)->format) 1361</pre> 1362</div> 1363<hr> 1364<div class="refsect2"> 1365<a name="GST-AUDIO-FORMAT-INFO-IS-FLOAT:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_IS_FLOAT()</h3> 1366<pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_IS_FLOAT(info) !!((info)->flags & GST_AUDIO_FORMAT_FLAG_FLOAT) 1367</pre> 1368</div> 1369<hr> 1370<div class="refsect2"> 1371<a name="GST-AUDIO-FORMAT-INFO-IS-INTEGER:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_IS_INTEGER()</h3> 1372<pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_IS_INTEGER(info) !!((info)->flags & GST_AUDIO_FORMAT_FLAG_INTEGER) 1373</pre> 1374</div> 1375<hr> 1376<div class="refsect2"> 1377<a name="GST-AUDIO-FORMAT-INFO-IS-BIG-ENDIAN:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN()</h3> 1378<pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN(info) ((info)->endianness == G_BIG_ENDIAN) 1379</pre> 1380</div> 1381<hr> 1382<div class="refsect2"> 1383<a name="GST-AUDIO-FORMAT-INFO-IS-LITTLE-ENDIAN:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN()</h3> 1384<pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN(info) ((info)->endianness == G_LITTLE_ENDIAN) 1385</pre> 1386</div> 1387<hr> 1388<div class="refsect2"> 1389<a name="GST-AUDIO-FORMAT-INFO-IS-SIGNED:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_IS_SIGNED()</h3> 1390<pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_IS_SIGNED(info) !!((info)->flags & GST_AUDIO_FORMAT_FLAG_SIGNED) 1391</pre> 1392</div> 1393<hr> 1394<div class="refsect2"> 1395<a name="GST-AUDIO-FORMAT-INFO-NAME:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_NAME()</h3> 1396<pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_NAME(info) ((info)->name) 1397</pre> 1398</div> 1399<hr> 1400<div class="refsect2"> 1401<a name="GST-AUDIO-FORMAT-INFO-WIDTH:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_WIDTH()</h3> 1402<pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_WIDTH(info) ((info)->width) 1403</pre> 1404</div> 1405<hr> 1406<div class="refsect2"> 1407<a name="GST-AUDIO-INFO-BPF:CAPS"></a><h3>GST_AUDIO_INFO_BPF()</h3> 1408<pre class="programlisting">#define GST_AUDIO_INFO_BPF(info) ((info)->bpf) 1409</pre> 1410</div> 1411<hr> 1412<div class="refsect2"> 1413<a name="GST-AUDIO-INFO-BPS:CAPS"></a><h3>GST_AUDIO_INFO_BPS()</h3> 1414<pre class="programlisting">#define GST_AUDIO_INFO_BPS(info) (GST_AUDIO_INFO_DEPTH(info) >> 3) 1415</pre> 1416</div> 1417<hr> 1418<div class="refsect2"> 1419<a name="GST-AUDIO-INFO-CHANNELS:CAPS"></a><h3>GST_AUDIO_INFO_CHANNELS()</h3> 1420<pre class="programlisting">#define GST_AUDIO_INFO_CHANNELS(info) ((info)->channels) 1421</pre> 1422</div> 1423<hr> 1424<div class="refsect2"> 1425<a name="GST-AUDIO-INFO-DEPTH:CAPS"></a><h3>GST_AUDIO_INFO_DEPTH()</h3> 1426<pre class="programlisting">#define GST_AUDIO_INFO_DEPTH(i) (GST_AUDIO_FORMAT_INFO_DEPTH((i)->finfo)) 1427</pre> 1428</div> 1429<hr> 1430<div class="refsect2"> 1431<a name="GST-AUDIO-INFO-FLAGS:CAPS"></a><h3>GST_AUDIO_INFO_FLAGS()</h3> 1432<pre class="programlisting">#define GST_AUDIO_INFO_FLAGS(info) ((info)->flags) 1433</pre> 1434</div> 1435<hr> 1436<div class="refsect2"> 1437<a name="GST-AUDIO-INFO-FORMAT:CAPS"></a><h3>GST_AUDIO_INFO_FORMAT()</h3> 1438<pre class="programlisting">#define GST_AUDIO_INFO_FORMAT(i) (GST_AUDIO_FORMAT_INFO_FORMAT((i)->finfo)) 1439</pre> 1440</div> 1441<hr> 1442<div class="refsect2"> 1443<a name="GST-AUDIO-INFO-NAME:CAPS"></a><h3>GST_AUDIO_INFO_NAME()</h3> 1444<pre class="programlisting">#define GST_AUDIO_INFO_NAME(i) (GST_AUDIO_FORMAT_INFO_NAME((i)->finfo)) 1445</pre> 1446</div> 1447<hr> 1448<div class="refsect2"> 1449<a name="GST-AUDIO-INFO-POSITION:CAPS"></a><h3>GST_AUDIO_INFO_POSITION()</h3> 1450<pre class="programlisting">#define GST_AUDIO_INFO_POSITION(info,c) ((info)->position[c]) 1451</pre> 1452</div> 1453<hr> 1454<div class="refsect2"> 1455<a name="GST-AUDIO-INFO-RATE:CAPS"></a><h3>GST_AUDIO_INFO_RATE()</h3> 1456<pre class="programlisting">#define GST_AUDIO_INFO_RATE(info) ((info)->rate) 1457</pre> 1458</div> 1459<hr> 1460<div class="refsect2"> 1461<a name="GST-AUDIO-INFO-WIDTH:CAPS"></a><h3>GST_AUDIO_INFO_WIDTH()</h3> 1462<pre class="programlisting">#define GST_AUDIO_INFO_WIDTH(i) (GST_AUDIO_FORMAT_INFO_WIDTH((i)->finfo)) 1463</pre> 1464</div> 1465<hr> 1466<div class="refsect2"> 1467<a name="GST-AUDIO-INFO-ENDIANNESS:CAPS"></a><h3>GST_AUDIO_INFO_ENDIANNESS()</h3> 1468<pre class="programlisting">#define GST_AUDIO_INFO_ENDIANNESS(i) (GST_AUDIO_FORMAT_INFO_ENDIANNESS((i)->finfo)) 1469</pre> 1470</div> 1471<hr> 1472<div class="refsect2"> 1473<a name="GST-AUDIO-INFO-IS-BIG-ENDIAN:CAPS"></a><h3>GST_AUDIO_INFO_IS_BIG_ENDIAN()</h3> 1474<pre class="programlisting">#define GST_AUDIO_INFO_IS_BIG_ENDIAN(i) (GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN((i)->finfo)) 1475</pre> 1476</div> 1477<hr> 1478<div class="refsect2"> 1479<a name="GST-AUDIO-INFO-IS-FLOAT:CAPS"></a><h3>GST_AUDIO_INFO_IS_FLOAT()</h3> 1480<pre class="programlisting">#define GST_AUDIO_INFO_IS_FLOAT(i) (GST_AUDIO_FORMAT_INFO_IS_FLOAT((i)->finfo)) 1481</pre> 1482</div> 1483<hr> 1484<div class="refsect2"> 1485<a name="GST-AUDIO-INFO-IS-INTEGER:CAPS"></a><h3>GST_AUDIO_INFO_IS_INTEGER()</h3> 1486<pre class="programlisting">#define GST_AUDIO_INFO_IS_INTEGER(i) (GST_AUDIO_FORMAT_INFO_IS_INTEGER((i)->finfo)) 1487</pre> 1488</div> 1489<hr> 1490<div class="refsect2"> 1491<a name="GST-AUDIO-INFO-IS-LITTLE-ENDIAN:CAPS"></a><h3>GST_AUDIO_INFO_IS_LITTLE_ENDIAN()</h3> 1492<pre class="programlisting">#define GST_AUDIO_INFO_IS_LITTLE_ENDIAN(i) (GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN((i)->finfo)) 1493</pre> 1494</div> 1495<hr> 1496<div class="refsect2"> 1497<a name="GST-AUDIO-INFO-IS-SIGNED:CAPS"></a><h3>GST_AUDIO_INFO_IS_SIGNED()</h3> 1498<pre class="programlisting">#define GST_AUDIO_INFO_IS_SIGNED(i) (GST_AUDIO_FORMAT_INFO_IS_SIGNED((i)->finfo)) 1499</pre> 1500</div> 1501<hr> 1502<div class="refsect2"> 1503<a name="GST-AUDIO-INFO-IS-UNPOSITIONED:CAPS"></a><h3>GST_AUDIO_INFO_IS_UNPOSITIONED()</h3> 1504<pre class="programlisting">#define GST_AUDIO_INFO_IS_UNPOSITIONED(info) ((info)->flags & GST_AUDIO_FLAG_UNPOSITIONED) 1505</pre> 1506</div> 1507<hr> 1508<div class="refsect2"> 1509<a name="GST-AUDIO-INFO-IS-VALID:CAPS"></a><h3>GST_AUDIO_INFO_IS_VALID()</h3> 1510<pre class="programlisting">#define GST_AUDIO_INFO_IS_VALID(i) ((i)->finfo != NULL && (i)->rate > 0 && (i)->channels > 0 && (i)->bpf > 0) 1511</pre> 1512</div> 1513<hr> 1514<div class="refsect2"> 1515<a name="GST-AUDIO-INFO-LAYOUT:CAPS"></a><h3>GST_AUDIO_INFO_LAYOUT()</h3> 1516<pre class="programlisting">#define GST_AUDIO_INFO_LAYOUT(info) ((info)->layout) 1517</pre> 1518</div> 1519<hr> 1520<div class="refsect2"> 1521<a name="GST-FRAMES-TO-CLOCK-TIME:CAPS"></a><h3>GST_FRAMES_TO_CLOCK_TIME()</h3> 1522<pre class="programlisting">#define GST_FRAMES_TO_CLOCK_TIME(frames, rate)</pre> 1523<p>Calculate clocktime from sample <em class="parameter"><code>frames</code></em> 1524 and <em class="parameter"><code>rate</code></em> 1525.</p> 1526<div class="refsect3"> 1527<a name="GST-FRAMES-TO-CLOCK-TIME.parameters"></a><h4>Parameters</h4> 1528<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1529<colgroup> 1530<col width="150px" class="parameters_name"> 1531<col class="parameters_description"> 1532<col width="200px" class="parameters_annotations"> 1533</colgroup> 1534<tbody> 1535<tr> 1536<td class="parameter_name"><p>frames</p></td> 1537<td class="parameter_description"><p>sample frames</p></td> 1538<td class="parameter_annotations"> </td> 1539</tr> 1540<tr> 1541<td class="parameter_name"><p>rate</p></td> 1542<td class="parameter_description"><p>sampling rate</p></td> 1543<td class="parameter_annotations"> </td> 1544</tr> 1545</tbody> 1546</table></div> 1547</div> 1548</div> 1549<hr> 1550<div class="refsect2"> 1551<a name="GST-CLOCK-TIME-TO-FRAMES:CAPS"></a><h3>GST_CLOCK_TIME_TO_FRAMES()</h3> 1552<pre class="programlisting">#define GST_CLOCK_TIME_TO_FRAMES(clocktime, rate)</pre> 1553<p>Calculate frames from <em class="parameter"><code>clocktime</code></em> 1554 and sample <em class="parameter"><code>rate</code></em> 1555.</p> 1556<div class="refsect3"> 1557<a name="GST-CLOCK-TIME-TO-FRAMES.parameters"></a><h4>Parameters</h4> 1558<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1559<colgroup> 1560<col width="150px" class="parameters_name"> 1561<col class="parameters_description"> 1562<col width="200px" class="parameters_annotations"> 1563</colgroup> 1564<tbody> 1565<tr> 1566<td class="parameter_name"><p>clocktime</p></td> 1567<td class="parameter_description"><p>clock time</p></td> 1568<td class="parameter_annotations"> </td> 1569</tr> 1570<tr> 1571<td class="parameter_name"><p>rate</p></td> 1572<td class="parameter_description"><p>sampling rate</p></td> 1573<td class="parameter_annotations"> </td> 1574</tr> 1575</tbody> 1576</table></div> 1577</div> 1578</div> 1579<hr> 1580<div class="refsect2"> 1581<a name="GST-AUDIO-NE:CAPS"></a><h3>GST_AUDIO_NE()</h3> 1582<pre class="programlisting"># define GST_AUDIO_NE(s) G_STRINGIFY(s)"LE" 1583</pre> 1584<p>Turns audio format string <em class="parameter"><code>s</code></em> 1585 into the format string for native endianness.</p> 1586<div class="refsect3"> 1587<a name="GST-AUDIO-NE.parameters"></a><h4>Parameters</h4> 1588<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1589<colgroup> 1590<col width="150px" class="parameters_name"> 1591<col class="parameters_description"> 1592<col width="200px" class="parameters_annotations"> 1593</colgroup> 1594<tbody><tr> 1595<td class="parameter_name"><p>s</p></td> 1596<td class="parameter_description"><p>format string without endianness marker</p></td> 1597<td class="parameter_annotations"> </td> 1598</tr></tbody> 1599</table></div> 1600</div> 1601</div> 1602<hr> 1603<div class="refsect2"> 1604<a name="GST-AUDIO-OE:CAPS"></a><h3>GST_AUDIO_OE()</h3> 1605<pre class="programlisting"># define GST_AUDIO_OE(s) G_STRINGIFY(s)"BE" 1606</pre> 1607<p>Turns audio format string <em class="parameter"><code>s</code></em> 1608 into the format string for other endianness.</p> 1609<div class="refsect3"> 1610<a name="GST-AUDIO-OE.parameters"></a><h4>Parameters</h4> 1611<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1612<colgroup> 1613<col width="150px" class="parameters_name"> 1614<col class="parameters_description"> 1615<col width="200px" class="parameters_annotations"> 1616</colgroup> 1617<tbody><tr> 1618<td class="parameter_name"><p>s</p></td> 1619<td class="parameter_description"><p>format string without endianness marker</p></td> 1620<td class="parameter_annotations"> </td> 1621</tr></tbody> 1622</table></div> 1623</div> 1624</div> 1625<hr> 1626<div class="refsect2"> 1627<a name="GST-AUDIO-CAPS-MAKE:CAPS"></a><h3>GST_AUDIO_CAPS_MAKE()</h3> 1628<pre class="programlisting">#define GST_AUDIO_CAPS_MAKE(format)</pre> 1629<p>Generic caps string for audio, for use in pad templates.</p> 1630<div class="refsect3"> 1631<a name="GST-AUDIO-CAPS-MAKE.parameters"></a><h4>Parameters</h4> 1632<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1633<colgroup> 1634<col width="150px" class="parameters_name"> 1635<col class="parameters_description"> 1636<col width="200px" class="parameters_annotations"> 1637</colgroup> 1638<tbody><tr> 1639<td class="parameter_name"><p>format</p></td> 1640<td class="parameter_description"><p>string format that describes the sample layout, as string 1641(e.g. "S16LE", "S8", etc.)</p></td> 1642<td class="parameter_annotations"> </td> 1643</tr></tbody> 1644</table></div> 1645</div> 1646</div> 1647<hr> 1648<div class="refsect2"> 1649<a name="gst-audio-buffer-clip"></a><h3>gst_audio_buffer_clip ()</h3> 1650<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="returnvalue">GstBuffer</span></a> * 1651gst_audio_buffer_clip (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a> *buffer</code></em>, 1652 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstSegment.html#GstSegment-struct"><span class="type">GstSegment</span></a> *segment</code></em>, 1653 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> rate</code></em>, 1654 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> bpf</code></em>);</pre> 1655<p>Clip the buffer to the given <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstSegment.html#GstSegment-struct"><code class="literal">GstSegment</code></a>.</p> 1656<p>After calling this function the caller does not own a reference to 1657<em class="parameter"><code>buffer</code></em> 1658 anymore.</p> 1659<div class="refsect3"> 1660<a name="gst-audio-buffer-clip.parameters"></a><h4>Parameters</h4> 1661<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1662<colgroup> 1663<col width="150px" class="parameters_name"> 1664<col class="parameters_description"> 1665<col width="200px" class="parameters_annotations"> 1666</colgroup> 1667<tbody> 1668<tr> 1669<td class="parameter_name"><p>buffer</p></td> 1670<td class="parameter_description"><p>The buffer to clip. </p></td> 1671<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> 1672</tr> 1673<tr> 1674<td class="parameter_name"><p>segment</p></td> 1675<td class="parameter_description"><p>Segment in <a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstFormat.html#GST-FORMAT-TIME:CAPS"><code class="literal">GST_FORMAT_TIME</code></a> or <a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstFormat.html#GST-FORMAT-DEFAULT:CAPS"><code class="literal">GST_FORMAT_DEFAULT</code></a> to which 1676the buffer should be clipped.</p></td> 1677<td class="parameter_annotations"> </td> 1678</tr> 1679<tr> 1680<td class="parameter_name"><p>rate</p></td> 1681<td class="parameter_description"><p>sample rate.</p></td> 1682<td class="parameter_annotations"> </td> 1683</tr> 1684<tr> 1685<td class="parameter_name"><p>bpf</p></td> 1686<td class="parameter_description"><p>size of one audio frame in bytes. This is the size of one sample * 1687number of channels.</p></td> 1688<td class="parameter_annotations"> </td> 1689</tr> 1690</tbody> 1691</table></div> 1692</div> 1693<div class="refsect3"> 1694<a name="gst-audio-buffer-clip.returns"></a><h4>Returns</h4> 1695<p><a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the buffer is completely outside the configured segment, 1696otherwise the clipped buffer is returned.</p> 1697<p>If the buffer has no timestamp, it is assumed to be inside the segment and 1698is not clipped. </p> 1699<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> 1700</div> 1701</div> 1702<hr> 1703<div class="refsect2"> 1704<a name="gst-audio-buffer-map"></a><h3>gst_audio_buffer_map ()</h3> 1705<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 1706gst_audio_buffer_map (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioBuffer" title="GstAudioBuffer"><span class="type">GstAudioBuffer</span></a> *buffer</code></em>, 1707 <em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>, 1708 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a> *gstbuffer</code></em>, 1709 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMemory.html#GstMapFlags"><span class="type">GstMapFlags</span></a> flags</code></em>);</pre> 1710<p>Maps an audio <em class="parameter"><code>gstbuffer</code></em> 1711 so that it can be read or written and stores the 1712result of the map operation in <em class="parameter"><code>buffer</code></em> 1713.</p> 1714<p>This is especially useful when the <em class="parameter"><code>gstbuffer</code></em> 1715 is in non-interleaved (planar) 1716layout, in which case this function will use the information in the 1717<em class="parameter"><code>gstbuffer</code></em> 1718's attached <a class="link" href="gst-plugins-base-libs-GstAudio-meta.html#GstAudioMeta" title="struct GstAudioMeta"><span class="type">GstAudioMeta</span></a> in order to map each channel in a 1719separate "plane" in <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioBuffer" title="GstAudioBuffer"><span class="type">GstAudioBuffer</span></a>. If a <a class="link" href="gst-plugins-base-libs-GstAudio-meta.html#GstAudioMeta" title="struct GstAudioMeta"><span class="type">GstAudioMeta</span></a> is not attached 1720on the <em class="parameter"><code>gstbuffer</code></em> 1721, then it must be in interleaved layout.</p> 1722<p>If a <a class="link" href="gst-plugins-base-libs-GstAudio-meta.html#GstAudioMeta" title="struct GstAudioMeta"><span class="type">GstAudioMeta</span></a> is attached, then the <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> on the meta is checked 1723against <em class="parameter"><code>info</code></em> 1724. Normally, they should be equal, but in case they are not, 1725a g_critical will be printed and the <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> from the meta will be 1726used.</p> 1727<p>In non-interleaved buffers, it is possible to have each channel on a separate 1728<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMemory.html#GstMemory-struct"><span class="type">GstMemory</span></a>. In this case, each memory will be mapped separately to avoid 1729copying their contents in a larger memory area. Do note though that it is 1730not supported to have a single channel spanning over two or more different 1731<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMemory.html#GstMemory-struct"><span class="type">GstMemory</span></a> objects. Although the map operation will likely succeed in this 1732case, it will be highly sub-optimal and it is recommended to merge all the 1733memories in the buffer before calling this function.</p> 1734<p>Note: The actual <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a> is not ref'ed, but it is required to stay valid 1735as long as it's mapped.</p> 1736<div class="refsect3"> 1737<a name="gst-audio-buffer-map.parameters"></a><h4>Parameters</h4> 1738<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1739<colgroup> 1740<col width="150px" class="parameters_name"> 1741<col class="parameters_description"> 1742<col width="200px" class="parameters_annotations"> 1743</colgroup> 1744<tbody> 1745<tr> 1746<td class="parameter_name"><p>buffer</p></td> 1747<td class="parameter_description"><p>pointer to a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioBuffer" title="GstAudioBuffer"><span class="type">GstAudioBuffer</span></a></p></td> 1748<td class="parameter_annotations"> </td> 1749</tr> 1750<tr> 1751<td class="parameter_name"><p>info</p></td> 1752<td class="parameter_description"><p>the audio properties of the buffer</p></td> 1753<td class="parameter_annotations"> </td> 1754</tr> 1755<tr> 1756<td class="parameter_name"><p>gstbuffer</p></td> 1757<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a> to be mapped. </p></td> 1758<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> 1759</tr> 1760<tr> 1761<td class="parameter_name"><p>flags</p></td> 1762<td class="parameter_description"><p>the access mode for the memory</p></td> 1763<td class="parameter_annotations"> </td> 1764</tr> 1765</tbody> 1766</table></div> 1767</div> 1768<div class="refsect3"> 1769<a name="gst-audio-buffer-map.returns"></a><h4>Returns</h4> 1770<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the map operation succeeded or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</p> 1771</div> 1772<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 1773</div> 1774<hr> 1775<div class="refsect2"> 1776<a name="gst-audio-buffer-truncate"></a><h3>gst_audio_buffer_truncate ()</h3> 1777<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="returnvalue">GstBuffer</span></a> * 1778gst_audio_buffer_truncate (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a> *buffer</code></em>, 1779 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> bpf</code></em>, 1780 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> trim</code></em>, 1781 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> samples</code></em>);</pre> 1782<p>Truncate the buffer to finally have <em class="parameter"><code>samples</code></em> 1783 number of samples, removing 1784the necessary amount of samples from the end and <em class="parameter"><code>trim</code></em> 1785 number of samples 1786from the beginning.</p> 1787<p>After calling this function the caller does not own a reference to 1788<em class="parameter"><code>buffer</code></em> 1789 anymore.</p> 1790<div class="refsect3"> 1791<a name="gst-audio-buffer-truncate.parameters"></a><h4>Parameters</h4> 1792<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1793<colgroup> 1794<col width="150px" class="parameters_name"> 1795<col class="parameters_description"> 1796<col width="200px" class="parameters_annotations"> 1797</colgroup> 1798<tbody> 1799<tr> 1800<td class="parameter_name"><p>buffer</p></td> 1801<td class="parameter_description"><p>The buffer to truncate. </p></td> 1802<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> 1803</tr> 1804<tr> 1805<td class="parameter_name"><p>bpf</p></td> 1806<td class="parameter_description"><p>size of one audio frame in bytes. This is the size of one sample * 1807number of channels.</p></td> 1808<td class="parameter_annotations"> </td> 1809</tr> 1810<tr> 1811<td class="parameter_name"><p>trim</p></td> 1812<td class="parameter_description"><p>the number of samples to remove from the beginning of the buffer</p></td> 1813<td class="parameter_annotations"> </td> 1814</tr> 1815<tr> 1816<td class="parameter_name"><p>samples</p></td> 1817<td class="parameter_description"><p>the final number of samples that should exist in this buffer or -1 1818to use all the remaining samples if you are only removing samples from the 1819beginning.</p></td> 1820<td class="parameter_annotations"> </td> 1821</tr> 1822</tbody> 1823</table></div> 1824</div> 1825<div class="refsect3"> 1826<a name="gst-audio-buffer-truncate.returns"></a><h4>Returns</h4> 1827<p>the truncated buffer or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the arguments 1828were invalid. </p> 1829<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> 1830</div> 1831<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 1832</div> 1833<hr> 1834<div class="refsect2"> 1835<a name="gst-audio-buffer-unmap"></a><h3>gst_audio_buffer_unmap ()</h3> 1836<pre class="programlisting"><span class="returnvalue">void</span> 1837gst_audio_buffer_unmap (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioBuffer" title="GstAudioBuffer"><span class="type">GstAudioBuffer</span></a> *buffer</code></em>);</pre> 1838<p>Unmaps an audio buffer that was previously mapped with 1839<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-buffer-map" title="gst_audio_buffer_map ()"><code class="function">gst_audio_buffer_map()</code></a>.</p> 1840<div class="refsect3"> 1841<a name="gst-audio-buffer-unmap.parameters"></a><h4>Parameters</h4> 1842<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1843<colgroup> 1844<col width="150px" class="parameters_name"> 1845<col class="parameters_description"> 1846<col width="200px" class="parameters_annotations"> 1847</colgroup> 1848<tbody><tr> 1849<td class="parameter_name"><p>buffer</p></td> 1850<td class="parameter_description"><p>the <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioBuffer" title="GstAudioBuffer"><span class="type">GstAudioBuffer</span></a> to unmap</p></td> 1851<td class="parameter_annotations"> </td> 1852</tr></tbody> 1853</table></div> 1854</div> 1855<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 1856</div> 1857<hr> 1858<div class="refsect2"> 1859<a name="gst-audio-resampler-free"></a><h3>gst_audio_resampler_free ()</h3> 1860<pre class="programlisting"><span class="returnvalue">void</span> 1861gst_audio_resampler_free (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a> *resampler</code></em>);</pre> 1862<p>Free a previously allocated <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a> <em class="parameter"><code>resampler</code></em> 1863.</p> 1864<div class="refsect3"> 1865<a name="gst-audio-resampler-free.parameters"></a><h4>Parameters</h4> 1866<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1867<colgroup> 1868<col width="150px" class="parameters_name"> 1869<col class="parameters_description"> 1870<col width="200px" class="parameters_annotations"> 1871</colgroup> 1872<tbody><tr> 1873<td class="parameter_name"><p>resampler</p></td> 1874<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a></p></td> 1875<td class="parameter_annotations"> </td> 1876</tr></tbody> 1877</table></div> 1878</div> 1879<p class="since">Since: <a class="link" href="ix10.html#api-index-1.6">1.6</a></p> 1880</div> 1881<hr> 1882<div class="refsect2"> 1883<a name="gst-audio-resampler-get-in-frames"></a><h3>gst_audio_resampler_get_in_frames ()</h3> 1884<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> 1885gst_audio_resampler_get_in_frames (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a> *resampler</code></em>, 1886 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> out_frames</code></em>);</pre> 1887<p>Get the number of input frames that would currently be needed 1888to produce <em class="parameter"><code>out_frames</code></em> 1889 from <em class="parameter"><code>resampler</code></em> 1890.</p> 1891<div class="refsect3"> 1892<a name="gst-audio-resampler-get-in-frames.parameters"></a><h4>Parameters</h4> 1893<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1894<colgroup> 1895<col width="150px" class="parameters_name"> 1896<col class="parameters_description"> 1897<col width="200px" class="parameters_annotations"> 1898</colgroup> 1899<tbody> 1900<tr> 1901<td class="parameter_name"><p>resampler</p></td> 1902<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a></p></td> 1903<td class="parameter_annotations"> </td> 1904</tr> 1905<tr> 1906<td class="parameter_name"><p>out_frames</p></td> 1907<td class="parameter_description"><p>number of input frames</p></td> 1908<td class="parameter_annotations"> </td> 1909</tr> 1910</tbody> 1911</table></div> 1912</div> 1913<div class="refsect3"> 1914<a name="gst-audio-resampler-get-in-frames.returns"></a><h4>Returns</h4> 1915<p> The number of input frames needed for producing 1916<em class="parameter"><code>out_frames</code></em> 1917of data from <em class="parameter"><code>resampler</code></em> 1918.</p> 1919</div> 1920</div> 1921<hr> 1922<div class="refsect2"> 1923<a name="gst-audio-resampler-get-max-latency"></a><h3>gst_audio_resampler_get_max_latency ()</h3> 1924<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> 1925gst_audio_resampler_get_max_latency (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a> *resampler</code></em>);</pre> 1926<p>Get the maximum number of input samples that the resampler would 1927need before producing output.</p> 1928<div class="refsect3"> 1929<a name="gst-audio-resampler-get-max-latency.parameters"></a><h4>Parameters</h4> 1930<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1931<colgroup> 1932<col width="150px" class="parameters_name"> 1933<col class="parameters_description"> 1934<col width="200px" class="parameters_annotations"> 1935</colgroup> 1936<tbody><tr> 1937<td class="parameter_name"><p>resampler</p></td> 1938<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a></p></td> 1939<td class="parameter_annotations"> </td> 1940</tr></tbody> 1941</table></div> 1942</div> 1943<div class="refsect3"> 1944<a name="gst-audio-resampler-get-max-latency.returns"></a><h4>Returns</h4> 1945<p> the latency of <em class="parameter"><code>resampler</code></em> 1946as expressed in the number of 1947frames.</p> 1948</div> 1949</div> 1950<hr> 1951<div class="refsect2"> 1952<a name="gst-audio-resampler-get-out-frames"></a><h3>gst_audio_resampler_get_out_frames ()</h3> 1953<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> 1954gst_audio_resampler_get_out_frames (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a> *resampler</code></em>, 1955 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> in_frames</code></em>);</pre> 1956<p>Get the number of output frames that would be currently available when 1957<em class="parameter"><code>in_frames</code></em> 1958 are given to <em class="parameter"><code>resampler</code></em> 1959.</p> 1960<div class="refsect3"> 1961<a name="gst-audio-resampler-get-out-frames.parameters"></a><h4>Parameters</h4> 1962<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1963<colgroup> 1964<col width="150px" class="parameters_name"> 1965<col class="parameters_description"> 1966<col width="200px" class="parameters_annotations"> 1967</colgroup> 1968<tbody> 1969<tr> 1970<td class="parameter_name"><p>resampler</p></td> 1971<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a></p></td> 1972<td class="parameter_annotations"> </td> 1973</tr> 1974<tr> 1975<td class="parameter_name"><p>in_frames</p></td> 1976<td class="parameter_description"><p>number of input frames</p></td> 1977<td class="parameter_annotations"> </td> 1978</tr> 1979</tbody> 1980</table></div> 1981</div> 1982<div class="refsect3"> 1983<a name="gst-audio-resampler-get-out-frames.returns"></a><h4>Returns</h4> 1984<p> The number of frames that would be availabe after giving 1985<em class="parameter"><code>in_frames</code></em> 1986as input to <em class="parameter"><code>resampler</code></em> 1987.</p> 1988</div> 1989</div> 1990<hr> 1991<div class="refsect2"> 1992<a name="gst-audio-resampler-new"></a><h3>gst_audio_resampler_new ()</h3> 1993<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="returnvalue">GstAudioResampler</span></a> * 1994gst_audio_resampler_new (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResamplerMethod" title="enum GstAudioResamplerMethod"><span class="type">GstAudioResamplerMethod</span></a> method</code></em>, 1995 <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResamplerFlags" title="enum GstAudioResamplerFlags"><span class="type">GstAudioResamplerFlags</span></a> flags</code></em>, 1996 <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>, 1997 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> channels</code></em>, 1998 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> in_rate</code></em>, 1999 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> out_rate</code></em>, 2000 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstStructure.html#GstStructure-struct"><span class="type">GstStructure</span></a> *options</code></em>);</pre> 2001<p>Make a new resampler.</p> 2002<div class="refsect3"> 2003<a name="gst-audio-resampler-new.parameters"></a><h4>Parameters</h4> 2004<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2005<colgroup> 2006<col width="150px" class="parameters_name"> 2007<col class="parameters_description"> 2008<col width="200px" class="parameters_annotations"> 2009</colgroup> 2010<tbody> 2011<tr> 2012<td class="parameter_name"><p>method</p></td> 2013<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResamplerMethod" title="enum GstAudioResamplerMethod"><span class="type">GstAudioResamplerMethod</span></a></p></td> 2014<td class="parameter_annotations"> </td> 2015</tr> 2016<tr> 2017<td class="parameter_name"><p>flags</p></td> 2018<td class="parameter_description"><p><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResamplerFlags" title="enum GstAudioResamplerFlags"><span class="type">GstAudioResamplerFlags</span></a></p></td> 2019<td class="parameter_annotations"> </td> 2020</tr> 2021<tr> 2022<td class="parameter_name"><p>format</p></td> 2023<td class="parameter_description"><p>the <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="type">GstAudioFormat</span></a></p></td> 2024<td class="parameter_annotations"> </td> 2025</tr> 2026<tr> 2027<td class="parameter_name"><p>channels</p></td> 2028<td class="parameter_description"><p>the number of channels</p></td> 2029<td class="parameter_annotations"> </td> 2030</tr> 2031<tr> 2032<td class="parameter_name"><p>in_rate</p></td> 2033<td class="parameter_description"><p>input rate</p></td> 2034<td class="parameter_annotations"> </td> 2035</tr> 2036<tr> 2037<td class="parameter_name"><p>out_rate</p></td> 2038<td class="parameter_description"><p>output rate</p></td> 2039<td class="parameter_annotations"> </td> 2040</tr> 2041<tr> 2042<td class="parameter_name"><p>options</p></td> 2043<td class="parameter_description"><p>extra options</p></td> 2044<td class="parameter_annotations"> </td> 2045</tr> 2046</tbody> 2047</table></div> 2048</div> 2049<div class="refsect3"> 2050<a name="gst-audio-resampler-new.returns"></a><h4>Returns</h4> 2051<p>The new <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a>, or 2052<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure. </p> 2053<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> 2054</div> 2055</div> 2056<hr> 2057<div class="refsect2"> 2058<a name="gst-audio-resampler-options-set-quality"></a><h3>gst_audio_resampler_options_set_quality ()</h3> 2059<pre class="programlisting"><span class="returnvalue">void</span> 2060gst_audio_resampler_options_set_quality 2061 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResamplerMethod" title="enum GstAudioResamplerMethod"><span class="type">GstAudioResamplerMethod</span></a> method</code></em>, 2062 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> quality</code></em>, 2063 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> in_rate</code></em>, 2064 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> out_rate</code></em>, 2065 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstStructure.html#GstStructure-struct"><span class="type">GstStructure</span></a> *options</code></em>);</pre> 2066<p>Set the parameters for resampling from <em class="parameter"><code>in_rate</code></em> 2067 to <em class="parameter"><code>out_rate</code></em> 2068 using <em class="parameter"><code>method</code></em> 2069 2070for <em class="parameter"><code>quality</code></em> 2071 in <em class="parameter"><code>options</code></em> 2072.</p> 2073<div class="refsect3"> 2074<a name="gst-audio-resampler-options-set-quality.parameters"></a><h4>Parameters</h4> 2075<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2076<colgroup> 2077<col width="150px" class="parameters_name"> 2078<col class="parameters_description"> 2079<col width="200px" class="parameters_annotations"> 2080</colgroup> 2081<tbody> 2082<tr> 2083<td class="parameter_name"><p>method</p></td> 2084<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResamplerMethod" title="enum GstAudioResamplerMethod"><span class="type">GstAudioResamplerMethod</span></a></p></td> 2085<td class="parameter_annotations"> </td> 2086</tr> 2087<tr> 2088<td class="parameter_name"><p>quality</p></td> 2089<td class="parameter_description"><p>the quality</p></td> 2090<td class="parameter_annotations"> </td> 2091</tr> 2092<tr> 2093<td class="parameter_name"><p>in_rate</p></td> 2094<td class="parameter_description"><p>the input rate</p></td> 2095<td class="parameter_annotations"> </td> 2096</tr> 2097<tr> 2098<td class="parameter_name"><p>out_rate</p></td> 2099<td class="parameter_description"><p>the output rate</p></td> 2100<td class="parameter_annotations"> </td> 2101</tr> 2102<tr> 2103<td class="parameter_name"><p>options</p></td> 2104<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstStructure.html#GstStructure-struct"><span class="type">GstStructure</span></a></p></td> 2105<td class="parameter_annotations"> </td> 2106</tr> 2107</tbody> 2108</table></div> 2109</div> 2110</div> 2111<hr> 2112<div class="refsect2"> 2113<a name="gst-audio-resampler-resample"></a><h3>gst_audio_resampler_resample ()</h3> 2114<pre class="programlisting"><span class="returnvalue">void</span> 2115gst_audio_resampler_resample (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a> *resampler</code></em>, 2116 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> in[]</code></em>, 2117 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> in_frames</code></em>, 2118 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> out[]</code></em>, 2119 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> out_frames</code></em>);</pre> 2120<p>Perform resampling on <em class="parameter"><code>in_frames</code></em> 2121 frames in <em class="parameter"><code>in</code></em> 2122 and write <em class="parameter"><code>out_frames</code></em> 2123 to <em class="parameter"><code>out</code></em> 2124.</p> 2125<p>In case the samples are interleaved, <em class="parameter"><code>in</code></em> 2126 and <em class="parameter"><code>out</code></em> 2127 must point to an 2128array with a single element pointing to a block of interleaved samples.</p> 2129<p>If non-interleaved samples are used, <em class="parameter"><code>in</code></em> 2130 and <em class="parameter"><code>out</code></em> 2131 must point to an 2132array with pointers to memory blocks, one for each channel.</p> 2133<p><em class="parameter"><code>in</code></em> 2134 may be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, in which case <em class="parameter"><code>in_frames</code></em> 2135 of silence samples are pushed 2136into the resampler.</p> 2137<p>This function always produces <em class="parameter"><code>out_frames</code></em> 2138 of output and consumes <em class="parameter"><code>in_frames</code></em> 2139 of 2140input. Use <a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-resampler-get-out-frames" title="gst_audio_resampler_get_out_frames ()"><code class="function">gst_audio_resampler_get_out_frames()</code></a> and 2141<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-resampler-get-in-frames" title="gst_audio_resampler_get_in_frames ()"><code class="function">gst_audio_resampler_get_in_frames()</code></a> to make sure <em class="parameter"><code>in_frames</code></em> 2142 and <em class="parameter"><code>out_frames</code></em> 2143 2144are matching and <em class="parameter"><code>in</code></em> 2145 and <em class="parameter"><code>out</code></em> 2146 point to enough memory.</p> 2147<div class="refsect3"> 2148<a name="gst-audio-resampler-resample.parameters"></a><h4>Parameters</h4> 2149<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2150<colgroup> 2151<col width="150px" class="parameters_name"> 2152<col class="parameters_description"> 2153<col width="200px" class="parameters_annotations"> 2154</colgroup> 2155<tbody> 2156<tr> 2157<td class="parameter_name"><p>resampler</p></td> 2158<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a></p></td> 2159<td class="parameter_annotations"> </td> 2160</tr> 2161<tr> 2162<td class="parameter_name"><p>in</p></td> 2163<td class="parameter_description"><p>input samples</p></td> 2164<td class="parameter_annotations"> </td> 2165</tr> 2166<tr> 2167<td class="parameter_name"><p>in_frames</p></td> 2168<td class="parameter_description"><p>number of input frames</p></td> 2169<td class="parameter_annotations"> </td> 2170</tr> 2171<tr> 2172<td class="parameter_name"><p>out</p></td> 2173<td class="parameter_description"><p>output samples</p></td> 2174<td class="parameter_annotations"> </td> 2175</tr> 2176<tr> 2177<td class="parameter_name"><p>out_frames</p></td> 2178<td class="parameter_description"><p>number of output frames</p></td> 2179<td class="parameter_annotations"> </td> 2180</tr> 2181</tbody> 2182</table></div> 2183</div> 2184</div> 2185<hr> 2186<div class="refsect2"> 2187<a name="gst-audio-resampler-reset"></a><h3>gst_audio_resampler_reset ()</h3> 2188<pre class="programlisting"><span class="returnvalue">void</span> 2189gst_audio_resampler_reset (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a> *resampler</code></em>);</pre> 2190<p>Reset <em class="parameter"><code>resampler</code></em> 2191 to the state it was when it was first created, discarding 2192all sample history.</p> 2193<div class="refsect3"> 2194<a name="gst-audio-resampler-reset.parameters"></a><h4>Parameters</h4> 2195<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2196<colgroup> 2197<col width="150px" class="parameters_name"> 2198<col class="parameters_description"> 2199<col width="200px" class="parameters_annotations"> 2200</colgroup> 2201<tbody><tr> 2202<td class="parameter_name"><p>resampler</p></td> 2203<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a></p></td> 2204<td class="parameter_annotations"> </td> 2205</tr></tbody> 2206</table></div> 2207</div> 2208</div> 2209<hr> 2210<div class="refsect2"> 2211<a name="gst-audio-resampler-update"></a><h3>gst_audio_resampler_update ()</h3> 2212<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2213gst_audio_resampler_update (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a> *resampler</code></em>, 2214 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> in_rate</code></em>, 2215 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> out_rate</code></em>, 2216 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstStructure.html#GstStructure-struct"><span class="type">GstStructure</span></a> *options</code></em>);</pre> 2217<p>Update the resampler parameters for <em class="parameter"><code>resampler</code></em> 2218. This function should 2219not be called concurrently with any other function on <em class="parameter"><code>resampler</code></em> 2220.</p> 2221<p>When <em class="parameter"><code>in_rate</code></em> 2222 or <em class="parameter"><code>out_rate</code></em> 2223 is 0, its value is unchanged.</p> 2224<p>When <em class="parameter"><code>options</code></em> 2225 is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the previously configured options are reused.</p> 2226<div class="refsect3"> 2227<a name="gst-audio-resampler-update.parameters"></a><h4>Parameters</h4> 2228<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2229<colgroup> 2230<col width="150px" class="parameters_name"> 2231<col class="parameters_description"> 2232<col width="200px" class="parameters_annotations"> 2233</colgroup> 2234<tbody> 2235<tr> 2236<td class="parameter_name"><p>resampler</p></td> 2237<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioResampler" title="GstAudioResampler"><span class="type">GstAudioResampler</span></a></p></td> 2238<td class="parameter_annotations"> </td> 2239</tr> 2240<tr> 2241<td class="parameter_name"><p>in_rate</p></td> 2242<td class="parameter_description"><p>new input rate</p></td> 2243<td class="parameter_annotations"> </td> 2244</tr> 2245<tr> 2246<td class="parameter_name"><p>out_rate</p></td> 2247<td class="parameter_description"><p>new output rate</p></td> 2248<td class="parameter_annotations"> </td> 2249</tr> 2250<tr> 2251<td class="parameter_name"><p>options</p></td> 2252<td class="parameter_description"><p>new options or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td> 2253<td class="parameter_annotations"> </td> 2254</tr> 2255</tbody> 2256</table></div> 2257</div> 2258<div class="refsect3"> 2259<a name="gst-audio-resampler-update.returns"></a><h4>Returns</h4> 2260<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the new parameters could be set</p> 2261</div> 2262</div> 2263<hr> 2264<div class="refsect2"> 2265<a name="gst-audio-stream-align-new"></a><h3>gst_audio_stream_align_new ()</h3> 2266<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="returnvalue">GstAudioStreamAlign</span></a> * 2267gst_audio_stream_align_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> rate</code></em>, 2268 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> alignment_threshold</code></em>, 2269 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> discont_wait</code></em>);</pre> 2270<p>Allocate a new <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a> with the given configuration. All 2271processing happens according to sample rate <em class="parameter"><code>rate</code></em> 2272, until 2273<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-set-rate" title="gst_audio_stream_align_set_rate ()"><code class="function">gst_audio_stream_align_set_rate()</code></a> is called with a new <em class="parameter"><code>rate</code></em> 2274. 2275A negative rate can be used for reverse playback.</p> 2276<p><em class="parameter"><code>alignment_threshold</code></em> 2277 gives the tolerance in nanoseconds after which a 2278timestamp difference is considered a discontinuity. Once detected, 2279<em class="parameter"><code>discont_wait</code></em> 2280 nanoseconds have to pass without going below the threshold 2281again until the output buffer is marked as a discontinuity. These can later 2282be re-configured with <a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-set-alignment-threshold" title="gst_audio_stream_align_set_alignment_threshold ()"><code class="function">gst_audio_stream_align_set_alignment_threshold()</code></a> and 2283<a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-set-discont-wait" title="gst_audio_stream_align_set_discont_wait ()"><code class="function">gst_audio_stream_align_set_discont_wait()</code></a>.</p> 2284<div class="refsect3"> 2285<a name="gst-audio-stream-align-new.parameters"></a><h4>Parameters</h4> 2286<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2287<colgroup> 2288<col width="150px" class="parameters_name"> 2289<col class="parameters_description"> 2290<col width="200px" class="parameters_annotations"> 2291</colgroup> 2292<tbody> 2293<tr> 2294<td class="parameter_name"><p>rate</p></td> 2295<td class="parameter_description"><p>a sample rate</p></td> 2296<td class="parameter_annotations"> </td> 2297</tr> 2298<tr> 2299<td class="parameter_name"><p>alignment_threshold</p></td> 2300<td class="parameter_description"><p>a alignment threshold in nanoseconds</p></td> 2301<td class="parameter_annotations"> </td> 2302</tr> 2303<tr> 2304<td class="parameter_name"><p>discont_wait</p></td> 2305<td class="parameter_description"><p>discont wait in nanoseconds</p></td> 2306<td class="parameter_annotations"> </td> 2307</tr> 2308</tbody> 2309</table></div> 2310</div> 2311<div class="refsect3"> 2312<a name="gst-audio-stream-align-new.returns"></a><h4>Returns</h4> 2313<p> a new <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a>. free with <a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-free" title="gst_audio_stream_align_free ()"><code class="function">gst_audio_stream_align_free()</code></a>.</p> 2314</div> 2315<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 2316</div> 2317<hr> 2318<div class="refsect2"> 2319<a name="gst-audio-stream-align-copy"></a><h3>gst_audio_stream_align_copy ()</h3> 2320<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="returnvalue">GstAudioStreamAlign</span></a> * 2321gst_audio_stream_align_copy (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a> *align</code></em>);</pre> 2322<p>Copy a GstAudioStreamAlign structure.</p> 2323<div class="refsect3"> 2324<a name="gst-audio-stream-align-copy.parameters"></a><h4>Parameters</h4> 2325<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2326<colgroup> 2327<col width="150px" class="parameters_name"> 2328<col class="parameters_description"> 2329<col width="200px" class="parameters_annotations"> 2330</colgroup> 2331<tbody><tr> 2332<td class="parameter_name"><p>align</p></td> 2333<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a></p></td> 2334<td class="parameter_annotations"> </td> 2335</tr></tbody> 2336</table></div> 2337</div> 2338<div class="refsect3"> 2339<a name="gst-audio-stream-align-copy.returns"></a><h4>Returns</h4> 2340<p> a new <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a>. free with gst_audio_stream_align_free.</p> 2341</div> 2342<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 2343</div> 2344<hr> 2345<div class="refsect2"> 2346<a name="gst-audio-stream-align-free"></a><h3>gst_audio_stream_align_free ()</h3> 2347<pre class="programlisting"><span class="returnvalue">void</span> 2348gst_audio_stream_align_free (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a> *align</code></em>);</pre> 2349<p>Free a GstAudioStreamAlign structure previously allocated with <a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-new" title="gst_audio_stream_align_new ()"><code class="function">gst_audio_stream_align_new()</code></a> 2350or <a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-stream-align-copy" title="gst_audio_stream_align_copy ()"><code class="function">gst_audio_stream_align_copy()</code></a>.</p> 2351<div class="refsect3"> 2352<a name="gst-audio-stream-align-free.parameters"></a><h4>Parameters</h4> 2353<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2354<colgroup> 2355<col width="150px" class="parameters_name"> 2356<col class="parameters_description"> 2357<col width="200px" class="parameters_annotations"> 2358</colgroup> 2359<tbody><tr> 2360<td class="parameter_name"><p>align</p></td> 2361<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a></p></td> 2362<td class="parameter_annotations"> </td> 2363</tr></tbody> 2364</table></div> 2365</div> 2366<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 2367</div> 2368<hr> 2369<div class="refsect2"> 2370<a name="gst-audio-stream-align-mark-discont"></a><h3>gst_audio_stream_align_mark_discont ()</h3> 2371<pre class="programlisting"><span class="returnvalue">void</span> 2372gst_audio_stream_align_mark_discont (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a> *align</code></em>);</pre> 2373<p>Marks the next buffer as discontinuous and resets timestamp tracking.</p> 2374<div class="refsect3"> 2375<a name="gst-audio-stream-align-mark-discont.parameters"></a><h4>Parameters</h4> 2376<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2377<colgroup> 2378<col width="150px" class="parameters_name"> 2379<col class="parameters_description"> 2380<col width="200px" class="parameters_annotations"> 2381</colgroup> 2382<tbody><tr> 2383<td class="parameter_name"><p>align</p></td> 2384<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a></p></td> 2385<td class="parameter_annotations"> </td> 2386</tr></tbody> 2387</table></div> 2388</div> 2389<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 2390</div> 2391<hr> 2392<div class="refsect2"> 2393<a name="gst-audio-stream-align-process"></a><h3>gst_audio_stream_align_process ()</h3> 2394<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 2395gst_audio_stream_align_process (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a> *align</code></em>, 2396 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> discont</code></em>, 2397 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timestamp</code></em>, 2398 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_samples</code></em>, 2399 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> *out_timestamp</code></em>, 2400 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> *out_duration</code></em>, 2401 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *out_sample_position</code></em>);</pre> 2402<p>Processes data with <em class="parameter"><code>timestamp</code></em> 2403 and <em class="parameter"><code>n_samples</code></em> 2404, and returns the output 2405timestamp, duration and sample position together with a boolean to signal 2406whether a discontinuity was detected or not. All non-discontinuous data 2407will have perfect timestamps and durations.</p> 2408<p>A discontinuity is detected once the difference between the actual 2409timestamp and the timestamp calculated from the sample count since the last 2410discontinuity differs by more than the alignment threshold for a duration 2411longer than discont wait.</p> 2412<p>Note: In reverse playback, every buffer is considered discontinuous in the 2413context of buffer flags because the last sample of the previous buffer is 2414discontinuous with the first sample of the current one. However for this 2415function they are only considered discontinuous in reverse playback if the 2416first sample of the previous buffer is discontinuous with the last sample 2417of the current one.</p> 2418<div class="refsect3"> 2419<a name="gst-audio-stream-align-process.parameters"></a><h4>Parameters</h4> 2420<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2421<colgroup> 2422<col width="150px" class="parameters_name"> 2423<col class="parameters_description"> 2424<col width="200px" class="parameters_annotations"> 2425</colgroup> 2426<tbody> 2427<tr> 2428<td class="parameter_name"><p>align</p></td> 2429<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a></p></td> 2430<td class="parameter_annotations"> </td> 2431</tr> 2432<tr> 2433<td class="parameter_name"><p>discont</p></td> 2434<td class="parameter_description"><p>if this data is considered to be discontinuous</p></td> 2435<td class="parameter_annotations"> </td> 2436</tr> 2437<tr> 2438<td class="parameter_name"><p>timestamp</p></td> 2439<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> of the start of the data</p></td> 2440<td class="parameter_annotations"> </td> 2441</tr> 2442<tr> 2443<td class="parameter_name"><p>n_samples</p></td> 2444<td class="parameter_description"><p>number of samples to process</p></td> 2445<td class="parameter_annotations"> </td> 2446</tr> 2447<tr> 2448<td class="parameter_name"><p>out_timestamp</p></td> 2449<td class="parameter_description"><p>output timestamp of the data. </p></td> 2450<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 2451</tr> 2452<tr> 2453<td class="parameter_name"><p>out_duration</p></td> 2454<td class="parameter_description"><p>output duration of the data. </p></td> 2455<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 2456</tr> 2457<tr> 2458<td class="parameter_name"><p>out_sample_position</p></td> 2459<td class="parameter_description"><p>output sample position of the start of the data. </p></td> 2460<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> 2461</tr> 2462</tbody> 2463</table></div> 2464</div> 2465<div class="refsect3"> 2466<a name="gst-audio-stream-align-process.returns"></a><h4>Returns</h4> 2467<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a discontinuity was detected, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p> 2468</div> 2469<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 2470</div> 2471<hr> 2472<div class="refsect2"> 2473<a name="gst-audio-stream-align-get-samples-since-discont"></a><h3>gst_audio_stream_align_get_samples_since_discont ()</h3> 2474<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> 2475gst_audio_stream_align_get_samples_since_discont 2476 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a> *align</code></em>);</pre> 2477<p>Returns the number of samples that were processed since the last 2478discontinuity was detected.</p> 2479<div class="refsect3"> 2480<a name="gst-audio-stream-align-get-samples-since-discont.parameters"></a><h4>Parameters</h4> 2481<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2482<colgroup> 2483<col width="150px" class="parameters_name"> 2484<col class="parameters_description"> 2485<col width="200px" class="parameters_annotations"> 2486</colgroup> 2487<tbody><tr> 2488<td class="parameter_name"><p>align</p></td> 2489<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a></p></td> 2490<td class="parameter_annotations"> </td> 2491</tr></tbody> 2492</table></div> 2493</div> 2494<div class="refsect3"> 2495<a name="gst-audio-stream-align-get-samples-since-discont.returns"></a><h4>Returns</h4> 2496<p> The number of samples processed since the last discontinuity.</p> 2497</div> 2498<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 2499</div> 2500<hr> 2501<div class="refsect2"> 2502<a name="gst-audio-stream-align-get-timestamp-at-discont"></a><h3>gst_audio_stream_align_get_timestamp_at_discont ()</h3> 2503<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a> 2504gst_audio_stream_align_get_timestamp_at_discont 2505 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a> *align</code></em>);</pre> 2506<p>Timestamp that was passed when a discontinuity was detected, i.e. the first 2507timestamp after the discontinuity.</p> 2508<div class="refsect3"> 2509<a name="gst-audio-stream-align-get-timestamp-at-discont.parameters"></a><h4>Parameters</h4> 2510<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2511<colgroup> 2512<col width="150px" class="parameters_name"> 2513<col class="parameters_description"> 2514<col width="200px" class="parameters_annotations"> 2515</colgroup> 2516<tbody><tr> 2517<td class="parameter_name"><p>align</p></td> 2518<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a></p></td> 2519<td class="parameter_annotations"> </td> 2520</tr></tbody> 2521</table></div> 2522</div> 2523<div class="refsect3"> 2524<a name="gst-audio-stream-align-get-timestamp-at-discont.returns"></a><h4>Returns</h4> 2525<p> The last timestamp at when a discontinuity was detected</p> 2526</div> 2527<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 2528</div> 2529<hr> 2530<div class="refsect2"> 2531<a name="gst-audio-stream-align-get-alignment-threshold"></a><h3>gst_audio_stream_align_get_alignment_threshold ()</h3> 2532<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a> 2533gst_audio_stream_align_get_alignment_threshold 2534 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a> *align</code></em>);</pre> 2535<p>Gets the currently configured alignment threshold.</p> 2536<div class="refsect3"> 2537<a name="gst-audio-stream-align-get-alignment-threshold.parameters"></a><h4>Parameters</h4> 2538<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2539<colgroup> 2540<col width="150px" class="parameters_name"> 2541<col class="parameters_description"> 2542<col width="200px" class="parameters_annotations"> 2543</colgroup> 2544<tbody><tr> 2545<td class="parameter_name"><p>align</p></td> 2546<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a></p></td> 2547<td class="parameter_annotations"> </td> 2548</tr></tbody> 2549</table></div> 2550</div> 2551<div class="refsect3"> 2552<a name="gst-audio-stream-align-get-alignment-threshold.returns"></a><h4>Returns</h4> 2553<p> The currently configured alignment threshold</p> 2554</div> 2555<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 2556</div> 2557<hr> 2558<div class="refsect2"> 2559<a name="gst-audio-stream-align-set-alignment-threshold"></a><h3>gst_audio_stream_align_set_alignment_threshold ()</h3> 2560<pre class="programlisting"><span class="returnvalue">void</span> 2561gst_audio_stream_align_set_alignment_threshold 2562 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a> *align</code></em>, 2563 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> alignment_threshold</code></em>);</pre> 2564<p>Sets <em class="parameter"><code>alignment_treshold</code></em> 2565 as new alignment threshold for the following processing.</p> 2566<div class="refsect3"> 2567<a name="gst-audio-stream-align-set-alignment-threshold.parameters"></a><h4>Parameters</h4> 2568<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2569<colgroup> 2570<col width="150px" class="parameters_name"> 2571<col class="parameters_description"> 2572<col width="200px" class="parameters_annotations"> 2573</colgroup> 2574<tbody> 2575<tr> 2576<td class="parameter_name"><p>align</p></td> 2577<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a></p></td> 2578<td class="parameter_annotations"> </td> 2579</tr> 2580<tr> 2581<td class="parameter_name"><p>alignment_threshold</p></td> 2582<td class="parameter_description"><p>a new alignment threshold</p></td> 2583<td class="parameter_annotations"> </td> 2584</tr> 2585</tbody> 2586</table></div> 2587</div> 2588<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 2589</div> 2590<hr> 2591<div class="refsect2"> 2592<a name="gst-audio-stream-align-get-discont-wait"></a><h3>gst_audio_stream_align_get_discont_wait ()</h3> 2593<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a> 2594gst_audio_stream_align_get_discont_wait 2595 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a> *align</code></em>);</pre> 2596<p>Gets the currently configured discont wait.</p> 2597<div class="refsect3"> 2598<a name="gst-audio-stream-align-get-discont-wait.parameters"></a><h4>Parameters</h4> 2599<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2600<colgroup> 2601<col width="150px" class="parameters_name"> 2602<col class="parameters_description"> 2603<col width="200px" class="parameters_annotations"> 2604</colgroup> 2605<tbody><tr> 2606<td class="parameter_name"><p>align</p></td> 2607<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a></p></td> 2608<td class="parameter_annotations"> </td> 2609</tr></tbody> 2610</table></div> 2611</div> 2612<div class="refsect3"> 2613<a name="gst-audio-stream-align-get-discont-wait.returns"></a><h4>Returns</h4> 2614<p> The currently configured discont wait</p> 2615</div> 2616<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 2617</div> 2618<hr> 2619<div class="refsect2"> 2620<a name="gst-audio-stream-align-set-discont-wait"></a><h3>gst_audio_stream_align_set_discont_wait ()</h3> 2621<pre class="programlisting"><span class="returnvalue">void</span> 2622gst_audio_stream_align_set_discont_wait 2623 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a> *align</code></em>, 2624 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> discont_wait</code></em>);</pre> 2625<p>Sets <em class="parameter"><code>alignment_treshold</code></em> 2626 as new discont wait for the following processing.</p> 2627<div class="refsect3"> 2628<a name="gst-audio-stream-align-set-discont-wait.parameters"></a><h4>Parameters</h4> 2629<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2630<colgroup> 2631<col width="150px" class="parameters_name"> 2632<col class="parameters_description"> 2633<col width="200px" class="parameters_annotations"> 2634</colgroup> 2635<tbody> 2636<tr> 2637<td class="parameter_name"><p>align</p></td> 2638<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a></p></td> 2639<td class="parameter_annotations"> </td> 2640</tr> 2641<tr> 2642<td class="parameter_name"><p>discont_wait</p></td> 2643<td class="parameter_description"><p>a new discont wait</p></td> 2644<td class="parameter_annotations"> </td> 2645</tr> 2646</tbody> 2647</table></div> 2648</div> 2649<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 2650</div> 2651<hr> 2652<div class="refsect2"> 2653<a name="gst-audio-stream-align-get-rate"></a><h3>gst_audio_stream_align_get_rate ()</h3> 2654<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> 2655gst_audio_stream_align_get_rate (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a> *align</code></em>);</pre> 2656<p>Gets the currently configured sample rate.</p> 2657<div class="refsect3"> 2658<a name="gst-audio-stream-align-get-rate.parameters"></a><h4>Parameters</h4> 2659<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2660<colgroup> 2661<col width="150px" class="parameters_name"> 2662<col class="parameters_description"> 2663<col width="200px" class="parameters_annotations"> 2664</colgroup> 2665<tbody><tr> 2666<td class="parameter_name"><p>align</p></td> 2667<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a></p></td> 2668<td class="parameter_annotations"> </td> 2669</tr></tbody> 2670</table></div> 2671</div> 2672<div class="refsect3"> 2673<a name="gst-audio-stream-align-get-rate.returns"></a><h4>Returns</h4> 2674<p> The currently configured sample rate</p> 2675</div> 2676<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 2677</div> 2678<hr> 2679<div class="refsect2"> 2680<a name="gst-audio-stream-align-set-rate"></a><h3>gst_audio_stream_align_set_rate ()</h3> 2681<pre class="programlisting"><span class="returnvalue">void</span> 2682gst_audio_stream_align_set_rate (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a> *align</code></em>, 2683 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> rate</code></em>);</pre> 2684<p>Sets <em class="parameter"><code>rate</code></em> 2685 as new sample rate for the following processing. If the sample 2686rate differs this implicitely marks the next data as discontinuous.</p> 2687<div class="refsect3"> 2688<a name="gst-audio-stream-align-set-rate.parameters"></a><h4>Parameters</h4> 2689<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2690<colgroup> 2691<col width="150px" class="parameters_name"> 2692<col class="parameters_description"> 2693<col width="200px" class="parameters_annotations"> 2694</colgroup> 2695<tbody> 2696<tr> 2697<td class="parameter_name"><p>align</p></td> 2698<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a></p></td> 2699<td class="parameter_annotations"> </td> 2700</tr> 2701<tr> 2702<td class="parameter_name"><p>rate</p></td> 2703<td class="parameter_description"><p>a new sample rate</p></td> 2704<td class="parameter_annotations"> </td> 2705</tr> 2706</tbody> 2707</table></div> 2708</div> 2709<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 2710</div> 2711</div> 2712<div class="refsect1"> 2713<a name="gst-plugins-base-libs-GstAudio.other_details"></a><h2>Types and Values</h2> 2714<div class="refsect2"> 2715<a name="GstAudioFlags"></a><h3>enum GstAudioFlags</h3> 2716<p>Extra audio flags</p> 2717<div class="refsect3"> 2718<a name="GstAudioFlags.members"></a><h4>Members</h4> 2719<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2720<colgroup> 2721<col width="300px" class="enum_members_name"> 2722<col class="enum_members_description"> 2723<col width="200px" class="enum_members_annotations"> 2724</colgroup> 2725<tbody> 2726<tr> 2727<td class="enum_member_name"><p><a name="GST-AUDIO-FLAG-NONE:CAPS"></a>GST_AUDIO_FLAG_NONE</p></td> 2728<td class="enum_member_description"> 2729<p>no valid flag</p> 2730</td> 2731<td class="enum_member_annotations"> </td> 2732</tr> 2733<tr> 2734<td class="enum_member_name"><p><a name="GST-AUDIO-FLAG-UNPOSITIONED:CAPS"></a>GST_AUDIO_FLAG_UNPOSITIONED</p></td> 2735<td class="enum_member_description"> 2736<p>the position array explicitly 2737 contains unpositioned channels.</p> 2738</td> 2739<td class="enum_member_annotations"> </td> 2740</tr> 2741</tbody> 2742</table></div> 2743</div> 2744</div> 2745<hr> 2746<div class="refsect2"> 2747<a name="GstAudioFormat"></a><h3>enum GstAudioFormat</h3> 2748<p>Enum value describing the most common audio formats.</p> 2749<div class="refsect3"> 2750<a name="GstAudioFormat.members"></a><h4>Members</h4> 2751<div class="informaltable"><table class="informaltable" width="100%" border="0"> 2752<colgroup> 2753<col width="300px" class="enum_members_name"> 2754<col class="enum_members_description"> 2755<col width="200px" class="enum_members_annotations"> 2756</colgroup> 2757<tbody> 2758<tr> 2759<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-UNKNOWN:CAPS"></a>GST_AUDIO_FORMAT_UNKNOWN</p></td> 2760<td class="enum_member_description"> 2761<p>unknown or unset audio format</p> 2762</td> 2763<td class="enum_member_annotations"> </td> 2764</tr> 2765<tr> 2766<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-ENCODED:CAPS"></a>GST_AUDIO_FORMAT_ENCODED</p></td> 2767<td class="enum_member_description"> 2768<p>encoded audio format</p> 2769</td> 2770<td class="enum_member_annotations"> </td> 2771</tr> 2772<tr> 2773<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S8:CAPS"></a>GST_AUDIO_FORMAT_S8</p></td> 2774<td class="enum_member_description"> 2775<p>8 bits in 8 bits, signed</p> 2776</td> 2777<td class="enum_member_annotations"> </td> 2778</tr> 2779<tr> 2780<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U8:CAPS"></a>GST_AUDIO_FORMAT_U8</p></td> 2781<td class="enum_member_description"> 2782<p>8 bits in 8 bits, unsigned</p> 2783</td> 2784<td class="enum_member_annotations"> </td> 2785</tr> 2786<tr> 2787<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S16LE:CAPS"></a>GST_AUDIO_FORMAT_S16LE</p></td> 2788<td class="enum_member_description"> 2789<p>16 bits in 16 bits, signed, little endian</p> 2790</td> 2791<td class="enum_member_annotations"> </td> 2792</tr> 2793<tr> 2794<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S16BE:CAPS"></a>GST_AUDIO_FORMAT_S16BE</p></td> 2795<td class="enum_member_description"> 2796<p>16 bits in 16 bits, signed, big endian</p> 2797</td> 2798<td class="enum_member_annotations"> </td> 2799</tr> 2800<tr> 2801<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U16LE:CAPS"></a>GST_AUDIO_FORMAT_U16LE</p></td> 2802<td class="enum_member_description"> 2803<p>16 bits in 16 bits, unsigned, little endian</p> 2804</td> 2805<td class="enum_member_annotations"> </td> 2806</tr> 2807<tr> 2808<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U16BE:CAPS"></a>GST_AUDIO_FORMAT_U16BE</p></td> 2809<td class="enum_member_description"> 2810<p>16 bits in 16 bits, unsigned, big endian</p> 2811</td> 2812<td class="enum_member_annotations"> </td> 2813</tr> 2814<tr> 2815<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S24-32LE:CAPS"></a>GST_AUDIO_FORMAT_S24_32LE</p></td> 2816<td class="enum_member_description"> 2817<p>24 bits in 32 bits, signed, little endian</p> 2818</td> 2819<td class="enum_member_annotations"> </td> 2820</tr> 2821<tr> 2822<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S24-32BE:CAPS"></a>GST_AUDIO_FORMAT_S24_32BE</p></td> 2823<td class="enum_member_description"> 2824<p>24 bits in 32 bits, signed, big endian</p> 2825</td> 2826<td class="enum_member_annotations"> </td> 2827</tr> 2828<tr> 2829<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U24-32LE:CAPS"></a>GST_AUDIO_FORMAT_U24_32LE</p></td> 2830<td class="enum_member_description"> 2831<p>24 bits in 32 bits, unsigned, little endian</p> 2832</td> 2833<td class="enum_member_annotations"> </td> 2834</tr> 2835<tr> 2836<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U24-32BE:CAPS"></a>GST_AUDIO_FORMAT_U24_32BE</p></td> 2837<td class="enum_member_description"> 2838<p>24 bits in 32 bits, unsigned, big endian</p> 2839</td> 2840<td class="enum_member_annotations"> </td> 2841</tr> 2842<tr> 2843<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S32LE:CAPS"></a>GST_AUDIO_FORMAT_S32LE</p></td> 2844<td class="enum_member_description"> 2845<p>32 bits in 32 bits, signed, little endian</p> 2846</td> 2847<td class="enum_member_annotations"> </td> 2848</tr> 2849<tr> 2850<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S32BE:CAPS"></a>GST_AUDIO_FORMAT_S32BE</p></td> 2851<td class="enum_member_description"> 2852<p>32 bits in 32 bits, signed, big endian</p> 2853</td> 2854<td class="enum_member_annotations"> </td> 2855</tr> 2856<tr> 2857<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U32LE:CAPS"></a>GST_AUDIO_FORMAT_U32LE</p></td> 2858<td class="enum_member_description"> 2859<p>32 bits in 32 bits, unsigned, little endian</p> 2860</td> 2861<td class="enum_member_annotations"> </td> 2862</tr> 2863<tr> 2864<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U32BE:CAPS"></a>GST_AUDIO_FORMAT_U32BE</p></td> 2865<td class="enum_member_description"> 2866<p>32 bits in 32 bits, unsigned, big endian</p> 2867</td> 2868<td class="enum_member_annotations"> </td> 2869</tr> 2870<tr> 2871<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S24LE:CAPS"></a>GST_AUDIO_FORMAT_S24LE</p></td> 2872<td class="enum_member_description"> 2873<p>24 bits in 24 bits, signed, little endian</p> 2874</td> 2875<td class="enum_member_annotations"> </td> 2876</tr> 2877<tr> 2878<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S24BE:CAPS"></a>GST_AUDIO_FORMAT_S24BE</p></td> 2879<td class="enum_member_description"> 2880<p>24 bits in 24 bits, signed, big endian</p> 2881</td> 2882<td class="enum_member_annotations"> </td> 2883</tr> 2884<tr> 2885<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U24LE:CAPS"></a>GST_AUDIO_FORMAT_U24LE</p></td> 2886<td class="enum_member_description"> 2887<p>24 bits in 24 bits, unsigned, little endian</p> 2888</td> 2889<td class="enum_member_annotations"> </td> 2890</tr> 2891<tr> 2892<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U24BE:CAPS"></a>GST_AUDIO_FORMAT_U24BE</p></td> 2893<td class="enum_member_description"> 2894<p>24 bits in 24 bits, unsigned, big endian</p> 2895</td> 2896<td class="enum_member_annotations"> </td> 2897</tr> 2898<tr> 2899<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S20LE:CAPS"></a>GST_AUDIO_FORMAT_S20LE</p></td> 2900<td class="enum_member_description"> 2901<p>20 bits in 24 bits, signed, little endian</p> 2902</td> 2903<td class="enum_member_annotations"> </td> 2904</tr> 2905<tr> 2906<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S20BE:CAPS"></a>GST_AUDIO_FORMAT_S20BE</p></td> 2907<td class="enum_member_description"> 2908<p>20 bits in 24 bits, signed, big endian</p> 2909</td> 2910<td class="enum_member_annotations"> </td> 2911</tr> 2912<tr> 2913<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U20LE:CAPS"></a>GST_AUDIO_FORMAT_U20LE</p></td> 2914<td class="enum_member_description"> 2915<p>20 bits in 24 bits, unsigned, little endian</p> 2916</td> 2917<td class="enum_member_annotations"> </td> 2918</tr> 2919<tr> 2920<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U20BE:CAPS"></a>GST_AUDIO_FORMAT_U20BE</p></td> 2921<td class="enum_member_description"> 2922<p>20 bits in 24 bits, unsigned, big endian</p> 2923</td> 2924<td class="enum_member_annotations"> </td> 2925</tr> 2926<tr> 2927<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S18LE:CAPS"></a>GST_AUDIO_FORMAT_S18LE</p></td> 2928<td class="enum_member_description"> 2929<p>18 bits in 24 bits, signed, little endian</p> 2930</td> 2931<td class="enum_member_annotations"> </td> 2932</tr> 2933<tr> 2934<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S18BE:CAPS"></a>GST_AUDIO_FORMAT_S18BE</p></td> 2935<td class="enum_member_description"> 2936<p>18 bits in 24 bits, signed, big endian</p> 2937</td> 2938<td class="enum_member_annotations"> </td> 2939</tr> 2940<tr> 2941<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U18LE:CAPS"></a>GST_AUDIO_FORMAT_U18LE</p></td> 2942<td class="enum_member_description"> 2943<p>18 bits in 24 bits, unsigned, little endian</p> 2944</td> 2945<td class="enum_member_annotations"> </td> 2946</tr> 2947<tr> 2948<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U18BE:CAPS"></a>GST_AUDIO_FORMAT_U18BE</p></td> 2949<td class="enum_member_description"> 2950<p>18 bits in 24 bits, unsigned, big endian</p> 2951</td> 2952<td class="enum_member_annotations"> </td> 2953</tr> 2954<tr> 2955<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-F32LE:CAPS"></a>GST_AUDIO_FORMAT_F32LE</p></td> 2956<td class="enum_member_description"> 2957<p>32-bit floating point samples, little endian</p> 2958</td> 2959<td class="enum_member_annotations"> </td> 2960</tr> 2961<tr> 2962<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-F32BE:CAPS"></a>GST_AUDIO_FORMAT_F32BE</p></td> 2963<td class="enum_member_description"> 2964<p>32-bit floating point samples, big endian</p> 2965</td> 2966<td class="enum_member_annotations"> </td> 2967</tr> 2968<tr> 2969<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-F64LE:CAPS"></a>GST_AUDIO_FORMAT_F64LE</p></td> 2970<td class="enum_member_description"> 2971<p>64-bit floating point samples, little endian</p> 2972</td> 2973<td class="enum_member_annotations"> </td> 2974</tr> 2975<tr> 2976<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-F64BE:CAPS"></a>GST_AUDIO_FORMAT_F64BE</p></td> 2977<td class="enum_member_description"> 2978<p>64-bit floating point samples, big endian</p> 2979</td> 2980<td class="enum_member_annotations"> </td> 2981</tr> 2982<tr> 2983<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S16:CAPS"></a>GST_AUDIO_FORMAT_S16</p></td> 2984<td class="enum_member_description"> 2985<p>16 bits in 16 bits, signed, native endianness</p> 2986</td> 2987<td class="enum_member_annotations"> </td> 2988</tr> 2989<tr> 2990<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U16:CAPS"></a>GST_AUDIO_FORMAT_U16</p></td> 2991<td class="enum_member_description"> 2992<p>16 bits in 16 bits, unsigned, native endianness</p> 2993</td> 2994<td class="enum_member_annotations"> </td> 2995</tr> 2996<tr> 2997<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S24-32:CAPS"></a>GST_AUDIO_FORMAT_S24_32</p></td> 2998<td class="enum_member_description"> 2999<p>24 bits in 32 bits, signed, native endianness</p> 3000</td> 3001<td class="enum_member_annotations"> </td> 3002</tr> 3003<tr> 3004<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U24-32:CAPS"></a>GST_AUDIO_FORMAT_U24_32</p></td> 3005<td class="enum_member_description"> 3006<p>24 bits in 32 bits, unsigned, native endianness</p> 3007</td> 3008<td class="enum_member_annotations"> </td> 3009</tr> 3010<tr> 3011<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S32:CAPS"></a>GST_AUDIO_FORMAT_S32</p></td> 3012<td class="enum_member_description"> 3013<p>32 bits in 32 bits, signed, native endianness</p> 3014</td> 3015<td class="enum_member_annotations"> </td> 3016</tr> 3017<tr> 3018<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U32:CAPS"></a>GST_AUDIO_FORMAT_U32</p></td> 3019<td class="enum_member_description"> 3020<p>32 bits in 32 bits, unsigned, native endianness</p> 3021</td> 3022<td class="enum_member_annotations"> </td> 3023</tr> 3024<tr> 3025<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S24:CAPS"></a>GST_AUDIO_FORMAT_S24</p></td> 3026<td class="enum_member_description"> 3027<p>24 bits in 24 bits, signed, native endianness</p> 3028</td> 3029<td class="enum_member_annotations"> </td> 3030</tr> 3031<tr> 3032<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U24:CAPS"></a>GST_AUDIO_FORMAT_U24</p></td> 3033<td class="enum_member_description"> 3034<p>24 bits in 24 bits, unsigned, native endianness</p> 3035</td> 3036<td class="enum_member_annotations"> </td> 3037</tr> 3038<tr> 3039<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S20:CAPS"></a>GST_AUDIO_FORMAT_S20</p></td> 3040<td class="enum_member_description"> 3041<p>20 bits in 24 bits, signed, native endianness</p> 3042</td> 3043<td class="enum_member_annotations"> </td> 3044</tr> 3045<tr> 3046<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U20:CAPS"></a>GST_AUDIO_FORMAT_U20</p></td> 3047<td class="enum_member_description"> 3048<p>20 bits in 24 bits, unsigned, native endianness</p> 3049</td> 3050<td class="enum_member_annotations"> </td> 3051</tr> 3052<tr> 3053<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-S18:CAPS"></a>GST_AUDIO_FORMAT_S18</p></td> 3054<td class="enum_member_description"> 3055<p>18 bits in 24 bits, signed, native endianness</p> 3056</td> 3057<td class="enum_member_annotations"> </td> 3058</tr> 3059<tr> 3060<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-U18:CAPS"></a>GST_AUDIO_FORMAT_U18</p></td> 3061<td class="enum_member_description"> 3062<p>18 bits in 24 bits, unsigned, native endianness</p> 3063</td> 3064<td class="enum_member_annotations"> </td> 3065</tr> 3066<tr> 3067<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-F32:CAPS"></a>GST_AUDIO_FORMAT_F32</p></td> 3068<td class="enum_member_description"> 3069<p>32-bit floating point samples, native endianness</p> 3070</td> 3071<td class="enum_member_annotations"> </td> 3072</tr> 3073<tr> 3074<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-F64:CAPS"></a>GST_AUDIO_FORMAT_F64</p></td> 3075<td class="enum_member_description"> 3076<p>64-bit floating point samples, native endianness</p> 3077</td> 3078<td class="enum_member_annotations"> </td> 3079</tr> 3080</tbody> 3081</table></div> 3082</div> 3083</div> 3084<hr> 3085<div class="refsect2"> 3086<a name="GstAudioFormatFlags"></a><h3>enum GstAudioFormatFlags</h3> 3087<p>The different audio flags that a format info can have.</p> 3088<div class="refsect3"> 3089<a name="GstAudioFormatFlags.members"></a><h4>Members</h4> 3090<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3091<colgroup> 3092<col width="300px" class="enum_members_name"> 3093<col class="enum_members_description"> 3094<col width="200px" class="enum_members_annotations"> 3095</colgroup> 3096<tbody> 3097<tr> 3098<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-FLAG-INTEGER:CAPS"></a>GST_AUDIO_FORMAT_FLAG_INTEGER</p></td> 3099<td class="enum_member_description"> 3100<p>integer samples</p> 3101</td> 3102<td class="enum_member_annotations"> </td> 3103</tr> 3104<tr> 3105<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-FLAG-FLOAT:CAPS"></a>GST_AUDIO_FORMAT_FLAG_FLOAT</p></td> 3106<td class="enum_member_description"> 3107<p>float samples</p> 3108</td> 3109<td class="enum_member_annotations"> </td> 3110</tr> 3111<tr> 3112<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-FLAG-SIGNED:CAPS"></a>GST_AUDIO_FORMAT_FLAG_SIGNED</p></td> 3113<td class="enum_member_description"> 3114<p>signed samples</p> 3115</td> 3116<td class="enum_member_annotations"> </td> 3117</tr> 3118<tr> 3119<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-FLAG-COMPLEX:CAPS"></a>GST_AUDIO_FORMAT_FLAG_COMPLEX</p></td> 3120<td class="enum_member_description"> 3121<p>complex layout</p> 3122</td> 3123<td class="enum_member_annotations"> </td> 3124</tr> 3125<tr> 3126<td class="enum_member_name"><p><a name="GST-AUDIO-FORMAT-FLAG-UNPACK:CAPS"></a>GST_AUDIO_FORMAT_FLAG_UNPACK</p></td> 3127<td class="enum_member_description"> 3128<p>the format can be used in 3129<a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatUnpack" title="GstAudioFormatUnpack ()"><span class="type">GstAudioFormatUnpack</span></a> and <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatPack" title="GstAudioFormatPack ()"><span class="type">GstAudioFormatPack</span></a> functions</p> 3130</td> 3131<td class="enum_member_annotations"> </td> 3132</tr> 3133</tbody> 3134</table></div> 3135</div> 3136</div> 3137<hr> 3138<div class="refsect2"> 3139<a name="GstAudioFormatInfo-struct"></a><h3>struct GstAudioFormatInfo</h3> 3140<pre class="programlisting">struct GstAudioFormatInfo { 3141 GstAudioFormat format; 3142 const gchar *name; 3143 const gchar *description; 3144 GstAudioFormatFlags flags; 3145 gint endianness; 3146 gint width; 3147 gint depth; 3148 guint8 silence[8]; 3149 3150 GstAudioFormat unpack_format; 3151 GstAudioFormatUnpack unpack_func; 3152 GstAudioFormatPack pack_func; 3153}; 3154</pre> 3155<p>Information for an audio format.</p> 3156<div class="refsect3"> 3157<a name="GstAudioFormatInfo.members"></a><h4>Members</h4> 3158<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3159<colgroup> 3160<col width="300px" class="struct_members_name"> 3161<col class="struct_members_description"> 3162<col width="200px" class="struct_members_annotations"> 3163</colgroup> 3164<tbody> 3165<tr> 3166<td class="struct_member_name"><p><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-struct.format"></a>format</code></em>;</p></td> 3167<td class="struct_member_description"><p><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="type">GstAudioFormat</span></a></p></td> 3168<td class="struct_member_annotations"> </td> 3169</tr> 3170<tr> 3171<td class="struct_member_name"><p>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstAudioFormatInfo-struct.name"></a>name</code></em>;</p></td> 3172<td class="struct_member_description"><p>string representation of the format</p></td> 3173<td class="struct_member_annotations"> </td> 3174</tr> 3175<tr> 3176<td class="struct_member_name"><p>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstAudioFormatInfo-struct.description"></a>description</code></em>;</p></td> 3177<td class="struct_member_description"><p>user readable description of the format</p></td> 3178<td class="struct_member_annotations"> </td> 3179</tr> 3180<tr> 3181<td class="struct_member_name"><p><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-struct.flags"></a>flags</code></em>;</p></td> 3182<td class="struct_member_description"><p><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatFlags" title="enum GstAudioFormatFlags"><span class="type">GstAudioFormatFlags</span></a></p></td> 3183<td class="struct_member_annotations"> </td> 3184</tr> 3185<tr> 3186<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstAudioFormatInfo-struct.endianness"></a>endianness</code></em>;</p></td> 3187<td class="struct_member_description"><p>the endianness</p></td> 3188<td class="struct_member_annotations"> </td> 3189</tr> 3190<tr> 3191<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstAudioFormatInfo-struct.width"></a>width</code></em>;</p></td> 3192<td class="struct_member_description"><p>amount of bits used for one sample</p></td> 3193<td class="struct_member_annotations"> </td> 3194</tr> 3195<tr> 3196<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstAudioFormatInfo-struct.depth"></a>depth</code></em>;</p></td> 3197<td class="struct_member_description"><p>amount of valid bits in <em class="parameter"><code>width</code></em> 3198</p></td> 3199<td class="struct_member_annotations"> </td> 3200</tr> 3201<tr> 3202<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> <em class="structfield"><code><a name="GstAudioFormatInfo-struct.silence"></a>silence</code></em>[8];</p></td> 3203<td class="struct_member_description"><p><em class="parameter"><code>width</code></em> 3204/8 bytes with 1 silent sample</p></td> 3205<td class="struct_member_annotations"> </td> 3206</tr> 3207<tr> 3208<td class="struct_member_name"><p><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-struct.unpack-format"></a>unpack_format</code></em>;</p></td> 3209<td class="struct_member_description"><p>the format of the unpacked samples</p></td> 3210<td class="struct_member_annotations"> </td> 3211</tr> 3212<tr> 3213<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatUnpack" title="GstAudioFormatUnpack ()"><span class="type">GstAudioFormatUnpack</span></a> <em class="structfield"><code><a name="GstAudioFormatInfo-struct.unpack-func"></a>unpack_func</code></em>;</p></td> 3214<td class="struct_member_description"><p>function to unpack samples</p></td> 3215<td class="struct_member_annotations"> </td> 3216</tr> 3217<tr> 3218<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatPack" title="GstAudioFormatPack ()"><span class="type">GstAudioFormatPack</span></a> <em class="structfield"><code><a name="GstAudioFormatInfo-struct.pack-func"></a>pack_func</code></em>;</p></td> 3219<td class="struct_member_description"><p>function to pack samples</p></td> 3220<td class="struct_member_annotations"> </td> 3221</tr> 3222</tbody> 3223</table></div> 3224</div> 3225</div> 3226<hr> 3227<div class="refsect2"> 3228<a name="GstAudioInfo-struct"></a><h3>struct GstAudioInfo</h3> 3229<pre class="programlisting">struct GstAudioInfo { 3230 const GstAudioFormatInfo *finfo; 3231 GstAudioFlags flags; 3232 GstAudioLayout layout; 3233 gint rate; 3234 gint channels; 3235 gint bpf; 3236 GstAudioChannelPosition position[64]; 3237}; 3238</pre> 3239<p>Information describing audio properties. This information can be filled 3240in 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>.</p> 3241<p>Use the provided macros to access the info in this structure.</p> 3242<div class="refsect3"> 3243<a name="GstAudioInfo.members"></a><h4>Members</h4> 3244<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3245<colgroup> 3246<col width="300px" class="struct_members_name"> 3247<col class="struct_members_description"> 3248<col width="200px" class="struct_members_annotations"> 3249</colgroup> 3250<tbody> 3251<tr> 3252<td class="struct_member_name"><p>const <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioFormatInfo"><span class="type">GstAudioFormatInfo</span></a> *<em class="structfield"><code><a name="GstAudioInfo-struct.finfo"></a>finfo</code></em>;</p></td> 3253<td class="struct_member_description"><p>the format info of the audio</p></td> 3254<td class="struct_member_annotations"> </td> 3255</tr> 3256<tr> 3257<td class="struct_member_name"><p><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-struct.flags"></a>flags</code></em>;</p></td> 3258<td class="struct_member_description"><p>additional audio flags</p></td> 3259<td class="struct_member_annotations"> </td> 3260</tr> 3261<tr> 3262<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioLayout" title="enum GstAudioLayout"><span class="type">GstAudioLayout</span></a> <em class="structfield"><code><a name="GstAudioInfo-struct.layout"></a>layout</code></em>;</p></td> 3263<td class="struct_member_description"><p>audio layout</p></td> 3264<td class="struct_member_annotations"> </td> 3265</tr> 3266<tr> 3267<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstAudioInfo-struct.rate"></a>rate</code></em>;</p></td> 3268<td class="struct_member_description"><p>the audio sample rate</p></td> 3269<td class="struct_member_annotations"> </td> 3270</tr> 3271<tr> 3272<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstAudioInfo-struct.channels"></a>channels</code></em>;</p></td> 3273<td class="struct_member_description"><p>the number of channels</p></td> 3274<td class="struct_member_annotations"> </td> 3275</tr> 3276<tr> 3277<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstAudioInfo-struct.bpf"></a>bpf</code></em>;</p></td> 3278<td class="struct_member_description"><p>the number of bytes for one frame, this is the size of one 3279sample * <em class="parameter"><code>channels</code></em> 3280</p></td> 3281<td class="struct_member_annotations"> </td> 3282</tr> 3283<tr> 3284<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-Audio-channels.html#GstAudioChannelPosition" title="enum GstAudioChannelPosition"><span class="type">GstAudioChannelPosition</span></a> <em class="structfield"><code><a name="GstAudioInfo-struct.position"></a>position</code></em>[64];</p></td> 3285<td class="struct_member_description"><p>the positions for each channel</p></td> 3286<td class="struct_member_annotations"> </td> 3287</tr> 3288</tbody> 3289</table></div> 3290</div> 3291</div> 3292<hr> 3293<div class="refsect2"> 3294<a name="GstAudioLayout"></a><h3>enum GstAudioLayout</h3> 3295<p>Layout of the audio samples for the different channels.</p> 3296<div class="refsect3"> 3297<a name="GstAudioLayout.members"></a><h4>Members</h4> 3298<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3299<colgroup> 3300<col width="300px" class="enum_members_name"> 3301<col class="enum_members_description"> 3302<col width="200px" class="enum_members_annotations"> 3303</colgroup> 3304<tbody> 3305<tr> 3306<td class="enum_member_name"><p><a name="GST-AUDIO-LAYOUT-INTERLEAVED:CAPS"></a>GST_AUDIO_LAYOUT_INTERLEAVED</p></td> 3307<td class="enum_member_description"> 3308<p>interleaved audio</p> 3309</td> 3310<td class="enum_member_annotations"> </td> 3311</tr> 3312<tr> 3313<td class="enum_member_name"><p><a name="GST-AUDIO-LAYOUT-NON-INTERLEAVED:CAPS"></a>GST_AUDIO_LAYOUT_NON_INTERLEAVED</p></td> 3314<td class="enum_member_description"> 3315<p>non-interleaved audio</p> 3316</td> 3317<td class="enum_member_annotations"> </td> 3318</tr> 3319</tbody> 3320</table></div> 3321</div> 3322</div> 3323<hr> 3324<div class="refsect2"> 3325<a name="GstAudioPackFlags"></a><h3>enum GstAudioPackFlags</h3> 3326<p>The different flags that can be used when packing and unpacking.</p> 3327<div class="refsect3"> 3328<a name="GstAudioPackFlags.members"></a><h4>Members</h4> 3329<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3330<colgroup> 3331<col width="300px" class="enum_members_name"> 3332<col class="enum_members_description"> 3333<col width="200px" class="enum_members_annotations"> 3334</colgroup> 3335<tbody> 3336<tr> 3337<td class="enum_member_name"><p><a name="GST-AUDIO-PACK-FLAG-NONE:CAPS"></a>GST_AUDIO_PACK_FLAG_NONE</p></td> 3338<td class="enum_member_description"> 3339<p>No flag</p> 3340</td> 3341<td class="enum_member_annotations"> </td> 3342</tr> 3343<tr> 3344<td class="enum_member_name"><p><a name="GST-AUDIO-PACK-FLAG-TRUNCATE-RANGE:CAPS"></a>GST_AUDIO_PACK_FLAG_TRUNCATE_RANGE</p></td> 3345<td class="enum_member_description"> 3346<p>When the source has a smaller depth 3347 than the target format, set the least significant bits of the target 3348 to 0. This is likely sightly faster but less accurate. When this flag 3349 is not specified, the most significant bits of the source are duplicated 3350 in the least significant bits of the destination.</p> 3351</td> 3352<td class="enum_member_annotations"> </td> 3353</tr> 3354</tbody> 3355</table></div> 3356</div> 3357</div> 3358<hr> 3359<div class="refsect2"> 3360<a name="GST-META-TAG-AUDIO-STR:CAPS"></a><h3>GST_META_TAG_AUDIO_STR</h3> 3361<pre class="programlisting">#define GST_META_TAG_AUDIO_STR "audio" 3362</pre> 3363<p>This metadata is relevant for audio streams.</p> 3364<p class="since">Since: <a class="link" href="ix14.html#api-index-1.2">1.2</a></p> 3365</div> 3366<hr> 3367<div class="refsect2"> 3368<a name="GST-META-TAG-AUDIO-CHANNELS-STR:CAPS"></a><h3>GST_META_TAG_AUDIO_CHANNELS_STR</h3> 3369<pre class="programlisting">#define GST_META_TAG_AUDIO_CHANNELS_STR "channels" 3370</pre> 3371<p>This metadata stays relevant as long as channels are unchanged.</p> 3372<p class="since">Since: <a class="link" href="ix14.html#api-index-1.2">1.2</a></p> 3373</div> 3374<hr> 3375<div class="refsect2"> 3376<a name="GST-META-TAG-AUDIO-RATE-STR:CAPS"></a><h3>GST_META_TAG_AUDIO_RATE_STR</h3> 3377<pre class="programlisting">#define GST_META_TAG_AUDIO_RATE_STR "rate" 3378</pre> 3379<p>This metadata stays relevant as long as sample rate is unchanged.</p> 3380<p class="since">Since: <a class="link" href="ix08.html#api-index-1.8">1.8</a></p> 3381</div> 3382<hr> 3383<div class="refsect2"> 3384<a name="GST-AUDIO-RATE-RANGE:CAPS"></a><h3>GST_AUDIO_RATE_RANGE</h3> 3385<pre class="programlisting">#define GST_AUDIO_RATE_RANGE "(int) [ 1, max ]" 3386</pre> 3387<p>Maximum range of allowed sample rates, for use in template caps strings.</p> 3388</div> 3389<hr> 3390<div class="refsect2"> 3391<a name="GST-AUDIO-CHANNELS-RANGE:CAPS"></a><h3>GST_AUDIO_CHANNELS_RANGE</h3> 3392<pre class="programlisting">#define GST_AUDIO_CHANNELS_RANGE "(int) [ 1, max ]" 3393</pre> 3394<p>Maximum range of allowed channels, for use in template caps strings.</p> 3395</div> 3396<hr> 3397<div class="refsect2"> 3398<a name="GST-AUDIO-FORMATS-ALL:CAPS"></a><h3>GST_AUDIO_FORMATS_ALL</h3> 3399<pre class="programlisting">#define GST_AUDIO_FORMATS_ALL</pre> 3400<p>List of all audio formats, for use in template caps strings.</p> 3401</div> 3402<hr> 3403<div class="refsect2"> 3404<a name="GST-AUDIO-DEF-RATE:CAPS"></a><h3>GST_AUDIO_DEF_RATE</h3> 3405<pre class="programlisting">#define GST_AUDIO_DEF_RATE 44100 3406</pre> 3407<p>Standard sampling rate used in consumer audio.</p> 3408</div> 3409<hr> 3410<div class="refsect2"> 3411<a name="GST-AUDIO-DEF-CHANNELS:CAPS"></a><h3>GST_AUDIO_DEF_CHANNELS</h3> 3412<pre class="programlisting">#define GST_AUDIO_DEF_CHANNELS 2 3413</pre> 3414<p>Standard number of channels used in consumer audio.</p> 3415</div> 3416<hr> 3417<div class="refsect2"> 3418<a name="GST-AUDIO-DEF-FORMAT:CAPS"></a><h3>GST_AUDIO_DEF_FORMAT</h3> 3419<pre class="programlisting">#define GST_AUDIO_DEF_FORMAT "S16LE" 3420</pre> 3421<p>Standard format used in consumer audio.</p> 3422</div> 3423<hr> 3424<div class="refsect2"> 3425<a name="GstAudioBuffer"></a><h3>GstAudioBuffer</h3> 3426<pre class="programlisting">typedef struct { 3427 GstAudioInfo info; 3428 3429 gsize n_samples; 3430 gint n_planes; 3431 gpointer *planes; 3432 3433 GstBuffer *buffer; 3434} GstAudioBuffer; 3435</pre> 3436<p>A structure containing the result of an audio buffer map operation, 3437which is executed with <a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-buffer-map" title="gst_audio_buffer_map ()"><code class="function">gst_audio_buffer_map()</code></a>. For non-interleaved (planar) 3438buffers, the beginning of each channel in the buffer has its own pointer in 3439the <em class="parameter"><code>planes</code></em> 3440 array. For interleaved buffers, the <em class="parameter"><code>planes</code></em> 3441 array only contains 3442one item, which is the pointer to the beginning of the buffer, and <em class="parameter"><code>n_planes</code></em> 3443 3444equals 1.</p> 3445<p>The different channels in <em class="parameter"><code>planes</code></em> 3446 are always in the GStreamer channel order.</p> 3447<div class="refsect3"> 3448<a name="GstAudioBuffer.members"></a><h4>Members</h4> 3449<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3450<colgroup> 3451<col width="300px" class="struct_members_name"> 3452<col class="struct_members_description"> 3453<col width="200px" class="struct_members_annotations"> 3454</colgroup> 3455<tbody> 3456<tr> 3457<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> <em class="structfield"><code><a name="GstAudioBuffer.info"></a>info</code></em>;</p></td> 3458<td class="struct_member_description"><p>a <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioInfo"><span class="type">GstAudioInfo</span></a> describing the audio properties of this buffer</p></td> 3459<td class="struct_member_annotations"> </td> 3460</tr> 3461<tr> 3462<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> <em class="structfield"><code><a name="GstAudioBuffer.n-samples"></a>n_samples</code></em>;</p></td> 3463<td class="struct_member_description"><p>the size of the buffer in samples</p></td> 3464<td class="struct_member_annotations"> </td> 3465</tr> 3466<tr> 3467<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstAudioBuffer.n-planes"></a>n_planes</code></em>;</p></td> 3468<td class="struct_member_description"><p>the number of planes available</p></td> 3469<td class="struct_member_annotations"> </td> 3470</tr> 3471<tr> 3472<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *<em class="structfield"><code><a name="GstAudioBuffer.planes"></a>planes</code></em>;</p></td> 3473<td class="struct_member_description"><p>an array of <em class="parameter"><code>n_planes</code></em> 3474pointers pointing to the start of each 3475plane in the mapped buffer</p></td> 3476<td class="struct_member_annotations"> </td> 3477</tr> 3478<tr> 3479<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a> *<em class="structfield"><code><a name="GstAudioBuffer.buffer"></a>buffer</code></em>;</p></td> 3480<td class="struct_member_description"><p>the mapped buffer</p></td> 3481<td class="struct_member_annotations"> </td> 3482</tr> 3483</tbody> 3484</table></div> 3485</div> 3486<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 3487</div> 3488<hr> 3489<div class="refsect2"> 3490<a name="GstAudioResampler"></a><h3>GstAudioResampler</h3> 3491<pre class="programlisting">typedef struct _GstAudioResampler GstAudioResampler;</pre> 3492</div> 3493<hr> 3494<div class="refsect2"> 3495<a name="GstAudioResamplerFilterInterpolation"></a><h3>enum GstAudioResamplerFilterInterpolation</h3> 3496<p>The different filter interpolation methods.</p> 3497<div class="refsect3"> 3498<a name="GstAudioResamplerFilterInterpolation.members"></a><h4>Members</h4> 3499<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3500<colgroup> 3501<col width="300px" class="enum_members_name"> 3502<col class="enum_members_description"> 3503<col width="200px" class="enum_members_annotations"> 3504</colgroup> 3505<tbody> 3506<tr> 3507<td class="enum_member_name"><p><a name="GST-AUDIO-RESAMPLER-FILTER-INTERPOLATION-NONE:CAPS"></a>GST_AUDIO_RESAMPLER_FILTER_INTERPOLATION_NONE</p></td> 3508<td class="enum_member_description"> 3509<p>no interpolation</p> 3510</td> 3511<td class="enum_member_annotations"> </td> 3512</tr> 3513<tr> 3514<td class="enum_member_name"><p><a name="GST-AUDIO-RESAMPLER-FILTER-INTERPOLATION-LINEAR:CAPS"></a>GST_AUDIO_RESAMPLER_FILTER_INTERPOLATION_LINEAR</p></td> 3515<td class="enum_member_description"> 3516<p>linear interpolation of the 3517 filter coeficients.</p> 3518</td> 3519<td class="enum_member_annotations"> </td> 3520</tr> 3521<tr> 3522<td class="enum_member_name"><p><a name="GST-AUDIO-RESAMPLER-FILTER-INTERPOLATION-CUBIC:CAPS"></a>GST_AUDIO_RESAMPLER_FILTER_INTERPOLATION_CUBIC</p></td> 3523<td class="enum_member_description"> 3524<p>cubic interpolation of the 3525 filter coeficients.</p> 3526</td> 3527<td class="enum_member_annotations"> </td> 3528</tr> 3529</tbody> 3530</table></div> 3531</div> 3532</div> 3533<hr> 3534<div class="refsect2"> 3535<a name="GstAudioResamplerFilterMode"></a><h3>enum GstAudioResamplerFilterMode</h3> 3536<p>Select for the filter tables should be set up.</p> 3537<div class="refsect3"> 3538<a name="GstAudioResamplerFilterMode.members"></a><h4>Members</h4> 3539<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3540<colgroup> 3541<col width="300px" class="enum_members_name"> 3542<col class="enum_members_description"> 3543<col width="200px" class="enum_members_annotations"> 3544</colgroup> 3545<tbody> 3546<tr> 3547<td class="enum_member_name"><p><a name="GST-AUDIO-RESAMPLER-FILTER-MODE-INTERPOLATED:CAPS"></a>GST_AUDIO_RESAMPLER_FILTER_MODE_INTERPOLATED</p></td> 3548<td class="enum_member_description"> 3549<p>Use interpolated filter tables. This 3550 uses less memory but more CPU and is slightly less accurate but it allows for more 3551 efficient variable rate resampling with <a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-resampler-update" title="gst_audio_resampler_update ()"><code class="function">gst_audio_resampler_update()</code></a>.</p> 3552</td> 3553<td class="enum_member_annotations"> </td> 3554</tr> 3555<tr> 3556<td class="enum_member_name"><p><a name="GST-AUDIO-RESAMPLER-FILTER-MODE-FULL:CAPS"></a>GST_AUDIO_RESAMPLER_FILTER_MODE_FULL</p></td> 3557<td class="enum_member_description"> 3558<p>Use full filter table. This uses more memory 3559 but less CPU.</p> 3560</td> 3561<td class="enum_member_annotations"> </td> 3562</tr> 3563<tr> 3564<td class="enum_member_name"><p><a name="GST-AUDIO-RESAMPLER-FILTER-MODE-AUTO:CAPS"></a>GST_AUDIO_RESAMPLER_FILTER_MODE_AUTO</p></td> 3565<td class="enum_member_description"> 3566<p>Automatically choose between interpolated 3567 and full filter tables.</p> 3568</td> 3569<td class="enum_member_annotations"> </td> 3570</tr> 3571</tbody> 3572</table></div> 3573</div> 3574</div> 3575<hr> 3576<div class="refsect2"> 3577<a name="GstAudioResamplerFlags"></a><h3>enum GstAudioResamplerFlags</h3> 3578<p>Different resampler flags.</p> 3579<div class="refsect3"> 3580<a name="GstAudioResamplerFlags.members"></a><h4>Members</h4> 3581<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3582<colgroup> 3583<col width="300px" class="enum_members_name"> 3584<col class="enum_members_description"> 3585<col width="200px" class="enum_members_annotations"> 3586</colgroup> 3587<tbody> 3588<tr> 3589<td class="enum_member_name"><p><a name="GST-AUDIO-RESAMPLER-FLAG-NONE:CAPS"></a>GST_AUDIO_RESAMPLER_FLAG_NONE</p></td> 3590<td class="enum_member_description"> 3591<p>no flags</p> 3592</td> 3593<td class="enum_member_annotations"> </td> 3594</tr> 3595<tr> 3596<td class="enum_member_name"><p><a name="GST-AUDIO-RESAMPLER-FLAG-NON-INTERLEAVED-IN:CAPS"></a>GST_AUDIO_RESAMPLER_FLAG_NON_INTERLEAVED_IN</p></td> 3597<td class="enum_member_description"> 3598<p>input samples are non-interleaved. 3599 an array of blocks of samples, one for each channel, should be passed to the 3600 resample function.</p> 3601</td> 3602<td class="enum_member_annotations"> </td> 3603</tr> 3604<tr> 3605<td class="enum_member_name"><p><a name="GST-AUDIO-RESAMPLER-FLAG-NON-INTERLEAVED-OUT:CAPS"></a>GST_AUDIO_RESAMPLER_FLAG_NON_INTERLEAVED_OUT</p></td> 3606<td class="enum_member_description"> 3607<p>output samples are non-interleaved. 3608 an array of blocks of samples, one for each channel, should be passed to the 3609 resample function.</p> 3610</td> 3611<td class="enum_member_annotations"> </td> 3612</tr> 3613<tr> 3614<td class="enum_member_name"><p><a name="GST-AUDIO-RESAMPLER-FLAG-VARIABLE-RATE:CAPS"></a>GST_AUDIO_RESAMPLER_FLAG_VARIABLE_RATE</p></td> 3615<td class="enum_member_description"> 3616<p>optimize for dynamic updates of the sample 3617 rates with <a class="link" href="gst-plugins-base-libs-GstAudio.html#gst-audio-resampler-update" title="gst_audio_resampler_update ()"><code class="function">gst_audio_resampler_update()</code></a>. This will select an interpolating filter 3618 when <a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-FILTER-MODE-AUTO:CAPS"><span class="type">GST_AUDIO_RESAMPLER_FILTER_MODE_AUTO</span></a> is configured.</p> 3619</td> 3620<td class="enum_member_annotations"> </td> 3621</tr> 3622</tbody> 3623</table></div> 3624</div> 3625</div> 3626<hr> 3627<div class="refsect2"> 3628<a name="GstAudioResamplerMethod"></a><h3>enum GstAudioResamplerMethod</h3> 3629<p>Different subsampling and upsampling methods</p> 3630<div class="refsect3"> 3631<a name="GstAudioResamplerMethod.members"></a><h4>Members</h4> 3632<div class="informaltable"><table class="informaltable" width="100%" border="0"> 3633<colgroup> 3634<col width="300px" class="enum_members_name"> 3635<col class="enum_members_description"> 3636<col width="200px" class="enum_members_annotations"> 3637</colgroup> 3638<tbody> 3639<tr> 3640<td class="enum_member_name"><p><a name="GST-AUDIO-RESAMPLER-METHOD-NEAREST:CAPS"></a>GST_AUDIO_RESAMPLER_METHOD_NEAREST</p></td> 3641<td class="enum_member_description"> 3642<p>Duplicates the samples when 3643 upsampling and drops when downsampling</p> 3644</td> 3645<td class="enum_member_annotations"> </td> 3646</tr> 3647<tr> 3648<td class="enum_member_name"><p><a name="GST-AUDIO-RESAMPLER-METHOD-LINEAR:CAPS"></a>GST_AUDIO_RESAMPLER_METHOD_LINEAR</p></td> 3649<td class="enum_member_description"> 3650<p>Uses linear interpolation to reconstruct 3651 missing samples and averaging to downsample</p> 3652</td> 3653<td class="enum_member_annotations"> </td> 3654</tr> 3655<tr> 3656<td class="enum_member_name"><p><a name="GST-AUDIO-RESAMPLER-METHOD-CUBIC:CAPS"></a>GST_AUDIO_RESAMPLER_METHOD_CUBIC</p></td> 3657<td class="enum_member_description"> 3658<p>Uses cubic interpolation</p> 3659</td> 3660<td class="enum_member_annotations"> </td> 3661</tr> 3662<tr> 3663<td class="enum_member_name"><p><a name="GST-AUDIO-RESAMPLER-METHOD-BLACKMAN-NUTTALL:CAPS"></a>GST_AUDIO_RESAMPLER_METHOD_BLACKMAN_NUTTALL</p></td> 3664<td class="enum_member_description"> 3665<p>Uses Blackman-Nuttall windowed sinc interpolation</p> 3666</td> 3667<td class="enum_member_annotations"> </td> 3668</tr> 3669<tr> 3670<td class="enum_member_name"><p><a name="GST-AUDIO-RESAMPLER-METHOD-KAISER:CAPS"></a>GST_AUDIO_RESAMPLER_METHOD_KAISER</p></td> 3671<td class="enum_member_description"> 3672<p>Uses Kaiser windowed sinc interpolation</p> 3673</td> 3674<td class="enum_member_annotations"> </td> 3675</tr> 3676</tbody> 3677</table></div> 3678</div> 3679<p class="since">Since: <a class="link" href="ix10.html#api-index-1.6">1.6</a></p> 3680</div> 3681<hr> 3682<div class="refsect2"> 3683<a name="GST-AUDIO-RESAMPLER-OPT-CUBIC-B:CAPS"></a><h3>GST_AUDIO_RESAMPLER_OPT_CUBIC_B</h3> 3684<pre class="programlisting">#define GST_AUDIO_RESAMPLER_OPT_CUBIC_B "GstAudioResampler.cubic-b" 3685</pre> 3686<p>G_TYPE_DOUBLE, B parameter of the cubic filter. 3687Values between 0.0 and 2.0 are accepted. 1.0 is the default.</p> 3688<p>Below are some values of popular filters: 3689 B C 3690Hermite 0.0 0.0 3691Spline 1.0 0.0 3692Catmull-Rom 0.0 1/2</p> 3693</div> 3694<hr> 3695<div class="refsect2"> 3696<a name="GST-AUDIO-RESAMPLER-OPT-CUBIC-C:CAPS"></a><h3>GST_AUDIO_RESAMPLER_OPT_CUBIC_C</h3> 3697<pre class="programlisting">#define GST_AUDIO_RESAMPLER_OPT_CUBIC_C "GstAudioResampler.cubic-c" 3698</pre> 3699<p>G_TYPE_DOUBLE, C parameter of the cubic filter. 3700Values between 0.0 and 2.0 are accepted. 0.0 is the default.</p> 3701<p>See <a class="link" href="gst-plugins-base-libs-GstAudio.html#GST-AUDIO-RESAMPLER-OPT-CUBIC-B:CAPS" title="GST_AUDIO_RESAMPLER_OPT_CUBIC_B"><span class="type">GST_AUDIO_RESAMPLER_OPT_CUBIC_B</span></a> for some more common values</p> 3702</div> 3703<hr> 3704<div class="refsect2"> 3705<a name="GST-AUDIO-RESAMPLER-OPT-CUTOFF:CAPS"></a><h3>GST_AUDIO_RESAMPLER_OPT_CUTOFF</h3> 3706<pre class="programlisting">#define GST_AUDIO_RESAMPLER_OPT_CUTOFF "GstAudioResampler.cutoff" 3707</pre> 3708<p>G_TYPE_DOUBLE, Cutoff parameter for the filter. 0.940 is the default.</p> 3709</div> 3710<hr> 3711<div class="refsect2"> 3712<a name="GST-AUDIO-RESAMPLER-OPT-FILTER-INTERPOLATION:CAPS"></a><h3>GST_AUDIO_RESAMPLER_OPT_FILTER_INTERPOLATION</h3> 3713<pre class="programlisting">#define GST_AUDIO_RESAMPLER_OPT_FILTER_INTERPOLATION "GstAudioResampler.filter-interpolation" 3714</pre> 3715<p>GST_TYPE_AUDIO_RESAMPLER_INTERPOLATION: how the filter coeficients should be 3716 interpolated. 3717GST_AUDIO_RESAMPLER_FILTER_INTERPOLATION_CUBIC is default.</p> 3718</div> 3719<hr> 3720<div class="refsect2"> 3721<a name="GST-AUDIO-RESAMPLER-OPT-FILTER-MODE:CAPS"></a><h3>GST_AUDIO_RESAMPLER_OPT_FILTER_MODE</h3> 3722<pre class="programlisting">#define GST_AUDIO_RESAMPLER_OPT_FILTER_MODE "GstAudioResampler.filter-mode" 3723</pre> 3724<p>GST_TYPE_AUDIO_RESAMPLER_FILTER_MODE: how the filter tables should be 3725constructed. 3726GST_AUDIO_RESAMPLER_FILTER_MODE_AUTO is the default.</p> 3727</div> 3728<hr> 3729<div class="refsect2"> 3730<a name="GST-AUDIO-RESAMPLER-OPT-FILTER-MODE-THRESHOLD:CAPS"></a><h3>GST_AUDIO_RESAMPLER_OPT_FILTER_MODE_THRESHOLD</h3> 3731<pre class="programlisting">#define GST_AUDIO_RESAMPLER_OPT_FILTER_MODE_THRESHOLD "GstAudioResampler.filter-mode-threshold" 3732</pre> 3733<p>G_TYPE_UINT: the amount of memory to use for full filter tables before 3734switching to interpolated filter tables. 37351048576 is the default.</p> 3736</div> 3737<hr> 3738<div class="refsect2"> 3739<a name="GST-AUDIO-RESAMPLER-OPT-FILTER-OVERSAMPLE:CAPS"></a><h3>GST_AUDIO_RESAMPLER_OPT_FILTER_OVERSAMPLE</h3> 3740<pre class="programlisting">#define GST_AUDIO_RESAMPLER_OPT_FILTER_OVERSAMPLE "GstAudioResampler.filter-oversample" 3741</pre> 3742<p>G_TYPE_UINT, oversampling to use when interpolating filters 37438 is the default.</p> 3744</div> 3745<hr> 3746<div class="refsect2"> 3747<a name="GST-AUDIO-RESAMPLER-OPT-MAX-PHASE-ERROR:CAPS"></a><h3>GST_AUDIO_RESAMPLER_OPT_MAX_PHASE_ERROR</h3> 3748<pre class="programlisting">#define GST_AUDIO_RESAMPLER_OPT_MAX_PHASE_ERROR "GstAudioResampler.max-phase-error" 3749</pre> 3750<p>G_TYPE_DOUBLE: The maximum allowed phase error when switching sample 3751rates. 37520.1 is the default.</p> 3753</div> 3754<hr> 3755<div class="refsect2"> 3756<a name="GST-AUDIO-RESAMPLER-OPT-N-TAPS:CAPS"></a><h3>GST_AUDIO_RESAMPLER_OPT_N_TAPS</h3> 3757<pre class="programlisting">#define GST_AUDIO_RESAMPLER_OPT_N_TAPS "GstAudioResampler.n-taps" 3758</pre> 3759<p>G_TYPE_INT: the number of taps to use for the filter. 37600 is the default and selects the taps automatically.</p> 3761</div> 3762<hr> 3763<div class="refsect2"> 3764<a name="GST-AUDIO-RESAMPLER-OPT-STOP-ATTENUATION:CAPS"></a><h3>GST_AUDIO_RESAMPLER_OPT_STOP_ATTENUATION</h3> 3765<pre class="programlisting">#define GST_AUDIO_RESAMPLER_OPT_STOP_ATTENUATION "GstAudioResampler.stop-attenutation" 3766</pre> 3767<p>G_TYPE_DOUBLE, stopband attenuation in decibels. The attenuation 3768after the stopband for the kaiser window. 85 dB is the default.</p> 3769</div> 3770<hr> 3771<div class="refsect2"> 3772<a name="GST-AUDIO-RESAMPLER-OPT-TRANSITION-BANDWIDTH:CAPS"></a><h3>GST_AUDIO_RESAMPLER_OPT_TRANSITION_BANDWIDTH</h3> 3773<pre class="programlisting">#define GST_AUDIO_RESAMPLER_OPT_TRANSITION_BANDWIDTH "GstAudioResampler.transition-bandwidth" 3774</pre> 3775<p>G_TYPE_DOUBLE, transition bandwidth. The width of the 3776transition band for the kaiser window. 0.087 is the default.</p> 3777</div> 3778<hr> 3779<div class="refsect2"> 3780<a name="GST-AUDIO-RESAMPLER-QUALITY-DEFAULT:CAPS"></a><h3>GST_AUDIO_RESAMPLER_QUALITY_DEFAULT</h3> 3781<pre class="programlisting">#define GST_AUDIO_RESAMPLER_QUALITY_DEFAULT 4 3782</pre> 3783</div> 3784<hr> 3785<div class="refsect2"> 3786<a name="GST-AUDIO-RESAMPLER-QUALITY-MAX:CAPS"></a><h3>GST_AUDIO_RESAMPLER_QUALITY_MAX</h3> 3787<pre class="programlisting">#define GST_AUDIO_RESAMPLER_QUALITY_MAX 10 3788</pre> 3789</div> 3790<hr> 3791<div class="refsect2"> 3792<a name="GST-AUDIO-RESAMPLER-QUALITY-MIN:CAPS"></a><h3>GST_AUDIO_RESAMPLER_QUALITY_MIN</h3> 3793<pre class="programlisting">#define GST_AUDIO_RESAMPLER_QUALITY_MIN 0 3794</pre> 3795</div> 3796<hr> 3797<div class="refsect2"> 3798<a name="GstAudioStreamAlign-struct"></a><h3>GstAudioStreamAlign</h3> 3799<pre class="programlisting">typedef struct _GstAudioStreamAlign GstAudioStreamAlign;</pre> 3800<p>The opaque <a class="link" href="gst-plugins-base-libs-GstAudio.html#GstAudioStreamAlign"><span class="type">GstAudioStreamAlign</span></a> data structure.</p> 3801<p class="since">Since: <a class="link" href="ix04.html#api-index-1.14">1.14</a></p> 3802</div> 3803</div> 3804</div> 3805<div class="footer"> 3806<hr>Generated by GTK-Doc V1.28</div> 3807</body> 3808</html>
