docs/libs/html/gst-plugins-base-libs-gstmixertrack.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>gstmixertrack</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
   8 <link rel="up" href="gstreamer-interfaces.html" title="Interfaces Library">
   9 <link rel="prev" href="gst-plugins-base-libs-gstmixeroptions.html" title="gstmixeroptions">
  10 <link rel="next" href="gst-plugins-base-libs-gstnavigation.html" title="gstnavigation">
  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-base-libs-gstmixeroptions.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="gstreamer-interfaces.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 Library Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-libs-gstnavigation.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-libs-gstmixertrack.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-libs-gstmixertrack.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-libs-gstmixertrack.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-libs-gstmixertrack.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-base-libs-gstmixertrack"></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-libs-gstmixertrack.top_of_page"></a>gstmixertrack</span></h2>
  38 <p>gstmixertrack — Basic mixer control object (volume slider, switch)</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="gst-plugins-base-libs-gstmixertrack.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstMixerTrack"></a><pre class="synopsis">
  45 #include &lt;gst/interfaces/mixer.h&gt;
  46
  47 struct              <a class="link" href="gst-plugins-base-libs-gstmixertrack.html#GstMixerTrack-struct" title="struct GstMixerTrack">GstMixerTrack</a>;
  48 enum                <a class="link" href="gst-plugins-base-libs-gstmixertrack.html#GstMixerTrackFlags" title="enum GstMixerTrackFlags">GstMixerTrackFlags</a>;
  49 #define             <a class="link" href="gst-plugins-base-libs-gstmixertrack.html#GST-MIXER-TRACK-HAS-FLAG:CAPS" title="GST_MIXER_TRACK_HAS_FLAG()">GST_MIXER_TRACK_HAS_FLAG</a>            (channel,
  50                                                          flag)
  51 </pre>
  52 </div>
  53 <div class="refsect1">
  54 <a name="gst-plugins-base-libs-gstmixertrack.object-hierarchy"></a><h2>Object Hierarchy</h2>
  55 <pre class="synopsis">
  56   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  57    +----GstMixerTrack
  58          +----<a class="link" href="gst-plugins-base-libs-gstmixeroptions.html#GstMixerOptions">GstMixerOptions</a>
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="gst-plugins-base-libs-gstmixertrack.properties"></a><h2>Properties</h2>
  63 <pre class="synopsis">
  64   "<a class="link" href="gst-plugins-base-libs-gstmixertrack.html#GstMixerTrack--flags" title='The "flags" property'>flags</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read
  65   "<a class="link" href="gst-plugins-base-libs-gstmixertrack.html#GstMixerTrack--index" title='The "index" property'>index</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct Only
  66   "<a class="link" href="gst-plugins-base-libs-gstmixertrack.html#GstMixerTrack--label" title='The "label" property'>label</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  67   "<a class="link" href="gst-plugins-base-libs-gstmixertrack.html#GstMixerTrack--max-volume" title='The "max-volume" property'>max-volume</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read
  68   "<a class="link" href="gst-plugins-base-libs-gstmixertrack.html#GstMixerTrack--min-volume" title='The "min-volume" property'>min-volume</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read
  69   "<a class="link" href="gst-plugins-base-libs-gstmixertrack.html#GstMixerTrack--num-channels" title='The "num-channels" property'>num-channels</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read
  70   "<a class="link" href="gst-plugins-base-libs-gstmixertrack.html#GstMixerTrack--untranslated-label" title='The "untranslated-label" property'>untranslated-label</a>"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
  71 </pre>
  72 </div>
  73 <div class="refsect1">
  74 <a name="gst-plugins-base-libs-gstmixertrack.description"></a><h2>Description</h2>
  75 <p>
  76 Basic mixer control object (note that it is a GObject and not a GstObject).
  77 </p>
  78 <p>
  79 A mixer track represents a single slider control of none, one or more
  80 channels. A mixer track with no channels is usually interpreted as a
  81 on/off switch control.
  82 </p>
  83 <p>
  84 Note the presence of both min_volume and max_volume fields. Applications
  85 must not assume that min_volume is 0 or max_volume is any particular
  86 value.
  87 </p>
  88 </div>
  89 <div class="refsect1">
  90 <a name="gst-plugins-base-libs-gstmixertrack.details"></a><h2>Details</h2>
  91 <div class="refsect2">
  92 <a name="GstMixerTrack-struct"></a><h3>struct GstMixerTrack</h3>
  93 <pre class="programlisting">struct GstMixerTrack;</pre>
  94 </div>
  95 <hr>
  96 <div class="refsect2">
  97 <a name="GstMixerTrackFlags"></a><h3>enum GstMixerTrackFlags</h3>
  98 <pre class="programlisting">typedef enum {
  99   GST_MIXER_TRACK_INPUT  = (1&lt;&lt;0),
 100   GST_MIXER_TRACK_OUTPUT = (1&lt;&lt;1),
 101   GST_MIXER_TRACK_MUTE   = (1&lt;&lt;2),
 102   GST_MIXER_TRACK_RECORD = (1&lt;&lt;3),
 103   GST_MIXER_TRACK_MASTER = (1&lt;&lt;4),
 104   GST_MIXER_TRACK_SOFTWARE = (1&lt;&lt;5),
 105   GST_MIXER_TRACK_NO_RECORD = (1&lt;&lt;6),
 106   GST_MIXER_TRACK_NO_MUTE = (1&lt;&lt;7),
 107   GST_MIXER_TRACK_WHITELIST = (1&lt;&lt;8),
 108   GST_MIXER_TRACK_READONLY = (1&lt;&lt;9),
 109   GST_MIXER_TRACK_WRITEONLY = (1&lt;&lt;10)
 110 } GstMixerTrackFlags;
 111 </pre>
 112 <p>
 113 Mixer track flags.
 114 </p>
 115 <div class="variablelist"><table border="0">
 116 <col align="left" valign="top">
 117 <tbody>
 118 <tr>
 119 <td><p><a name="GST-MIXER-TRACK-INPUT:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_INPUT</code></span></p></td>
 120 <td>mixer track is for input
 121 </td>
 122 </tr>
 123 <tr>
 124 <td><p><a name="GST-MIXER-TRACK-OUTPUT:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_OUTPUT</code></span></p></td>
 125 <td>mixer track is for output
 126 </td>
 127 </tr>
 128 <tr>
 129 <td><p><a name="GST-MIXER-TRACK-MUTE:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_MUTE</code></span></p></td>
 130 <td>input or output is muted
 131 </td>
 132 </tr>
 133 <tr>
 134 <td><p><a name="GST-MIXER-TRACK-RECORD:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_RECORD</code></span></p></td>
 135 <td>input is audible in speakers attached to output
 136     (for <a class="link" href="gst-plugins-base-libs-gstmixertrack.html#GST-MIXER-TRACK-INPUT:CAPS"><span class="type">GST_MIXER_TRACK_INPUT</span></a> mixer tracks only)
 137 </td>
 138 </tr>
 139 <tr>
 140 <td><p><a name="GST-MIXER-TRACK-MASTER:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_MASTER</code></span></p></td>
 141 <td>this mixer track is likely to be the master control
 142 </td>
 143 </tr>
 144 <tr>
 145 <td><p><a name="GST-MIXER-TRACK-SOFTWARE:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_SOFTWARE</code></span></p></td>
 146 <td>mixer track's' volume control is implemented
 147     in software (as opposed to a hardware control)
 148 </td>
 149 </tr>
 150 <tr>
 151 <td><p><a name="GST-MIXER-TRACK-NO-RECORD:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_NO_RECORD</code></span></p></td>
 152 <td>input track lacks support for recordable.
 153     Since: 0.10.23
 154 </td>
 155 </tr>
 156 <tr>
 157 <td><p><a name="GST-MIXER-TRACK-NO-MUTE:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_NO_MUTE</code></span></p></td>
 158 <td>play track doesn't support mute. Since: 0.10.23
 159 </td>
 160 </tr>
 161 <tr>
 162 <td><p><a name="GST-MIXER-TRACK-WHITELIST:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_WHITELIST</code></span></p></td>
 163 <td>track should be displayed "by default" in apps.
 164     Since: 0.10.23
 165 </td>
 166 </tr>
 167 <tr>
 168 <td><p><a name="GST-MIXER-TRACK-READONLY:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_READONLY</code></span></p></td>
 169 <td>track is read-only. Since: 0.10.25
 170 </td>
 171 </tr>
 172 <tr>
 173 <td><p><a name="GST-MIXER-TRACK-WRITEONLY:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_WRITEONLY</code></span></p></td>
 174 <td>track is write-only. Since: 0.10.25
 175 </td>
 176 </tr>
 177 </tbody>
 178 </table></div>
 179 </div>
 180 <hr>
 181 <div class="refsect2">
 182 <a name="GST-MIXER-TRACK-HAS-FLAG:CAPS"></a><h3>GST_MIXER_TRACK_HAS_FLAG()</h3>
 183 <pre class="programlisting">#define             GST_MIXER_TRACK_HAS_FLAG(channel, flag)</pre>
 184 </div>
 185 </div>
 186 <div class="refsect1">
 187 <a name="gst-plugins-base-libs-gstmixertrack.property-details"></a><h2>Property Details</h2>
 188 <div class="refsect2">
 189 <a name="GstMixerTrack--flags"></a><h3>The <code class="literal">"flags"</code> property</h3>
 190 <pre class="programlisting">  "flags"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read</pre>
 191 <p>Flags indicating the type of mixer track.</p>
 192 <p>Default value: 0</p>
 193 </div>
 194 <hr>
 195 <div class="refsect2">
 196 <a name="GstMixerTrack--index"></a><h3>The <code class="literal">"index"</code> property</h3>
 197 <pre class="programlisting">  "index"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct Only</pre>
 198 <p>
 199 Index of the mixer track, if available. Mixer track implementations
 200 must set this at construct time. This can be used to discern between
 201 multiple tracks with identical labels.
 202 </p>
 203 <p>Default value: 0</p>
 204 <p class="since">Since 0.10.21</p>
 205 </div>
 206 <hr>
 207 <div class="refsect2">
 208 <a name="GstMixerTrack--label"></a><h3>The <code class="literal">"label"</code> property</h3>
 209 <pre class="programlisting">  "label"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 210 <p>The label assigned to the track (may be translated).</p>
 211 <p>Default value: NULL</p>
 212 </div>
 213 <hr>
 214 <div class="refsect2">
 215 <a name="GstMixerTrack--max-volume"></a><h3>The <code class="literal">"max-volume"</code> property</h3>
 216 <pre class="programlisting">  "max-volume"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read</pre>
 217 <p>The maximum possible volume level.</p>
 218 <p>Default value: 0</p>
 219 </div>
 220 <hr>
 221 <div class="refsect2">
 222 <a name="GstMixerTrack--min-volume"></a><h3>The <code class="literal">"min-volume"</code> property</h3>
 223 <pre class="programlisting">  "min-volume"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read</pre>
 224 <p>The minimum possible volume level.</p>
 225 <p>Default value: 0</p>
 226 </div>
 227 <hr>
 228 <div class="refsect2">
 229 <a name="GstMixerTrack--num-channels"></a><h3>The <code class="literal">"num-channels"</code> property</h3>
 230 <pre class="programlisting">  "num-channels"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read</pre>
 231 <p>The number of channels contained within the track.</p>
 232 <p>Allowed values: &gt;= 0</p>
 233 <p>Default value: 0</p>
 234 </div>
 235 <hr>
 236 <div class="refsect2">
 237 <a name="GstMixerTrack--untranslated-label"></a><h3>The <code class="literal">"untranslated-label"</code> property</h3>
 238 <pre class="programlisting">  "untranslated-label"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 239 <p>
 240 The untranslated label of the mixer track, if available. Mixer track
 241 implementations must set this at construct time. Applications may find
 242 this useful to determine icons for various kind of tracks. However,
 243 applications mustn't make any assumptions about the naming of tracks,
 244 the untranslated labels are purely informational and may change.
 245 </p>
 246 <p>Default value: NULL</p>
 247 <p class="since">Since 0.10.13</p>
 248 </div>
 249 </div>
 250 <div class="refsect1">
 251 <a name="gst-plugins-base-libs-gstmixertrack.see-also"></a><h2>See Also</h2>
 252 GstMixer, GstMixerOptions
 253 </div>
 254 </div>
 255 <div class="footer">
 256 <hr>
 257           Generated by GTK-Doc V1.18</div>
 258 </body>
 259 </html>