adding mixer docs

Original commit message from CVS:
adding mixer docs
This commit is contained in:
Thomas Vander Stichele 2005-06-30 15:27:33 +00:00
parent 1f62f7e724
commit d23c35c394
3 changed files with 194 additions and 0 deletions

View file

@ -8,6 +8,7 @@
<!ENTITY GstAudio SYSTEM "xml/gstaudio.xml">
<!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml">
<!ENTITY GstGConf SYSTEM "xml/gstgconf.xml">
<!ENTITY GstMixer SYSTEM "xml/gstmixer.xml">
<!ENTITY GstRingBuffer SYSTEM "xml/gstringbuffer.xml">
<!ENTITY GstTuner SYSTEM "xml/gsttuner.xml">
@ -45,6 +46,7 @@ This library should be linked to by getting cflags and libs from
<filename>-lgstinterfaces-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstColorBalance;
&GstMixer;
&GstTuner;
</chapter>

View file

@ -28,6 +28,30 @@ gst_color_balance_value_changed
gst_gconf_get_string
</SECTION>
<SECTION>
<FILE>gstmixer</FILE>
<INCLUDE>gst/interfaces/mixer.h</INCLUDE>
GstMixer
GstMixerClass
GstMixerOptions
GstMixerTrack
gst_mixer_list_tracks
gst_mixer_get_volume
gst_mixer_set_volume
gst_mixer_set_mute
gst_mixer_set_record
gst_mixer_set_option
gst_mixer_mute_toggled
gst_mixer_record_toggled
gst_mixer_volume_changed
gst_mixer_option_changed
gst_mixer_options_get_values
</SECTION>
<SECTION>
<FILE>gstringbuffer</FILE>
<INCLUDE>gst/audio/gstringbuffer.h</INCLUDE>

View file

@ -0,0 +1,168 @@
<!-- ##### SECTION Title ##### -->
gstmixer
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstMixer ##### -->
<para>
</para>
<!-- ##### STRUCT GstMixerClass ##### -->
<para>
</para>
@klass:
@mixer_type:
@list_tracks:
@set_volume:
@get_volume:
@set_mute:
@set_record:
@mute_toggled:
@record_toggled:
@volume_changed:
@set_option:
@get_option:
@option_changed:
@_gst_reserved:
<!-- ##### STRUCT GstMixerOptions ##### -->
<para>
</para>
@parent:
@values:
@_gst_reserved:
<!-- ##### STRUCT GstMixerTrack ##### -->
<para>
</para>
@parent:
@label:
@flags:
<!-- ##### FUNCTION gst_mixer_list_tracks ##### -->
<para>
</para>
@mixer:
@Returns:
<!-- ##### FUNCTION gst_mixer_get_volume ##### -->
<para>
</para>
@mixer:
@track:
@volumes:
<!-- ##### FUNCTION gst_mixer_set_volume ##### -->
<para>
</para>
@mixer:
@track:
@volumes:
<!-- ##### FUNCTION gst_mixer_set_mute ##### -->
<para>
</para>
@mixer:
@track:
@mute:
<!-- ##### FUNCTION gst_mixer_set_record ##### -->
<para>
</para>
@mixer:
@track:
@record:
<!-- ##### FUNCTION gst_mixer_set_option ##### -->
<para>
</para>
@mixer:
@opts:
@value:
<!-- ##### FUNCTION gst_mixer_mute_toggled ##### -->
<para>
</para>
@mixer:
@track:
@mute:
<!-- ##### FUNCTION gst_mixer_record_toggled ##### -->
<para>
</para>
@mixer:
@track:
@record:
<!-- ##### FUNCTION gst_mixer_volume_changed ##### -->
<para>
</para>
@mixer:
@track:
@volumes:
<!-- ##### FUNCTION gst_mixer_option_changed ##### -->
<para>
</para>
@mixer:
@opts:
@value:
<!-- ##### FUNCTION gst_mixer_options_get_values ##### -->
<para>
</para>
@mixer_options:
@Returns: