tizen 2.3 release
[framework/multimedia/gst-plugins-base0.10.git] / docs / libs / html / gst-plugins-base-libs-gsttagmux.html
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>gsttagmux</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
8 <link rel="up" href="gstreamer-tag.html" title="Tag Support Library">
9 <link rel="prev" href="gst-plugins-base-libs-gsttagdemux.html" title="gsttagdemux">
10 <link rel="next" href="gst-plugins-base-libs-gsttaglanguagecodes.html" title="gsttaglanguagecodes">
11 <meta name="generator" content="GTK-Doc V1.18 (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="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="gst-plugins-base-libs-gsttagdemux.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 0.10 Library Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-base-libs-gsttaglanguagecodes.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-gsttagmux.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-base-libs-gsttagmux.description" class="shortcut">Description</a>
27 </td></tr>
28 </table>
29 <div class="refentry">
30 <a name="gst-plugins-base-libs-gsttagmux"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
32 <td valign="top">
33 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gsttagmux.top_of_page"></a>gsttagmux</span></h2>
34 <p>gsttagmux — Base class for adding tags that are in one single chunk
35                     directly at the beginning or at the end of a file</p>
36 </td>
37 <td valign="top" align="right"></td>
38 </tr></table></div>
39 <div class="refsynopsisdiv">
40 <a name="gst-plugins-base-libs-gsttagmux.synopsis"></a><h2>Synopsis</h2>
41 <pre class="synopsis">
42 #include &lt;gst/tag/gsttagmux.h&gt;
43
44 struct              <a class="link" href="gst-plugins-base-libs-gsttagmux.html#GstTagMux" title="struct GstTagMux">GstTagMux</a>;
45 struct              <a class="link" href="gst-plugins-base-libs-gsttagmux.html#GstTagMuxClass" title="struct GstTagMuxClass">GstTagMuxClass</a>;
46 </pre>
47 </div>
48 <div class="refsect1">
49 <a name="gst-plugins-base-libs-gsttagmux.description"></a><h2>Description</h2>
50 <p>
51 </p>
52 <div class="refsect2">
53 <a name="idp15390752"></a><h3>Deriving from GstTagMux</h3>
54 <p>
55 Provides a base class for adding tags at the beginning or end of a
56 stream.
57 </p>
58 <p>
59 Subclasses have to do the following things:
60 </p>
61 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
62 <li class="listitem"><p>
63  In their base init function, they must add pad templates for the sink
64  pad and the source pad to the element class, describing the media type
65  they accept and output in the caps of the pad template.
66  </p></li>
67 <li class="listitem"><p>
68  In their class init function, they must override the
69  GST_TAG_MUX_CLASS(mux_klass)-&gt;render_start_tag and/or
70  GST_TAG_MUX_CLASS(mux_klass)-&gt;render_end_tag vfuncs and set up a render
71  function.
72  </p></li>
73 </ul></div>
74 <p>
75 </p>
76 </div>
77 <p>
78 </p>
79 <p>
80 Since 0.10.36
81 </p>
82 </div>
83 <div class="refsect1">
84 <a name="gst-plugins-base-libs-gsttagmux.details"></a><h2>Details</h2>
85 <div class="refsect2">
86 <a name="GstTagMux"></a><h3>struct GstTagMux</h3>
87 <pre class="programlisting">struct GstTagMux {
88   GstElement    element;
89 };
90 </pre>
91 <p>
92 Opaque <a class="link" href="gst-plugins-base-libs-gsttagmux.html#GstTagMux" title="struct GstTagMux"><span class="type">GstTagMux</span></a> structure.
93 </p>
94 <div class="variablelist"><table border="0">
95 <col align="left" valign="top">
96 <tbody><tr>
97 <td><p><span class="term"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> <em class="structfield"><code><a name="GstTagMux.element"></a>element</code></em>;</span></p></td>
98 <td>parent element</td>
99 </tr></tbody>
100 </table></div>
101 <p class="since">Since 0.10.36</p>
102 </div>
103 <hr>
104 <div class="refsect2">
105 <a name="GstTagMuxClass"></a><h3>struct GstTagMuxClass</h3>
106 <pre class="programlisting">struct GstTagMuxClass {
107   GstElementClass parent_class;
108
109   /* vfuncs */
110   GstBuffer  * (*render_start_tag) (GstTagMux * mux, const GstTagList * tag_list);
111   GstBuffer  * (*render_end_tag)   (GstTagMux * mux, const GstTagList * tag_list);
112 };
113 </pre>
114 <p>
115 The <a class="link" href="gst-plugins-base-libs-gsttagmux.html#GstTagMuxClass" title="struct GstTagMuxClass"><span class="type">GstTagMuxClass</span></a> structure. Subclasses need to override at least one
116 of the two render vfuncs.
117 </p>
118 <div class="variablelist"><table border="0">
119 <col align="left" valign="top">
120 <tbody>
121 <tr>
122 <td><p><span class="term"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html#GstElementClass"><span class="type">GstElementClass</span></a> <em class="structfield"><code><a name="GstTagMuxClass.parent-class"></a>parent_class</code></em>;</span></p></td>
123 <td>the parent class.</td>
124 </tr>
125 <tr>
126 <td><p><span class="term"><em class="structfield"><code><a name="GstTagMuxClass.render-start-tag"></a>render_start_tag</code></em> ()</span></p></td>
127 <td>create a tag buffer to add to the beginning of the
128 input stream given a tag list, or NULL</td>
129 </tr>
130 <tr>
131 <td><p><span class="term"><em class="structfield"><code><a name="GstTagMuxClass.render-end-tag"></a>render_end_tag</code></em> ()</span></p></td>
132 <td>create a tag buffer to add to the end of the
133 input stream given a tag list, or NULL</td>
134 </tr>
135 </tbody>
136 </table></div>
137 <p class="since">Since 0.10.36</p>
138 </div>
139 </div>
140 <div class="refsect1">
141 <a name="gst-plugins-base-libs-gsttagmux.see-also"></a><h2>See Also</h2>
142 GstApeMux, GstId3Mux
143 </div>
144 </div>
145 <div class="footer">
146 <hr>
147           Generated by GTK-Doc V1.18</div>
148 </body>
149 </html>