mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-23 16:50:47 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: improve GstMixer and GstTuner docs

Browse source 
Mention that elements implementing GstMixer and GstTuner need to be
in the right state before they can be used. Also mention GLib
functions for converting filenames to and from URIs.

Fixes #602877.
This commit is contained in:
Tim-Philipp Müller 2009-11-25 15:39:44 +00:00
parent 23da3639f0
commit 5a1c788d9a
1 changed files with 31 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
docs/manual/advanced-interfaces.xml
View file

@ -39,6 +39,11 @@
type being either <classname>GST_URI_SRC</classname> for a source type being either <classname>GST_URI_SRC</classname> for a source
element, or <classname>GST_URI_SINK</classname> for a sink element. element, or <classname>GST_URI_SINK</classname> for a sink element.
</para> </para>
<para>
You can convert filenames to and from URIs using GLib's
<function>g_filename_to_uri ()</function> and
<function>g_uri_to_filename ()</function>.
</para>
</sect1> </sect1>
<sect1 id="section-interfaces-mixer"> <sect1 id="section-interfaces-mixer">
@ -61,6 +66,22 @@
(osssrc, osssink, ossmixer) and the ALSA plugins (alsasrc, alsasink (osssrc, osssink, ossmixer) and the ALSA plugins (alsasrc, alsasink
and alsamixer). and alsamixer).
</para> </para>
<para>
You should not use this interface for volume control in a playback
application. Either use a <classname>volume</classname> element or use
<classname>playbin</classname>'s <quote>volume</quote> property, or use
the audiosink's <quote>volume</quote> property (if it has one).
</para>
<note>
<para>
In order for the <classname>GstMixer</classname> interface to be
usable, the element implementing it needs to be in the right state,
so that the underlying mixer device is open. This usually means the
element needs to be at least in <classname>GST_STATE_READY</classname>
before you can use this interface. You will get confusing warnings
if the element is not in the right state when the interface is used.
</para>
</note>
</sect1> </sect1>
<sect1 id="section-interfaces-tuner"> <sect1 id="section-interfaces-tuner">
@ -81,6 +102,16 @@
This interface is currently only implemented by the Video4linux and This interface is currently only implemented by the Video4linux and
Video4linux2 elements. Video4linux2 elements.
</para> </para>
<note>
<para>
In order for the <classname>GstTuner</classname> interface to be
usable, the element implementing it needs to be in the right state,
so that the underlying device is open. This usually means the
element needs to be at least in <classname>GST_STATE_READY</classname>
before you can use this interface. You will get confusing warnings
if the element is not in the right state when the interface is used.
</para>
</note>
</sect1> </sect1>
<sect1 id="section-interfaces-colorbalance"> <sect1 id="section-interfaces-colorbalance">