4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>gstaudioiec61937</title>
5
<title>GStreamer Base Plugins 1.0 Library Reference Manual: gstaudioiec61937</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
8
8
<link rel="up" href="gstreamer-audio.html" title="Audio Library">
9
9
<link rel="prev" href="gst-plugins-base-libs-gstaudioringbuffer.html" title="gstaudioringbuffer">
10
10
<link rel="next" href="gst-plugins-base-libs-gststreamvolume.html" title="gststreamvolume">
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
<td><a accesskey="p" href="gst-plugins-base-libs-gstaudioringbuffer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="gstreamer-audio.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">GStreamer Base Plugins 1.0 Library Reference Manual</th>
21
<td><a accesskey="n" href="gst-plugins-base-libs-gststreamvolume.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#gst-plugins-base-libs-gstaudioiec61937.synopsis" class="shortcut">Top</a>
26
<a href="#gst-plugins-base-libs-gstaudioiec61937.description" class="shortcut">Description</a>
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><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-gstaudioiec61937.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
19
<a href="#gst-plugins-base-libs-gstaudioiec61937.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
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="gst-plugins-base-libs-gstaudioringbuffer.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-gststreamvolume.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
29
26
<div class="refentry">
30
27
<a name="gst-plugins-base-libs-gstaudioiec61937"></a><div class="titlepage"></div>
31
28
<div class="refnamediv"><table width="100%"><tr>
33
30
<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstaudioiec61937.top_of_page"></a>gstaudioiec61937</span></h2>
34
31
<p>gstaudioiec61937 — Utility functions for IEC 61937 payloading</p>
36
<td valign="top" align="right"></td>
33
<td class="gallery_image" valign="top" align="right"></td>
37
34
</tr></table></div>
38
<div class="refsynopsisdiv">
39
<a name="gst-plugins-base-libs-gstaudioiec61937.synopsis"></a><h2>Synopsis</h2>
40
<pre class="synopsis">
41
#include <gst/audio/gstaudioiec61937.h>
43
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="gst-plugins-base-libs-gstaudioiec61937.html#gst-audio-iec61937-frame-size" title="gst_audio_iec61937_frame_size ()">gst_audio_iec61937_frame_size</a> (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBufferSpec" title="struct GstAudioRingBufferSpec"><span class="type">GstAudioRingBufferSpec</span></a> *spec</code></em>);
44
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstaudioiec61937.html#gst-audio-iec61937-payload" title="gst_audio_iec61937_payload ()">gst_audio_iec61937_payload</a> (<em class="parameter"><code>const <span class="type">guint8</span> *src</code></em>,
45
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> src_n</code></em>,
46
<em class="parameter"><code><span class="type">guint8</span> *dst</code></em>,
47
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> dst_n</code></em>,
48
<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBufferSpec" title="struct GstAudioRingBufferSpec"><span class="type">GstAudioRingBufferSpec</span></a> *spec</code></em>,
49
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> endianness</code></em>);
35
<div class="refsect1">
36
<a name="gst-plugins-base-libs-gstaudioiec61937.functions"></a><h2>Functions</h2>
37
<div class="informaltable"><table width="100%" border="0">
39
<col width="150px" class="functions_return">
40
<col class="functions_name">
44
<td class="function_type">
45
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
47
<td class="function_name">
48
<a class="link" href="gst-plugins-base-libs-gstaudioiec61937.html#gst-audio-iec61937-frame-size" title="gst_audio_iec61937_frame_size ()">gst_audio_iec61937_frame_size</a> <span class="c_punctuation">()</span>
52
<td class="function_type">
53
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
55
<td class="function_name">
56
<a class="link" href="gst-plugins-base-libs-gstaudioiec61937.html#gst-audio-iec61937-payload" title="gst_audio_iec61937_payload ()">gst_audio_iec61937_payload</a> <span class="c_punctuation">()</span>
62
<div class="refsect1">
63
<a name="gst-plugins-base-libs-gstaudioiec61937.object-hierarchy"></a><h2>Object Hierarchy</h2>
67
<div class="refsect1">
68
<a name="gst-plugins-base-libs-gstaudioiec61937.includes"></a><h2>Includes</h2>
69
<pre class="synopsis">#include <gst/audio/gstaudioiec61937.h>
52
72
<div class="refsect1">
53
73
<a name="gst-plugins-base-libs-gstaudioiec61937.description"></a><h2>Description</h2>
55
This module contains some helper functions for encapsulating various
56
audio formats in IEC 61937 headers and padding.
74
<p>This module contains some helper functions for encapsulating various
75
audio formats in IEC 61937 headers and padding.</p>
59
77
<div class="refsect1">
60
<a name="gst-plugins-base-libs-gstaudioiec61937.details"></a><h2>Details</h2>
78
<a name="gst-plugins-base-libs-gstaudioiec61937.functions_details"></a><h2>Functions</h2>
61
79
<div class="refsect2">
62
<a name="gst-audio-iec61937-frame-size"></a><h3>gst_audio_iec61937_frame_size ()</h3>
63
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> gst_audio_iec61937_frame_size (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBufferSpec" title="struct GstAudioRingBufferSpec"><span class="type">GstAudioRingBufferSpec</span></a> *spec</code></em>);</pre>
65
Calculated the size of the buffer expected by <a class="link" href="gst-plugins-base-libs-gstaudioiec61937.html#gst-audio-iec61937-payload" title="gst_audio_iec61937_payload ()"><code class="function">gst_audio_iec61937_payload()</code></a> for
66
payloading type from <em class="parameter"><code>spec</code></em>.
68
<div class="variablelist"><table border="0" class="variablelist">
80
<a name="gst-audio-iec61937-frame-size"></a><h3>gst_audio_iec61937_frame_size ()</h3>
81
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
82
gst_audio_iec61937_frame_size (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBufferSpec" title="struct GstAudioRingBufferSpec"><span class="type">GstAudioRingBufferSpec</span></a> *spec</code></em>);</pre>
83
<p>Calculated the size of the buffer expected by <a class="link" href="gst-plugins-base-libs-gstaudioiec61937.html#gst-audio-iec61937-payload" title="gst_audio_iec61937_payload ()"><code class="function">gst_audio_iec61937_payload()</code></a> for
84
payloading type from <em class="parameter"><code>spec</code></em>
86
<div class="refsect3">
87
<a name="id-1.2.6.17.7.2.5"></a><h4>Parameters</h4>
88
<div class="informaltable"><table width="100%" border="0">
70
<col align="left" valign="top">
90
<col width="150px" class="parameters_name">
91
<col class="parameters_description">
92
<col width="200px" class="parameters_annotations">
75
<td><p><span class="term"><em class="parameter"><code>spec</code></em> :</span></p></td>
76
<td>the ringbufer spec</td>
79
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
80
<td>the size or 0 if the given <em class="parameter"><code>type</code></em> is not supported or cannot be
95
<td class="parameter_name"><p>spec</p></td>
96
<td class="parameter_description"><p>the ringbufer spec</p></td>
97
<td class="parameter_annotations"> </td>
101
<div class="refsect3">
102
<a name="id-1.2.6.17.7.2.6"></a><h4>Returns</h4>
103
<p> the size or 0 if the given <em class="parameter"><code>type</code></em>
104
is not supported or cannot be
87
110
<div class="refsect2">
88
<a name="gst-audio-iec61937-payload"></a><h3>gst_audio_iec61937_payload ()</h3>
89
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_audio_iec61937_payload (<em class="parameter"><code>const <span class="type">guint8</span> *src</code></em>,
90
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> src_n</code></em>,
91
<em class="parameter"><code><span class="type">guint8</span> *dst</code></em>,
92
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> dst_n</code></em>,
93
<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBufferSpec" title="struct GstAudioRingBufferSpec"><span class="type">GstAudioRingBufferSpec</span></a> *spec</code></em>,
94
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> endianness</code></em>);</pre>
96
Payloads <em class="parameter"><code>src</code></em> in the form specified by IEC 61937 for the type from <em class="parameter"><code>spec</code></em> and
97
stores the result in <em class="parameter"><code>dst</code></em>. <em class="parameter"><code>src</code></em> must contain exactly one frame of data and
98
the frame is not checked for errors.
100
<div class="variablelist"><table border="0" class="variablelist">
111
<a name="gst-audio-iec61937-payload"></a><h3>gst_audio_iec61937_payload ()</h3>
112
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
113
gst_audio_iec61937_payload (<em class="parameter"><code>const <span class="type">guint8</span> *src</code></em>,
114
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> src_n</code></em>,
115
<em class="parameter"><code><span class="type">guint8</span> *dst</code></em>,
116
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> dst_n</code></em>,
117
<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstaudioringbuffer.html#GstAudioRingBufferSpec" title="struct GstAudioRingBufferSpec"><span class="type">GstAudioRingBufferSpec</span></a> *spec</code></em>,
118
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> endianness</code></em>);</pre>
119
<p>Payloads <em class="parameter"><code>src</code></em>
120
in the form specified by IEC 61937 for the type from <em class="parameter"><code>spec</code></em>
122
stores the result in <em class="parameter"><code>dst</code></em>
123
. <em class="parameter"><code>src</code></em>
124
must contain exactly one frame of data and
125
the frame is not checked for errors.</p>
126
<div class="refsect3">
127
<a name="id-1.2.6.17.7.3.5"></a><h4>Parameters</h4>
128
<div class="informaltable"><table width="100%" border="0">
102
<col align="left" valign="top">
130
<col width="150px" class="parameters_name">
131
<col class="parameters_description">
132
<col width="200px" class="parameters_annotations">
107
<td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
108
<td>a buffer containing the data to payload. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=src_n]</span>
112
<td><p><span class="term"><em class="parameter"><code>src_n</code></em> :</span></p></td>
113
<td>size of <em class="parameter"><code>src</code></em> in bytes</td>
116
<td><p><span class="term"><em class="parameter"><code>dst</code></em> :</span></p></td>
117
<td>the destination buffer to store the
118
payloaded contents in. Should not overlap with <em class="parameter"><code>src</code></em>. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=dst_n]</span>
122
<td><p><span class="term"><em class="parameter"><code>dst_n</code></em> :</span></p></td>
123
<td>size of <em class="parameter"><code>dst</code></em> in bytes</td>
126
<td><p><span class="term"><em class="parameter"><code>spec</code></em> :</span></p></td>
127
<td>the ringbufer spec for <em class="parameter"><code>src</code></em>
131
<td><p><span class="term"><em class="parameter"><code>endianness</code></em> :</span></p></td>
132
<td>the expected byte order of the payloaded data</td>
135
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
136
<td>transfer-full: <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the payloading was successful, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
136
<td class="parameter_name"><p>src</p></td>
137
<td class="parameter_description"><p> a buffer containing the data to payload. </p></td>
138
<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>
141
<td class="parameter_name"><p>src_n</p></td>
142
<td class="parameter_description"><p>size of <em class="parameter"><code>src</code></em>
144
<td class="parameter_annotations"> </td>
147
<td class="parameter_name"><p>dst</p></td>
148
<td class="parameter_description"><p> the destination buffer to store the
149
payloaded contents in. Should not overlap with <em class="parameter"><code>src</code></em>
151
<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>
154
<td class="parameter_name"><p>dst_n</p></td>
155
<td class="parameter_description"><p>size of <em class="parameter"><code>dst</code></em>
157
<td class="parameter_annotations"> </td>
160
<td class="parameter_name"><p>spec</p></td>
161
<td class="parameter_description"><p>the ringbufer spec for <em class="parameter"><code>src</code></em>
163
<td class="parameter_annotations"> </td>
166
<td class="parameter_name"><p>endianness</p></td>
167
<td class="parameter_description"><p>the expected byte order of the payloaded data</p></td>
168
<td class="parameter_annotations"> </td>
173
<div class="refsect3">
174
<a name="id-1.2.6.17.7.3.6"></a><h4>Returns</h4>
175
<p> transfer-full: <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the payloading was successful, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
181
<div class="refsect1">
182
<a name="gst-plugins-base-libs-gstaudioiec61937.other_details"></a><h2>Types and Values</h2>
144
185
<div class="footer">
146
Generated by GTK-Doc V1.19</div>
187
Generated by GTK-Doc V1.20</div>
b'\\ No newline at end of file'
added
removed
docs/libs/html/gst-plugins-base-libs-gstaudioiec61937.html
