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 IEC61937: 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="GstAudioRingBuffer.html" title="GstAudioRingBuffer"> 10<link rel="next" href="GstStreamVolume.html" title="GstStreamVolume"> 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-IEC61937.description" class="shortcut">Description</a></span> 19</td> 20<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 21<td><a accesskey="u" href="gstreamer-audio.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 22<td><a accesskey="p" href="GstAudioRingBuffer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 23<td><a accesskey="n" href="GstStreamVolume.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 24</tr></table> 25<div class="refentry"> 26<a name="gst-plugins-base-libs-GstAudio-IEC61937"></a><div class="titlepage"></div> 27<div class="refnamediv"><table width="100%"><tr> 28<td valign="top"> 29<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-GstAudio-IEC61937.top_of_page"></a>GstAudio IEC61937</span></h2> 30<p>GstAudio IEC61937 — Utility functions for IEC 61937 payloading</p> 31</td> 32<td class="gallery_image" valign="top" align="right"></td> 33</tr></table></div> 34<div class="refsect1"> 35<a name="gst-plugins-base-libs-GstAudio-IEC61937.functions"></a><h2>Functions</h2> 36<div class="informaltable"><table class="informaltable" width="100%" border="0"> 37<colgroup> 38<col width="150px" class="functions_return"> 39<col class="functions_name"> 40</colgroup> 41<tbody> 42<tr> 43<td class="function_type"> 44<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> 45</td> 46<td class="function_name"> 47<a class="link" href="gst-plugins-base-libs-GstAudio-IEC61937.html#gst-audio-iec61937-frame-size" title="gst_audio_iec61937_frame_size ()">gst_audio_iec61937_frame_size</a> <span class="c_punctuation">()</span> 48</td> 49</tr> 50<tr> 51<td class="function_type"> 52<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 53</td> 54<td class="function_name"> 55<a class="link" href="gst-plugins-base-libs-GstAudio-IEC61937.html#gst-audio-iec61937-payload" title="gst_audio_iec61937_payload ()">gst_audio_iec61937_payload</a> <span class="c_punctuation">()</span> 56</td> 57</tr> 58</tbody> 59</table></div> 60</div> 61<div class="refsect1"> 62<a name="gst-plugins-base-libs-GstAudio-IEC61937.includes"></a><h2>Includes</h2> 63<pre class="synopsis">#include <gst/audio/audio.h> 64</pre> 65</div> 66<div class="refsect1"> 67<a name="gst-plugins-base-libs-GstAudio-IEC61937.description"></a><h2>Description</h2> 68<p>This module contains some helper functions for encapsulating various 69audio formats in IEC 61937 headers and padding.</p> 70</div> 71<div class="refsect1"> 72<a name="gst-plugins-base-libs-GstAudio-IEC61937.functions_details"></a><h2>Functions</h2> 73<div class="refsect2"> 74<a name="gst-audio-iec61937-frame-size"></a><h3>gst_audio_iec61937_frame_size ()</h3> 75<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> 76gst_audio_iec61937_frame_size (<em class="parameter"><code>const <a class="link" href="GstAudioRingBuffer.html#GstAudioRingBufferSpec" title="struct GstAudioRingBufferSpec"><span class="type">GstAudioRingBufferSpec</span></a> *spec</code></em>);</pre> 77<p>Calculated the size of the buffer expected by <a class="link" href="gst-plugins-base-libs-GstAudio-IEC61937.html#gst-audio-iec61937-payload" title="gst_audio_iec61937_payload ()"><code class="function">gst_audio_iec61937_payload()</code></a> for 78payloading type from <em class="parameter"><code>spec</code></em> 79.</p> 80<div class="refsect3"> 81<a name="gst-audio-iec61937-frame-size.parameters"></a><h4>Parameters</h4> 82<div class="informaltable"><table class="informaltable" width="100%" border="0"> 83<colgroup> 84<col width="150px" class="parameters_name"> 85<col class="parameters_description"> 86<col width="200px" class="parameters_annotations"> 87</colgroup> 88<tbody><tr> 89<td class="parameter_name"><p>spec</p></td> 90<td class="parameter_description"><p>the ringbufer spec</p></td> 91<td class="parameter_annotations"> </td> 92</tr></tbody> 93</table></div> 94</div> 95<div class="refsect3"> 96<a name="gst-audio-iec61937-frame-size.returns"></a><h4>Returns</h4> 97<p> the size or 0 if the given <em class="parameter"><code>type</code></em> 98is not supported or cannot be 99payloaded.</p> 100</div> 101</div> 102<hr> 103<div class="refsect2"> 104<a name="gst-audio-iec61937-payload"></a><h3>gst_audio_iec61937_payload ()</h3> 105<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 106gst_audio_iec61937_payload (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *src</code></em>, 107 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> src_n</code></em>, 108 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *dst</code></em>, 109 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> dst_n</code></em>, 110 <em class="parameter"><code>const <a class="link" href="GstAudioRingBuffer.html#GstAudioRingBufferSpec" title="struct GstAudioRingBufferSpec"><span class="type">GstAudioRingBufferSpec</span></a> *spec</code></em>, 111 <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>);</pre> 112<p>Payloads <em class="parameter"><code>src</code></em> 113 in the form specified by IEC 61937 for the type from <em class="parameter"><code>spec</code></em> 114 and 115stores the result in <em class="parameter"><code>dst</code></em> 116. <em class="parameter"><code>src</code></em> 117 must contain exactly one frame of data and 118the frame is not checked for errors.</p> 119<div class="refsect3"> 120<a name="gst-audio-iec61937-payload.parameters"></a><h4>Parameters</h4> 121<div class="informaltable"><table class="informaltable" width="100%" border="0"> 122<colgroup> 123<col width="150px" class="parameters_name"> 124<col class="parameters_description"> 125<col width="200px" class="parameters_annotations"> 126</colgroup> 127<tbody> 128<tr> 129<td class="parameter_name"><p>src</p></td> 130<td class="parameter_description"><p>a buffer containing the data to payload. </p></td> 131<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=src_n]</span></td> 132</tr> 133<tr> 134<td class="parameter_name"><p>src_n</p></td> 135<td class="parameter_description"><p>size of <em class="parameter"><code>src</code></em> 136in bytes</p></td> 137<td class="parameter_annotations"> </td> 138</tr> 139<tr> 140<td class="parameter_name"><p>dst</p></td> 141<td class="parameter_description"><p>the destination buffer to store the 142payloaded contents in. Should not overlap with <em class="parameter"><code>src</code></em> 143. </p></td> 144<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=dst_n]</span></td> 145</tr> 146<tr> 147<td class="parameter_name"><p>dst_n</p></td> 148<td class="parameter_description"><p>size of <em class="parameter"><code>dst</code></em> 149in bytes</p></td> 150<td class="parameter_annotations"> </td> 151</tr> 152<tr> 153<td class="parameter_name"><p>spec</p></td> 154<td class="parameter_description"><p>the ringbufer spec for <em class="parameter"><code>src</code></em> 155</p></td> 156<td class="parameter_annotations"> </td> 157</tr> 158<tr> 159<td class="parameter_name"><p>endianness</p></td> 160<td class="parameter_description"><p>the expected byte order of the payloaded data</p></td> 161<td class="parameter_annotations"> </td> 162</tr> 163</tbody> 164</table></div> 165</div> 166<div class="refsect3"> 167<a name="gst-audio-iec61937-payload.returns"></a><h4>Returns</h4> 168<p> transfer-full: <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the payloading was successful, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> 169otherwise.</p> 170</div> 171</div> 172</div> 173<div class="refsect1"> 174<a name="gst-plugins-base-libs-GstAudio-IEC61937.other_details"></a><h2>Types and Values</h2> 175</div> 176</div> 177<div class="footer"> 178<hr>Generated by GTK-Doc V1.28</div> 179</body> 180</html>
