Commit 12e21fb3 authored by Stefan Kost's avatar Stefan Kost
Browse files

docs/libs/: first batch of reordering things, add index & hierarchy

Original commit message from CVS:
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* docs/libs/gst-plugins-base-libs.types:
first batch of reordering things, add index & hierarchy
parent 31c54a66
2006-06-11 Stefan Kost <ensonic@users.sf.net>
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* docs/libs/gst-plugins-base-libs.types:
first batch of reordering things, add index & hierarchy
2006-06-11 Thomas Vander Stichele <thomas at apestaart dot org>
 
* configure.ac:
......
......@@ -3,99 +3,152 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
<!ENTITY GstCompiling SYSTEM "compiling.sgml">
<!-- audio -->
<!ENTITY GstAudio SYSTEM "xml/gstaudio.xml">
<!ENTITY GstAudioClock SYSTEM "xml/gstaudioclock.xml">
<!ENTITY GstAudioFilter SYSTEM "xml/gstaudiofilter.xml">
<!ENTITY GstAudioMixerUtils SYSTEM "xml/gstaudiomixerutils.xml">
<!ENTITY GstAudioSink SYSTEM "xml/gstaudiosink.xml">
<!ENTITY GstAudioSrc SYSTEM "xml/gstaudiosrc.xml">
<!ENTITY GstBaseAudioSink SYSTEM "xml/gstbaseaudiosink.xml">
<!ENTITY GstBaseAudioSrc SYSTEM "xml/gstbaseaudiosrc.xml">
<!ENTITY GstRingBuffer SYSTEM "xml/gstringbuffer.xml">
<!-- cdda -->
<!ENTITY GstCddaBaseSrc SYSTEM "xml/gstcddabasesrc.xml">
<!ENTITY GstVideo SYSTEM "xml/gstvideo.xml">
<!ENTITY GstVideoSink SYSTEM "xml/gstvideosink.xml">
<!ENTITY GstVideoFilter SYSTEM "xml/gstvideofilter.xml">
<!-- floatcast -->
<!ENTITY GstFloatCast SYSTEM "xml/gstfloatcast.xml">
<!-- interfaces -->
<!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml">
<!ENTITY GstColorBalanceChannel SYSTEM "xml/gstcolorbalancechannel.xml">
<!ENTITY GstMixer SYSTEM "xml/gstmixer.xml">
<!ENTITY GstRingBuffer SYSTEM "xml/gstringbuffer.xml">
<!ENTITY GstMixerOptions SYSTEM "xml/gstmixeroptions.xml">
<!ENTITY GstMixerTrack SYSTEM "xml/gstmixertrack.xml">
<!ENTITY GstNavigation SYSTEM "xml/gstnavigation.xml">
<!ENTITY GstPropertyProbe SYSTEM "xml/gstpropertyprobe.xml">
<!ENTITY GstTuner SYSTEM "xml/gsttuner.xml">
<!ENTITY GstTunerChannel SYSTEM "xml/gsttunerchannel.xml">
<!ENTITY GstTunerNorm SYSTEM "xml/gsttunernorm.xml">
<!ENTITY GstXOverlay SYSTEM "xml/gstxoverlay.xml">
<!-- netbuffer -->
<!-- riff -->
<!-- rtp -->
<!-- tag -->
<!ENTITY GstTag SYSTEM "xml/gsttag.xml">
<!ENTITY GstTagVorbis SYSTEM "xml/gsttagvorbis.xml">
<!ENTITY GstTagID3 SYSTEM "xml/gsttagid3.xml">
<!ENTITY GstTuner SYSTEM "xml/gsttuner.xml">
<!ENTITY GstXOverlay SYSTEM "xml/gstxoverlay.xml">
<!-- video -->
<!ENTITY GstVideo SYSTEM "xml/gstvideo.xml">
<!ENTITY GstVideoFilter SYSTEM "xml/gstvideofilter.xml">
<!ENTITY GstVideoSink SYSTEM "xml/gstvideosink.xml">
<!-- generated by gtkdoc-mkdb -->
<!ENTITY gst-plugin-libs-tree-index SYSTEM "xml/tree_index.sgml">
]>
<book id="index">
<bookinfo>
<title>GStreamer Base Plugins &GST_MAJORMINOR; Library Reference Manual</title>
<releaseinfo>for GStreamer Library &GST_MAJORMINOR; (&GST_VERSION;)</releaseinfo>
</bookinfo>
<chapter id="gstreamer-plugins-base">
<part id="gstreamer-plugins-base">
<title>GStreamer Base Plugins Libraries</title>
<para>
This manual describes the libraries provided by the GStreamer Base Plugins
package.
This manual describes the libraries provided by the GStreamer Base Plugins
package.
</para>
&GstCompiling;
</chapter>
<chapter id="gstreamer-audio">
<title>Audio Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base.pc</filename> and adding
<filename>-lgstaudio-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstAudio;
&GstAudioMixerUtils;
&GstBaseAudioSink;
&GstAudioSink;
&GstRingBuffer;
</chapter>
<chapter id="gstreamer-audio">
<title>Audio Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base.pc</filename> and adding
<filename>-lgstaudio-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstAudio;
&GstAudioClock;
&GstAudioFilter;
&GstAudioMixerUtils;
&GstBaseAudioSink;
&GstBaseAudioSrc;
&GstAudioSink;
&GstAudioSrc;
&GstRingBuffer;
</chapter>
<chapter id="gstreamer-cdda">
<title>CDDA Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base.pc</filename> and adding
<filename>-lgstcdda-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstCddaBaseSrc;
</chapter>
<chapter id="gstreamer-floatcast">
<title>FloatCast Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base.pc</filename> and adding
<filename>-lgstfloatcase-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstFloatCast;
</chapter>
<chapter id="gstreamer-interfaces">
<title>Interfaces Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base.pc</filename> and adding
<filename>-lgstinterfaces-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstColorBalance;
&GstColorBalanceChannel;
&GstMixer;
&GstMixerOptions;
&GstMixerTrack;
&GstNavigation;
&GstPropertyProbe;
&GstTuner;
&GstTunerChannel;
&GstTunerNorm;
&GstXOverlay;
</chapter>
<chapter id="gstreamer-tag">
<title>Tag Support Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base.pc</filename> and adding
<filename>-lgsttag-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstTag;
&GstTagVorbis;
&GstTagID3;
</chapter>
<chapter id="gstreamer-video">
<title>Video Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base.pc</filename> and adding
<filename>-lgstvideo-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstVideo;
&GstVideoSink;
&GstVideoFilter;
</chapter>
</part>
<chapter id="gstreamer-video">
<title>Video Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base.pc</filename> and adding
<filename>-lgstvideo-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstVideo;
&GstVideoSink;
&GstVideoFilter;
</chapter>
<chapter id="gstreamer-interfaces">
<title>Interfaces Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base.pc</filename> and adding
<filename>-lgstinterfaces-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstColorBalance;
&GstMixer;
&GstTuner;
&GstXOverlay;
</chapter>
<chapter id="gstreamer-tag">
<title>Tag Support Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base.pc</filename> and adding
<filename>-lgsttag-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstTag;
&GstTagVorbis;
&GstTagID3;
</chapter>
<chapter id="gstreamer-cdda">
<title>CDDA Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base.pc</filename> and adding
<filename>-lgstcdda-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstCddaBaseSrc;
</chapter>
<part id="gstreamer-libs-hierarchy">
<title>Object Hierarchy</title>
&gst-plugin-libs-tree-index;
</part>
<index id="api-index">
<title>Index</title>
</index>
</book>
# audio
<SECTION>
<FILE>gstaudio</FILE>
<INCLUDE>gst/audio/audio.h</INCLUDE>
GstAudioFieldFlag
GST_FRAMES_TO_CLOCK_TIME
GST_CLOCK_TIME_TO_FRAMES
GST_AUDIO_DEF_RATE
GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS
GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS
GST_AUDIO_INT_PAD_TEMPLATE_CAPS
GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS
gst_audio_frame_byte_size
gst_audio_frame_length
gst_audio_duration_from_pad_buffer
......@@ -9,6 +19,41 @@ gst_audio_is_buffer_framed
gst_audio_structure_set_int
</SECTION>
<SECTION>
<FILE>gstaudioclock</FILE>
<INCLUDE>gst/audio/gstaudioclock.h</INCLUDE>
GstAudioClock
GstAudioClockClass
gst_audio_clock_new
<SUBSECTION Standard>
GST_AUDIO_CLOCK
GST_IS_AUDIO_CLOCK
GST_TYPE_AUDIO_CLOCK
gst_audio_clock_get_type
GST_AUDIO_CLOCK_CLASS
GST_IS_AUDIO_CLOCK_CLASS
GST_AUDIO_CLOCK_GET_CLASS
</SECTION>
<SECTION>
<FILE>gstaudiofilter</FILE>
<INCLUDE>gst/audio/gstaudiofilter.h</INCLUDE>
GstAudioFilter
GstAudioFilterClass
GstAudioFilterFilterFunc
GstAudioFilterInplaceFilterFunc
GstAudioFilterSetupFunc
gst_audio_filter_class_add_pad_templates
<SUBSECTION Standard>
GST_AUDIO_FILTER
GST_IS_AUDIO_FILTER
GST_TYPE_AUDIO_FILTER
gst_audio_filter_get_type
GST_AUDIO_FILTER_CLASS
GST_IS_AUDIO_FILTER_CLASS
GST_AUDIO_FILTER_GET_CLASS
</SECTION>
<SECTION>
<FILE>gstaudiomixerutils</FILE>
<INCLUDE>gst/audio/mixerutils.h</INCLUDE>
......@@ -21,6 +66,29 @@ gst_audio_default_registry_mixer_filter
<INCLUDE>gst/audio/gstaudiosink.h</INCLUDE>
GstAudioSink
GstAudioSinkClass
<SUBSECTION Standard>
GST_AUDIO_SINK
GST_IS_AUDIO_SINK
GST_TYPE_AUDIO_SINK
gst_audio_sink_get_type
GST_AUDIO_SINK_CLASS
GST_IS_AUDIO_SINK_CLASS
GST_AUDIO_SINK_GET_CLASS
</SECTION>
<SECTION>
<FILE>gstaudiosrc</FILE>
<INCLUDE>gst/audio/gstaudiosrc.h</INCLUDE>
GstAudioSrc
GstAudioSrcClass
<SUBSECTION Standard>
GST_AUDIO_SRC
GST_IS_AUDIO_SRC
GST_TYPE_AUDIO_SRC
gst_audio_src_get_type
GST_AUDIO_SRC_CLASS
GST_IS_AUDIO_SRC_CLASS
GST_AUDIO_SRC_GET_CLASS
</SECTION>
<SECTION>
......@@ -41,11 +109,91 @@ GST_IS_BASE_AUDIO_SINK_CLASS
GST_BASE_AUDIO_SINK_GET_CLASS
</SECTION>
<SECTION>
<FILE>gstbaseaudiosrc</FILE>
<INCLUDE>gst/audio/gstbaseaudiosrc.h</INCLUDE>
GstBaseAudioSrc
GstBaseAudioSrcClass
GST_BASE_AUDIO_SRC_CLOCK
GST_BASE_AUDIO_SRC_PAD
gst_base_audio_src_create_ringbuffer
<SUBSECTION Standard>
GST_BASE_AUDIO_SRC
GST_IS_BASE_AUDIO_SRC
GST_TYPE_BASE_AUDIO_SRC
gst_base_audio_src_get_type
GST_BASE_AUDIO_SRC_CLASS
GST_IS_BASE_AUDIO_SRC_CLASS
GST_BASE_AUDIO_SRC_GET_CLASS
</SECTION>
<SECTION>
<FILE>gstringbuffer</FILE>
<INCLUDE>gst/audio/gstringbuffer.h</INCLUDE>
GstRingBuffer
GstRingBufferSpec
GstRingBufferClass
GstRingBufferCallback
GstRingBufferSegState
GstRingBufferState
GST_RING_BUFFER_BROADCAST
GST_RING_BUFFER_GET_COND
GST_RING_BUFFER_SIGNAL
GST_RING_BUFFER_WAIT
gst_ring_buffer_set_callback
gst_ring_buffer_acquire
gst_ring_buffer_release
gst_ring_buffer_is_acquired
gst_ring_buffer_start
gst_ring_buffer_pause
gst_ring_buffer_stop
gst_ring_buffer_delay
gst_ring_buffer_samples_done
gst_ring_buffer_set_sample
gst_ring_buffer_commit
gst_ring_buffer_prepare_read
gst_ring_buffer_read
gst_ring_buffer_prepare_write
gst_ring_buffer_clear
gst_ring_buffer_clear_all
gst_ring_buffer_advance
gst_ring_buffer_close_device
gst_ring_buffer_open_device
gst_ring_buffer_device_is_open
gst_ring_buffer_may_start
gst_ring_buffer_parse_caps
gst_ring_buffer_set_flushing
<SUBSECTION Standard>
GST_TYPE_RING_BUFFER
GST_RING_BUFFER
GST_RING_BUFFER_CLASS
GST_RING_BUFFER_GET_CLASS
GST_IS_RING_BUFFER
GST_IS_RING_BUFFER_CLASS
gst_ring_buffer_get_type
<SUBSECTION Private>
gst_ring_buffer_debug_spec_buff
gst_ring_buffer_debug_spec_caps
</SECTION>
# cdda
<SECTION>
<FILE>gstcddabasesrc</FILE>
<INCLUDE>gst/cdda/gstcddabasesrc.h</INCLUDE>
GstCddaBaseSrc
GstCddaBaseSrcClass
GstCddaBaseSrcTrack
GstCddaBaseSrcMode
gst_cdda_base_src_add_track
......@@ -53,17 +201,72 @@ GST_TAG_CDDA_CDDB_DISCID
GST_TAG_CDDA_CDDB_DISCID_FULL
GST_TAG_CDDA_MUSICBRAINZ_DISCID
GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL
<SUBSECTION Standard>
GST_CDDA_BASE_SRC
GST_CDDA_BASE_SRC_CLASS
GST_CDDA_BASE_SRC_GET_CLASS
GST_IS_CDDA_BASE_SRC
GST_IS_CDDA_BASE_SRC_CLASS
GST_TYPE_CDDA_BASE_SRC
gst_cdda_base_src_get_type
</SECTION>
# floatcast
<SECTION>
<FILE>gstfloatcast</FILE>
<INCLUDE>gst/floatcase/floatcast.h</INCLUDE>
GDOUBLE_FROM_BE
GDOUBLE_FROM_LE
GDOUBLE_TO_BE
GDOUBLE_TO_LE
GFLOAT_FROM_BE
GFLOAT_FROM_LE
GFLOAT_TO_BE
GFLOAT_TO_LE
gst_cast_double
gst_cast_float
</SECTION>
# interfaces
<SECTION>
<FILE>gstcolorbalance</FILE>
<INCLUDE>gst/interfaces/colorbalance.h</INCLUDE>
<INCLUDE>gst/interfaces/color.h</INCLUDE>
GstColorBalance
GstColorBalanceClass
GstColorBalanceType
gst_color_balance_list_channels
gst_color_balance_get_value
gst_color_balance_set_value
gst_color_balance_value_changed
<SUBSECTION Standard>
GST_COLOR_BALANCE
GST_COLOR_BALANCE_CLASS
GST_COLOR_BALANCE_GET_CLASS
GST_COLOR_BALANCE_TYPE
GST_IS_COLOR_BALANCE
GST_IS_COLOR_BALANCE_CLASS
GST_TYPE_COLOR_BALANCE
GST_TYPE_COLOR_BALANCE_TYPE
gst_color_balance_get_type
gst_color_balance_type_get_type
</SECTION>
<SECTION>
<FILE>gstcolorbalancechannel</FILE>
<INCLUDE>gst/interfaces/colorbalancechannel.h</INCLUDE>
GstColorBalanceChannel
GstColorBalanceChannelClass
<SUBSECTION Standard>
GST_COLOR_BALANCE_CHANNEL
GST_COLOR_BALANCE_CHANNEL_CLASS
GST_IS_COLOR_BALANCE_CHANNEL
GST_IS_COLOR_BALANCE_CHANNEL_CLASS
GST_TYPE_COLOR_BALANCE_CHANNEL
gst_color_balance_channel_get_type
</SECTION>
<SECTION>
......@@ -71,8 +274,7 @@ gst_color_balance_value_changed
<INCLUDE>gst/interfaces/mixer.h</INCLUDE>
GstMixer
GstMixerClass
GstMixerOptions
GstMixerTrack
GstMixerType
gst_mixer_list_tracks
gst_mixer_get_volume
......@@ -86,38 +288,184 @@ gst_mixer_mute_toggled
gst_mixer_record_toggled
gst_mixer_volume_changed
gst_mixer_option_changed
gst_mixer_get_option
<SUBSECTION Standard>
GST_TYPE_MIXER
GST_TYPE_MIXER_TYPE
GST_MIXER
GST_MIXER_CLASS
GST_MIXER_GET_CLASS
GST_MIXER_TYPE
GST_IS_MIXER
GST_IS_MIXER_CLASS
gst_mixer_get_type
gst_mixer_type_get_type
</SECTION>
<SECTION>
<FILE>gstmixeroptions</FILE>
<INCLUDE>gst/interfaces/mixer.h</INCLUDE>
GstMixerOptions
GstMixerOptionsClass
gst_mixer_options_get_values
<SUBSECTION Standard>
GST_TYPE_MIXER_OPTIONS
GST_MIXER_OPTIONS
GST_MIXER_OPTIONS_CLASS
GST_IS_MIXER_OPTIONS
GST_IS_MIXER_OPTIONS_CLASS
gst_mixer_options_get_type
</SECTION>
<SECTION>
<FILE>gstringbuffer</FILE>
<INCLUDE>gst/audio/gstringbuffer.h</INCLUDE>
GstRingBuffer
GstRingBufferSpec
GstRingBufferClass
<FILE>gstmixertrack</FILE>
<INCLUDE>gst/interfaces/mixer.h</INCLUDE>
GstMixerTrack
GstMixerTrackClass
GstMixerTrackFlags
GST_MIXER_TRACK_HAS_FLAG
<SUBSECTION Standard>
GST_TYPE_MIXER_TRACK
GST_TYPE_MIXER_TRACK_FLAGS
GST_MIXER_TRACK
GST_MIXER_TRACK_CLASS
GST_IS_MIXER_TRACK
GST_IS_MIXER_TRACK_CLASS
gst_mixer_track_flags_get_type
gst_mixer_track_get_type
</SECTION>
gst_ring_buffer_set_callback
<SECTION>
<FILE>gstnavigation</FILE>
<INCLUDE>gst/interfaces/navigation.h</INCLUDE>
GstNavigation
GstNavigationInterface
gst_ring_buffer_acquire
gst_ring_buffer_release
gst_ring_buffer_is_acquired
gst_navigation_send_event
gst_navigation_send_key_event
gst_navigation_send_mouse_event
<SUBSECTION Standard>
GST_TYPE_NAVIGATION
GST_NAVIGATION
GST_NAVIGATION_GET_IFACE
GST_IS_NAVIGATION
gst_navigation_get_type
</SECTION>
gst_ring_buffer_start
gst_ring_buffer_pause
gst_ring_buffer_stop
<SECTION>
<FILE>gstpropertyprobe</FILE>
<INCLUDE>gst/interfaces/propertyprobe.h</INCLUDE>
GstPropertyProbe
GstPropertyProbeInterface
gst_ring_buffer_delay
gst_ring_buffer_samples_done
gst_ring_buffer_set_sample
gst_ring_buffer_commit
gst_property_probe_get_properties
gst_property_probe_get_property
gst_property_probe_get_values
gst_property_probe_get_values_name
gst_property_probe_needs_probe
gst_property_probe_needs_probe_name
gst_property_probe_probe_and_get_values
gst_property_probe_probe_and_get_values_name
gst_property_probe_probe_property
gst_property_probe_probe_property_name
<SUBSECTION Standard>
GST_TYPE_PROPERTY_PROBE
GST_PROPERTY_PROBE
GST_PROPERTY_PROBE_GET_IFACE
GST_IS_PROPERTY_PROBE
gst_property_probe_get_type
</SECTION>
gst_ring_buffer_prepare_read
gst_ring_buffer_clear
gst_ring_buffer_advance
<SECTION>
<FILE>gsttuner</FILE>
<INCLUDE>gst/interfaces/tuner.h</INCLUDE>
GstTuner
GstTunerClass
gst_tuner_list_channels
gst_tuner_get_channel
gst_tuner_set_channel
gst_tuner_list_norms
gst_tuner_get_norm
gst_tuner_set_norm
gst_tuner_get_frequency
gst_tuner_set_frequency
gst_tuner_signal_strength
gst_tuner_find_norm_by_name
gst_tuner_find_channel_by_name
gst_tuner_channel_changed
gst_tuner_norm_changed
gst_tuner_frequency_changed
gst_tuner_signal_changed
<SUBSECTION Standard>
GST_TYPE_TUNER
GST_TUNER
GST_TUNER_CLASS
GST_TUNER_GET_CLASS
GST_IS_TUNER
GST_IS_TUNER_CLASS
gst_tuner_get_type
</SECTION>
<SECTION>