~sipe-collab/sipe-collab/gstreamer-plugins-base

« back to all changes in this revision

Viewing changes to docs/libs/html/gst-plugins-base-libs-gsttagxmp.html

  • Committer: Sebastian Dröge
  • Date: 2014-04-19 13:47:47 UTC
  • mfrom: (1.1.23)
  • Revision ID: git-v1:d06393f82dba0d5f13ec2e66275d75cf8178fe5c
Merge tag 'upstream/1.2.4'

Upstream version 1.2.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>gsttagxmp</title>
 
5
<title>GStreamer Base Plugins 1.0 Library Reference Manual: gsttagxmp</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-tag.html" title="Tag Support Library">
9
9
<link rel="prev" href="gst-plugins-base-libs-gsttagexif.html" title="gsttagexif">
10
10
<link rel="next" href="gst-plugins-base-libs-gsttagxmpwriter.html" title="gsttagxmpwriter">
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">
13
13
</head>
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">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="gst-plugins-base-libs-gsttagexif.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="gstreamer-tag.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-gsttagxmpwriter.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#gst-plugins-base-libs-gsttagxmp.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#gst-plugins-base-libs-gsttagxmp.description" class="shortcut">Description</a>
27
 
</td></tr>
28
 
</table>
 
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-gsttagxmp.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
 
19
                  <a href="#gst-plugins-base-libs-gsttagxmp.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-tag.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-gsttagexif.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-gsttagxmpwriter.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
25
</tr></table>
29
26
<div class="refentry">
30
27
<a name="gst-plugins-base-libs-gsttagxmp"></a><div class="titlepage"></div>
31
28
<div class="refnamediv"><table width="100%"><tr>
34
31
<p>gsttagxmp — tag mappings and support functions for plugins
35
32
                    dealing with xmp packets</p>
36
33
</td>
37
 
<td valign="top" align="right"></td>
 
34
<td class="gallery_image" valign="top" align="right"></td>
38
35
</tr></table></div>
39
 
<div class="refsynopsisdiv">
40
 
<a name="gst-plugins-base-libs-gsttagxmp.synopsis"></a><h2>Synopsis</h2>
41
 
<pre class="synopsis">
42
 
#include &lt;gst/tag/tag.h&gt;
43
 
 
44
 
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="returnvalue">GstTagList</span></a> *        <a class="link" href="gst-plugins-base-libs-gsttagxmp.html#gst-tag-list-from-xmp-buffer" title="gst_tag_list_from_xmp_buffer ()">gst_tag_list_from_xmp_buffer</a>        (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>);
45
 
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         <a class="link" href="gst-plugins-base-libs-gsttagxmp.html#gst-tag-list-to-xmp-buffer" title="gst_tag_list_to_xmp_buffer ()">gst_tag_list_to_xmp_buffer</a>          (<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> *list</code></em>,
46
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> read_only</code></em>,
47
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **schemas</code></em>);
48
 
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **      <a class="link" href="gst-plugins-base-libs-gsttagxmp.html#gst-tag-xmp-list-schemas" title="gst_tag_xmp_list_schemas ()">gst_tag_xmp_list_schemas</a>            (<em class="parameter"><code><span class="type">void</span></code></em>);
 
36
<div class="refsect1">
 
37
<a name="gst-plugins-base-libs-gsttagxmp.functions"></a><h2>Functions</h2>
 
38
<div class="informaltable"><table width="100%" border="0">
 
39
<colgroup>
 
40
<col width="150px" class="functions_return">
 
41
<col class="functions_name">
 
42
</colgroup>
 
43
<tbody>
 
44
<tr>
 
45
<td class="function_type">
 
46
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="returnvalue">GstTagList</span></a> *
 
47
</td>
 
48
<td class="function_name">
 
49
<a class="link" href="gst-plugins-base-libs-gsttagxmp.html#gst-tag-list-from-xmp-buffer" title="gst_tag_list_from_xmp_buffer ()">gst_tag_list_from_xmp_buffer</a> <span class="c_punctuation">()</span>
 
50
</td>
 
51
</tr>
 
52
<tr>
 
53
<td class="function_type">
 
54
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *
 
55
</td>
 
56
<td class="function_name">
 
57
<a class="link" href="gst-plugins-base-libs-gsttagxmp.html#gst-tag-list-to-xmp-buffer" title="gst_tag_list_to_xmp_buffer ()">gst_tag_list_to_xmp_buffer</a> <span class="c_punctuation">()</span>
 
58
</td>
 
59
</tr>
 
60
<tr>
 
61
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
 
62
</td>
 
63
<td class="function_name">
 
64
<a class="link" href="gst-plugins-base-libs-gsttagxmp.html#gst-tag-xmp-list-schemas" title="gst_tag_xmp_list_schemas ()">gst_tag_xmp_list_schemas</a> <span class="c_punctuation">()</span>
 
65
</td>
 
66
</tr>
 
67
</tbody>
 
68
</table></div>
 
69
</div>
 
70
<div class="refsect1">
 
71
<a name="gst-plugins-base-libs-gsttagxmp.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
72
<pre class="screen">
 
73
</pre>
 
74
</div>
 
75
<div class="refsect1">
 
76
<a name="gst-plugins-base-libs-gsttagxmp.includes"></a><h2>Includes</h2>
 
77
<pre class="synopsis">#include &lt;gst/tag/tag.h&gt;
49
78
</pre>
50
79
</div>
51
80
<div class="refsect1">
52
81
<a name="gst-plugins-base-libs-gsttagxmp.description"></a><h2>Description</h2>
53
 
<p>
54
 
Contains various utility functions for plugins to parse or create
55
 
xmp packets and map them to and from <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a>s.
56
 
</p>
57
 
<p>
58
 
Please note that the xmp parser is very lightweight and not strict at all.
59
 
</p>
 
82
<p>Contains various utility functions for plugins to parse or create
 
83
xmp packets and map them to and from <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a>s.</p>
 
84
<p>Please note that the xmp parser is very lightweight and not strict at all.</p>
60
85
</div>
61
86
<div class="refsect1">
62
 
<a name="gst-plugins-base-libs-gsttagxmp.details"></a><h2>Details</h2>
63
 
<div class="refsect2">
64
 
<a name="gst-tag-list-from-xmp-buffer"></a><h3>gst_tag_list_from_xmp_buffer ()</h3>
65
 
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="returnvalue">GstTagList</span></a> *        gst_tag_list_from_xmp_buffer        (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>);</pre>
66
 
<p>
67
 
Parse a xmp packet into a taglist.
68
 
</p>
69
 
<div class="variablelist"><table border="0" class="variablelist">
70
 
<colgroup>
71
 
<col align="left" valign="top">
72
 
<col>
73
 
</colgroup>
74
 
<tbody>
75
 
<tr>
76
 
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
77
 
<td>buffer</td>
78
 
</tr>
79
 
<tr>
80
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
81
 
<td>new taglist or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, free the list when done</td>
82
 
</tr>
83
 
</tbody>
84
 
</table></div>
85
 
</div>
86
 
<hr>
87
 
<div class="refsect2">
88
 
<a name="gst-tag-list-to-xmp-buffer"></a><h3>gst_tag_list_to_xmp_buffer ()</h3>
89
 
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         gst_tag_list_to_xmp_buffer          (<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> *list</code></em>,
90
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> read_only</code></em>,
91
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **schemas</code></em>);</pre>
92
 
<p>
93
 
Formats a taglist as a xmp packet using only the selected
94
 
schemas. An empty list (<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>) means that all schemas should
95
 
be used
96
 
</p>
97
 
<div class="variablelist"><table border="0" class="variablelist">
98
 
<colgroup>
99
 
<col align="left" valign="top">
100
 
<col>
101
 
</colgroup>
102
 
<tbody>
103
 
<tr>
104
 
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
105
 
<td>tags</td>
106
 
</tr>
107
 
<tr>
108
 
<td><p><span class="term"><em class="parameter"><code>read_only</code></em> :</span></p></td>
109
 
<td>does the container forbid inplace editing</td>
110
 
</tr>
111
 
<tr>
112
 
<td><p><span class="term"><em class="parameter"><code>schemas</code></em> :</span></p></td>
113
 
<td>
114
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of schemas to be used on serialization</td>
115
 
</tr>
116
 
<tr>
117
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
118
 
<td>new buffer or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, unref the buffer when done</td>
119
 
</tr>
120
 
</tbody>
121
 
</table></div>
122
 
</div>
123
 
<hr>
124
 
<div class="refsect2">
125
 
<a name="gst-tag-xmp-list-schemas"></a><h3>gst_tag_xmp_list_schemas ()</h3>
126
 
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **      gst_tag_xmp_list_schemas            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
127
 
<p>
128
 
Gets the list of supported schemas in the xmp lib
129
 
</p>
130
 
<div class="variablelist"><table border="0" class="variablelist">
131
 
<colgroup>
132
 
<col align="left" valign="top">
133
 
<col>
 
87
<a name="gst-plugins-base-libs-gsttagxmp.functions_details"></a><h2>Functions</h2>
 
88
<div class="refsect2">
 
89
<a name="gst-tag-list-from-xmp-buffer"></a><h3>gst_tag_list_from_xmp_buffer ()</h3>
 
90
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="returnvalue">GstTagList</span></a> *
 
91
gst_tag_list_from_xmp_buffer (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>);</pre>
 
92
<p>Parse a xmp packet into a taglist.</p>
 
93
<div class="refsect3">
 
94
<a name="id-1.2.12.7.7.2.5"></a><h4>Parameters</h4>
 
95
<div class="informaltable"><table width="100%" border="0">
 
96
<colgroup>
 
97
<col width="150px" class="parameters_name">
 
98
<col class="parameters_description">
 
99
<col width="200px" class="parameters_annotations">
134
100
</colgroup>
135
101
<tbody><tr>
136
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
137
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of strings with the
138
 
schema names. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
139
 
</td>
 
102
<td class="parameter_name"><p>buffer</p></td>
 
103
<td class="parameter_description"><p>buffer</p></td>
 
104
<td class="parameter_annotations"> </td>
140
105
</tr></tbody>
141
106
</table></div>
142
107
</div>
 
108
<div class="refsect3">
 
109
<a name="id-1.2.12.7.7.2.6"></a><h4>Returns</h4>
 
110
<p> new taglist or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, free the list when done</p>
 
111
<p></p>
 
112
</div>
 
113
</div>
 
114
<hr>
 
115
<div class="refsect2">
 
116
<a name="gst-tag-list-to-xmp-buffer"></a><h3>gst_tag_list_to_xmp_buffer ()</h3>
 
117
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *
 
118
gst_tag_list_to_xmp_buffer (<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> *list</code></em>,
 
119
                            <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> read_only</code></em>,
 
120
                            <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **schemas</code></em>);</pre>
 
121
<p>Formats a taglist as a xmp packet using only the selected
 
122
schemas. An empty list (<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>) means that all schemas should
 
123
be used</p>
 
124
<div class="refsect3">
 
125
<a name="id-1.2.12.7.7.3.5"></a><h4>Parameters</h4>
 
126
<div class="informaltable"><table width="100%" border="0">
 
127
<colgroup>
 
128
<col width="150px" class="parameters_name">
 
129
<col class="parameters_description">
 
130
<col width="200px" class="parameters_annotations">
 
131
</colgroup>
 
132
<tbody>
 
133
<tr>
 
134
<td class="parameter_name"><p>list</p></td>
 
135
<td class="parameter_description"><p>tags</p></td>
 
136
<td class="parameter_annotations"> </td>
 
137
</tr>
 
138
<tr>
 
139
<td class="parameter_name"><p>read_only</p></td>
 
140
<td class="parameter_description"><p>does the container forbid inplace editing</p></td>
 
141
<td class="parameter_annotations"> </td>
 
142
</tr>
 
143
<tr>
 
144
<td class="parameter_name"><p>schemas</p></td>
 
145
<td class="parameter_description"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of schemas to be used on serialization</p></td>
 
146
<td class="parameter_annotations"> </td>
 
147
</tr>
 
148
</tbody>
 
149
</table></div>
 
150
</div>
 
151
<div class="refsect3">
 
152
<a name="id-1.2.12.7.7.3.6"></a><h4>Returns</h4>
 
153
<p> new buffer or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, unref the buffer when done</p>
 
154
<p></p>
 
155
</div>
 
156
</div>
 
157
<hr>
 
158
<div class="refsect2">
 
159
<a name="gst-tag-xmp-list-schemas"></a><h3>gst_tag_xmp_list_schemas ()</h3>
 
160
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
 
161
gst_tag_xmp_list_schemas (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
162
<p>Gets the list of supported schemas in the xmp lib</p>
 
163
<div class="refsect3">
 
164
<a name="id-1.2.12.7.7.4.5"></a><h4>Returns</h4>
 
165
<p> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of strings with the
 
166
schema names. </p>
 
167
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
168
</div>
 
169
</div>
 
170
</div>
 
171
<div class="refsect1">
 
172
<a name="gst-plugins-base-libs-gsttagxmp.other_details"></a><h2>Types and Values</h2>
143
173
</div>
144
174
<div class="refsect1">
145
175
<a name="gst-plugins-base-libs-gsttagxmp.see-also"></a><h2>See Also</h2>
146
 
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a>
 
176
<p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a></p>
147
177
</div>
148
178
</div>
149
179
<div class="footer">
150
180
<hr>
151
 
          Generated by GTK-Doc V1.19</div>
 
181
          Generated by GTK-Doc V1.20</div>
152
182
</body>
153
183
</html>
 
 
b'\\ No newline at end of file'