gstreamer/docs/plugins/gst-plugins-base-plugins-sections.txt
Jan Schmidt d58def621b Add some documentation comments, and some new headers to be scanned.
Original commit message from CVS:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-base-plugins-overrides.txt:
* docs/plugins/gst-plugins-base-plugins-sections.txt:
* docs/plugins/gst-plugins-base-plugins.args:
* docs/plugins/gst-plugins-base-plugins.hierarchy:
* docs/plugins/gst-plugins-base-plugins.interfaces:
* docs/plugins/gst-plugins-base-plugins.prerequisites:
* docs/plugins/inspect/plugin-adder.xml:
* docs/plugins/inspect/plugin-alsa.xml:
* docs/plugins/inspect/plugin-audioconvert.xml:
* docs/plugins/inspect/plugin-audiorate.xml:
* docs/plugins/inspect/plugin-audioresample.xml:
* docs/plugins/inspect/plugin-audiotestsrc.xml:
* docs/plugins/inspect/plugin-cdparanoia.xml:
* docs/plugins/inspect/plugin-decodebin.xml:
* docs/plugins/inspect/plugin-ffmpegcolorspace.xml:
* docs/plugins/inspect/plugin-gdp.xml:
* docs/plugins/inspect/plugin-gio.xml:
* docs/plugins/inspect/plugin-gnomevfs.xml:
* docs/plugins/inspect/plugin-libvisual.xml:
* docs/plugins/inspect/plugin-ogg.xml:
* docs/plugins/inspect/plugin-pango.xml:
* docs/plugins/inspect/plugin-playback.xml:
* docs/plugins/inspect/plugin-queue2.xml:
* docs/plugins/inspect/plugin-subparse.xml:
* docs/plugins/inspect/plugin-tcp.xml:
* docs/plugins/inspect/plugin-theora.xml:
* docs/plugins/inspect/plugin-typefindfunctions.xml:
* docs/plugins/inspect/plugin-uridecodebin.xml:
* docs/plugins/inspect/plugin-video4linux.xml:
* docs/plugins/inspect/plugin-videorate.xml:
* docs/plugins/inspect/plugin-videoscale.xml:
* docs/plugins/inspect/plugin-videotestsrc.xml:
* docs/plugins/inspect/plugin-volume.xml:
* docs/plugins/inspect/plugin-vorbis.xml:
* docs/plugins/inspect/plugin-ximagesink.xml:
* docs/plugins/inspect/plugin-xvimagesink.xml:
* ext/cdparanoia/gstcdparanoiasrc.c:
* ext/ogg/gstoggdemux.c:
* ext/ogg/gstoggdemux.h:
* ext/ogg/gstoggmux.c:
* ext/ogg/gstoggmux.h:
* gst/audioconvert/audioconvert.c:
* gst/audioconvert/audioconvert.h:
* gst/audioconvert/gstaudioconvert.h:
* gst/gdp/gstgdpdepay.h:
* gst/gdp/gstgdppay.h:
* gst/playback/gstdecodebin.c:
* gst/playback/gstdecodebin2.c:
* gst/playback/gstplaybin.c:
* gst/playback/gstplaybin2.c:
* gst/playback/gsturidecodebin.c:
* gst/tcp/gstmultifdsink.c:
* gst/tcp/gstmultifdsink.h:
* gst/tcp/gsttcp.h:
Add some documentation comments, and some new headers to be scanned.
Rename some internal enum declarations (audioconvert's DitherType and
NoiseShapingType, GstUnitType from the TCP elements) to match the
documented GObject type names so that the docs pick them up.
Name the playbin2 docs markups properly so they get picked up. They'll
need renaming back when/if playbin2 becomes playbin.
100% symbol coverage for the plugin docs, booya.
2008-05-22 22:09:16 +00:00

649 lines
12 KiB
Text

<SECTION>
<FILE>element-adder</FILE>
<TITLE>adder</TITLE>
GstAdder
<SUBSECTION Standard>
GST_ADDER
GST_IS_ADDER
GST_TYPE_ADDER
GST_ADDER_CLASS
GST_IS_ADDER_CLASS
GST_ADDER_GET_CLASS
gst_adder_get_type
GstAdderClass
GstAdderFormat
GstAdderFunction
GstAdderInputChannel
</SECTION>
<SECTION>
<FILE>element-alsamixer</FILE>
GstAlsaMixerElement
<TITLE>alsamixer</TITLE>
<SUBSECTION Standard>
GstAlsaMixerElementClass
GST_ALSA_MIXER_ELEMENT
GST_IS_ALSA_MIXER_ELEMENT
GST_TYPE_ALSA_MIXER_ELEMENT
gst_alsa_mixer_element_get_type
GST_ALSA_MIXER_ELEMENT_CLASS
GST_IS_ALSA_MIXER_ELEMENT_CLASS
</SECTION>
<SECTION>
<FILE>element-alsasink</FILE>
GstAlsaSink
<TITLE>alsasink</TITLE>
<SUBSECTION Standard>
GstAlsaSinkClass
GST_ALSA_SINK
GST_ALSA_SINK_CAST
GST_IS_ALSA_SINK
GST_TYPE_ALSA_SINK
GST_ALSA_SINK_CLASS
GST_IS_ALSA_SINK_CLASS
GST_ALSA_SINK_GET_LOCK
GST_ALSA_SINK_LOCK
GST_ALSA_SINK_UNLOCK
gst_alsasink_get_type
</SECTION>
<SECTION>
<FILE>element-alsasrc</FILE>
GstAlsaSrc
<TITLE>alsasrc</TITLE>
<SUBSECTION Standard>
GstAlsaSrcClass
GST_ALSA_SRC
GST_IS_ALSA_SRC
GST_TYPE_ALSA_SRC
GST_ALSA_SRC_CLASS
GST_IS_ALSA_SRC_CLASS
GST_ALSA_SRC_CAST
GST_ALSA_SRC_GET_LOCK
GST_ALSA_SRC_LOCK
GST_ALSA_SRC_UNLOCK
gst_alsasrc_get_type
</SECTION>
<SECTION>
<FILE>element-audioconvert</FILE>
<TITLE>audioconvert</TITLE>
GstAudioConvert
GstAudioConvertDithering
GstAudioConvertNoiseShaping
<SUBSECTION Standard>
GST_AUDIO_CONVERT
GST_AUDIO_CONVERT_CLASS
GST_IS_AUDIO_CONVERT
GST_IS_AUDIO_CONVERT_CLASS
GST_TYPE_AUDIO_CONVERT
GstAudioConvertClass
AudioConvertCtx
AudioConvertFmt
AudioConvertMix
AudioConvertPack
AudioConvertQuantize
AudioConvertUnpack
audio_convert_clean_context
audio_convert_clean_fmt
audio_convert_convert
audio_convert_get_sizes
audio_convert_prepare_context
</SECTION>
<SECTION>
<FILE>element-audioresample</FILE>
<TITLE>audioresample</TITLE>
GstAudioresample
<SUBSECTION Standard>
GST_AUDIORESAMPLE
GST_IS_AUDIORESAMPLE
GST_TYPE_AUDIORESAMPLE
gst_audioresample_get_type
GST_AUDIORESAMPLE_CLASS
GST_IS_AUDIORESAMPLE_CLASS
GstAudioresampleClass
</SECTION>
<SECTION>
<FILE>element-audiotestsrc</FILE>
<TITLE>audiotestsrc</TITLE>
GstAudioTestSrc
GstAudioTestSrcWave
<SUBSECTION Standard>
GST_AUDIO_TEST_SRC
GST_AUDIO_TEST_SRC_CLASS
GST_IS_AUDIO_TEST_SRC
GST_IS_AUDIO_TEST_SRC_CLASS
GST_TYPE_AUDIO_TEST_SRC
GstAudioTestSrcClass
GstAudioTestSrcFormat
gst_audio_test_src_get_type
GstPinkNoise
PINK_MAX_RANDOM_ROWS
PINK_RANDOM_BITS
PINK_RANDOM_SHIFT
ProcessFunc
</SECTION>
<SECTION>
<FILE>element-cdparanoiasrc</FILE>
<TITLE>cdparanoiasrc</TITLE>
GstCdParanoiaSrc
<SUBSECTION Standard>
GstCdParanoiaSrcClass
GST_CD_PARANOIA_SRC
GST_CD_PARANOIA_SRC_CLASS
GST_CD_PARANOIA_SRC_GET_CLASS
GST_IS_CD_PARANOIA_SRC
GST_IS_CD_PARANOIA_SRC_CLASS
GST_TYPE_CD_PARANOIA_SRC
gst_cd_paranoia_src_get_type
size16
size32
</SECTION>
<SECTION>
<FILE>element-clockoverlay</FILE>
<TITLE>clockoverlay</TITLE>
GstClockOverlay
<SUBSECTION Standard>
GST_CLOCK_OVERLAY
GST_CLOCK_OVERLAY_CLASS
GST_IS_CLOCK_OVERLAY
GST_IS_CLOCK_OVERLAY_CLASS
GST_TYPE_CLOCK_OVERLAY
GstClockOverlayClass
gst_clock_overlay_get_type
</SECTION>
<SECTION>
<FILE>element-decodebin</FILE>
<TITLE>decodebin</TITLE>
GstDecodeBin
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>element-decodebin2</FILE>
<TITLE>decodebin2</TITLE>
GstDecodeBin2
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>element-ffmpegcolorspace</FILE>
<TITLE>ffmpegcolorspace</TITLE>
GstFFMpegCsp
<SUBSECTION Standard>
GST_FFMPEGCSP
GST_FFMPEGCSP_CLASS
GST_IS_FFMPEGCSP
GST_IS_FFMPEGCSP_CLASS
GST_TYPE_FFMPEGCSP
GstFFMpegCspClass
</SECTION>
<SECTION>
<FILE>element-gdpdepay</FILE>
GstGDPDepay
<TITLE>gdpdepay</TITLE>
<SUBSECTION Standard>
GstGDPDepayClass
GstGDPDepayState
GST_GDP_DEPAY
GST_GDP_DEPAY_CLASS
GST_IS_GDP_DEPAY
GST_IS_GDP_DEPAY_CLASS
GST_TYPE_GDP_DEPAY
gst_gdp_depay_plugin_init
</SECTION>
<SECTION>
<FILE>element-gdppay</FILE>
GstGDPPay
<TITLE>gdppay</TITLE>
<SUBSECTION Standard>
GstGDPPayClass
GST_GDP_PAY
GST_GDP_PAY_CLASS
GST_IS_GDP_PAY
GST_IS_GDP_PAY_CLASS
GST_TYPE_GDP_PAY
gst_gdp_pay_plugin_init
</SECTION>
<SECTION>
<FILE>element-giosink</FILE>
GstGioSink
<TITLE>giosink</TITLE>
<SUBSECTION Standard>
GstGioSinkClass
GST_GIO_SINK
GST_GIO_SINK_CLASS
GST_IS_GIO_SINK
GST_IS_GIO_SINK_CLASS
GST_TYPE_GIO_SINK
gst_gio_sink_get_type
</SECTION>
<SECTION>
<FILE>element-giosrc</FILE>
GstGioSrc
<TITLE>giosrc</TITLE>
<SUBSECTION Standard>
GstGioSrcClass
GST_GIO_SRC
GST_GIO_SRC_CLASS
GST_IS_GIO_SRC
GST_IS_GIO_SRC_CLASS
GST_TYPE_GIO_SRC
gst_gio_src_get_type
</SECTION>
<SECTION>
<FILE>element-giostreamsink</FILE>
GstGioStreamSink
<TITLE>giostreamsink</TITLE>
<SUBSECTION Standard>
GstGioStreamSinkClass
GST_GIO_STREAM_SINK
GST_GIO_STREAM_SINK_CLASS
GST_IS_GIO_STREAM_SINK
GST_IS_GIO_STREAM_SINK_CLASS
GST_TYPE_GIO_STREAM_SINK
gst_gio_stream_sink_get_type
</SECTION>
<SECTION>
<FILE>element-giostreamsrc</FILE>
GstGioStreamSrc
<TITLE>giostreamsrc</TITLE>
<SUBSECTION Standard>
GstGioStreamSrcClass
GST_GIO_STREAM_SRC
GST_GIO_STREAM_SRC_CLASS
GST_IS_GIO_STREAM_SRC
GST_IS_GIO_STREAM_SRC_CLASS
GST_TYPE_GIO_STREAM_SRC
gst_gio_stream_src_get_type
</SECTION>
<SECTION>
<FILE>element-multifdsink</FILE>
<TITLE>multifdsink</TITLE>
GstMultiFdSink
GstRecoverPolicy
GstSyncMethod
GstClientStatus
GstTCPProtocol
GstTCPUnitType
<SUBSECTION Standard>
CLIENTS_LOCK
CLIENTS_LOCK_FREE
CLIENTS_LOCK_INIT
CLIENTS_UNLOCK
GST_TYPE_MULTI_FD_SINK
GST_IS_MULTI_FD_SINK
GST_IS_MULTI_FD_SINK_CLASS
GST_MULTI_FD_SINK
GST_MULTI_FD_SINK_CLASS
GST_MULTI_FD_SINK_GET_CLASS
GstTCPClient
GstMultiFdSinkFlags
GstMultiFdSinkClass
gst_multi_fd_sink_add
gst_multi_fd_sink_add_full
gst_multi_fd_sink_clear
gst_multi_fd_sink_get_stats
gst_multi_fd_sink_get_type
gst_multi_fd_sink_remove
gst_multi_fd_sink_remove_flush
GST_TYPE_TCP_PROTOCOL
gst_tcp_protocol_get_type
</SECTION>
<SECTION>
<FILE>element-gnomevfssink</FILE>
<TITLE>gnomevfssink</TITLE>
GstGnomeVFSSink
<SUBSECTION Standard>
GstGnomeVFSSinkClass
GST_GNOME_VFS_SINK_CLASS
GST_TYPE_GNOME_VFS_SINK
GST_IS_GNOME_VFS_SINK
gst_gnome_vfs_sink_get_type
GST_IS_GNOME_VFS_SINK_CLASS
GST_GNOME_VFS_SINK
</SECTION>
<SECTION>
<FILE>element-gnomevfssrc</FILE>
<TITLE>gnomevfssrc</TITLE>
GstGnomeVFSSrc
<SUBSECTION Standard>
GST_GNOME_VFS_SRC
GST_GNOME_VFS_SRC_CLASS
GST_IS_GNOME_VFS_SRC
GST_IS_GNOME_VFS_SRC_CLASS
GST_TYPE_GNOME_VFS_SRC
GstGnomeVFSSrcClass
gst_gnome_vfs_src_get_type
</SECTION>
<SECTION>
<FILE>element-oggdemux</FILE>
<TITLE>oggdemux</TITLE>
GstOggDemux
<SUBSECTION Standard>
GST_OGG_DEMUX
GST_OGG_DEMUX_CLASS
GST_IS_OGG_DEMUX
GST_IS_OGG_DEMUX_CLASS
GST_TYPE_OGG_DEMUX
GstOggDemuxClass
GST_IS_OGG_PAD
GST_IS_OGG_PAD_CLASS
GST_OGG_PAD
GST_OGG_PAD_CLASS
GST_TYPE_OGG_PAD
GstOggChain
GstOggPad
GstOggPadClass
GstOggPadMode
GstOggPadState
</SECTION>
<SECTION>
<FILE>element-oggmux</FILE>
<TITLE>oggmux</TITLE>
GstOggMux
<SUBSECTION Standard>
gst_ogg_mux_get_type
GST_OGG_MUX
GST_OGG_MUX_CLASS
GST_IS_OGG_MUX
GST_IS_OGG_MUX_CLASS
GST_TYPE_OGG_MUX
GstOggMuxClass
</SECTION>
<SECTION>
<FILE>element-playbin</FILE>
<TITLE>playbin</TITLE>
GstPlayBin
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>element-playbin2</FILE>
<TITLE>playbin2</TITLE>
GstPlayBin2
GstPlayFlags
<SUBSECTION Standard>
gst_play_flags_get_type
GST_TYPE_PLAY_FLAGS
</SECTION>
<SECTION>
<FILE>element-tcpserversink</FILE>
<TITLE>tcpserversink</TITLE>
GstTCPServerSink
<SUBSECTION Standard>
GstTCPServerSinkClass
GST_TCP_SERVER_SINK
GstTCPServerSinkFlags
GST_TYPE_TCP_SERVER_SINK
gst_tcp_server_sink_get_type
GST_IS_TCP_SERVER_SINK_CLASS
GST_IS_TCP_SERVER_SINK
TCP_DEFAULT_HOST
TCP_DEFAULT_PORT
TCP_HIGHEST_PORT
gst_tcp_gdp_read_buffer
gst_tcp_gdp_read_caps
gst_tcp_gdp_read_event
gst_tcp_gdp_write_buffer
gst_tcp_gdp_write_caps
gst_tcp_gdp_write_event
gst_tcp_host_to_ip
gst_tcp_read_buffer
gst_tcp_socket_close
gst_tcp_socket_write
</SECTION>
<SECTION>
<FILE>element-textoverlay</FILE>
<TITLE>textoverlay</TITLE>
GstTextOverlay
GstTextOverlayVAlign
GstTextOverlayHAlign
GstTextOverlayWrapMode
<SUBSECTION Standard>
GST_TEXT_OVERLAY
GST_TEXT_OVERLAY_CLASS
GST_TEXT_OVERLAY_GET_CLASS
GST_IS_TEXT_OVERLAY
GST_IS_TEXT_OVERLAY_CLASS
GST_TYPE_TEXT_OVERLAY
GstTextOverlayClass
gst_text_overlay_get_type
GstTextOverlayLineAlign
</SECTION>
<SECTION>
<FILE>element-textrender</FILE>
<TITLE>textrender</TITLE>
GstTextRender
<SUBSECTION Standard>
GST_TEXT_RENDER
GST_TEXT_RENDER_CLASS
GST_TEXT_RENDER_GET_CLASS
GST_IS_TEXT_RENDER
GST_IS_TEXT_RENDER_CLASS
GST_TYPE_TEXT_RENDER
GstTextRenderClass
gst_text_render_get_type
</SECTION>
<SECTION>
<FILE>element-theoradec</FILE>
<TITLE>theoradec</TITLE>
GstTheoraDec
<SUBSECTION Standard>
GST_THEORA_DEC
GST_IS_THEORA_DEC
GST_TYPE_THEORA_DEC
GST_THEORA_DEC_CLASS
GST_IS_THEORA_DEC_CLASS
GstTheoraDecClass
</SECTION>
<SECTION>
<FILE>element-theoraenc</FILE>
<TITLE>theoraenc</TITLE>
GstTheoraEnc
GstTheoraEncBorderMode
<SUBSECTION Standard>
GST_THEORA_ENC
GST_THEORA_ENC_CLASS
GST_IS_THEORA_ENC
GST_IS_THEORA_ENC_CLASS
GST_TYPE_THEORA_ENC
GstTheoraEncClass
</SECTION>
<SECTION>
<FILE>element-timeoverlay</FILE>
<TITLE>timeoverlay</TITLE>
GstTimeOverlay
<SUBSECTION Standard>
GST_TIME_OVERLAY
GST_TIME_OVERLAY_CLASS
GST_IS_TIME_OVERLAY
GST_IS_TIME_OVERLAY_CLASS
GST_TYPE_TIME_OVERLAY
GstTimeOverlayClass
gst_time_overlay_get_type
</SECTION>
<SECTION>
<FILE>element-uridecodebin</FILE>
<TITLE>uridecodebin</TITLE>
GstURIDecodeBin
GstAutoplugSelectResult
<SUBSECTION Standard>
GST_TYPE_AUTOPLUG_SELECT_RESULT
gst_autoplug_select_result_get_type
</SECTION>
<SECTION>
<FILE>element-videorate</FILE>
<TITLE>videorate</TITLE>
GstVideoRate
<SUBSECTION Standard>
GstVideoRateClass
GST_VIDEO_RATE
GST_IS_VIDEO_RATE
GST_TYPE_VIDEO_RATE
GST_VIDEO_RATE_CLASS
GST_IS_VIDEO_RATE_CLASS
</SECTION>
<SECTION>
<FILE>element-videoscale</FILE>
<TITLE>videoscale</TITLE>
GstVideoScale
GstVideoScaleMethod
<SUBSECTION Standard>
GstVideoScaleClass
GST_CAT_DEFAULT
GST_VIDEO_SCALE
GST_IS_VIDEO_SCALE
GST_TYPE_VIDEO_SCALE
gst_video_scale_get_type
GST_VIDEO_SCALE_CLASS
GST_IS_VIDEO_SCALE_CLASS
</SECTION>
<SECTION>
<FILE>element-videotestsrc</FILE>
<TITLE>videotestsrc</TITLE>
GstVideoTestSrc
GstVideoTestSrcPattern
<SUBSECTION Standard>
GST_VIDEO_TEST_SRC
GST_VIDEO_TEST_SRC_CLASS
GST_IS_VIDEO_TEST_SRC
GST_IS_VIDEO_TEST_SRC_CLASS
GST_TYPE_VIDEO_TEST_SRC
GstVideoTestSrcClass
gst_video_test_src_get_type
</SECTION>
<SECTION>
<FILE>element-volume</FILE>
<TITLE>volume</TITLE>
GstVolume
<SUBSECTION Standard>
GST_VOLUME
GST_VOLUME_CLASS
GST_IS_VOLUME
GST_IS_VOLUME_CLASS
GST_TYPE_VOLUME
GstVolumeClass
gst_volume_get_type
</SECTION>
<SECTION>
<FILE>element-vorbisdec</FILE>
GstVorbisDec
<TITLE>vorbisdec</TITLE>
<SUBSECTION Standard>
GstVorbisDecClass
GST_VORBIS_DEC
GST_IS_VORBIS_DEC
GST_TYPE_VORBIS_DEC
gst_vorbis_dec_get_type
GST_VORBIS_DEC_CLASS
GST_IS_VORBIS_DEC_CLASS
</SECTION>
<SECTION>
<FILE>element-vorbisenc</FILE>
<TITLE>vorbisenc</TITLE>
GstVorbisEnc
<SUBSECTION Standard>
GstVorbisEncClass
GST_IS_VORBISENC
GST_VORBISENC_CLASS
GST_VORBISENC
GST_TCP_SERVER_SINK_CLASS
GST_TYPE_VORBISENC
GST_IS_VORBISENC_CLASS
gst_vorbis_enc_get_type
</SECTION>
<SECTION>
<FILE>element-vorbisparse</FILE>
<TITLE>vorbisparse</TITLE>
GstVorbisParse
<SUBSECTION Standard>
GstVorbisParseClass
GST_VORBIS_PARSE
GST_IS_VORBIS_PARSE
GST_TYPE_VORBIS_PARSE
gst_vorbis_parse_get_type
GST_VORBIS_PARSE_CLASS
GST_IS_VORBIS_PARSE_CLASS
</SECTION>
<SECTION>
<FILE>element-vorbistag</FILE>
<TITLE>vorbistag</TITLE>
GstVorbisTag
<SUBSECTION Standard>
GstVorbisTagClass
GST_VORBIS_TAG
GST_IS_VORBIS_TAG
GST_TYPE_VORBIS_TAG
gst_vorbis_tag_get_type
GST_VORBIS_TAG_CLASS
GST_IS_VORBIS_TAG_CLASS
</SECTION>
<SECTION>
<FILE>element-ximagesink</FILE>
<TITLE>ximagesink</TITLE>
GstXImageSink
<SUBSECTION Standard>
GST_XIMAGESINK
GST_XIMAGESINK_CLASS
GST_IS_XIMAGESINK
GST_IS_XIMAGESINK_CLASS
GST_TYPE_XIMAGESINK
gst_ximagesink_get_type
GstXImageBuffer
GstXImageBufferClass
GstXImageSinkClass
GstXContext
GstXWindow
</SECTION>
<SECTION>
<FILE>element-xvimagesink</FILE>
<TITLE>xvimagesink</TITLE>
GstXvImageSink
<SUBSECTION Standard>
GST_XVIMAGESINK
GST_XVIMAGESINK_CLASS
GST_IS_XVIMAGESINK
GST_IS_XVIMAGESINK_CLASS
GST_TYPE_XVIMAGESINK
gst_xvimagesink_get_type
GstXvImageBuffer
GstXvImageBufferClass
GstXvImageFormat
GstXvImageSinkClass
</SECTION>