upload tizen1.0 source
[framework/multimedia/gst-plugins-good0.10.git] / docs / plugins / html / gst-plugins-good-plugins-audiopanorama.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>audiopanorama</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-audioinvert.html" title="audioinvert">
10 <link rel="next" href="gst-plugins-good-plugins-audiokaraoke.html" title="audiokaraoke">
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-audioinvert.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-audiokaraoke.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-audiopanorama.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-good-plugins-audiopanorama.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-good-plugins-audiopanorama.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-good-plugins-audiopanorama.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="gst-plugins-good-plugins-audiopanorama"></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-audiopanorama.top_of_page"></a>audiopanorama</span></h2>
38 <p>audiopanorama — Positions audio streams in the stereo panorama</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-audiopanorama.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstAudioPanorama"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-audiopanorama.html#GstAudioPanorama-struct" title="struct GstAudioPanorama">GstAudioPanorama</a>;
45 </pre>
46 </div>
47 <div class="refsect1">
48 <a name="gst-plugins-good-plugins-audiopanorama.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/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
54                      +----GstAudioPanorama
55 </pre>
56 </div>
57 <div class="refsect1">
58 <a name="gst-plugins-good-plugins-audiopanorama.properties"></a><h2>Properties</h2>
59 <pre class="synopsis">
60   "<a class="link" href="gst-plugins-good-plugins-audiopanorama.html#GstAudioPanorama--panorama" title='The "panorama" property'>panorama</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
61   "<a class="link" href="gst-plugins-good-plugins-audiopanorama.html#GstAudioPanorama--method" title='The "method" property'>method</a>"                   <span class="type">GstAudioPanoramaMethod</span>  : Read / Write
62 </pre>
63 </div>
64 <div class="refsect1">
65 <a name="gst-plugins-good-plugins-audiopanorama.description"></a><h2>Description</h2>
66 <p>
67 Stereo panorama effect with controllable pan position. One can choose between the default psychoacoustic panning method,
68 which keeps the same perceived loudness, and a simple panning method that just controls the volume on one channel.
69 </p>
70 <p>
71 </p>
72 <div class="refsect2">
73 <a name="idp5718064"></a><h3>Example launch line</h3>
74 <div class="informalexample">
75   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
76     <tbody>
77       <tr>
78         <td class="listing_lines" align="right"><pre>1
79 2
80 3
81 4</pre></td>
82         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch audiotestsrc wave<span class="gtkdoc opt">=</span>saw <span class="gtkdoc opt">!</span> audiopanorama panorama<span class="gtkdoc opt">=-</span><span class="number">1.00</span> <span class="gtkdoc opt">!</span> alsasink
83 gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=</span><span class="string">&quot;melo1.ogg&quot;</span> <span class="gtkdoc opt">!</span> oggdemux <span class="gtkdoc opt">!</span> vorbisdec <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audiopanorama panorama<span class="gtkdoc opt">=-</span><span class="number">1.00</span> <span class="gtkdoc opt">!</span> alsasink
84 gst<span class="gtkdoc opt">-</span>launch audiotestsrc wave<span class="gtkdoc opt">=</span>saw <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audiopanorama panorama<span class="gtkdoc opt">=-</span><span class="number">1.00</span> <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> alsasink
85 gst<span class="gtkdoc opt">-</span>launch audiotestsrc wave<span class="gtkdoc opt">=</span>saw <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audiopanorama method<span class="gtkdoc opt">=</span>simple panorama<span class="gtkdoc opt">=-</span><span class="number">0.50</span> <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> alsasink</pre></td>
86       </tr>
87     </tbody>
88   </table>
89 </div>
90
91 </div>
92 <p>
93 </p>
94 <div class="refsynopsisdiv">
95 <h2>Synopsis</h2>
96 <div class="refsect2">
97 <a name="idp8729296"></a><h3>Element Information</h3>
98 <div class="variablelist"><table border="0">
99 <col align="left" valign="top">
100 <tbody>
101 <tr>
102 <td><p><span class="term">plugin</span></p></td>
103 <td>
104             <a class="link" href="gst-plugins-good-plugins-plugin-audiofx.html#plugin-audiofx">audiofx</a>
105           </td>
106 </tr>
107 <tr>
108 <td><p><span class="term">author</span></p></td>
109 <td>Stefan Kost &lt;ensonic@users.sf.net&gt;</td>
110 </tr>
111 <tr>
112 <td><p><span class="term">class</span></p></td>
113 <td>Filter/Effect/Audio</td>
114 </tr>
115 </tbody>
116 </table></div>
117 </div>
118 <hr>
119 <div class="refsect2">
120 <a name="idp9775120"></a><h3>Element Pads</h3>
121 <div class="variablelist"><table border="0">
122 <col align="left" valign="top">
123 <tbody>
124 <tr>
125 <td><p><span class="term">name</span></p></td>
126 <td>sink</td>
127 </tr>
128 <tr>
129 <td><p><span class="term">direction</span></p></td>
130 <td>sink</td>
131 </tr>
132 <tr>
133 <td><p><span class="term">presence</span></p></td>
134 <td>always</td>
135 </tr>
136 <tr>
137 <td><p><span class="term">details</span></p></td>
138 <td>audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2 ], endianness=(int)1234, width=(int)32</td>
139 </tr>
140 <tr>
141 <td><p><span class="term"></span></p></td>
142 <td> audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2 ], endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean)true</td>
143 </tr>
144 </tbody>
145 </table></div>
146 <div class="variablelist"><table border="0">
147 <col align="left" valign="top">
148 <tbody>
149 <tr>
150 <td><p><span class="term">name</span></p></td>
151 <td>src</td>
152 </tr>
153 <tr>
154 <td><p><span class="term">direction</span></p></td>
155 <td>source</td>
156 </tr>
157 <tr>
158 <td><p><span class="term">presence</span></p></td>
159 <td>always</td>
160 </tr>
161 <tr>
162 <td><p><span class="term">details</span></p></td>
163 <td>audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)2, endianness=(int)1234, width=(int)32</td>
164 </tr>
165 <tr>
166 <td><p><span class="term"></span></p></td>
167 <td> audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)2, endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean)true</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-audiopanorama.details"></a><h2>Details</h2>
178 <div class="refsect2">
179 <a name="GstAudioPanorama-struct"></a><h3>struct GstAudioPanorama</h3>
180 <pre class="programlisting">struct GstAudioPanorama;</pre>
181 <p>
182 </p>
183 </div>
184 </div>
185 <div class="refsect1">
186 <a name="gst-plugins-good-plugins-audiopanorama.property-details"></a><h2>Property Details</h2>
187 <div class="refsect2">
188 <a name="GstAudioPanorama--panorama"></a><h3>The <code class="literal">"panorama"</code> property</h3>
189 <pre class="programlisting">  "panorama"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
190 <p>Position in stereo panorama (-1.0 left -&gt; 1.0 right).</p>
191 <p>Allowed values: [-1,1]</p>
192 <p>Default value: 0</p>
193 </div>
194 <hr>
195 <div class="refsect2">
196 <a name="GstAudioPanorama--method"></a><h3>The <code class="literal">"method"</code> property</h3>
197 <pre class="programlisting">  "method"                   <span class="type">GstAudioPanoramaMethod</span>  : Read / Write</pre>
198 <p>
199 Panning method: psychoacoustic mode keeps the same perceived loudness,
200 while simple mode just controls the volume of one channel. It's merely
201 a matter of taste which method should be chosen.
202 </p>
203 <p>Default value: Psychoacoustic Panning (default)</p>
204 <p class="since">Since 0.10.6</p>
205 </div>
206 </div>
207 </div>
208 <div class="footer">
209 <hr>
210           Generated by GTK-Doc V1.17</div>
211 </body>
212 </html>