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>id3mux: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements"> 9<link rel="prev" href="gst-plugins-bad-plugins-hlssink.html" title="hlssink"> 10<link rel="next" href="gst-plugins-bad-plugins-interaudiosink.html" title="interaudiosink"> 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-bad-plugins-id3mux.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-id3mux.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-id3mux.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-bad-plugins-id3mux.properties" class="shortcut">Properties</a></span> 22</td> 23<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 24<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 25<td><a accesskey="p" href="gst-plugins-bad-plugins-hlssink.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 26<td><a accesskey="n" href="gst-plugins-bad-plugins-interaudiosink.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 27</tr></table> 28<div class="refentry"> 29<a name="gst-plugins-bad-plugins-id3mux"></a><div class="titlepage"></div> 30<div class="refnamediv"><table width="100%"><tr> 31<td valign="top"> 32<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-id3mux.top_of_page"></a>id3mux</span></h2> 33<p>id3mux</p> 34</td> 35<td class="gallery_image" valign="top" align="right"></td> 36</tr></table></div> 37<div class="refsect1"> 38<a name="gst-plugins-bad-plugins-id3mux.properties"></a><h2>Properties</h2> 39<div class="informaltable"><table class="informaltable" border="0"> 40<colgroup> 41<col width="150px" class="properties_type"> 42<col width="300px" class="properties_name"> 43<col width="200px" class="properties_flags"> 44</colgroup> 45<tbody> 46<tr> 47<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 48<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-id3mux.html#GstId3Mux--v2-version" title="The “v2-version” property">v2-version</a></td> 49<td class="property_flags">Read / Write / Construct</td> 50</tr> 51<tr> 52<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 53<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-id3mux.html#GstId3Mux--write-v1" title="The “write-v1” property">write-v1</a></td> 54<td class="property_flags">Read / Write / Construct</td> 55</tr> 56<tr> 57<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 58<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-id3mux.html#GstId3Mux--write-v2" title="The “write-v2” property">write-v2</a></td> 59<td class="property_flags">Read / Write / Construct</td> 60</tr> 61</tbody> 62</table></div> 63</div> 64<a name="GstId3Mux"></a><div class="refsect1"> 65<a name="gst-plugins-bad-plugins-id3mux.other"></a><h2>Types and Values</h2> 66<div class="informaltable"><table class="informaltable" width="100%" border="0"> 67<colgroup> 68<col width="150px" class="name"> 69<col class="description"> 70</colgroup> 71<tbody><tr> 72<td class="datatype_keyword">struct</td> 73<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-id3mux.html#GstId3Mux-struct" title="struct GstId3Mux">GstId3Mux</a></td> 74</tr></tbody> 75</table></div> 76</div> 77<div class="refsect1"> 78<a name="gst-plugins-bad-plugins-id3mux.object-hierarchy"></a><h2>Object Hierarchy</h2> 79<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 80 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 81 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 82 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 83 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-GstTagMux.html#GstTagMux">GstTagMux</a> 84 <span class="lineart">╰──</span> GstId3Mux 85</pre> 86</div> 87<div class="refsect1"> 88<a name="gst-plugins-bad-plugins-id3mux.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 89<p> 90GstId3Mux implements 91 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstTagSetter.html#GstTagSetter-struct">GstTagSetter</a>.</p> 92</div> 93<div class="refsect1"> 94<a name="gst-plugins-bad-plugins-id3mux.description"></a><h2>Description</h2> 95<p>This element adds ID3v2 tags to the beginning of a stream, and ID3v1 tags 96to the end.</p> 97<p>It defaults to writing ID3 version 2.3.0 tags (since those are the most 98widely supported), but can optionally write version 2.4.0 tags.</p> 99<p>Applications can set the tags to write using the <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstTagSetter.html#GstTagSetter-struct"><span class="type">GstTagSetter</span></a> interface. 100Tags sent by upstream elements will be picked up automatically (and merged 101according to the merge mode set via the tag setter interface).</p> 102<div class="refsect3"> 103<a name="id-1.2.109.8.5"></a><h4>Example pipelines</h4> 104<div class="informalexample"> 105 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 106 <tbody> 107 <tr> 108 <td class="listing_lines" align="right"><pre>1</pre></td> 109 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> <span class="gtkdoc opt">-</span>v filesrc location<span class="gtkdoc opt">=</span>foo<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> id3mux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>foo<span class="gtkdoc opt">.</span>mp3</pre></td> 110 </tr> 111 </tbody> 112 </table> 113</div> 114 115<p> A pipeline that transcodes a file from Ogg/Vorbis to mp3 format with 116ID3 tags that contain the same metadata as the the Ogg/Vorbis file. 117Make sure the Ogg/Vorbis file actually has comments to preserve.</p> 118<div class="informalexample"> 119 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 120 <tbody> 121 <tr> 122 <td class="listing_lines" align="right"><pre>1</pre></td> 123 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> <span class="gtkdoc opt">-</span>m filesrc location<span class="gtkdoc opt">=</span>foo<span class="gtkdoc opt">.</span>mp3 <span class="gtkdoc opt">!</span> id3demux <span class="gtkdoc opt">!</span> fakesink silent<span class="gtkdoc opt">=</span>TRUE</pre></td> 124 </tr> 125 </tbody> 126 </table> 127</div> 128 129<p> Verify that tags have been written.</p> 130</div> 131<div class="refsynopsisdiv"> 132<h2>Synopsis</h2> 133<div class="refsect2"> 134<a name="id-1.2.109.8.6.1"></a><h3>Element Information</h3> 135<div class="variablelist"><table border="0" class="variablelist"> 136<colgroup> 137<col align="left" valign="top"> 138<col> 139</colgroup> 140<tbody> 141<tr> 142<td><p><span class="term">plugin</span></p></td> 143<td> 144 <a class="link" href="gst-plugins-bad-plugins-plugin-id3tag.html#plugin-id3tag">id3tag</a> 145 </td> 146</tr> 147<tr> 148<td><p><span class="term">author</span></p></td> 149<td>Michael Smith <msmith@songbirdnest.com>, Tim-Philipp Müller <tim centricular net></td> 150</tr> 151<tr> 152<td><p><span class="term">class</span></p></td> 153<td>Formatter/Metadata</td> 154</tr> 155</tbody> 156</table></div> 157</div> 158<hr> 159<div class="refsect2"> 160<a name="id-1.2.109.8.6.2"></a><h3>Element Pads</h3> 161<div class="variablelist"><table border="0" class="variablelist"> 162<colgroup> 163<col align="left" valign="top"> 164<col> 165</colgroup> 166<tbody> 167<tr> 168<td><p><span class="term">name</span></p></td> 169<td>sink</td> 170</tr> 171<tr> 172<td><p><span class="term">direction</span></p></td> 173<td>sink</td> 174</tr> 175<tr> 176<td><p><span class="term">presence</span></p></td> 177<td>always</td> 178</tr> 179<tr> 180<td><p><span class="term">details</span></p></td> 181<td>ANY</td> 182</tr> 183</tbody> 184</table></div> 185<div class="variablelist"><table border="0" class="variablelist"> 186<colgroup> 187<col align="left" valign="top"> 188<col> 189</colgroup> 190<tbody> 191<tr> 192<td><p><span class="term">name</span></p></td> 193<td>src</td> 194</tr> 195<tr> 196<td><p><span class="term">direction</span></p></td> 197<td>source</td> 198</tr> 199<tr> 200<td><p><span class="term">presence</span></p></td> 201<td>always</td> 202</tr> 203<tr> 204<td><p><span class="term">details</span></p></td> 205<td>application/x-id3</td> 206</tr> 207</tbody> 208</table></div> 209</div> 210</div> 211</div> 212<div class="refsect1"> 213<a name="gst-plugins-bad-plugins-id3mux.functions_details"></a><h2>Functions</h2> 214<p></p> 215</div> 216<div class="refsect1"> 217<a name="gst-plugins-bad-plugins-id3mux.other_details"></a><h2>Types and Values</h2> 218<div class="refsect2"> 219<a name="GstId3Mux-struct"></a><h3>struct GstId3Mux</h3> 220<pre class="programlisting">struct GstId3Mux;</pre> 221</div> 222</div> 223<div class="refsect1"> 224<a name="gst-plugins-bad-plugins-id3mux.property-details"></a><h2>Property Details</h2> 225<div class="refsect2"> 226<a name="GstId3Mux--v2-version"></a><h3>The <code class="literal">“v2-version”</code> property</h3> 227<pre class="programlisting"> “v2-version” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 228<p>Set version (3 for id3v2.3, 4 for id3v2.4) of id3v2 tags.</p> 229<p>Flags: Read / Write / Construct</p> 230<p>Allowed values: [3,4]</p> 231<p>Default value: 3</p> 232</div> 233<hr> 234<div class="refsect2"> 235<a name="GstId3Mux--write-v1"></a><h3>The <code class="literal">“write-v1”</code> property</h3> 236<pre class="programlisting"> “write-v1” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 237<p>Write an id3v1 tag at the end of the file.</p> 238<p>Flags: Read / Write / Construct</p> 239<p>Default value: FALSE</p> 240</div> 241<hr> 242<div class="refsect2"> 243<a name="GstId3Mux--write-v2"></a><h3>The <code class="literal">“write-v2”</code> property</h3> 244<pre class="programlisting"> “write-v2” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 245<p>Write an id3v2 tag at the start of the file.</p> 246<p>Flags: Read / Write / Construct</p> 247<p>Default value: TRUE</p> 248</div> 249</div> 250<div class="refsect1"> 251<a name="gst-plugins-bad-plugins-id3mux.see-also"></a><h2>See Also</h2> 252<p><span class="type">GstID3Demux</span>, <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstTagSetter.html#GstTagSetter-struct"><span class="type">GstTagSetter</span></a></p> 253</div> 254</div> 255<div class="footer"> 256<hr>Generated by GTK-Doc V1.28</div> 257</body> 258</html>
