docs/plugins/html/gst-plugins-good-plugins-id3demux.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>id3demux</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
   9 <link rel="prev" href="gst-plugins-good-plugins-icydemux.html" title="icydemux">
  10 <link rel="next" href="gst-plugins-good-plugins-id3v2mux.html" title="id3v2mux">
  11 <meta name="generator" content="GTK-Doc V1.17 (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-good-plugins-icydemux.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.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 Good Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-good-plugins-id3v2mux.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-good-plugins-id3demux.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-id3demux.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-id3demux.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-id3demux.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-id3demux"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-id3demux.top_of_page"></a>id3demux</span></h2>
  38 <p>id3demux — Read and output ID3v1 and ID3v2 tags while demuxing the contents</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="gst-plugins-good-plugins-id3demux.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstID3Demux"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-id3demux.html#GstID3Demux-struct" title="struct GstID3Demux">GstID3Demux</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-id3demux.object-hierarchy"></a><h2>Object Hierarchy</h2>
  49 <pre class="synopsis">
  50   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  51    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  52          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  53                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gsttagdemux.html#GstTagDemux">GstTagDemux</a>
  54                      +----GstID3Demux
  55 </pre>
  56 </div>
  57 <div class="refsect1">
  58 <a name="gst-plugins-good-plugins-id3demux.properties"></a><h2>Properties</h2>
  59 <pre class="synopsis">
  60   "<a class="link" href="gst-plugins-good-plugins-id3demux.html#GstID3Demux--prefer-v1" title='The "prefer-v1" property'>prefer-v1</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
  61 </pre>
  62 </div>
  63 <div class="refsect1">
  64 <a name="gst-plugins-good-plugins-id3demux.description"></a><h2>Description</h2>
  65 <p>
  66 id3demux accepts data streams with either (or both) ID3v2 regions at the
  67 start, or ID3v1 at the end. The mime type of the data between the tag blocks
  68 is detected using typefind functions, and the appropriate output mime type
  69 set on outgoing buffers.
  70 </p>
  71 <p>
  72 The element is only able to read ID3v1 tags from a seekable stream, because
  73 they are at the end of the stream. That is, when get_range mode is supported
  74 by the upstream elements. If get_range operation is available, id3demux makes
  75 it available downstream. This means that elements which require get_range
  76 mode, such as wavparse, can operate on files containing ID3 tag information.
  77 </p>
  78 <p>
  79 This id3demux element replaced an older element with the same name which
  80 relied on libid3tag from the MAD project.
  81 </p>
  82 <p>
  83 </p>
  84 <div class="refsect2">
  85 <a name="idp5421680"></a><h3>Example launch line</h3>
  86 <div class="informalexample">
  87   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  88     <tbody>
  89       <tr>
  90         <td class="listing_lines" align="right"><pre>1</pre></td>
  91         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=</span>file<span class="gtkdoc opt">.</span>mp3 <span class="gtkdoc opt">!</span> id3demux <span class="gtkdoc opt">!</span> fakesink <span class="gtkdoc opt">-</span>t</pre></td>
  92       </tr>
  93     </tbody>
  94   </table>
  95 </div>
  96  This pipeline should read any available ID3 tag information and output it.
  97 The contents of the file inside the ID3 tag regions should be detected, and
  98 the appropriate mime type set on buffers produced from id3demux.
  99 </div>
 100 <p>
 101 </p>
 102 <div class="refsynopsisdiv">
 103 <h2>Synopsis</h2>
 104 <div class="refsect2">
 105 <a name="idp11532576"></a><h3>Element Information</h3>
 106 <div class="variablelist"><table border="0">
 107 <col align="left" valign="top">
 108 <tbody>
 109 <tr>
 110 <td><p><span class="term">plugin</span></p></td>
 111 <td>
 112             <a class="link" href="gst-plugins-good-plugins-plugin-id3demux.html#plugin-id3demux">id3demux</a>
 113           </td>
 114 </tr>
 115 <tr>
 116 <td><p><span class="term">author</span></p></td>
 117 <td>Jan Schmidt &lt;thaytan@mad.scientist.com&gt;</td>
 118 </tr>
 119 <tr>
 120 <td><p><span class="term">class</span></p></td>
 121 <td>Codec/Demuxer/Metadata</td>
 122 </tr>
 123 </tbody>
 124 </table></div>
 125 </div>
 126 <hr>
 127 <div class="refsect2">
 128 <a name="idp10931616"></a><h3>Element Pads</h3>
 129 <div class="variablelist"><table border="0">
 130 <col align="left" valign="top">
 131 <tbody>
 132 <tr>
 133 <td><p><span class="term">name</span></p></td>
 134 <td>sink</td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term">direction</span></p></td>
 138 <td>sink</td>
 139 </tr>
 140 <tr>
 141 <td><p><span class="term">presence</span></p></td>
 142 <td>always</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term">details</span></p></td>
 146 <td>application/x-id3</td>
 147 </tr>
 148 </tbody>
 149 </table></div>
 150 <div class="variablelist"><table border="0">
 151 <col align="left" valign="top">
 152 <tbody>
 153 <tr>
 154 <td><p><span class="term">name</span></p></td>
 155 <td>src</td>
 156 </tr>
 157 <tr>
 158 <td><p><span class="term">direction</span></p></td>
 159 <td>source</td>
 160 </tr>
 161 <tr>
 162 <td><p><span class="term">presence</span></p></td>
 163 <td>sometimes</td>
 164 </tr>
 165 <tr>
 166 <td><p><span class="term">details</span></p></td>
 167 <td>ANY</td>
 168 </tr>
 169 </tbody>
 170 </table></div>
 171 </div>
 172 </div>
 173 <p>
 174 </p>
 175 </div>
 176 <div class="refsect1">
 177 <a name="gst-plugins-good-plugins-id3demux.details"></a><h2>Details</h2>
 178 <div class="refsect2">
 179 <a name="GstID3Demux-struct"></a><h3>struct GstID3Demux</h3>
 180 <pre class="programlisting">struct GstID3Demux;</pre>
 181 <p>
 182 </p>
 183 </div>
 184 </div>
 185 <div class="refsect1">
 186 <a name="gst-plugins-good-plugins-id3demux.property-details"></a><h2>Property Details</h2>
 187 <div class="refsect2">
 188 <a name="GstID3Demux--prefer-v1"></a><h3>The <code class="literal">"prefer-v1"</code> property</h3>
 189 <pre class="programlisting">  "prefer-v1"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
 190 <p>Prefer tags from ID3v1 tag at end of file when both ID3v1 and ID3v2 tags are present.</p>
 191 <p>Default value: FALSE</p>
 192 </div>
 193 </div>
 194 </div>
 195 <div class="footer">
 196 <hr>
 197           Generated by GTK-Doc V1.17</div>
 198 </body>
 199 </html>