mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-18 15:51:11 +00:00
Code Issues 1 Projects Releases Wiki Activity
gstreamer/docs/plugins/gst-plugins-base-plugins-docs.sgml

72 lines
3.1 KiB
Text
Raw Normal View History

first stab at documenting elements Original commit message from CVS: first stab at documenting elements
2005-08-05 17:13:10 +00:00
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
renamed to actual element names, so much nicer to look at Original commit message from CVS: * common/gtk-doc-plugins.mak: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: renamed to actual element names, so much nicer to look at * docs/plugins/tmpl/gstmultifdsink.sgml: remove * docs/plugins/tmpl/multifdsink.sgml: * docs/plugins/tmpl/tcpserversink.sgml: add * ext/alsa/gstalsa.c: * ext/cdparanoia/gstcdparanoia.c: (cdparanoia_get_property): * ext/ogg/gstoggmux.c: * gst/audioconvert/gstaudioconvert.c: (gst_audio_convert_chain): * gst/playback/gstdecodebin.c: * gst/tcp/gstmultifdsink.c: (gst_multifdsink_class_init): * gst/tcp/gsttcpserversink.c: various fixes and documentation additions
2005-08-05 18:51:29 +00:00
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
]>
first stab at documenting elements Original commit message from CVS: first stab at documenting elements
2005-08-05 17:13:10 +00:00
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
renamed to actual element names, so much nicer to look at Original commit message from CVS: * common/gtk-doc-plugins.mak: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: renamed to actual element names, so much nicer to look at * docs/plugins/tmpl/gstmultifdsink.sgml: remove * docs/plugins/tmpl/multifdsink.sgml: * docs/plugins/tmpl/tcpserversink.sgml: add * ext/alsa/gstalsa.c: * ext/cdparanoia/gstcdparanoia.c: (cdparanoia_get_property): * ext/ogg/gstoggmux.c: * gst/audioconvert/gstaudioconvert.c: (gst_audio_convert_chain): * gst/playback/gstdecodebin.c: * gst/tcp/gstmultifdsink.c: (gst_multifdsink_class_init): * gst/tcp/gsttcpserversink.c: various fixes and documentation additions
2005-08-05 18:51:29 +00:00
<title>GStreamer Base Plugins &GST_MAJORMINOR; Plugins Reference Manual</title>
first stab at documenting elements Original commit message from CVS: first stab at documenting elements
2005-08-05 17:13:10 +00:00
</bookinfo>
add all plugin docs to the documentation Original commit message from CVS: add all plugin docs to the documentation
2005-08-15 14:52:08 +00:00
<chapter>
<title>gst-plugins-base Elements</title>
Added alsa docs. Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: * ext/alsa/gstalsamixer.c: * ext/alsa/gstalsamixer.h: * ext/alsa/gstalsamixerelement.c: (gst_alsa_mixer_element_class_init), (gst_alsa_mixer_element_init): * ext/alsa/gstalsamixerelement.h: * ext/alsa/gstalsasink.c: * ext/alsa/gstalsasink.h: * ext/alsa/gstalsasrc.c: (gst_alsasrc_class_init), (gst_alsasrc_init): * ext/alsa/gstalsasrc.h: Added alsa docs. Small code cleanups.
2006-03-01 18:25:18 +00:00
<xi:include href="xml/element-alsamixer.xml" />
<xi:include href="xml/element-alsasink.xml" />
<xi:include href="xml/element-alsasrc.xml" />
add/fix docs Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: * gst/volume/gstvolume.c: add/fix docs * gst-libs/gst/audio/audio.c: (gst_audio_frame_byte_size): * gst-libs/gst/audio/audio.h: add conversion macros for frames <-> clocktime
2005-09-23 18:14:54 +00:00
<xi:include href="xml/element-audioconvert.xml" />
add new plugin and element Original commit message from CVS: * configure.ac: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: * gst/audioscale/gstaudioscale.c: (gst_audioscale_method_get_type): * gst/audiotestsrc/Makefile.am: * gst/audiotestsrc/gstaudiotestsrc.c: (gst_audiostestsrc_wave_get_type), (gst_audiotestsrc_base_init), (gst_audiotestsrc_class_init), (gst_audiotestsrc_init), (gst_audiotestsrc_src_fixate), (gst_audiotestsrc_setcaps), (gst_audiotestsrc_get_query_types), (gst_audiotestsrc_src_query), (gst_audiotestsrc_wait), (gst_audiotestsrc_unlock), (gst_audiotestsrc_create_sine), (gst_audiotestsrc_create_square), (gst_audiotestsrc_create_saw), (gst_audiotestsrc_create_triangle), (gst_audiotestsrc_create_silence), (gst_audiotestsrc_create_white_noise), (gst_audiotestsrc_change_wave), (gst_audiotestsrc_create), (gst_audiotestsrc_set_property), (gst_audiotestsrc_get_property), (gst_audiotestsrc_start), (plugin_init): * gst/audiotestsrc/gstaudiotestsrc.h: add new plugin and element * gst/sine/gstsinesrc.c: (gst_sinesrc_class_init): use gobject_class
2005-10-09 18:34:44 +00:00
<xi:include href="xml/element-audiotestsrc.xml" />
Add gtk-doc blurbs to pango elements. Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: * docs/plugins/gst-plugins-base-plugins.hierarchy: * ext/pango/gstclockoverlay.c: * ext/pango/gsttextoverlay.c: * ext/pango/gsttextrender.c: * ext/pango/gsttimeoverlay.c: Add gtk-doc blurbs to pango elements.
2005-12-02 16:52:54 +00:00
<xi:include href="xml/element-clockoverlay.xml" />
add more elements to the docs Original commit message from CVS: add more elements to the docs
2005-09-11 21:45:24 +00:00
<xi:include href="xml/element-ffmpegcolorspace.xml" />
add theoraenc Original commit message from CVS: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: * ext/theora/theoraenc.c: add theoraenc
2005-09-14 21:36:02 +00:00
<xi:include href="xml/element-gnomevfssink.xml" />
docs/plugins/: Add docs stuff for gnomevfssrc and gnomevfssink. Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * 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.signals: Add docs stuff for gnomevfssrc and gnomevfssink. * ext/gnomevfs/gstgnomevfssrc.c: Fix example pipeline in gtk-doc blurb.
2005-12-27 21:58:28 +00:00
<xi:include href="xml/element-gnomevfssrc.xml" />
add all plugin docs to the documentation Original commit message from CVS: add all plugin docs to the documentation
2005-08-15 14:52:08 +00:00
<xi:include href="xml/element-multifdsink.xml" />
<xi:include href="xml/element-tcpserversink.xml" />
Updated/added documentation. Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: * ext/pango/gstclockoverlay.h: * ext/pango/gsttextoverlay.h: * ext/pango/gsttextrender.h: * ext/pango/gsttimeoverlay.h: * ext/theora/gsttheoradec.h: * ext/theora/gsttheoraenc.h: * ext/theora/theoradec.c: * ext/theora/theoraenc.c: * gst/audioconvert/gstaudioconvert.h: * gst/audiotestsrc/gstaudiotestsrc.h: * gst/ffmpegcolorspace/gstffmpegcolorspace.h: * gst/tcp/gstmultifdsink.c: (gst_multi_fd_sink_class_init): * gst/tcp/gstmultifdsink.h: Updated/added documentation. * ext/pango/gsttextoverlay.c: (gst_text_overlay_valign_get_type), (gst_text_overlay_halign_get_type), (gst_text_overlay_wrap_mode_get_type), (gst_text_overlay_base_init), (gst_text_overlay_class_init), (gst_text_overlay_init), (gst_text_overlay_set_property), (gst_text_overlay_get_property): Fix up properties to be enums instead of string to make bindings, introspection and automatic GUI creation possible. Add getters for the properties.
2006-03-01 16:24:37 +00:00
<xi:include href="xml/element-theoradec.xml" />
add theoraenc Original commit message from CVS: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: * ext/theora/theoraenc.c: add theoraenc
2005-09-14 21:36:02 +00:00
<xi:include href="xml/element-theoraenc.xml" />
Add gtk-doc blurbs to pango elements. Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: * docs/plugins/gst-plugins-base-plugins.hierarchy: * ext/pango/gstclockoverlay.c: * ext/pango/gsttextoverlay.c: * ext/pango/gsttextrender.c: * ext/pango/gsttimeoverlay.c: Add gtk-doc blurbs to pango elements.
2005-12-02 16:52:54 +00:00
<xi:include href="xml/element-textoverlay.xml" />
<xi:include href="xml/element-textrender.xml" />
<xi:include href="xml/element-timeoverlay.xml" />
docs/: Added some more docs to libs and plugins. 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: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: Added some more docs to libs and plugins. * gst-libs/gst/audio/gstringbuffer.c: (gst_ring_buffer_prepare_read), (gst_ring_buffer_clear): * gst-libs/gst/audio/gstringbuffer.h: Document ringbuffer some more. * gst/videorate/gstvideorate.c: (gst_video_rate_class_init), (gst_video_rate_setcaps), (gst_video_rate_reset), (gst_video_rate_init), (gst_video_rate_flush_prev), (gst_video_rate_swap_prev), (gst_video_rate_event), (gst_video_rate_chain), (gst_video_rate_change_state): * gst/videorate/gstvideorate.h: Fix videorate to use segments. Make it work with 0/1 framerates (closes #331903) Handle EOS correctly. Added docs.
2006-03-02 16:47:34 +00:00
<xi:include href="xml/element-videorate.xml" />
add more elements to the docs Original commit message from CVS: add more elements to the docs
2005-09-11 21:45:24 +00:00
<xi:include href="xml/element-videotestsrc.xml" />
<xi:include href="xml/element-volume.xml" />
Fix some more docs. Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: * ext/gnomevfs/gstgnomevfssink.h: * ext/gnomevfs/gstgnomevfssrc.h: * ext/vorbis/vorbisdec.c: (vorbis_handle_data_packet): * ext/vorbis/vorbisdec.h: * ext/vorbis/vorbisenc.c: (gst_vorbisenc_convert_sink): * ext/vorbis/vorbisenc.h: * ext/vorbis/vorbisparse.c: (vorbis_parse_set_header_on_caps), (vorbis_parse_chain), (vorbis_parse_change_state): * ext/vorbis/vorbisparse.h: * gst/audioconvert/gstaudioconvert.h: * gst/tcp/gsttcpserversink.h: * gst/videotestsrc/gstvideotestsrc.c: * gst/videotestsrc/gstvideotestsrc.h: * gst/volume/gstvolume.c: * gst/volume/gstvolume.h: Fix some more docs. Added docs for vorbisdec and vorbisparse. Fix vorbisparse.
2006-03-01 17:39:28 +00:00
<xi:include href="xml/element-vorbisdec.xml" />
add all plugin docs to the documentation Original commit message from CVS: add all plugin docs to the documentation
2005-08-15 14:52:08 +00:00
<xi:include href="xml/element-vorbisenc.xml" />
Fix some more docs. Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: * ext/gnomevfs/gstgnomevfssink.h: * ext/gnomevfs/gstgnomevfssrc.h: * ext/vorbis/vorbisdec.c: (vorbis_handle_data_packet): * ext/vorbis/vorbisdec.h: * ext/vorbis/vorbisenc.c: (gst_vorbisenc_convert_sink): * ext/vorbis/vorbisenc.h: * ext/vorbis/vorbisparse.c: (vorbis_parse_set_header_on_caps), (vorbis_parse_chain), (vorbis_parse_change_state): * ext/vorbis/vorbisparse.h: * gst/audioconvert/gstaudioconvert.h: * gst/tcp/gsttcpserversink.h: * gst/videotestsrc/gstvideotestsrc.c: * gst/videotestsrc/gstvideotestsrc.h: * gst/volume/gstvolume.c: * gst/volume/gstvolume.h: Fix some more docs. Added docs for vorbisdec and vorbisparse. Fix vorbisparse.
2006-03-01 17:39:28 +00:00
<xi:include href="xml/element-vorbisparse.xml" />
docs/plugins/: Updated version. Original commit message from CVS: 2005-11-26 Julien MOUTTE <julien@moutte.net> * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: * 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-decodebin.xml: * docs/plugins/inspect/plugin-ffmpegcolorspace.xml: * docs/plugins/inspect/plugin-gnomevfs.xml: * docs/plugins/inspect/plugin-ogg.xml: * docs/plugins/inspect/plugin-playbin.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-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: Updated version. * sys/ximage/ximagesink.c: Adding documentation for ximagesink.
2005-11-26 14:44:08 +00:00
<xi:include href="xml/element-ximagesink.xml" />
Added doc for xvimagesink. Original commit message from CVS: 2005-11-26 Julien MOUTTE <julien@moutte.net> * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: * sys/xvimage/xvimagesink.c: Added doc for xvimagesink.
2005-11-26 15:26:36 +00:00
<xi:include href="xml/element-xvimagesink.xml" />
add all plugin docs to the documentation Original commit message from CVS: add all plugin docs to the documentation
2005-08-15 14:52:08 +00:00
</chapter>
first stab at documenting elements Original commit message from CVS: first stab at documenting elements
2005-08-05 17:13:10 +00:00
<chapter>
<title>gst-plugins-base Plugins</title>
add all plugin docs to the documentation Original commit message from CVS: add all plugin docs to the documentation
2005-08-15 14:52:08 +00:00
<xi:include href="xml/plugin-adder.xml" />
<xi:include href="xml/plugin-alsa.xml" />
<xi:include href="xml/plugin-audioconvert.xml" />
<xi:include href="xml/plugin-audiorate.xml" />
docs/plugins/: Fix hierarchy, added some more elements to the docs. Original commit message from CVS: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * 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.signals: Fix hierarchy, added some more elements to the docs. * gst/ffmpegcolorspace/gstffmpegcolorspace.c: (gst_ffmpegcsp_get_type): * gst/ffmpegcolorspace/gstffmpegcolorspace.h: Fix docs for ffmpegcolorspace.
2006-03-02 11:28:23 +00:00
<xi:include href="xml/plugin-audioresample.xml" />
add new plugin and element Original commit message from CVS: * configure.ac: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: * gst/audioscale/gstaudioscale.c: (gst_audioscale_method_get_type): * gst/audiotestsrc/Makefile.am: * gst/audiotestsrc/gstaudiotestsrc.c: (gst_audiostestsrc_wave_get_type), (gst_audiotestsrc_base_init), (gst_audiotestsrc_class_init), (gst_audiotestsrc_init), (gst_audiotestsrc_src_fixate), (gst_audiotestsrc_setcaps), (gst_audiotestsrc_get_query_types), (gst_audiotestsrc_src_query), (gst_audiotestsrc_wait), (gst_audiotestsrc_unlock), (gst_audiotestsrc_create_sine), (gst_audiotestsrc_create_square), (gst_audiotestsrc_create_saw), (gst_audiotestsrc_create_triangle), (gst_audiotestsrc_create_silence), (gst_audiotestsrc_create_white_noise), (gst_audiotestsrc_change_wave), (gst_audiotestsrc_create), (gst_audiotestsrc_set_property), (gst_audiotestsrc_get_property), (gst_audiotestsrc_start), (plugin_init): * gst/audiotestsrc/gstaudiotestsrc.h: add new plugin and element * gst/sine/gstsinesrc.c: (gst_sinesrc_class_init): use gobject_class
2005-10-09 18:34:44 +00:00
<xi:include href="xml/plugin-audiotestsrc.xml" />
docs/plugins/: Fix hierarchy, added some more elements to the docs. Original commit message from CVS: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * 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.signals: Fix hierarchy, added some more elements to the docs. * gst/ffmpegcolorspace/gstffmpegcolorspace.c: (gst_ffmpegcsp_get_type): * gst/ffmpegcolorspace/gstffmpegcolorspace.h: Fix docs for ffmpegcolorspace.
2006-03-02 11:28:23 +00:00
<xi:include href="xml/plugin-cdparanoia.xml" />
add all plugin docs to the documentation Original commit message from CVS: add all plugin docs to the documentation
2005-08-15 14:52:08 +00:00
<xi:include href="xml/plugin-decodebin.xml" />
docs/plugins/: Fix hierarchy, added some more elements to the docs. Original commit message from CVS: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * 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.signals: Fix hierarchy, added some more elements to the docs. * gst/ffmpegcolorspace/gstffmpegcolorspace.c: (gst_ffmpegcsp_get_type): * gst/ffmpegcolorspace/gstffmpegcolorspace.h: Fix docs for ffmpegcolorspace.
2006-03-02 11:28:23 +00:00
<xi:include href="xml/plugin-ffmpegcolorspace.xml" />
add all plugin docs to the documentation Original commit message from CVS: add all plugin docs to the documentation
2005-08-15 14:52:08 +00:00
<xi:include href="xml/plugin-gnomevfs.xml" />
add libvisual plugin and theoraenc element to docs Original commit message from CVS: add libvisual plugin and theoraenc element to docs
2005-09-14 21:53:06 +00:00
<xi:include href="xml/plugin-libvisual.xml" />
add all plugin docs to the documentation Original commit message from CVS: add all plugin docs to the documentation
2005-08-15 14:52:08 +00:00
<xi:include href="xml/plugin-ogg.xml" />
add pango plugin to docs Original commit message from CVS: add pango plugin to docs
2005-12-01 15:52:27 +00:00
<xi:include href="xml/plugin-pango.xml" />
add all plugin docs to the documentation Original commit message from CVS: add all plugin docs to the documentation
2005-08-15 14:52:08 +00:00
<xi:include href="xml/plugin-playbin.xml" />
<xi:include href="xml/plugin-subparse.xml" />
<xi:include href="xml/plugin-tcp.xml" />
<xi:include href="xml/plugin-theora.xml" />
<xi:include href="xml/plugin-typefindfunctions.xml" />
<xi:include href="xml/plugin-video4linux.xml" />
<xi:include href="xml/plugin-videorate.xml" />
<xi:include href="xml/plugin-videoscale.xml" />
<xi:include href="xml/plugin-videotestsrc.xml" />
<xi:include href="xml/plugin-volume.xml" />
<xi:include href="xml/plugin-vorbis.xml" />
ximage was renamed to ximagesink Original commit message from CVS: ximage was renamed to ximagesink
2005-11-23 18:53:17 +00:00
<xi:include href="xml/plugin-ximagesink.xml" />
add all plugin docs to the documentation Original commit message from CVS: add all plugin docs to the documentation
2005-08-15 14:52:08 +00:00
<xi:include href="xml/plugin-xvimagesink.xml" />
first stab at documenting elements Original commit message from CVS: first stab at documenting elements
2005-08-05 17:13:10 +00:00
</chapter>
</book>
add all plugin docs to the documentation Original commit message from CVS: add all plugin docs to the documentation
2005-08-15 14:52:08 +00:00
Reference in a new issue Copy permalink