Google Git
Sign in
coral / mtk-gst-plugins-base-debian / 9cccb5bfaa3615b69fe3af57bff8604bc410d730 / . / docs / libs / html / gst-plugins-base-libs-gstmixertrack.html
blob: c8ca5f352df2a671dbacb8633011a6fee2f1e8c1 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gstmixertrack</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
<link rel="up" href="gstreamer-audio.html" title="Audio Library">
<link rel="prev" href="gst-plugins-base-libs-gstmixeroptions.html" title="gstmixeroptions">
<link rel="next" href="gstreamer-ffft.html" title="FFT Library">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<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>
<td><a accesskey="u" href="gstreamer-audio.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Base Plugins 1.0 Library Reference Manual</th>
<td><a accesskey="n" href="gstreamer-ffft.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gst-plugins-base-libs-gstmixertrack.synopsis" class="shortcut">Top</a>
 | 
<a href="#gst-plugins-base-libs-gstmixertrack.description" class="shortcut">Description</a>
 | 
<a href="#gst-plugins-base-libs-gstmixertrack.object-hierarchy" class="shortcut">Object Hierarchy</a>
 | 
<a href="#gst-plugins-base-libs-gstmixertrack.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="gst-plugins-base-libs-gstmixertrack"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstmixertrack.top_of_page"></a>gstmixertrack</span></h2>
<p>gstmixertrack — Basic mixer control object (volume slider, switch)</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gst-plugins-base-libs-gstmixertrack.synopsis"></a><h2>Synopsis</h2>
<a name="GstMixerTrack"></a><pre class="synopsis">
#include &lt;gst/audio/mixer.h&gt;
struct <a class="link" href="gst-plugins-base-libs-gstmixertrack.html#GstMixerTrack-struct" title="struct GstMixerTrack">GstMixerTrack</a>;
enum <a class="link" href="gst-plugins-base-libs-gstmixertrack.html#GstMixerTrackFlags" title="enum GstMixerTrackFlags">GstMixerTrackFlags</a>;
#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,
flag)
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gstmixertrack.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----GstMixerTrack
+----<a class="link" href="gst-plugins-base-libs-gstmixeroptions.html#GstMixerOptions">GstMixerOptions</a>
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gstmixertrack.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<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
"<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
"<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
"<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
"<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
"<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
"<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
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gstmixertrack.description"></a><h2>Description</h2>
<p>
Basic mixer control object (note that it is a GObject and not a GstObject).
</p>
<p>
A mixer track represents a single slider control of none, one or more
channels. A mixer track with no channels is usually interpreted as a
on/off switch control.
</p>
<p>
Note the presence of both min_volume and max_volume fields. Applications
must not assume that min_volume is 0 or max_volume is any particular
value.
</p>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gstmixertrack.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GstMixerTrack-struct"></a><h3>struct GstMixerTrack</h3>
<pre class="programlisting">struct GstMixerTrack;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GstMixerTrackFlags"></a><h3>enum GstMixerTrackFlags</h3>
<pre class="programlisting">typedef enum {
GST_MIXER_TRACK_INPUT = (1 &lt;&lt; 0),
GST_MIXER_TRACK_OUTPUT = (1 &lt;&lt; 1),
GST_MIXER_TRACK_MUTE = (1 &lt;&lt; 2),
GST_MIXER_TRACK_RECORD = (1 &lt;&lt; 3),
GST_MIXER_TRACK_MASTER = (1 &lt;&lt; 4),
GST_MIXER_TRACK_SOFTWARE = (1 &lt;&lt; 5),
GST_MIXER_TRACK_NO_RECORD = (1 &lt;&lt; 6),
GST_MIXER_TRACK_NO_MUTE = (1 &lt;&lt; 7),
GST_MIXER_TRACK_WHITELIST = (1 &lt;&lt; 8),
GST_MIXER_TRACK_READABLE = (1 &lt;&lt; 9),
GST_MIXER_TRACK_WRITABLE = (1 &lt;&lt; 10)
} GstMixerTrackFlags;
</pre>
<p>
Mixer track flags.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GST-MIXER-TRACK-INPUT:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_INPUT</code></span></p></td>
<td>mixer track is for input
</td>
</tr>
<tr>
<td><p><a name="GST-MIXER-TRACK-OUTPUT:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_OUTPUT</code></span></p></td>
<td>mixer track is for output
</td>
</tr>
<tr>
<td><p><a name="GST-MIXER-TRACK-MUTE:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_MUTE</code></span></p></td>
<td>input or output is muted
</td>
</tr>
<tr>
<td><p><a name="GST-MIXER-TRACK-RECORD:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_RECORD</code></span></p></td>
<td>input is audible in speakers attached to output
(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)
</td>
</tr>
<tr>
<td><p><a name="GST-MIXER-TRACK-MASTER:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_MASTER</code></span></p></td>
<td>this mixer track is likely to be the master control
</td>
</tr>
<tr>
<td><p><a name="GST-MIXER-TRACK-SOFTWARE:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_SOFTWARE</code></span></p></td>
<td>mixer track's' volume control is implemented
in software (as opposed to a hardware control)
</td>
</tr>
<tr>
<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>
<td>input track lacks support for recordable.
Since: 0.10.23
</td>
</tr>
<tr>
<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>
<td>play track doesn't support mute. Since: 0.10.23
</td>
</tr>
<tr>
<td><p><a name="GST-MIXER-TRACK-WHITELIST:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_WHITELIST</code></span></p></td>
<td>track should be displayed "by default" in apps.
Since: 0.10.23
</td>
</tr>
<tr>
<td><p><a name="GST-MIXER-TRACK-READABLE:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_READABLE</code></span></p></td>
<td>track is read-only. Since: 0.10.25
</td>
</tr>
<tr>
<td><p><a name="GST-MIXER-TRACK-WRITABLE:CAPS"></a><span class="term"><code class="literal">GST_MIXER_TRACK_WRITABLE</code></span></p></td>
<td>track is write-only. Since: 0.10.25
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GST-MIXER-TRACK-HAS-FLAG:CAPS"></a><h3>GST_MIXER_TRACK_HAS_FLAG()</h3>
<pre class="programlisting">#define GST_MIXER_TRACK_HAS_FLAG(channel, flag)</pre>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gstmixertrack.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstMixerTrack--flags"></a><h3>The <code class="literal">"flags"</code> property</h3>
<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>
<p>Flags indicating the type of mixer track.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMixerTrack--index"></a><h3>The <code class="literal">"index"</code> property</h3>
<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>
<p>
Index of the mixer track, if available. Mixer track implementations
must set this at construct time. This can be used to discern between
multiple tracks with identical labels.
</p>
<p>Default value: 0</p>
<p class="since">Since 0.10.21</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMixerTrack--label"></a><h3>The <code class="literal">"label"</code> property</h3>
<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>
<p>The label assigned to the track (may be translated).</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMixerTrack--max-volume"></a><h3>The <code class="literal">"max-volume"</code> property</h3>
<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>
<p>The maximum possible volume level.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMixerTrack--min-volume"></a><h3>The <code class="literal">"min-volume"</code> property</h3>
<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>
<p>The minimum possible volume level.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMixerTrack--num-channels"></a><h3>The <code class="literal">"num-channels"</code> property</h3>
<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>
<p>The number of channels contained within the track.</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMixerTrack--untranslated-label"></a><h3>The <code class="literal">"untranslated-label"</code> property</h3>
<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>
<p>
The untranslated label of the mixer track, if available. Mixer track
implementations must set this at construct time. Applications may find
this useful to determine icons for various kind of tracks. However,
applications mustn't make any assumptions about the naming of tracks,
the untranslated labels are purely informational and may change.
</p>
<p>Default value: NULL</p>
<p class="since">Since 0.10.13</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gstmixertrack.see-also"></a><h2>See Also</h2>
GstMixer, GstMixerOptions
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>