docs/plugins/html/gst-plugins-base-plugins-vorbistag.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>vorbistag</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-base Elements">
   9 <link rel="prev" href="gst-plugins-base-plugins-vorbisparse.html" title="vorbisparse">
  10 <link rel="next" href="gst-plugins-base-plugins-ximagesink.html" title="ximagesink">
  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-base-plugins-vorbisparse.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 Base Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-plugins-ximagesink.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-plugins-vorbistag.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-vorbistag.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-vorbistag.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-vorbistag.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-base-plugins-vorbistag"></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-base-plugins-vorbistag.top_of_page"></a>vorbistag</span></h2>
  38 <p>vorbistag — Retags vorbis streams</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="gst-plugins-base-plugins-vorbistag.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstVorbisTag"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-vorbistag.html#GstVorbisTag-struct" title="struct GstVorbisTag">GstVorbisTag</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-base-plugins-vorbistag.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 class="link" href="gst-plugins-base-plugins-vorbisparse.html#GstVorbisParse">GstVorbisParse</a>
  54                      +----GstVorbisTag
  55 </pre>
  56 </div>
  57 <div class="refsect1">
  58 <a name="gst-plugins-base-plugins-vorbistag.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  59 <p>
  60 GstVorbisTag implements
  61  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstTagSetter.html">GstTagSetter</a>.</p>
  62 </div>
  63 <div class="refsect1">
  64 <a name="gst-plugins-base-plugins-vorbistag.description"></a><h2>Description</h2>
  65 <p>
  66 The vorbistags element can change the tag contained within a raw
  67 vorbis stream. Specifically, it modifies the comments header packet
  68 of the vorbis stream.
  69 </p>
  70 <p>
  71 The element will also process the stream as the <span class="type">vorbisparse</span> element does
  72 so it can be used when remuxing an Ogg Vorbis stream, without additional
  73 elements.
  74 </p>
  75 <p>
  76 Applications can set the tags to write using the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstTagSetter.html"><span class="type">GstTagSetter</span></a> interface.
  77 Tags contained withing the vorbis bitstream will be picked up
  78 automatically (and merged according to the merge mode set via the tag
  79 setter interface).
  80 </p>
  81 <p>
  82 </p>
  83 <div class="refsect2">
  84 <a name="idp9228848"></a><h3>Example pipelines</h3>
  85 <div class="informalexample">
  86   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  87     <tbody>
  88       <tr>
  89         <td class="listing_lines" align="right"><pre>1</pre></td>
  90         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <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> oggdemux <span class="gtkdoc opt">!</span> vorbistag <span class="gtkdoc opt">!</span> oggmux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>bar<span class="gtkdoc opt">.</span>ogg</pre></td>
  91       </tr>
  92     </tbody>
  93   </table>
  94 </div>
  95  This element is not useful with gst-launch, because it does not support
  96 setting the tags on a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstTagSetter.html"><span class="type">GstTagSetter</span></a> interface. Conceptually, the element
  97 will usually be used in this order though.
  98 </div>
  99 <p>
 100 </p>
 101 <div class="refsynopsisdiv">
 102 <h2>Synopsis</h2>
 103 <div class="refsect2">
 104 <a name="idp8789296"></a><h3>Element Information</h3>
 105 <div class="variablelist"><table border="0">
 106 <col align="left" valign="top">
 107 <tbody>
 108 <tr>
 109 <td><p><span class="term">plugin</span></p></td>
 110 <td>
 111             <a class="link" href="gst-plugins-base-plugins-plugin-vorbis.html#plugin-vorbis">vorbis</a>
 112           </td>
 113 </tr>
 114 <tr>
 115 <td><p><span class="term">author</span></p></td>
 116 <td>James Livingston &lt;doclivingston@gmail.com&gt;</td>
 117 </tr>
 118 <tr>
 119 <td><p><span class="term">class</span></p></td>
 120 <td>Formatter/Metadata</td>
 121 </tr>
 122 </tbody>
 123 </table></div>
 124 </div>
 125 <hr>
 126 <div class="refsect2">
 127 <a name="idp14668272"></a><h3>Element Pads</h3>
 128 <div class="variablelist"><table border="0">
 129 <col align="left" valign="top">
 130 <tbody>
 131 <tr>
 132 <td><p><span class="term">name</span></p></td>
 133 <td>sink</td>
 134 </tr>
 135 <tr>
 136 <td><p><span class="term">direction</span></p></td>
 137 <td>sink</td>
 138 </tr>
 139 <tr>
 140 <td><p><span class="term">presence</span></p></td>
 141 <td>always</td>
 142 </tr>
 143 <tr>
 144 <td><p><span class="term">details</span></p></td>
 145 <td>audio/x-vorbis</td>
 146 </tr>
 147 </tbody>
 148 </table></div>
 149 <div class="variablelist"><table border="0">
 150 <col align="left" valign="top">
 151 <tbody>
 152 <tr>
 153 <td><p><span class="term">name</span></p></td>
 154 <td>src</td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term">direction</span></p></td>
 158 <td>source</td>
 159 </tr>
 160 <tr>
 161 <td><p><span class="term">presence</span></p></td>
 162 <td>always</td>
 163 </tr>
 164 <tr>
 165 <td><p><span class="term">details</span></p></td>
 166 <td>audio/x-vorbis</td>
 167 </tr>
 168 </tbody>
 169 </table></div>
 170 </div>
 171 </div>
 172 <p>
 173 </p>
 174 </div>
 175 <div class="refsect1">
 176 <a name="gst-plugins-base-plugins-vorbistag.details"></a><h2>Details</h2>
 177 <div class="refsect2">
 178 <a name="GstVorbisTag-struct"></a><h3>struct GstVorbisTag</h3>
 179 <pre class="programlisting">struct GstVorbisTag;</pre>
 180 <p>
 181 Opaque data structure.
 182 </p>
 183 </div>
 184 </div>
 185 <div class="refsect1">
 186 <a name="gst-plugins-base-plugins-vorbistag.see-also"></a><h2>See Also</h2>
 187 <span class="type">oggdemux</span>, <span class="type">oggmux</span>, <span class="type">vorbisparse</span>, <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstTagSetter.html"><span class="type">GstTagSetter</span></a>
 188 </div>
 189 </div>
 190 <div class="footer">
 191 <hr>
 192           Generated by GTK-Doc V1.17</div>
 193 </body>
 194 </html>