Tizen 2.0 Release
[framework/multimedia/gst-plugins-bad0.10.git] / docs / plugins / html / gst-plugins-bad-plugins-faac.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>faac</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer Bad Plugins 0.10 Plugins Reference Manual">
8 <link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9 <link rel="prev" href="gst-plugins-bad-plugins-edgedetect.html" title="edgedetect">
10 <link rel="next" href="gst-plugins-bad-plugins-faad.html" title="faad">
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-bad-plugins-edgedetect.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 Bad Plugins 0.10 Plugins Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-bad-plugins-faad.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-bad-plugins-faac.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-bad-plugins-faac.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-bad-plugins-faac.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-bad-plugins-faac.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
31                    | 
32                   <a href="#gst-plugins-bad-plugins-faac.properties" class="shortcut">Properties</a>
33 </td></tr>
34 </table>
35 <div class="refentry">
36 <a name="gst-plugins-bad-plugins-faac"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
38 <td valign="top">
39 <h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-faac.top_of_page"></a>faac</span></h2>
40 <p>faac — Free MPEG-2/4 AAC encoder</p>
41 </td>
42 <td valign="top" align="right"></td>
43 </tr></table></div>
44 <div class="refsynopsisdiv">
45 <a name="gst-plugins-bad-plugins-faac.synopsis"></a><h2>Synopsis</h2>
46 <a name="GstFaac"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac-struct" title="struct GstFaac">GstFaac</a>;
47 </pre>
48 </div>
49 <div class="refsect1">
50 <a name="gst-plugins-bad-plugins-faac.object-hierarchy"></a><h2>Object Hierarchy</h2>
51 <pre class="synopsis">
52   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
53    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
54          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
55                +----GstAudioEncoder
56                      +----GstFaac
57 </pre>
58 </div>
59 <div class="refsect1">
60 <a name="gst-plugins-bad-plugins-faac.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
61 <p>
62 GstFaac implements
63  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPreset.html">GstPreset</a>.</p>
64 </div>
65 <div class="refsect1">
66 <a name="gst-plugins-bad-plugins-faac.properties"></a><h2>Properties</h2>
67 <pre class="synopsis">
68   "<a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--bitrate" title='The "bitrate" property'>bitrate</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
69   "<a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--midside" title='The "midside" property'>midside</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
70   "<a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--outputformat" title='The "outputformat" property'>outputformat</a>"             <span class="type">GstFaacOutputFormat</span>   : Read / Write
71   "<a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--profile" title='The "profile" property'>profile</a>"                  <span class="type">GstFaacProfile</span>        : Read / Write
72   "<a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--shortctl" title='The "shortctl" property'>shortctl</a>"                 <span class="type">GstFaacShortCtl</span>       : Read / Write / Construct
73   "<a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--tns" title='The "tns" property'>tns</a>"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
74   "<a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--quality" title='The "quality" property'>quality</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
75   "<a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--rate-control" title='The "rate-control" property'>rate-control</a>"             <span class="type">GstFaacBrtype</span>         : Read / Write / Construct
76 </pre>
77 </div>
78 <div class="refsect1">
79 <a name="gst-plugins-bad-plugins-faac.description"></a><h2>Description</h2>
80 <div class="refsynopsisdiv">
81 <h2>Synopsis</h2>
82 <div class="refsect2">
83 <a name="idp12677840"></a><h3>Element Information</h3>
84 <div class="variablelist"><table border="0">
85 <col align="left" valign="top">
86 <tbody>
87 <tr>
88 <td><p><span class="term">plugin</span></p></td>
89 <td>
90             <a class="link" href="gst-plugins-bad-plugins-plugin-faac.html#plugin-faac">faac</a>
91           </td>
92 </tr>
93 <tr>
94 <td><p><span class="term">author</span></p></td>
95 <td>Ronald Bultje &lt;rbultje@ronald.bitfreak.net&gt;</td>
96 </tr>
97 <tr>
98 <td><p><span class="term">class</span></p></td>
99 <td>Codec/Encoder/Audio</td>
100 </tr>
101 </tbody>
102 </table></div>
103 </div>
104 <hr>
105 <div class="refsect2">
106 <a name="idp12685248"></a><h3>Element Pads</h3>
107 <div class="variablelist"><table border="0">
108 <col align="left" valign="top">
109 <tbody>
110 <tr>
111 <td><p><span class="term">name</span></p></td>
112 <td>sink</td>
113 </tr>
114 <tr>
115 <td><p><span class="term">direction</span></p></td>
116 <td>sink</td>
117 </tr>
118 <tr>
119 <td><p><span class="term">presence</span></p></td>
120 <td>always</td>
121 </tr>
122 <tr>
123 <td><p><span class="term">details</span></p></td>
124 <td>audio/x-raw-int, endianness=(int)1234, signed=(boolean)true, width=(int)16, depth=(int)16, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 }, channels=(int)[ 1, 6 ]</td>
125 </tr>
126 </tbody>
127 </table></div>
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>src</td>
134 </tr>
135 <tr>
136 <td><p><span class="term">direction</span></p></td>
137 <td>source</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/mpeg, mpegversion=(int)4, channels=(int)[ 1, 6 ], rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 }, stream-format=(string){ adts, raw }, base-profile=(string){ main, lc, ssr, ltp }</td>
146 </tr>
147 <tr>
148 <td><p><span class="term"></span></p></td>
149 <td> audio/mpeg, mpegversion=(int)2, channels=(int)[ 1, 6 ], rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 }, stream-format=(string){ adts, raw }, profile=(string){ main, lc }</td>
150 </tr>
151 </tbody>
152 </table></div>
153 </div>
154 </div>
155 <p>
156 </p>
157 </div>
158 <div class="refsect1">
159 <a name="gst-plugins-bad-plugins-faac.details"></a><h2>Details</h2>
160 <div class="refsect2">
161 <a name="GstFaac-struct"></a><h3>struct GstFaac</h3>
162 <pre class="programlisting">struct GstFaac;</pre>
163 <p>
164 </p>
165 </div>
166 </div>
167 <div class="refsect1">
168 <a name="gst-plugins-bad-plugins-faac.property-details"></a><h2>Property Details</h2>
169 <div class="refsect2">
170 <a name="GstFaac--bitrate"></a><h3>The <code class="literal">"bitrate"</code> property</h3>
171 <pre class="programlisting">  "bitrate"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
172 <p>Average Bitrate (ABR) in bits/sec.</p>
173 <p>Allowed values: [8000,320000]</p>
174 <p>Default value: 128000</p>
175 </div>
176 <hr>
177 <div class="refsect2">
178 <a name="GstFaac--midside"></a><h3>The <code class="literal">"midside"</code> property</h3>
179 <pre class="programlisting">  "midside"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
180 <p>Allow mid/side encoding.</p>
181 <p>Default value: TRUE</p>
182 </div>
183 <hr>
184 <div class="refsect2">
185 <a name="GstFaac--outputformat"></a><h3>The <code class="literal">"outputformat"</code> property</h3>
186 <pre class="programlisting">  "outputformat"             <span class="type">GstFaacOutputFormat</span>   : Read / Write</pre>
187 <p>Format of output frames.</p>
188 <p>Default value: OUTPUTFORMAT_RAW</p>
189 </div>
190 <hr>
191 <div class="refsect2">
192 <a name="GstFaac--profile"></a><h3>The <code class="literal">"profile"</code> property</h3>
193 <pre class="programlisting">  "profile"                  <span class="type">GstFaacProfile</span>        : Read / Write</pre>
194 <p>MPEG/AAC encoding profile.</p>
195 <p>Default value: LC</p>
196 </div>
197 <hr>
198 <div class="refsect2">
199 <a name="GstFaac--shortctl"></a><h3>The <code class="literal">"shortctl"</code> property</h3>
200 <pre class="programlisting">  "shortctl"                 <span class="type">GstFaacShortCtl</span>       : Read / Write / Construct</pre>
201 <p>Block type encorcing.</p>
202 <p>Default value: SHORTCTL_NORMAL</p>
203 </div>
204 <hr>
205 <div class="refsect2">
206 <a name="GstFaac--tns"></a><h3>The <code class="literal">"tns"</code> property</h3>
207 <pre class="programlisting">  "tns"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
208 <p>Use temporal noise shaping.</p>
209 <p>Default value: FALSE</p>
210 </div>
211 <hr>
212 <div class="refsect2">
213 <a name="GstFaac--quality"></a><h3>The <code class="literal">"quality"</code> property</h3>
214 <pre class="programlisting">  "quality"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
215 <p>Variable bitrate (VBR) quantizer quality in %.</p>
216 <p>Allowed values: [1,1000]</p>
217 <p>Default value: 100</p>
218 </div>
219 <hr>
220 <div class="refsect2">
221 <a name="GstFaac--rate-control"></a><h3>The <code class="literal">"rate-control"</code> property</h3>
222 <pre class="programlisting">  "rate-control"             <span class="type">GstFaacBrtype</span>         : Read / Write / Construct</pre>
223 <p>Encoding bitrate type (VBR/ABR).</p>
224 <p>Default value: VBR</p>
225 </div>
226 </div>
227 </div>
228 <div class="footer">
229 <hr>
230           Generated by GTK-Doc V1.18</div>
231 </body>
232 </html>