From 1e4ad29e52c94d4472e7e72509ac7eda80454ac0 Mon Sep 17 00:00:00 2001 From: David Schleef Date: Thu, 25 Mar 2004 04:20:33 +0000 Subject: [PATCH] docs/gst/gstreamer-docs.sgml: I got tired of the reference manual being such complete crap, that I decided to do majo... Original commit message from CVS: * docs/gst/gstreamer-docs.sgml: I got tired of the reference manual being such complete crap, that I decided to do major hacking of it. This checkin replaces any fine tuning that may have been done previously, with the benefit of actually being complete for much of the API that was changed since 0.6. Further fine tuning will occur shortly. (bug #134721) * docs/gst/gstreamer-sections.txt: * docs/gst/tmpl/GstBin.sgml: * docs/gst/tmpl/GstBuffer.sgml: * docs/gst/tmpl/GstCaps.sgml: * docs/gst/tmpl/GstClock.sgml: * docs/gst/tmpl/GstCompat.sgml: * docs/gst/tmpl/GstData.sgml: * docs/gst/tmpl/GstElement.sgml: * docs/gst/tmpl/GstEvent.sgml: * docs/gst/tmpl/GstIndex.sgml: * docs/gst/tmpl/GstStructure.sgml: * docs/gst/tmpl/GstTag.sgml: * docs/gst/tmpl/cothreads.sgml: * docs/gst/tmpl/cothreads_compat.sgml: * docs/gst/tmpl/gettext.sgml: * docs/gst/tmpl/grammar.tab.sgml: * docs/gst/tmpl/gst-i18n-app.sgml: * docs/gst/tmpl/gst-i18n-lib.sgml: * docs/gst/tmpl/gst.sgml: * docs/gst/tmpl/gst_private.sgml: * docs/gst/tmpl/gstaggregator.sgml: * docs/gst/tmpl/gstarch.sgml: * docs/gst/tmpl/gstatomic.sgml: * docs/gst/tmpl/gstatomic_impl.sgml: * docs/gst/tmpl/gstbin.sgml: * docs/gst/tmpl/gstbuffer.sgml: * docs/gst/tmpl/gstbufferstore.sgml: * docs/gst/tmpl/gstcaps.sgml: * docs/gst/tmpl/gstclock.sgml: * docs/gst/tmpl/gstcompat.sgml: * docs/gst/tmpl/gstconfig.sgml: * docs/gst/tmpl/gstcpu.sgml: * docs/gst/tmpl/gstdata.sgml: * docs/gst/tmpl/gstdata_private.sgml: * docs/gst/tmpl/gstelement.sgml: * docs/gst/tmpl/gstenumtypes.sgml: * docs/gst/tmpl/gsterror.sgml: * docs/gst/tmpl/gstevent.sgml: * docs/gst/tmpl/gstfakesink.sgml: * docs/gst/tmpl/gstfakesrc.sgml: * docs/gst/tmpl/gstfilesink.sgml: * docs/gst/tmpl/gstfilter.sgml: * docs/gst/tmpl/gstindex.sgml: * docs/gst/tmpl/gstinfo.sgml: * docs/gst/tmpl/gstinterface.sgml: * docs/gst/tmpl/gstlog.sgml: * docs/gst/tmpl/gstmacros.sgml: * docs/gst/tmpl/gstmarshal.sgml: * docs/gst/tmpl/gstmd5sink.sgml: * docs/gst/tmpl/gstmultifilesrc.sgml: * docs/gst/tmpl/gstobject.sgml: * docs/gst/tmpl/gstpad.sgml: * docs/gst/tmpl/gstparse.sgml: * docs/gst/tmpl/gstpipeline.sgml: * docs/gst/tmpl/gstplugin.sgml: * docs/gst/tmpl/gstpluginfeature.sgml: * docs/gst/tmpl/gstqueue.sgml: * docs/gst/tmpl/gstreamer-unused.sgml: * docs/gst/tmpl/gstregistry.sgml: * docs/gst/tmpl/gstregistrypool.sgml: * docs/gst/tmpl/gstscheduler.sgml: * docs/gst/tmpl/gstsearchfuncs.sgml: * docs/gst/tmpl/gstshaper.sgml: * docs/gst/tmpl/gstspider.sgml: * docs/gst/tmpl/gstspideridentity.sgml: * docs/gst/tmpl/gststructure.sgml: * docs/gst/tmpl/gstsystemclock.sgml: * docs/gst/tmpl/gsttag.sgml: * docs/gst/tmpl/gsttaginterface.sgml: * docs/gst/tmpl/gsttee.sgml: * docs/gst/tmpl/gstthread.sgml: * docs/gst/tmpl/gsttrace.sgml: * docs/gst/tmpl/gsttrashstack.sgml: * docs/gst/tmpl/gsttypefind.sgml: * docs/gst/tmpl/gsttypes.sgml: * docs/gst/tmpl/gsturi.sgml: * docs/gst/tmpl/gsturitype.sgml: * docs/gst/tmpl/gstutils.sgml: * docs/gst/tmpl/gstvalue.sgml: * docs/gst/tmpl/gstversion.sgml: * docs/gst/tmpl/gstxml.sgml: * docs/gst/tmpl/gstxmlregistry.sgml: * docs/gst/tmpl/gthread-cothreads.sgml: * docs/gst/tmpl/types.sgml: --- ChangeLog | 93 + docs/gst/gstreamer-docs.sgml | 6 +- docs/gst/gstreamer-sections.txt | 3124 ++++++++++++++++---------- docs/gst/tmpl/GstBin.sgml | 246 ++ docs/gst/tmpl/GstBuffer.sgml | 419 ++++ docs/gst/tmpl/GstCaps.sgml | 413 ++++ docs/gst/tmpl/GstClock.sgml | 425 ++++ docs/gst/tmpl/GstCompat.sgml | 152 ++ docs/gst/tmpl/GstData.sgml | 220 ++ docs/gst/tmpl/GstElement.sgml | 1315 +++++++++++ docs/gst/tmpl/GstEvent.sgml | 433 ++++ docs/gst/tmpl/GstIndex.sgml | 523 +++++ docs/gst/tmpl/GstStructure.sgml | 366 +++ docs/gst/tmpl/GstTag.sgml | 881 ++++++++ docs/gst/tmpl/cothreads.sgml | 68 +- docs/gst/tmpl/cothreads_compat.sgml | 140 ++ docs/gst/tmpl/gettext.sgml | 124 + docs/gst/tmpl/grammar.tab.sgml | 79 + docs/gst/tmpl/gst-i18n-app.sgml | 32 + docs/gst/tmpl/gst-i18n-lib.sgml | 32 + docs/gst/tmpl/gst.sgml | 79 +- docs/gst/tmpl/gst_private.sgml | 178 ++ docs/gst/tmpl/gstaggregator.sgml | 6 - docs/gst/tmpl/gstarch.sgml | 23 +- docs/gst/tmpl/gstatomic.sgml | 6 + docs/gst/tmpl/gstatomic_impl.sgml | 46 + docs/gst/tmpl/gstbin.sgml | 125 +- docs/gst/tmpl/gstbuffer.sgml | 204 +- docs/gst/tmpl/gstbufferstore.sgml | 63 + docs/gst/tmpl/gstcaps.sgml | 406 +++- docs/gst/tmpl/gstclock.sgml | 37 +- docs/gst/tmpl/gstcompat.sgml | 134 ++ docs/gst/tmpl/gstconfig.sgml | 69 +- docs/gst/tmpl/gstcpu.sgml | 3 +- docs/gst/tmpl/gstdata.sgml | 36 +- docs/gst/tmpl/gstdata_private.sgml | 16 + docs/gst/tmpl/gstelement.sgml | 1317 +++++++---- docs/gst/tmpl/gstenumtypes.sgml | 736 ++++++ docs/gst/tmpl/gsterror.sgml | 145 +- docs/gst/tmpl/gstevent.sgml | 215 +- docs/gst/tmpl/gstfakesink.sgml | 13 + docs/gst/tmpl/gstfakesrc.sgml | 1 - docs/gst/tmpl/gstfilesink.sgml | 24 + docs/gst/tmpl/gstfilter.sgml | 41 + docs/gst/tmpl/gstindex.sgml | 203 +- docs/gst/tmpl/gstinfo.sgml | 292 ++- docs/gst/tmpl/gstinterface.sgml | 27 +- docs/gst/tmpl/gstlog.sgml | 24 + docs/gst/tmpl/gstmacros.sgml | 37 + docs/gst/tmpl/gstmarshal.sgml | 241 ++ docs/gst/tmpl/gstmd5sink.sgml | 25 + docs/gst/tmpl/gstmultifilesrc.sgml | 24 + docs/gst/tmpl/gstobject.sgml | 223 +- docs/gst/tmpl/gstpad.sgml | 1650 +++++++++----- docs/gst/tmpl/gstparse.sgml | 32 +- docs/gst/tmpl/gstpipeline.sgml | 6 - docs/gst/tmpl/gstplugin.sgml | 209 +- docs/gst/tmpl/gstpluginfeature.sgml | 64 +- docs/gst/tmpl/gstqueue.sgml | 6 - docs/gst/tmpl/gstreamer-unused.sgml | 3034 +++++-------------------- docs/gst/tmpl/gstregistry.sgml | 95 +- docs/gst/tmpl/gstregistrypool.sgml | 24 +- docs/gst/tmpl/gstscheduler.sgml | 254 ++- docs/gst/tmpl/gstsearchfuncs.sgml | 166 ++ docs/gst/tmpl/gstshaper.sgml | 33 + docs/gst/tmpl/gstspider.sgml | 44 + docs/gst/tmpl/gstspideridentity.sgml | 45 + docs/gst/tmpl/gststructure.sgml | 23 +- docs/gst/tmpl/gstsystemclock.sgml | 2 +- docs/gst/tmpl/gsttag.sgml | 296 ++- docs/gst/tmpl/gsttaginterface.sgml | 11 +- docs/gst/tmpl/gsttee.sgml | 9 + docs/gst/tmpl/gstthread.sgml | 31 +- docs/gst/tmpl/gsttrace.sgml | 114 + docs/gst/tmpl/gsttrashstack.sgml | 51 + docs/gst/tmpl/gsttypefind.sgml | 90 +- docs/gst/tmpl/gsttypes.sgml | 249 ++ docs/gst/tmpl/gsturi.sgml | 172 +- docs/gst/tmpl/gsturitype.sgml | 31 + docs/gst/tmpl/gstutils.sgml | 93 +- docs/gst/tmpl/gstvalue.sgml | 394 +++- docs/gst/tmpl/gstversion.sgml | 47 + docs/gst/tmpl/gstxml.sgml | 54 +- docs/gst/tmpl/gstxmlregistry.sgml | 122 + docs/gst/tmpl/gthread-cothreads.sgml | 101 + docs/gst/tmpl/types.sgml | 79 + 86 files changed, 15902 insertions(+), 5839 deletions(-) create mode 100644 docs/gst/tmpl/GstBin.sgml create mode 100644 docs/gst/tmpl/GstBuffer.sgml create mode 100644 docs/gst/tmpl/GstCaps.sgml create mode 100644 docs/gst/tmpl/GstClock.sgml create mode 100644 docs/gst/tmpl/GstCompat.sgml create mode 100644 docs/gst/tmpl/GstData.sgml create mode 100644 docs/gst/tmpl/GstElement.sgml create mode 100644 docs/gst/tmpl/GstEvent.sgml create mode 100644 docs/gst/tmpl/GstIndex.sgml create mode 100644 docs/gst/tmpl/GstStructure.sgml create mode 100644 docs/gst/tmpl/GstTag.sgml create mode 100644 docs/gst/tmpl/cothreads_compat.sgml create mode 100644 docs/gst/tmpl/gettext.sgml create mode 100644 docs/gst/tmpl/grammar.tab.sgml create mode 100644 docs/gst/tmpl/gst-i18n-app.sgml create mode 100644 docs/gst/tmpl/gst-i18n-lib.sgml create mode 100644 docs/gst/tmpl/gst_private.sgml create mode 100644 docs/gst/tmpl/gstatomic_impl.sgml create mode 100644 docs/gst/tmpl/gstbufferstore.sgml create mode 100644 docs/gst/tmpl/gstdata_private.sgml create mode 100644 docs/gst/tmpl/gstenumtypes.sgml create mode 100644 docs/gst/tmpl/gstfilesink.sgml create mode 100644 docs/gst/tmpl/gstfilter.sgml create mode 100644 docs/gst/tmpl/gstmacros.sgml create mode 100644 docs/gst/tmpl/gstmarshal.sgml create mode 100644 docs/gst/tmpl/gstmd5sink.sgml create mode 100644 docs/gst/tmpl/gstmultifilesrc.sgml create mode 100644 docs/gst/tmpl/gstsearchfuncs.sgml create mode 100644 docs/gst/tmpl/gstshaper.sgml create mode 100644 docs/gst/tmpl/gstspider.sgml create mode 100644 docs/gst/tmpl/gstspideridentity.sgml create mode 100644 docs/gst/tmpl/gsttrashstack.sgml create mode 100644 docs/gst/tmpl/gsttypes.sgml create mode 100644 docs/gst/tmpl/gsturitype.sgml create mode 100644 docs/gst/tmpl/gstversion.sgml create mode 100644 docs/gst/tmpl/gstxmlregistry.sgml create mode 100644 docs/gst/tmpl/gthread-cothreads.sgml create mode 100644 docs/gst/tmpl/types.sgml diff --git a/ChangeLog b/ChangeLog index a6e26607bc..a8772338aa 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,96 @@ +2004-03-24 David Schleef + + * docs/gst/gstreamer-docs.sgml: I got tired of the reference + manual being such complete crap, that I decided to do major + hacking of it. This checkin replaces any fine tuning that + may have been done previously, with the benefit of actually + being complete for much of the API that was changed since + 0.6. Further fine tuning will occur shortly. (bug #134721) + * docs/gst/gstreamer-sections.txt: + * docs/gst/tmpl/GstBin.sgml: + * docs/gst/tmpl/GstBuffer.sgml: + * docs/gst/tmpl/GstCaps.sgml: + * docs/gst/tmpl/GstClock.sgml: + * docs/gst/tmpl/GstCompat.sgml: + * docs/gst/tmpl/GstData.sgml: + * docs/gst/tmpl/GstElement.sgml: + * docs/gst/tmpl/GstEvent.sgml: + * docs/gst/tmpl/GstIndex.sgml: + * docs/gst/tmpl/GstStructure.sgml: + * docs/gst/tmpl/GstTag.sgml: + * docs/gst/tmpl/cothreads.sgml: + * docs/gst/tmpl/cothreads_compat.sgml: + * docs/gst/tmpl/gettext.sgml: + * docs/gst/tmpl/grammar.tab.sgml: + * docs/gst/tmpl/gst-i18n-app.sgml: + * docs/gst/tmpl/gst-i18n-lib.sgml: + * docs/gst/tmpl/gst.sgml: + * docs/gst/tmpl/gst_private.sgml: + * docs/gst/tmpl/gstaggregator.sgml: + * docs/gst/tmpl/gstarch.sgml: + * docs/gst/tmpl/gstatomic.sgml: + * docs/gst/tmpl/gstatomic_impl.sgml: + * docs/gst/tmpl/gstbin.sgml: + * docs/gst/tmpl/gstbuffer.sgml: + * docs/gst/tmpl/gstbufferstore.sgml: + * docs/gst/tmpl/gstcaps.sgml: + * docs/gst/tmpl/gstclock.sgml: + * docs/gst/tmpl/gstcompat.sgml: + * docs/gst/tmpl/gstconfig.sgml: + * docs/gst/tmpl/gstcpu.sgml: + * docs/gst/tmpl/gstdata.sgml: + * docs/gst/tmpl/gstdata_private.sgml: + * docs/gst/tmpl/gstelement.sgml: + * docs/gst/tmpl/gstenumtypes.sgml: + * docs/gst/tmpl/gsterror.sgml: + * docs/gst/tmpl/gstevent.sgml: + * docs/gst/tmpl/gstfakesink.sgml: + * docs/gst/tmpl/gstfakesrc.sgml: + * docs/gst/tmpl/gstfilesink.sgml: + * docs/gst/tmpl/gstfilter.sgml: + * docs/gst/tmpl/gstindex.sgml: + * docs/gst/tmpl/gstinfo.sgml: + * docs/gst/tmpl/gstinterface.sgml: + * docs/gst/tmpl/gstlog.sgml: + * docs/gst/tmpl/gstmacros.sgml: + * docs/gst/tmpl/gstmarshal.sgml: + * docs/gst/tmpl/gstmd5sink.sgml: + * docs/gst/tmpl/gstmultifilesrc.sgml: + * docs/gst/tmpl/gstobject.sgml: + * docs/gst/tmpl/gstpad.sgml: + * docs/gst/tmpl/gstparse.sgml: + * docs/gst/tmpl/gstpipeline.sgml: + * docs/gst/tmpl/gstplugin.sgml: + * docs/gst/tmpl/gstpluginfeature.sgml: + * docs/gst/tmpl/gstqueue.sgml: + * docs/gst/tmpl/gstreamer-unused.sgml: + * docs/gst/tmpl/gstregistry.sgml: + * docs/gst/tmpl/gstregistrypool.sgml: + * docs/gst/tmpl/gstscheduler.sgml: + * docs/gst/tmpl/gstsearchfuncs.sgml: + * docs/gst/tmpl/gstshaper.sgml: + * docs/gst/tmpl/gstspider.sgml: + * docs/gst/tmpl/gstspideridentity.sgml: + * docs/gst/tmpl/gststructure.sgml: + * docs/gst/tmpl/gstsystemclock.sgml: + * docs/gst/tmpl/gsttag.sgml: + * docs/gst/tmpl/gsttaginterface.sgml: + * docs/gst/tmpl/gsttee.sgml: + * docs/gst/tmpl/gstthread.sgml: + * docs/gst/tmpl/gsttrace.sgml: + * docs/gst/tmpl/gsttrashstack.sgml: + * docs/gst/tmpl/gsttypefind.sgml: + * docs/gst/tmpl/gsttypes.sgml: + * docs/gst/tmpl/gsturi.sgml: + * docs/gst/tmpl/gsturitype.sgml: + * docs/gst/tmpl/gstutils.sgml: + * docs/gst/tmpl/gstvalue.sgml: + * docs/gst/tmpl/gstversion.sgml: + * docs/gst/tmpl/gstxml.sgml: + * docs/gst/tmpl/gstxmlregistry.sgml: + * docs/gst/tmpl/gthread-cothreads.sgml: + * docs/gst/tmpl/types.sgml: + 2004-03-24 Ronald Bultje * docs/pwg/other-sink.xml: diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index aa6c13a1b2..c479ce63ce 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -78,7 +78,7 @@ GStreamer Core Library - libgst.la provides all the core GStreamer services, + libgstreamer-0.8.so provides all the core GStreamer services, including initialization, plugin management and types, as well as the object hierarchy that defines elements and bins, along with some more specialized elements. @@ -92,7 +92,7 @@ with some more specialized elements. &GstCpu; &GstData; &GstElement; - &GstElementFactory; + &GstError; &GstEvent; &GstFormat; @@ -118,7 +118,7 @@ with some more specialized elements. &GstTagInterface; &GstThread; &GstTypeFind; - &GstTypeFindFactory; + &GstUri; &GstUtils; +GstBin + + + + + + + + + + + + + + + + + + + + + +@klass: + + + + +The signature of the callback for the post and pre iterate function as set with +gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function(). + + +@bin: The bin that performed the callback +@user_data: user data + + + + +Flags for a bin. + + +@GST_BIN_FLAG_MANAGER: This bin has a scheduler and can be used as a toplevel bin. +@GST_BIN_SELF_SCHEDULABLE: This bin iterates itself, so no calls to gst_bin_iterate() should be made. +@GST_BIN_FLAG_PREFER_COTHREADS: This bin preferes to have its elements scheduled with cothreads +@GST_BIN_FLAG_FIXED_CLOCK: This bin uses a fixed clock, possibly the one set with gst_bin_use_clock(). +@GST_BIN_FLAG_LAST: + + + + + + +@name: +@Returns: + + + + + + + +@bin: +@element: + + + + + + + +@bin: +@element_1: +@Varargs: + + + + + + + +@bin: +@element: + + + + + + + +@bin: +@element_1: +@Varargs: + + + + + + + +@bin: +@name: +@Returns: + + + + + + + +@bin: +@name: +@Returns: + + + + + + + +@bin: +@Returns: + + + + + + + +@bin: +@interface: +@Returns: + + + + + + + +@bin: +@interface: +@Returns: + + + + + + + +@bin: +@Returns: + + + + + + + +@bin: +@clock: + + + + + + + +@bin: +@Returns: + + + + + + + +@bin: + + + + + + + +@bin: +@Returns: + + + + + + + +@bin: +@oldstate: +@newstate: +@child: + + + + + + + +@bin: +@func: +@user_data: + + + + + + + +@bin: +@func: +@user_data: + + + + + + + +@gstbin: the object which received the signal. +@arg1: the element that was added to the bin + + + + + + +@gstbin: the object which received the signal. +@arg1: the element that was removed from the bin + + + +This signal is emitted when a bin iterates, either automatically or +due to a #gst_bin_iterate() call. The return value is used to +determine if the object method handler processed any data. +In most normal cases, a user-provided signal handler should return +FALSE. + + +@gstbin: the object which received the signal. +@Returns: TRUE if the state of the bin was advanced. + diff --git a/docs/gst/tmpl/GstBuffer.sgml b/docs/gst/tmpl/GstBuffer.sgml new file mode 100644 index 0000000000..1756629394 --- /dev/null +++ b/docs/gst/tmpl/GstBuffer.sgml @@ -0,0 +1,419 @@ + +GstBuffer + + + + + + + + + + + + + + + + + + +The basic structure of a buffer. + + +@data_type: +@data: +@size: +@maxsize: +@timestamp: +@duration: +@offset: +@offset_end: +@free_data: +@buffer_private: +@_gst_reserved: + + + + + + +@buffer: + + + + +The name used for tracing memory allocations + + + + + + +Gets a handle to the refcount structure of the buffer. + + +@buf: a #GstBuffer to get the refcount structure of. + + + + +Gets the current refcount value of the buffer. + + +@buf: a #GstBuffer to get the refcount value of. + + + + +Calls the buffer-specific copy function on the given buffer. + + +@buf: a #GstBuffer to copy. + + + + +Calls the buffer-specific free function on the given buffer. + + +@buf: a #GstBuffer to free. + + + + +Gets the flags from this buffer. + + +@buf: a #GstBuffer to retrieve the flags from. + + + + +Gives the status of a given flag of a buffer. + + +@buf: a #GstBuffer to query flags of. +@flag: the #GstBufferFlag to check. + + + + +Sets a buffer flag. + + +@buf: a #GstBuffer to modify flags of. +@flag: the #GstBufferFlag to set. + + + + +Clears a buffer flag. + + +@buf: a #GstBuffer to modify flags of. +@flag: the #GstBufferFlag to clear. + + + + +Retrieves a pointer to the data element of this buffer. + + +@buf: a #GstBuffer to get data pointer of. +@Returns: the pointer to the actual data contents of the buffer. + + + + +Gets the size of the data in this buffer. + + +@buf: a #GstBuffer to get data size of. + + + + +Gets the maximum size of this buffer. + + +@buf: a #GstBuffer to get maximum size of. + + + + +Gets the timestamp for this buffer. + + +@buf: a #GstBuffer to get timestamp of. + + + + + + + +@buf: + + + + + + + +@buf: + + + + +Gets the offset in the source file of this buffer. + + +@buf: a #GstBuffer to get offset of. + + + + + + + +@buf: + + + + + + + +@buf: + + + + + + + +@buf: + + + + + + + + + + + + + + + + + + + + + +@buffer: + + + + + + + +@buffer: + + + + + + + +@buffer: + + + + + + + +@buffer: + + + + + + + +@buffer: + + + + +A set of buffer flags used to describe properties of a #GstBuffer. + + +@GST_BUFFER_READONLY: the buffer is read-only. +@GST_BUFFER_SUBBUFFER: the buffer is a subbuffer, the parent buffer can be + found with the GST_BUFFER_POOL_PRIVATE() macro. +@GST_BUFFER_ORIGINAL: buffer is not a copy of another buffer. +@GST_BUFFER_DONTFREE: do not try to free the data when this buffer is + unreferenced. +@GST_BUFFER_KEY_UNIT: the buffer holds a key unit, a unit that can be + decoded independently of other buffers. +@GST_BUFFER_DONTKEEP: +@GST_BUFFER_FLAG_LAST: additional flags can be added starting from this flag. + + + + + + +@Returns: + + + + + + + +@size: +@Returns: + + + + +A convenience function to set the data and size on a buffer + + +@buf: The buffer to modify +@data: The data to set on the buffer +@size: The size to set on the buffer + + + + +Increases the refcount of the given buffer by one. + + +@buf: a #GstBuffer to increase the refcount of. + + + + +Increases the refcount of the buffer by the given value. + + +@buf: a #GstBuffer to increase the refcount of. +@c: the value to add to the refcount. + + + + +Decreases the refcount of the buffer. If the refcount reaches 0, the buffer +will be freed. + + +@buf: a #GstBuffer to unref. + + + + + + + +@dest: +@src: + + + + +Copies the given buffer using the copy function of the parent GstData structure. + + +@buf: a #GstBuffer to copy. +@Returns: a new #GstBuffer copy of the buffer. + + + + + + + +@buf: + + + + +This function returns a buffer that is safe to write to. +Copy the buffer if the refcount > 1 so that the newly +created buffer can be safely written to. +If the refcount is 1, this function just returns the original buffer. + + +@buf: a #GstBuffer to copy +@Returns: the #GstBuffer that can safely be written to. + + + + + + + +@parent: +@offset: +@size: +@Returns: + + + + + + + +@buf1: +@buf2: +@Returns: + + + + + + + +@buf1: +@buf2: +@Returns: + + + + + + + +@buf1: +@offset: +@buf2: +@len: +@Returns: + + + + + + + +@buffer: + + + + + + + +@buffer: +@Returns: + + diff --git a/docs/gst/tmpl/GstCaps.sgml b/docs/gst/tmpl/GstCaps.sgml new file mode 100644 index 0000000000..e535258647 --- /dev/null +++ b/docs/gst/tmpl/GstCaps.sgml @@ -0,0 +1,413 @@ + +GstCaps + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@caps: + + + + + + + +@caps: + + + + + + + +@string: +@caps: + + + + + + + +@string: + + + + + + + +@type: +@flags: +@structs: +@_gst_reserved: + + + + + + +@caps: +@string: +@_gst_reserved: + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@media_type: +@fieldname: +@Varargs: +@Returns: + + + + + + + +@struct1: +@Varargs: +@Returns: + + + + + + + +@structure: +@var_args: +@Returns: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps1: +@caps2: + + + + + + + +@caps1: +@structure: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps: +@index: +@Returns: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps: +@field: +@Varargs: + + + + + + + +@caps: +@field: +@varargs: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps1: +@caps2: +@Returns: + + + + + + + +@caps1: +@caps2: +@Returns: + + + + + + + +@caps1: +@caps2: +@Returns: + + + + + + + +@caps1: +@caps2: +@Returns: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps: +@parent: +@Returns: + + + + + + + +@parent: +@Returns: + + + + + + + +@caps: +@newcaps: + + + + + + + +@caps: +@Returns: + + + + + + + +@string: +@Returns: + + + + + + + +@structure: +@field_name: +@target: +@Returns: + + + + + + + +@structure: +@field_name: +@target: +@Returns: + + diff --git a/docs/gst/tmpl/GstClock.sgml b/docs/gst/tmpl/GstClock.sgml new file mode 100644 index 0000000000..d79f11998b --- /dev/null +++ b/docs/gst/tmpl/GstClock.sgml @@ -0,0 +1,425 @@ + +GstClock + + + + + + + + + + + + + + + + + + +A datatype to hold a time, measured in nanoseconds. + + + + + +A datatype to hold a timedifference, measured in nanoseconds. + + + + + +A detatype to hold the handle to an outstanding async clock callback + + + + + +Constant to define an undefined clock time + + + + + + + + + +@time: + + + + +Constant that defines one GStreamer second + + + + + + +Constant that defines one GStreamer millisecond + + + + + + +Constant that defines one GStreamer microsecond + + + + + + +Constant that defines one GStreamer nanosecond + + + + + + +Calculate a difference between to clock times. + + +@s: the first time +@e: the second time + + + + +Convert a GTimeVal to a GstClockTime + + +@tv: the timeval to convert + + + + +Convert a GstClockTime to a GTimeVal + + +@t: The GstClockTime to convert +@tv: The target timeval + + + + +The name used for tracing clock entry allocations. + + + + + + +All pending timeouts or periodic notifies are converted into +an entry. + + +@clock: +@type: +@time: +@interval: +@status: +@func: +@user_data: + + + +The function prototype of the callback. + + +@clock: The clock that triggered the callback +@time: The time it was triggered +@id: The id that expired +@user_data: user data passed in the async_wait call +@Returns: + + + + +The status of a clock timeout. + + +@GST_CLOCK_ENTRY_OK: timeout happened +@GST_CLOCK_ENTRY_EARLY: request for timout that has been passed +@GST_CLOCK_ENTRY_RESTART: need to restart the timeout request + + + +The type of the clock entry + + +@GST_CLOCK_ENTRY_SINGLE: a single shot timeout +@GST_CLOCK_ENTRY_PERIODIC: a periodic timeout request + + + +Cast to a clock entry + + +@entry: the entry to cast + + + + +Get the owner clock of the entry + + +@entry: the entry to query + + + + +Get the type of the clock entry + + +@entry: the entry to query + + + + +Get the requested time of this entry + + +@entry: the entry to query + + + + +Get the interval of this periodic entry + + +@entry: the entry to query + + + + +The status of the entry + + +@entry: the entry to query + + + + +The return value of a clock operation. + + +@GST_CLOCK_STOPPED: The clock is stopped. +@GST_CLOCK_TIMEOUT: The operation timed out. +@GST_CLOCK_EARLY: The operation was scheduled too late. +@GST_CLOCK_ERROR: An error occured +@GST_CLOCK_UNSUPPORTED: Operation is not supported + + + +The capabilities of this clock + + +@GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC: This clock can do a single sync timeut request +@GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC: This clock can do a single async timeout request +@GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC: This clock can do sync periodic timeout requests +@GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC: This clock can do async periodic timeout callbacks +@GST_CLOCK_FLAG_CAN_SET_RESOLUTION: The resolution of this clock can be changed +@GST_CLOCK_FLAG_CAN_SET_SPEED: The speed of this clock can be changed + + + +Get the clock flags + + +@clock: the clock to query + + + + + + + +@clock: +@speed: +@Returns: + + + + + + + +@clock: +@Returns: + + + + + + + +@clock: +@resolution: +@Returns: + + + + + + + +@clock: +@Returns: + + + + + + + +@clock: +@active: + + + + + + + +@clock: +@Returns: + + + + + + + +@clock: + + + + + + + +@clock: +@time: +@Returns: + + + + + + + +@clock: +@Returns: + + + + + + + +@clock: +@Returns: + + + + + + + +@clock: +@Returns: + + + + + + + +@clock: +@time: +@Returns: + + + + + + + +@clock: +@start_time: +@interval: +@Returns: + + + + + + + +@id: +@Returns: + + + + + + + +@id: +@jitter: +@Returns: + + + + + + + +@id: +@func: +@user_data: +@Returns: + + + + + + + +@id: + + + + + + + +@id: + + + + + + + +@id: + + + + + + + + + +Maximum allowed diff for clock sync requests against the real time. + + + + +Boolean property to activate stat generation on the clock. + + diff --git a/docs/gst/tmpl/GstCompat.sgml b/docs/gst/tmpl/GstCompat.sgml new file mode 100644 index 0000000000..4b09122c88 --- /dev/null +++ b/docs/gst/tmpl/GstCompat.sgml @@ -0,0 +1,152 @@ + +GstCompat + + + + + + + + + + + + + + + + + + + + + +@a: +@b: + + + + + + + +@a: +@b: +@c: +@d: + + + + + + + +@a: +@...: + + + + + + + +@a: +@b: +@c: + + + + + + + +@a: +@b: + + + + + + + +@a: +@b: + + + + + + + +@a: +@b: +@c: + + + + + + + +@a: +@b: + + + + + + + +@a: +@b: + + + + + + + +@a: +@b: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/GstData.sgml b/docs/gst/tmpl/GstData.sgml new file mode 100644 index 0000000000..7aa942013f --- /dev/null +++ b/docs/gst/tmpl/GstData.sgml @@ -0,0 +1,220 @@ + +GstData + + + + + + + + + + + + + + + + + + +Cast a pointer to a GstData + + +@data: The pointer to cast + + + + +Get the type of the GstData + + +@data: The data to get the type of + + + + +Get the flags of this GstData + + +@data: The data to get the flags of + + + + +Shift a given flag so that it can be used in an or operation + + +@flag: The flag to shift + + + + +Unset the given flag + + +@data: The data to unset the flag of +@flag: The flag to unset + + + + + + + + + + + +The base structure + + +@type: The type of this data. +@refcount: A refcount +@flags: The flags of this GstData +@free: A pointer to a custom free function +@copy: A pointer to a custom copy function +@_gst_reserved: + + + +The signature of the free function. Subclasses should provide a free function +with this signature and pass it in the gst_data_init() function. + + +@data: The GstData to free + + + + +The signature of the copy function. Subclasses should provide a copy function +with this signature and pass it in the gst_data_init() function. + + +@data: The GstData to copy +@Returns: A new GstData that is a copy of data + + + + +Various flags that can be set on a GstData + + +@GST_DATA_READONLY: The data is readonly +@GST_DATA_FLAG_LAST: Subclasses can add additional flags starting from this offset + + + +Get access to the refcount field of the GstData + + +@data: The GstData to get the refcount field of + + + + +Get the current refcount value + + +@data: The GstData to query + + + + +Get access to the copy function of the data + + +@data: The data to query + + + + +Get access to the free function of the data + + +@data: The data to query + + + + + + + +@data: +@type: +@flags: +@free: +@copy: + + + + + + + +@data: + + + + + + + +@data: +@target: + + + + + + + +@data: +@Returns: + + + + + + + +@data: +@Returns: + + + + + + + +@data: +@Returns: + + + + + + + +@data: +@Returns: + + + + + + + +@data: +@count: +@Returns: + + + + + + + +@data: + + diff --git a/docs/gst/tmpl/GstElement.sgml b/docs/gst/tmpl/GstElement.sgml new file mode 100644 index 0000000000..f9c1573342 --- /dev/null +++ b/docs/gst/tmpl/GstElement.sgml @@ -0,0 +1,1315 @@ + +GstElement + + + + + + + + + + + + + + + + +This struct is used to define public information about the element. It +describes the element, mostly for the benefit of editors. + + +@longname: +@klass: +@description: +@author: +@_gst_reserved: + + + + + + +@longname: +@klass: +@description: +@author: + + + + + + + +@details: + + + + +The maximun number of states. + + + + + + +This macro returns the current state of the element. + + +@obj: Element to return state for. + + + + +This macro returns the currently pending state of the element. + + +@obj: Element to return the pending state for. + + + + +Returns the state transition this object is going through. + + +@obj: the Element to return the state transition for + + + + +The Element is going from the NULL state to the READY state. + + + + + + +The Element is going from the READY state to the PAUSED state. + + + + + + +The Element is going from the PAUSED state to the PLAYING state. + + + + + + +The Element is going from the PLAYING state to the PAUSED state. + + + + + + +The Element is going from the PAUSED state to the READY state. + + + + + + +The Element is going from the READY state to the NULL state. + + + + + + + + + +@klass: + + + + +Helper macro to create query type functions + + +@functionname: The function name +@...: list of query types. + + + + +Halper macro to create element format functions + + +@functionname: The function name +@...: formats + + + + +A helper macro to create a mask function + + +@functionname: the name of the mask function +@...: Masks + + + + +This enum defines the standard flags that an element may have. + + +@GST_ELEMENT_COMPLEX: +@GST_ELEMENT_DECOUPLED: +@GST_ELEMENT_THREAD_SUGGESTED: +@GST_ELEMENT_INFINITE_LOOP: +@GST_ELEMENT_NEW_LOOPFUNC: +@GST_ELEMENT_EVENT_AWARE: +@GST_ELEMENT_USE_THREADSAFE_PROPERTIES: +@GST_ELEMENT_SCHEDULER_PRIVATE1: +@GST_ELEMENT_SCHEDULER_PRIVATE2: +@GST_ELEMENT_LOCKED_STATE: +@GST_ELEMENT_IN_ERROR: +@GST_ELEMENT_FLAG_LAST: + + + +Queries whether the Element should be placed in a thread. + + +@obj: a #GstElement to query + + + + +Query wether this element can handle events. + + +@obj: a #GstElement to query + + + + +Queries if the Element is decoupled. + + +@obj: a #GstElement to query + + + + +Gets the name of this element. Used in the core. Not ABI-compatible. + + +@obj: A #GstElement to query + + + + +Get the parent object of this element. + + +@obj: a #GstElement to query + + + + +Get the manager of this element. + + +@obj: a #GstElement to query + + + + +Get the scheduler of this element. + + +@obj: a #GstElement to query + + + + +Get the clock of this element + + +@obj: a #GstElement to query + + + + +Get the pads of this elements. + + +@obj: a #GstElement to query + + + + + + + +@el: +@domain: +@code: +@message: +@debug: + + + + +This function type is used to specify a loop function for the element. It +is passed the element in question, and is expect to return only in error +circumstances. + + +@element: The element in question. + + + + +The signature of the function to execute after this element +is scheduled. + + +@element: The element + + + + +The signature of the function to execute before this element +is scheduled. + + +@element: The element + + + + + + + +@klass: +@templ: + + + + + + + +@klass: +@first_name: +@Varargs: + + + + + + + +@klass: +@details: + + + + +The default deep notify handler that prints out the property change +notifications to stdout. + + + + + + + + + +@object: +@orig: +@error: +@debug: + + + + + + + +@element: +@loop: + + + + +Gets the name of the element. + + +@elem: +@Returns: the name of the element. + + + + + + + +Sets the name of the element, getting rid of the old name if there was one. + + +@elem: a #GstElement to set the name of. +@name: the new name of the element. + + + + +Gets the parent of an element. + + +@elem: a #GstElement to get the parent of. +@Returns: the #GstObject parent of the element. + + + + +Sets the parent of an element. + + +@elem: a #GstElement to set the parent of. +@parent: the new #GstObject parent of the object. + + + + + + + +@element: +@first_property_name: +@Varargs: + + + + + + + +@element: +@first_property_name: +@Varargs: + + + + + + + +@element: +@first_property_name: +@var_args: + + + + + + + +@element: +@first_property_name: +@var_args: + + + + + + + +@element: +@property_name: +@value: + + + + + + + +@element: +@property_name: +@value: + + + + + + + +@element: + + + + + + + +@element: + + + + + + + +@element: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@clock: + + + + + + + +@element: +@id: +@jitter: +@Returns: + +@clock: +@time: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@timestamp: +@Returns: + + + + + + + +@element: +@time: + + + + + + + +@element: +@diff: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@index: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + +@element: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@sched: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@pad: + + + + + + + +@element: +@pad: + + + + + + + +@element: +@pad: +@name: +@Returns: + + + + + + + +@element: +@pad: + + + + + + + + + + +@element: +@name: +@Returns: GList of #GstPads + + + + + + + +@element: +@name: +@Returns: + + + + + + + +@element: +@name: +@Returns: + + + + + + + +@element: +@pad: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@pad: +@Returns: + + + + + + + +@element: +@pad: +@filtercaps: +@Returns: + + + + + + + +@element_class: +@name: +@Returns: + + + + + + + +@element_class: +@Returns: + + + + + + + +@element: +@name: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + + + + + +@element: +@compattempl: +@Returns: + + + + + + + +@src: +@dest: +@Returns: + + + + + + + +@element_1: +@element_2: +@Varargs: +@Returns: + + + + + + + +@src: +@dest: +@filtercaps: +@Returns: + + + + + + + +@src: +@dest: + + + + + + + +@element_1: +@element_2: +@Varargs: + + + + + + + +@src: +@srcpadname: +@dest: +@destpadname: +@Returns: + + + + + + + +@src: +@srcpadname: +@dest: +@destpadname: +@filtercaps: +@Returns: + + + + + + + +@src: +@srcpadname: +@dest: +@destpadname: + + + + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@event: +@Returns: + + + + + + + +@element: +@seek_type: +@offset: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@type: +@format: +@value: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@src_format: +@src_value: +@dest_format: +@dest_value: +@Returns: + + + + + + + +@element: +@tag_list: + + + + + + + +@element: +@pad: +@timestamp: +@list: + + + + + + + +@element: + + + + + + + +@element: +@domain: +@code: +@message: +@debug: +@file: +@function: +@line: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@locked_state: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@state: +@Returns: + + + + + + + +@element: + + + + + + + +@state: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@Returns: + + + + + + + +@plugin: +@elementname: +@rank: +@type: +@Returns: + + + + + + + +@name: +@Returns: + + + + + + + +@factory: +@Returns: + + + + + + + +@factory: +@Returns: + + + + + + + +@factory: +@Returns: + + + + + + + +@factory: +@Returns: + + + + + + + +@factory: +@Returns: + + + + + + + +@factory: +@Returns: + + + + + + + +@factory: +@Returns: + + + + + + + +@factory: +@Returns: + + + + + + + +@factory: +@Returns: + + + + + + + +@factory: +@name: +@Returns: + + + + + + + +@factoryname: +@name: +@Returns: + + + + + + + +@factory: +@caps: +@Returns: + + + + + + + +@factory: +@caps: +@Returns: + + + + +Signal emited when the element goes to PAUSED due to an end-of-stream +condition. + + +@gstelement: the object which received the signal. + + + +This signal is emitted when an element has encountered an error that caused +it to fail performing its function. + + +@gstelement: the object which received the signal. +@arg1: the original #GstElement that generated the error. +@arg2: a #GError containing the translated error message. +@arg3: a debug string providing additional untranslated debug information, or NULL. + + + + + + +@gstelement: the object which received the signal. +@arg1: +@arg2: + + + +Is triggered whenever a new pad is added to an element. + + +@gstelement: the object which received the signal. +@arg1: the new pad that was added + + + +Is triggered whenever a pad has been removed from the element. + + +@gstelement: the object which received the signal. +@arg1: The pad that was removed. + + + +Is triggered whenever the state of an element changes. + + +@gstelement: the object which received the signal. +@arg1: the new state of the object +@arg2: + diff --git a/docs/gst/tmpl/GstEvent.sgml b/docs/gst/tmpl/GstEvent.sgml new file mode 100644 index 0000000000..6a1c5b2ebe --- /dev/null +++ b/docs/gst/tmpl/GstEvent.sgml @@ -0,0 +1,433 @@ + +GstEvent + + + + + + + + + + + + + + + + + + +The different major types of events. + + +@GST_EVENT_UNKNOWN: unknown event. +@GST_EVENT_EOS: an end-of-stream event. +@GST_EVENT_FLUSH: a flush event. +@GST_EVENT_EMPTY: an empty event. +@GST_EVENT_DISCONTINUOUS: a discontinuous event to indicate the stream has a discontinuity. +@GST_EVENT_QOS: a quality of service event +@GST_EVENT_SEEK: a seek event. +@GST_EVENT_SEEK_SEGMENT: a segment seek with start and stop position +@GST_EVENT_SEGMENT_DONE: the event that will be emited when the segment seek has ended +@GST_EVENT_SIZE: a size suggestion for a peer element +@GST_EVENT_RATE: adjust the output rate of an element +@GST_EVENT_FILLER: a dummy event that should be ignored by plugins +@GST_EVENT_TS_OFFSET: an event to set the time offset on buffers +@GST_EVENT_INTERRUPT: mainly used by _get based elements when they were interrupted + while waiting for a buffer. +@GST_EVENT_NAVIGATION: +@GST_EVENT_TAG: + + + +The name used for memory allocation tracing + + + + + + +Get the event type. + + +@event: The event to query. + + + + +Get the timestamp of the event. + + +@event: The event to query. + + + + +The source object that generated this event + + +@event: The event to query + + + + +Check if the event is an interrupt event + + +@event: The event to check + + + + +Shift for the format in the GstSeekType + + + + + + +Shift for the method in the GstSeekType + + + + + + +Shift for the flags in the GstSeekType + + + + + + +Mask for the format in the GstSeekType + + + + + + +Mask for the method in the GstSeekType + + + + + + +Mask for the flags in the GstSeekType + + + + + + +Event flags are used when querying for supported events + + +@GST_EVENT_FLAG_NONE: no value +@GST_RATE_FLAG_NEGATIVE: indicates negative rates are supported + + + +A convenience macro to create event mask functions + + +@type: The type of the first argument of the function +@functionname: the name of the function +@...: event masks, the last element is marked with 0 + + + + +The different types of seek events. When constructing a seek event a format, +a seek method and optional flags are OR-ed together. The seek event is then +inserted into the graph with #gst_pad_send_event() or #gst_element_send_event(). + + + Following example illustrates how to insert a seek event (1 second in the stream) + in a pipeline. + + + gboolean res; + GstEvent *event; + + event = gst_event_new_seek ( + GST_FORMAT_TIME | /* seek on time */ + GST_SEEK_METHOD_SET | /* set the absolute position */ + GST_SEEK_FLAG_FLUSH, /* flush any pending data */ + 1 * GST_SECOND); /* the seek offset (1 second) */ + + res = gst_element_send_event (GST_ELEMENT (osssink), event); + if (!res) { + g_warning ("seek failed"); + } + + + + +@GST_SEEK_METHOD_CUR: Seek to an relative position +@GST_SEEK_METHOD_SET: Seek to an absolute position +@GST_SEEK_METHOD_END: Seek relative to the end of the stream +@GST_SEEK_FLAG_FLUSH: Flush any pending data while seeking +@GST_SEEK_FLAG_ACCURATE: Seek as accuratly as possible +@GST_SEEK_FLAG_KEY_UNIT: Seek to a nearby key unit +@GST_SEEK_FLAG_SEGMENT_LOOP: Loop between start and stop in a segmented seek + + + +The seekaccuracy gives more information of how the seek was performed, +if the seek was accurate or fuzzy. + + +@GST_SEEK_CERTAIN: The seek was exact +@GST_SEEK_FUZZY: The seek was fuzzy, exact position can not be guaranteed + + + +Get the seektype of the GST_EVENT_SEEK. + + +@event: The event to query. + + + + +The format of the seek value + + +@event: The event operate on + + + + +The seek method to use as one of #GstSeekType + + +@event: The event operate on + + + + +The optional seek flags + + +@event: The event operate on + + + + +Get the offset of the seek event. + + +@event: The event to query. + + + + +The event stop position for a segment seek + + +@event: The event to query + + + + +Indicates how accurate the event was performed. + + +@event: The event to query + + + + +Flag that indicates the discont event was because of a new media +type. + + +@event: The event to operate on + + + + +The offset of the discont event. A discont evetn can hold up to 8 different +format/value pairs. + + +@event: The event to query +@i: The offset/value pair. + + + + +Get the number of offset/value pairs this event has. + + +@event: The event to query. + + + + +The format of the size event. + + +@event: The event to query + + + + +The value of the size event + + +@event: The event to query + + + + +Get access to the rate vale field + + +@event: The event to query + + + + + + + +@data: +@type: +@timestamp: +@src: + + + + + + +@type: +@Returns: + + + + +Increase the refcount of this event + + +@ev: The event to refcount + + + + +Increase the refcount of the event with the given value + + +@ev: The event to refcount +@c: The value to add to the refcount + + + + +Decrease the refcount of an event, freeing it if the refcount reaches 0 + + +@ev: The event to unref + + + + +Copy the event using the event specific copy function + + +@ev: The event to copy +@Returns: A new event that is a copy of the given input event + + + + + + + +@masks: +@mask: +@Returns: + + + + + + + +@type: +@offset: +@Returns: + + + + + + + +@type: +@start: +@stop: +@Returns: + + + + + + + +@format: +@value: +@Returns: + + + + + + + +@new_media: +@format1: +@Varargs: +@Returns: + + + + + + + +@new_media: +@format1: +@var_args: +@Returns: + + + + + + + +@event: +@format: +@value: +@Returns: + + + + +Create a new dummy event that should be ignored + + + + + + +Create a new flush event. + + + + diff --git a/docs/gst/tmpl/GstIndex.sgml b/docs/gst/tmpl/GstIndex.sgml new file mode 100644 index 0000000000..7813850083 --- /dev/null +++ b/docs/gst/tmpl/GstIndex.sgml @@ -0,0 +1,523 @@ + +GstIndexFactory + + + + + + + + + + + + + + + + + + + + + + + + + +The basic element of an index. + + +@type: +@id: + + + +A group of related entries in an index. + + +@groupnum: +@entries: +@certainty: +@peergroup: + + + +The certainty of a group in the index. + + +@GST_INDEX_UNKNOWN: accuracy is not known +@GST_INDEX_CERTAIN: accuracy is perfect +@GST_INDEX_FUZZY: accuracy is fuzzy + + + +The different types of entries in the index. + + +@GST_INDEX_ENTRY_ID: This entry is an id that maps an index id to its owner object +@GST_INDEX_ENTRY_ASSOCIATION: This entry is an association between formats +@GST_INDEX_ENTRY_OBJECT: An object +@GST_INDEX_ENTRY_FORMAT: A format definition + + + +Specify the method to find an index entry in the index. + + +@GST_INDEX_LOOKUP_EXACT: There has to be an exact indexentry with the given format/value +@GST_INDEX_LOOKUP_BEFORE: The exact entry or the one before it +@GST_INDEX_LOOKUP_AFTER: The exact entry or the one after it + + + +Get the number of associations in the entry. + + +@entry: The entry to query + + + + +Get the flags for this entry + + +@entry: The entry to query + + + + +Get the i-th format of the entry. + + +@entry: The entry to query +@i: The format index + + + + +Get the i-th value of the entry. + + +@entry: The entry to query +@i: The value index + + + + +An association in an entry. + + +@format: the format of the association +@value: the value of the association + + + +flags for an association entry + + +@GST_ASSOCIATION_FLAG_NONE: no extra flags +@GST_ASSOCIATION_FLAG_KEY_UNIT: the entry marks a key unit, a key unit is one + that marks a place where one can randomly seek to. +@GST_ASSOCIATION_FLAG_LAST: extra user defined flags should start here. + + + +Get the format of the format entry + + +@entry: The entry to query + + + + +Get the key of the format entry + + +@entry: The entry to query + + + + +An invalid index id + + + + + + +Get the description of the id entry + + +@entry: The entry to query + + + + +Function to filter out entries in the index. + + +@index: The index being queried +@entry: The entry to be added. +@Returns: This function should return TRUE if the entry is to be added + to the index, FALSE otherwise. + + + + +The method used to resolve index writers + + +@GST_INDEX_RESOLVER_CUSTOM: Use a custom resolver +@GST_INDEX_RESOLVER_GTYPE: Resolve based on the GType of the object +@GST_INDEX_RESOLVER_PATH: Resolve on the path in graph + + + +Function to resolve ids to writer descriptions. + + +@index: the index being queried. +@writer: The object that wants to write +@writer_string: A description of the writer. +@user_data: user_data as registered +@Returns: TRUE if an id could be assigned to the writer. + +@writer_id: A pointer to the id that has to be assigned to this writer + + + + +Flags for this index + + +@GST_INDEX_WRITABLE: The index is writable +@GST_INDEX_READABLE: The index is readable +@GST_INDEX_FLAG_LAST: First flag that can be used by subclasses + + + +Check if the index can be read from + + +@obj: The index to check + + + + +Check if the index can be written to + + +@obj: The index to check + + + + + + + +@Returns: + + + + + + + +@index: +@id: + + + + + + + +@index: +@Returns: + + + + + + + +@index: +@Returns: + + + + + + + +@index: +@groupnum: +@Returns: + + + + + + + +@index: +@certainty: + + + + + + + +@index: +@Returns: + + + + + + + +@index: +@filter: +@user_data: + + + + + + + +@index: +@resolver: +@user_data: + + + + + + + +@index: +@writer: +@id: +@Returns: + + + + + + + +@index: +@id: +@format: +@Returns: + + + + + + + +@index: +@id: +@flags: +@format: +@value: +@Varargs: +@Returns: + + + + + + + +@index: +@id: +@key: +@type: +@object: +@Returns: + + + + + + + +@index: +@id: +@description: +@Returns: + + + + + + + +@index: +@id: +@method: +@flags: +@format: +@value: +@Returns: + + + + + + + +@index: +@id: +@method: +@flags: +@format: +@value: +@func: +@user_data: +@Returns: + + + + + + + +@Returns: + + + + + + + +@entry: +@Returns: + + + + + + + +@entry: + + + + + + + +@entry: +@format: +@value: +@Returns: + + + + + + + + + + + + + + +@obj: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@Returns: + + + + + + + +@name: +@longdesc: +@type: +@Returns: + + + + + + + +@factory: + + + + + + + +@name: +@Returns: + + + + + + + +@factory: +@Returns: + + + + + + + +@name: +@Returns: + + diff --git a/docs/gst/tmpl/GstStructure.sgml b/docs/gst/tmpl/GstStructure.sgml new file mode 100644 index 0000000000..759239a07e --- /dev/null +++ b/docs/gst/tmpl/GstStructure.sgml @@ -0,0 +1,366 @@ + +GstStructure + + + + + + + + + + + + + + + + + + + + + +@type: +@name: +@fields: +@_gst_reserved: + + + + + + +@field_id: +@value: +@user_data: +@Returns: + + + + + + + +@name: +@Returns: + + + + + + + +@quark: +@Returns: + + + + + + + +@name: +@firstfield: +@Varargs: +@Returns: + + + + + + + +@name: +@firstfield: +@varargs: +@Returns: + + + + + + + +@structure: +@Returns: + + + + + + + +@structure: + + + + + + + +@structure: +@Returns: + + + + + + + +@structure: +@name: + + + + + + + +@structure: +@field: +@value: + + + + + + + +@structure: +@fieldname: +@value: + +@field: + + + + + + + +@structure: +@fieldname: +@Varargs: + +@field: + + + + + + + +@structure: +@fieldname: +@varargs: + +@field: + + + + + + + +@structure: +@field: +@Returns: + + + + + + + +@structure: +@fieldname: +@Returns: + +@field: + + + + + + + +@structure: +@fieldname: + +@field: + + + + + + + +@structure: +@fieldname: +@Varargs: + +@fieldnamename: + + + + + + + +@structure: +@fieldname: +@varargs: + +@fieldnamename: + + + + + + + +@structure: + + + + + + + +@structure: +@fieldname: +@Returns: + +@field: + + + + + + + +@structure: +@func: +@user_data: +@Returns: + + + + + + + +@structure: +@Returns: + + + + + + + +@structure: +@fieldname: +@Returns: + +@field: + + + + + + + +@structure: +@fieldname: +@type: +@Returns: + +@field: + + + + + + + +@structure: +@fieldname: +@value: +@Returns: + +@field: + + + + + + + +@structure: +@fieldname: +@value: +@Returns: + +@field: + + + + + + + +@structure: +@fieldname: +@value: +@Returns: + +@field: + + + + + + + +@structure: +@fieldname: +@value: +@Returns: + +@fieldnamename: +@field: + + + + + + + +@structure: +@fieldname: +@Returns: + +@field: + + + + + + + +@structure: +@Returns: + + + + + + + +@string: +@end: +@Returns: + + diff --git a/docs/gst/tmpl/GstTag.sgml b/docs/gst/tmpl/GstTag.sgml new file mode 100644 index 0000000000..ad040757a0 --- /dev/null +++ b/docs/gst/tmpl/GstTag.sgml @@ -0,0 +1,881 @@ + +GstTag + + + + + + + + + + + + + + + + + + + + + +@GST_TAG_MERGE_UNDEFINED: +@GST_TAG_MERGE_REPLACE_ALL: +@GST_TAG_MERGE_REPLACE: +@GST_TAG_MERGE_APPEND: +@GST_TAG_MERGE_PREPEND: +@GST_TAG_MERGE_KEEP: +@GST_TAG_MERGE_KEEP_ALL: +@GST_TAG_MERGE_COUNT: + + + + + + +@GST_TAG_FLAG_UNDEFINED: +@GST_TAG_FLAG_META: +@GST_TAG_FLAG_ENCODED: +@GST_TAG_FLAG_DECODED: +@GST_TAG_FLAG_COUNT: + + + + + + + + + + + + +@x: + + + + + + + +@x: + + + + + + + + + + + + + + +@list: +@tag: +@user_data: + + + + + + + +@dest: +@src: + + + + + + + +@name: +@flag: +@type: +@nick: +@blurb: +@func: + + + + + + + +@dest: +@src: + + + + + + + +@dest: +@src: + + + + + + + +@tag: +@Returns: + + + + + + + +@tag: +@Returns: + + + + + + + +@tag: +@Returns: + + + + + + + +@tag: +@Returns: + + + + + + + +@tag: +@Returns: + + + + + + + +@tag: +@Returns: + + + + + + + +@Returns: + + + + + + + +@p: +@Returns: + + + + + + + +@list: +@Returns: + + + + + + + +@into: +@from: +@mode: + + + + + + + +@list1: +@list2: +@mode: +@Returns: + + + + + + + +@list: + + + + + + + +@list: +@tag: +@Returns: + + + + + + + +@list: +@mode: +@tag: +@Varargs: + + + + + + + +@list: +@mode: +@tag: +@Varargs: + + + + + + + +@list: +@mode: +@tag: +@var_args: + + + + + + + +@list: +@mode: +@tag: +@var_args: + + + + + + + +@list: +@tag: + + + + + + + +@list: +@func: +@user_data: + + + + + + + +@list: +@tag: +@index: +@Returns: + + + + + + + +@dest: +@list: +@tag: +@Returns: + + + + + + + +@list: +@tag: +@value: +@Returns: + + + + + + + +@list: +@tag: +@index: +@value: +@Returns: + + + + + + + +@list: +@tag: +@value: +@Returns: + + + + + + + +@list: +@tag: +@index: +@value: +@Returns: + + + + + + + +@list: +@tag: +@value: +@Returns: + + + + + + + +@list: +@tag: +@index: +@value: +@Returns: + + + + + + + +@list: +@tag: +@value: +@Returns: + + + + + + + +@list: +@tag: +@index: +@value: +@Returns: + + + + + + + +@list: +@tag: +@value: +@Returns: + + + + + + + +@list: +@tag: +@index: +@value: +@Returns: + + + + + + + +@list: +@tag: +@value: +@Returns: + + + + + + + +@list: +@tag: +@index: +@value: +@Returns: + + + + + + + +@list: +@tag: +@value: +@Returns: + + + + + + + +@list: +@tag: +@index: +@value: +@Returns: + + + + + + + +@list: +@tag: +@value: +@Returns: + + + + + + + +@list: +@tag: +@index: +@value: +@Returns: + + + + + + + +@list: +@tag: +@value: +@Returns: + + + + + + + +@list: +@tag: +@index: +@value: +@Returns: + + + + + + + +@list: +@tag: +@value: +@Returns: + + + + + + + +@list: +@tag: +@index: +@value: +@Returns: + + + + + + + +@list: +@tag: +@value: +@Returns: + + + + + + + +@list: +@tag: +@index: +@value: +@Returns: + + + + + + + +@list: +@tag: +@value: +@Returns: + + + + + + + +@list: +@tag: +@index: +@value: +@Returns: + + + + + + + +@list: +@tag: +@value: +@Returns: + + + + + + + +@list: +@tag: +@index: +@value: +@Returns: + + + + + + + +@list: +@Returns: + + + + + + + +@tag_event: +@Returns: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/cothreads.sgml b/docs/gst/tmpl/cothreads.sgml index fb1d1a52de..4e3844c19c 100644 --- a/docs/gst/tmpl/cothreads.sgml +++ b/docs/gst/tmpl/cothreads.sgml @@ -38,21 +38,9 @@ The cothread state structure @stack_size: @magic_number: - - -the function that will be called when the cothread starts. The function -prototype is like a main() function, so you can do whatever you want with -it. - - -@argc: a main-like argument count -@argv: a main-like array of arguments -@Returns: a return code - - -The cothread context structure + @cothreads: @@ -61,6 +49,16 @@ The cothread context structure @mutex: @gst_thread: + + + + + +@argc: +@argv: +@Returns: + + Indicates the cothread is started. @@ -91,24 +89,26 @@ Indicates the cothread is destroyed. @ctx: - - - - - -@cothread: -@Returns: - - - + @cothread: +@key: @data: + + + + + +@cothread: +@key: +@Returns: + + @@ -153,26 +153,24 @@ Indicates the cothread is destroyed. @cothread: - + @cothread: -@key: -@Returns: - - - - - - - -@cothread: -@key: @data: + + + + + +@cothread: +@Returns: + + diff --git a/docs/gst/tmpl/cothreads_compat.sgml b/docs/gst/tmpl/cothreads_compat.sgml new file mode 100644 index 0000000000..e531d0f4a5 --- /dev/null +++ b/docs/gst/tmpl/cothreads_compat.sgml @@ -0,0 +1,140 @@ + +cothreads_compat + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@x: + + + + + + + +@stack: +@size: + + + + + + + +@to: + + + + + + + +@new_cothread: +@context: +@func: +@argc: +@argv: + + + + + + + +@cothread: +@context: +@func: +@argc: +@argv: + + + + + + + +@cothread: + + + + + + + + + + + + + + +@context: + + + + + + + +@cothread: + + + + + + + +@cothread: + + + + + + + +@context: + + + + + + + +@context: + + diff --git a/docs/gst/tmpl/gettext.sgml b/docs/gst/tmpl/gettext.sgml new file mode 100644 index 0000000000..4012b31740 --- /dev/null +++ b/docs/gst/tmpl/gettext.sgml @@ -0,0 +1,124 @@ + +gettext + + + + + + + + + + + + + + + + + + + +@Msgid: + +@String: + + + + + + + +@Domainname: +@Msgid: + +@Domain: +@String: + + + + + + + +@Domainname: +@Msgid: +@Category: + +@Domain: +@String: +@Type: + + + + + + + +@Msgid1: +@Msgid2: +@N: + + + + + + + +@Domainname: +@Msgid1: +@Msgid2: +@N: + + + + + + + +@Domainname: +@Msgid1: +@Msgid2: +@N: +@Category: + + + + + + + +@Domainname: + +@String: + + + + + + + +@Domainname: +@Dirname: + +@Domain: +@Directory: + + + + + + + +@Domainname: +@Codeset: + + + + + + + +@String: + + diff --git a/docs/gst/tmpl/grammar.tab.sgml b/docs/gst/tmpl/grammar.tab.sgml new file mode 100644 index 0000000000..47036256c5 --- /dev/null +++ b/docs/gst/tmpl/grammar.tab.sgml @@ -0,0 +1,79 @@ + +grammar.tab + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gst-i18n-app.sgml b/docs/gst/tmpl/gst-i18n-app.sgml new file mode 100644 index 0000000000..bab0aed42c --- /dev/null +++ b/docs/gst/tmpl/gst-i18n-app.sgml @@ -0,0 +1,32 @@ + +gst-i18n-app + + + + + + + + + + + + + + + + + + + +@String: + + + + + + + +@String: + + diff --git a/docs/gst/tmpl/gst-i18n-lib.sgml b/docs/gst/tmpl/gst-i18n-lib.sgml new file mode 100644 index 0000000000..6dd151cd86 --- /dev/null +++ b/docs/gst/tmpl/gst-i18n-lib.sgml @@ -0,0 +1,32 @@ + +gst-i18n-lib + + + + + + + + + + + + + + + + + + + +@String: + + + + + + + +@String: + + diff --git a/docs/gst/tmpl/gst.sgml b/docs/gst/tmpl/gst.sgml index 46383192d7..c489172d9a 100644 --- a/docs/gst/tmpl/gst.sgml +++ b/docs/gst/tmpl/gst.sgml @@ -90,11 +90,13 @@ pipeline and Microsoft's DirectShow for some background. @argv: - + +@argc: +@argv: @Returns: @@ -111,16 +113,6 @@ pipeline and Microsoft's DirectShow for some background. @Returns: - - - - - -@argc: -@argv: -@Returns: - - @@ -134,14 +126,28 @@ pipeline and Microsoft's DirectShow for some background. @Param3: - + -@major: -@minor: -@micro: +@Returns: + + + + + + + +@use_threads: + + + + + + + +@Returns: @@ -158,46 +164,3 @@ pipeline and Microsoft's DirectShow for some background. - - - - - -@Returns: - - - - - - - -@use_threads: - - - - -The variable that holds the GStreamer log domain - - - - - -The major version of GStreamer at compile time - - - - - - -The minor version of GStreamer at compile time - - - - - - -The micro version of GStreamer at compile time - - - - diff --git a/docs/gst/tmpl/gst_private.sgml b/docs/gst/tmpl/gst_private.sgml new file mode 100644 index 0000000000..2ebd3b78bb --- /dev/null +++ b/docs/gst/tmpl/gst_private.sgml @@ -0,0 +1,178 @@ + +gst_private + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstaggregator.sgml b/docs/gst/tmpl/gstaggregator.sgml index 6670f70513..51bcc6db44 100644 --- a/docs/gst/tmpl/gstaggregator.sgml +++ b/docs/gst/tmpl/gstaggregator.sgml @@ -15,12 +15,6 @@ methods to request buffers from its pads. - - - - - - diff --git a/docs/gst/tmpl/gstarch.sgml b/docs/gst/tmpl/gstarch.sgml index 49ac6d0ca7..7b03f9fda2 100644 --- a/docs/gst/tmpl/gstarch.sgml +++ b/docs/gst/tmpl/gstarch.sgml @@ -18,14 +18,6 @@ implementations in this file. - - -Jumps to a specific location in memory. - - -@target: the memory to jump to. - - Sets the stackpointer. @@ -34,6 +26,14 @@ Sets the stackpointer. @stackpointer: the stackpointer to set. + + +Jumps to a specific location in memory. + + +@target: the memory to jump to. + + Make toom on the stack? @@ -49,3 +49,10 @@ Do something funny, which is required on some archs.. + + + + + + + diff --git a/docs/gst/tmpl/gstatomic.sgml b/docs/gst/tmpl/gstatomic.sgml index 502e939ae7..700218c83c 100644 --- a/docs/gst/tmpl/gstatomic.sgml +++ b/docs/gst/tmpl/gstatomic.sgml @@ -19,6 +19,12 @@ as external methods. #GstMemChunk + + + + + + A structure that contains an integer that can be modified diff --git a/docs/gst/tmpl/gstatomic_impl.sgml b/docs/gst/tmpl/gstatomic_impl.sgml new file mode 100644 index 0000000000..832bfe1f8e --- /dev/null +++ b/docs/gst/tmpl/gstatomic_impl.sgml @@ -0,0 +1,46 @@ + +gstatomic_impl + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@ra: +@rb: + + diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml index 68c62da4bc..a982c24d48 100644 --- a/docs/gst/tmpl/gstbin.sgml +++ b/docs/gst/tmpl/gstbin.sgml @@ -2,7 +2,7 @@ GstBin -Base container element +Base class for elements that contain other elements @@ -55,21 +55,12 @@ clock providers in the bin. - + -Flags for a bin. + -@GST_BIN_FLAG_MANAGER: This bin has a scheduler and can be used as a toplevel bin. -@GST_BIN_SELF_SCHEDULABLE: This bin iterates itself, so no calls to gst_bin_iterate() should be made. -@GST_BIN_FLAG_PREFER_COTHREADS: This bin preferes to have its elements scheduled with cothreads -@GST_BIN_FLAG_FIXED_CLOCK: This bin uses a fixed clock, possibly the one set with gst_bin_use_clock(). -@GST_BIN_FLAG_LAST: - - - -The GstBin object - +@klass: @@ -82,6 +73,17 @@ gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function(). @user_data: user data + + +Flags for a bin. + + +@GST_BIN_FLAG_MANAGER: This bin has a scheduler and can be used as a toplevel bin. +@GST_BIN_SELF_SCHEDULABLE: This bin iterates itself, so no calls to gst_bin_iterate() should be made. +@GST_BIN_FLAG_PREFER_COTHREADS: This bin preferes to have its elements scheduled with cothreads +@GST_BIN_FLAG_FIXED_CLOCK: This bin uses a fixed clock, possibly the one set with gst_bin_use_clock(). +@GST_BIN_FLAG_LAST: + @@ -158,55 +160,27 @@ gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function(). @Returns: - + @bin: +@interface: @Returns: - + @bin: -@func: -@user_data: +@interface: +@Returns: - - - - - -@bin: -@func: -@user_data: - - - - - - - -@bin: -@oldstate: -@newstate: -@child: - - - - - - - -@bin: - - - + @@ -224,6 +198,63 @@ gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function(). @clock: + + + + + +@bin: +@Returns: + + + + + + + +@bin: + + + + + + + +@bin: +@Returns: + + + + + + + +@bin: +@oldstate: +@newstate: +@child: + + + + + + + +@bin: +@func: +@user_data: + + + + + + + +@bin: +@func: +@user_data: + + diff --git a/docs/gst/tmpl/gstbuffer.sgml b/docs/gst/tmpl/gstbuffer.sgml index 59207cea3b..740af31357 100644 --- a/docs/gst/tmpl/gstbuffer.sgml +++ b/docs/gst/tmpl/gstbuffer.sgml @@ -82,6 +82,31 @@ Last reviewed on August 30th, 2002 (0.4.0.1) #GstBufferPool, #GstPad, #GstData + + +The basic structure of a buffer. + + +@data_type: +@data: +@size: +@maxsize: +@timestamp: +@duration: +@offset: +@offset_end: +@free_data: +@buffer_private: +@_gst_reserved: + + + + + + +@buffer: + + The name used for tracing memory allocations @@ -89,23 +114,6 @@ The name used for tracing memory allocations - - -Casts an object to a GstBuffer. - - -@buf: an object to cast. -@Returns: the #GstBuffer to which the given object points. - - - - -Checks if the pointer is a GstBuffer. - - -@buf: a pointer to query. - - Gets a handle to the refcount structure of the buffer. @@ -206,6 +214,22 @@ Gets the timestamp for this buffer. @buf: a #GstBuffer to get timestamp of. + + + + + +@buf: + + + + + + + +@buf: + + Gets the offset in the source file of this buffer. @@ -214,6 +238,84 @@ Gets the offset in the source file of this buffer. @buf: a #GstBuffer to get offset of. + + + + + +@buf: + + + + + + + +@buf: + + + + + + + +@buf: + + + + + + + + + + + + + + + + + + + + + +@buffer: + + + + + + + +@buffer: + + + + + + + +@buffer: + + + + + + + +@buffer: + + + + + + + +@buffer: + + A set of buffer flags used to describe properties of a #GstBuffer. @@ -230,23 +332,6 @@ A set of buffer flags used to describe properties of a #GstBuffer. @GST_BUFFER_DONTKEEP: @GST_BUFFER_FLAG_LAST: additional flags can be added starting from this flag. - - -The basic structure of a buffer. - - -@data_type: -@data: -@size: -@maxsize: -@timestamp: -@duration: -@offset: -@offset_end: -@free_data: -@buffer_private: -@_gst_reserved: - @@ -274,23 +359,6 @@ A convenience function to set the data and size on a buffer @size: The size to set on the buffer - - - - - -@buffer: - - - - - - - -@buffer: -@Returns: - - Increases the refcount of the given buffer by one. @@ -317,6 +385,15 @@ will be freed. @buf: a #GstBuffer to unref. + + + + + +@dest: +@src: + + Copies the given buffer using the copy function of the parent GstData structure. @@ -326,6 +403,14 @@ Copies the given buffer using the copy function of the parent GstData structure. @Returns: a new #GstBuffer copy of the buffer. + + + + + +@buf: + + This function returns a buffer that is safe to write to. @@ -381,3 +466,20 @@ If the refcount is 1, this function just returns the original buffer. @Returns: + + + + + +@buffer: + + + + + + + +@buffer: +@Returns: + + diff --git a/docs/gst/tmpl/gstbufferstore.sgml b/docs/gst/tmpl/gstbufferstore.sgml new file mode 100644 index 0000000000..66832f386a --- /dev/null +++ b/docs/gst/tmpl/gstbufferstore.sgml @@ -0,0 +1,63 @@ + +GstBufferStore + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@store: + + + + + + + +@store: +@buffer: +@Returns: + + + + + + + +@store: +@offset: +@size: +@Returns: + + + + + + + +@store: +@offset: +@Returns: + + diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml index 00b6cfc976..477c850570 100644 --- a/docs/gst/tmpl/gstcaps.sgml +++ b/docs/gst/tmpl/gstcaps.sgml @@ -2,111 +2,89 @@ GstCaps -Capabilities of pads +Structure describing sets of media formats -GstCaps is used to attach capabilities to a pad. Capabilities are made of -a mime-type and a set of properties. GstCaps can be named and chained into -a list, which is then a GstCaps on its own. - - -GstCaps are created with gst_caps_new_simpl(), which takes a mime type and -a list of arguments in sets of 3, terminated with NULL. Each set of 3 -arguments is the name of a field, the GType of the field, and the value -of the field. The following example shows how to create a GstCaps. - - GstCaps *caps; - caps = gst_caps_new ( - "audio/x-raw-int", /* mime type */ - "channels", G_TYPE_INT, 5, - NULL); - - -The following code example is equivalent to the above example: - - GstCaps *caps; - - caps = gst_caps_from_string ("audio/x-raw-int, channels = (int) 5"); - - - -GstCaps are refcounted with gst_caps_ref() and gst_caps_unref(). - - -GstCaps can be chained with the gst_caps_append(), gst_caps_prepend() and -gst_caps_chain() functions. Use gst_caps_get_by_name() to get a named caps -structure from a chained list. - - -To get the properties of a caps structure the functions -gst_caps_get_boolean(), gst_caps_get_fourcc_int(), gst_caps_get_int(), -gst_caps_get_string(), gst_caps_get_float(), which all take a property name as an argument. - - -The fields of the caps structure can be modified with gst_caps_set_simple, -which takes the caps structure to be modified, a list of arguments in -sets of 3, terminated by NULL. The format of these arguments is the -same as above. - - - GstCaps *caps; - .... - - gst_caps_set_simple (caps, "channels", G_TYPE_INT, 20, NULL); - - - - -before modifying a GstCaps, it is a good idea to make a copy if it first with -gst_caps_copy_on_write(). This will copy the GstCaps if the refcount is >1. - - -If you need a unique instance of a GstCaps you can use the convenient -GST_CAPS_FACTORY() macro as shown below. - - GstStaticCaps my_caps = GST_STATIC_CAPS ( - "audio/x-raw-float, " - "channels = (int) 5; " - "audio/x-raw-int, " - "channels = (int) 5" - ) - ) - - void - some_function (void) - { - GstCaps *caps = gst_caps_copy (gst_static_caps_get (&my_caps)); - - ... - } - - - -If you want to check if a link between source and destination caps -is always possible, use gst_caps_is_always_compatible(), which returns -a boolean. -If you want to check if a link between source and destination caps -might be possible, use gst_caps_intersect(), which returns an intersection -of the capabilities. -#GstStructure, #GstPad + - + -The GType of the caps boxed type, for use in GValues. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@caps: + + + + + + + +@caps: + + + + + + + +@string: +@caps: + + + + + + + +@string: + + -The gstcaps structure + @type: @@ -114,6 +92,62 @@ The gstcaps structure @structs: @_gst_reserved: + + + + + +@caps: +@string: +@_gst_reserved: + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@media_type: +@fieldname: +@Varargs: +@Returns: + + + + + + + +@struct1: +@Varargs: +@Returns: + + + + + + + +@structure: +@var_args: +@Returns: + + @@ -123,7 +157,15 @@ The gstcaps structure @Returns: - + + + + + +@caps: + + + @@ -139,21 +181,118 @@ The gstcaps structure @caps1: @caps2: - -@caps: -@capstoadd: -@Returns: - + + + + + +@caps1: +@structure: + + + @caps: -@newcaps: - -@oldcaps: +@Returns: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps: +@index: +@Returns: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps: +@field: +@Varargs: + + + + + + + +@caps: +@field: +@varargs: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps: +@Returns: + + + + + + + +@caps1: +@caps2: +@Returns: @@ -164,9 +303,26 @@ The gstcaps structure @caps1: @caps2: @Returns: - -@fromcaps: -@tocaps: + + + + + + + +@caps1: +@caps2: +@Returns: + + + + + + + +@caps1: +@caps2: +@Returns: @@ -178,13 +334,12 @@ The gstcaps structure @Returns: - + -@caps1: -@caps2: +@caps: @Returns: @@ -207,13 +362,52 @@ The gstcaps structure @Returns: - + -@caps1: -@caps2: +@caps: +@newcaps: + + + + + + + +@caps: +@Returns: + + + + + + + +@string: +@Returns: + + + + + + + +@structure: +@field_name: +@target: +@Returns: + + + + + + + +@structure: +@field_name: +@target: @Returns: diff --git a/docs/gst/tmpl/gstclock.sgml b/docs/gst/tmpl/gstclock.sgml index 998e6b9079..a8ba95c7f0 100644 --- a/docs/gst/tmpl/gstclock.sgml +++ b/docs/gst/tmpl/gstclock.sgml @@ -46,6 +46,14 @@ Constant to define an undefined clock time + + + + + +@time: + + Constant that defines one GStreamer second @@ -100,6 +108,13 @@ Convert a GstClockTime to a GTimeVal @tv: The target timeval + + +The name used for tracing clock entry allocations. + + + + All pending timeouts or periodic notifies are converted into @@ -143,13 +158,6 @@ The type of the clock entry @GST_CLOCK_ENTRY_SINGLE: a single shot timeout @GST_CLOCK_ENTRY_PERIODIC: a periodic timeout request - - -The name used for tracing clock entry allocations. - - - - Cast to a clock entry @@ -229,12 +237,6 @@ Get the clock flags @clock: the clock to query - - - - - - @@ -318,6 +320,15 @@ Get the clock flags @Returns: + + + + + +@clock: +@Returns: + + diff --git a/docs/gst/tmpl/gstcompat.sgml b/docs/gst/tmpl/gstcompat.sgml index 551a87881b..df902215df 100644 --- a/docs/gst/tmpl/gstcompat.sgml +++ b/docs/gst/tmpl/gstcompat.sgml @@ -14,3 +14,137 @@ gstcompat + + + + + +@a: +@b: + + + + + + + +@a: +@b: +@c: +@d: + + + + + + + +@a: +@...: + + + + + + + +@a: +@b: +@c: + + + + + + + +@a: +@b: + + + + + + + +@a: +@b: + + + + + + + +@a: +@b: +@c: + + + + + + + +@a: +@b: + + + + + + + +@a: +@b: + + + + + + + +@a: +@b: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstconfig.sgml b/docs/gst/tmpl/gstconfig.sgml index 650cc595a8..99d7425611 100644 --- a/docs/gst/tmpl/gstconfig.sgml +++ b/docs/gst/tmpl/gstconfig.sgml @@ -2,7 +2,7 @@ GstConfig -configuration options +Configuration options @@ -37,14 +37,7 @@ If a subsystem is disabled in GStreamer, a value is defined in - - - - - - - - + @@ -59,13 +52,6 @@ If this is defined, the debugging subsystem - - - - - - - @@ -73,13 +59,6 @@ If this is defined, the debugging subsystem - - - - - - - @@ -87,13 +66,6 @@ If this is defined, the debugging subsystem - - - - - - - @@ -101,7 +73,7 @@ If this is defined, the debugging subsystem - + @@ -115,3 +87,38 @@ If this is defined, the debugging subsystem + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstcpu.sgml b/docs/gst/tmpl/gstcpu.sgml index d04c682789..d374782ab5 100644 --- a/docs/gst/tmpl/gstcpu.sgml +++ b/docs/gst/tmpl/gstcpu.sgml @@ -2,8 +2,7 @@ GstCpu - -Request the features of the CPU. +Descripe CPU features diff --git a/docs/gst/tmpl/gstdata.sgml b/docs/gst/tmpl/gstdata.sgml index c188d43043..1b5673e240 100644 --- a/docs/gst/tmpl/gstdata.sgml +++ b/docs/gst/tmpl/gstdata.sgml @@ -2,7 +2,7 @@ GstData -Common structure for GstBuffer, GstBufferPool, and GstEvent +Abstract structure for information that is passed among elements @@ -48,24 +48,6 @@ Shift a given flag so that it can be used in an or operation @flag: The flag to shift - - -Check if a given flag is set on the data - - -@data: The data to check -@flag: The flag to check for - - - - -Set the flag on the data - - -@data: The data to set the flag on -@flag: The flag to set - - Unset the given flag @@ -75,6 +57,13 @@ Unset the given flag @flag: The flag to unset + + + + + + + The base structure @@ -184,6 +173,15 @@ Get access to the free function of the data @Returns: + + + + + +@data: +@Returns: + + diff --git a/docs/gst/tmpl/gstdata_private.sgml b/docs/gst/tmpl/gstdata_private.sgml new file mode 100644 index 0000000000..784955c0e2 --- /dev/null +++ b/docs/gst/tmpl/gstdata_private.sgml @@ -0,0 +1,16 @@ + +gstdata_private + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index 4b966d9156..67ee4912f1 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -2,7 +2,7 @@ GstElement -Base class for all pipeline elements +Abstract base class for all pipeline elements @@ -65,11 +65,330 @@ and gst_element_set_clock(). You can wait for the clock to reach a given - + -The element object +This struct is used to define public information about the element. It +describes the element, mostly for the benefit of editors. +@longname: +@klass: +@description: +@author: +@_gst_reserved: + + + + + + +@longname: +@klass: +@description: +@author: + + + + + + + +@details: + + + + +The maximun number of states. + + + + + + +This macro returns the current state of the element. + + +@obj: Element to return state for. + + + + +This macro returns the currently pending state of the element. + + +@obj: Element to return the pending state for. + + + + +Returns the state transition this object is going through. + + +@obj: the Element to return the state transition for + + + + +The Element is going from the NULL state to the READY state. + + + + + + +The Element is going from the READY state to the PAUSED state. + + + + + + +The Element is going from the PAUSED state to the PLAYING state. + + + + + + +The Element is going from the PLAYING state to the PAUSED state. + + + + + + +The Element is going from the PAUSED state to the READY state. + + + + + + +The Element is going from the READY state to the NULL state. + + + + + + + + + +@klass: + + + + +Helper macro to create query type functions + + +@functionname: The function name +@...: list of query types. + + + + +Halper macro to create element format functions + + +@functionname: The function name +@...: formats + + + + +A helper macro to create a mask function + + +@functionname: the name of the mask function +@...: Masks + + + + +This enum defines the standard flags that an element may have. + + +@GST_ELEMENT_COMPLEX: +@GST_ELEMENT_DECOUPLED: +@GST_ELEMENT_THREAD_SUGGESTED: +@GST_ELEMENT_INFINITE_LOOP: +@GST_ELEMENT_NEW_LOOPFUNC: +@GST_ELEMENT_EVENT_AWARE: +@GST_ELEMENT_USE_THREADSAFE_PROPERTIES: +@GST_ELEMENT_SCHEDULER_PRIVATE1: +@GST_ELEMENT_SCHEDULER_PRIVATE2: +@GST_ELEMENT_LOCKED_STATE: +@GST_ELEMENT_IN_ERROR: +@GST_ELEMENT_FLAG_LAST: + + + +Queries whether the Element should be placed in a thread. + + +@obj: a #GstElement to query + + + + +Query wether this element can handle events. + + +@obj: a #GstElement to query + + + + +Queries if the Element is decoupled. + + +@obj: a #GstElement to query + + + + +Gets the name of this element. Used in the core. Not ABI-compatible. + + +@obj: A #GstElement to query + + + + +Get the parent object of this element. + + +@obj: a #GstElement to query + + + + +Get the manager of this element. + + +@obj: a #GstElement to query + + + + +Get the scheduler of this element. + + +@obj: a #GstElement to query + + + + +Get the clock of this element + + +@obj: a #GstElement to query + + + + +Get the pads of this elements. + + +@obj: a #GstElement to query + + + + + + + +@el: +@domain: +@code: +@message: +@debug: + + + + +This function type is used to specify a loop function for the element. It +is passed the element in question, and is expect to return only in error +circumstances. + + +@element: The element in question. + + + + +The signature of the function to execute after this element +is scheduled. + + +@element: The element + + + + +The signature of the function to execute before this element +is scheduled. + + +@element: The element + + + + + + + +@klass: +@templ: + + + + + + + +@klass: +@first_name: +@Varargs: + + + + + + + +@klass: +@details: + + + + +The default deep notify handler that prints out the property change +notifications to stdout. + + + + + + + + + +@object: +@orig: +@error: +@debug: + + + + + + + +@element: +@loop: + @@ -92,7 +411,258 @@ Sets the name of the element, getting rid of the old name if there was one. @name: the new name of the element. - + + +Gets the parent of an element. + + +@elem: a #GstElement to get the parent of. +@Returns: the #GstObject parent of the element. + + + + +Sets the parent of an element. + + +@elem: a #GstElement to set the parent of. +@parent: the new #GstObject parent of the object. + + + + + + + +@element: +@first_property_name: +@Varargs: + + + + + + + +@element: +@first_property_name: +@Varargs: + + + + + + + +@element: +@first_property_name: +@var_args: + + + + + + + +@element: +@first_property_name: +@var_args: + + + + + + + +@element: +@property_name: +@value: + + + + + + + +@element: +@property_name: +@value: + + + + + + + +@element: + + + + + + + +@element: + + + + + + + +@element: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@clock: + + + + + + + +@element: +@id: +@jitter: +@Returns: + +@clock: +@time: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@timestamp: +@Returns: + + + + + + + +@element: +@time: + + + + + + + +@element: +@diff: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@index: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + +@element: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@sched: + + + @@ -190,6 +760,46 @@ Sets the name of the element, getting rid of the old name if there was one. @Returns: + + + + + +@element: +@pad: +@Returns: + + + + + + + +@element: +@pad: +@filtercaps: +@Returns: + + + + + + + +@element_class: +@name: +@Returns: + + + + + + + +@element_class: +@Returns: + + @@ -213,13 +823,14 @@ Sets the name of the element, getting rid of the old name if there was one. - + -@klass: -@templ: +@element: +@compattempl: +@Returns: @@ -254,6 +865,25 @@ Sets the name of the element, getting rid of the old name if there was one. @Returns: + + + + + +@src: +@dest: + + + + + + + +@element_1: +@element_2: +@Varargs: + + @@ -279,25 +909,6 @@ Sets the name of the element, getting rid of the old name if there was one. @Returns: - - - - - -@src: -@dest: - - - - - - - -@element_1: -@element_2: -@Varargs: - - @@ -312,48 +923,7 @@ Sets the name of the element, getting rid of the old name if there was one. - - - - - -@element: -@pad: -@Returns: - - - - - - - -@element: -@pad: -@filtercaps: -@Returns: - - - - - - - -@element: -@compattempl: -@Returns: - - - - - - - -@element: -@state: -@Returns: - - - + @@ -362,32 +932,28 @@ Sets the name of the element, getting rid of the old name if there was one. @Returns: - + -@state: +@element: +@event: @Returns: - + @element: +@seek_type: +@offset: +@Returns: - - - - - -@element: - - - + @@ -396,268 +962,6 @@ Sets the name of the element, getting rid of the old name if there was one. @Returns: - - - - - -@element: - - - - - - - -@element: -@Returns: - - - - - - - -@element: -@Returns: - - - - - - - -@element: -@clock: - - - - - - - -@element: -@id: -@jitter: -@Returns: - -@clock: -@time: - - - - - - - -@element: -@Returns: - - - - - - - -@element: -@Returns: - - - - - - - -@element: -@index: - - - - - - - -@element: -@Returns: - - - - - - - -@element: -@Returns: - - - - - - - -@element: -@loop: - - - - -This function type is used to specify a loop function for the element. It -is passed the element in question, and is expect to return only in error -circumstances. - - -@element: The element in question. - - - - - - - -@element: -@Returns: - - - - - - - -@element: -@sched: - - - - -Gets the parent of an element. - - -@elem: a #GstElement to get the parent of. -@Returns: the #GstObject parent of the element. - - - - -Sets the parent of an element. - - -@elem: a #GstElement to set the parent of. -@parent: the new #GstObject parent of the object. - - - - - - - -@element: -@Returns: - - - - - - -The signature of the function to execute before this element -is scheduled. - - -@element: The element - - - - -The signature of the function to execute after this element -is scheduled. - - -@element: The element - - - - - - - -@element: - - - - - - - -@element: - - - - - - - -@element: -@first_property_name: -@Varargs: - - - - - - - -@element: -@property_name: -@value: - - - - - - - -@element: -@first_property_name: -@var_args: - - - - - - - -@element: -@first_property_name: -@Varargs: - - - - - - - -@element: - - - - - - - -@element: -@property_name: -@value: - - - - - - - -@element: -@first_property_name: -@var_args: - - @@ -670,25 +974,6 @@ is scheduled. @Returns: - - - - - -@element: -@event: -@Returns: - - - - - - - -@element: -@Returns: - - @@ -698,15 +983,6 @@ is scheduled. @Returns: - - - - - -@element: -@Returns: - - @@ -720,250 +996,319 @@ is scheduled. @Returns: - - -The default deep notify handler that prints out the property change -notifications to stdout. - - - - - + -@object: -@orig: -@error: -@debug: +@element: +@tag_list: - + -@el: +@element: +@pad: +@timestamp: +@list: + + + + + + + +@element: + + + + + + + +@element: @domain: @code: @message: @debug: +@file: +@function: +@line: - + -This enum defines the standard states an element may be in. You will normally -use gst_element_set_state() to change the state of an element. -@GST_STATE_VOID_PENDING: -@GST_STATE_NULL: Reset the state of an element. -@GST_STATE_READY: will make the element ready to start processing data. some -elements might have a non trivial way to initialize themselves. -@GST_STATE_PAUSED: means there really is data flowing temporary stops the data flow. -@GST_STATE_PLAYING: means there really is data flowing through the graph. +@element: +@Returns: - + + -This enum defines the standard return values that an element -can return after a state change. -@GST_STATE_FAILURE: the element could not perform the state change -@GST_STATE_SUCCESS: the element successfully changed its state -@GST_STATE_ASYNC: the element will asynchronously change its state as soon as possible +@element: +@locked_state: - + + -The maximun number of states. + + + +@element: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@state: +@Returns: + + + + + + + +@element: + + + + + + + +@state: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + - + -This macro returns the current state of the element. + -@obj: Element to return state for. +@obj: - + -This macro returns the currently pending state of the element. + -@obj: Element to return the pending state for. +@klass: - + -Returns the state transition this object is going through. + -@obj: the Element to return the state transition for +@obj: - + -The Element is going from the NULL state to the READY state. + +@klass: - + -The Element is going from the READY state to the PAUSED state. + +@Returns: - + -The Element is going from the PAUSED state to the READY state. + +@plugin: +@elementname: +@rank: +@type: +@Returns: - + -The Element is going from the PLAYING state to the PAUSED state. + +@name: +@Returns: - + -The Element is going from the PAUSED state to the PLAYING state. + +@factory: +@Returns: - + -The Element is going from the READY state to the NULL state. + +@factory: +@Returns: - + -This enum defines the standard flags that an element may have. + -@GST_ELEMENT_COMPLEX: -@GST_ELEMENT_DECOUPLED: -@GST_ELEMENT_THREAD_SUGGESTED: -@GST_ELEMENT_INFINITE_LOOP: -@GST_ELEMENT_NEW_LOOPFUNC: -@GST_ELEMENT_EVENT_AWARE: -@GST_ELEMENT_USE_THREADSAFE_PROPERTIES: -@GST_ELEMENT_SCHEDULER_PRIVATE1: -@GST_ELEMENT_SCHEDULER_PRIVATE2: -@GST_ELEMENT_LOCKED_STATE: -@GST_ELEMENT_IN_ERROR: -@GST_ELEMENT_FLAG_LAST: +@factory: +@Returns: - + + -Queries whether the Element should be placed in a thread. + -@obj: a #GstElement to query +@factory: +@Returns: - + -Queries if the Element is decoupled. + -@obj: a #GstElement to query +@factory: +@Returns: - + -Query wether this element can handle events. + -@obj: a #GstElement to query +@factory: +@Returns: - + -Get the parent object of this element. + -@obj: a #GstElement to query +@factory: +@Returns: - + -Gets the name of this element. Used in the core. Not ABI-compatible. + -@obj: A #GstElement to query +@factory: +@Returns: - + -Get the pads of this elements. + -@obj: a #GstElement to query +@factory: +@Returns: - + -Get the scheduler of this element. + -@obj: a #GstElement to query +@factory: +@name: +@Returns: - + -Get the manager of this element. + -@obj: a #GstElement to query +@factoryname: +@name: +@Returns: - + -Get the clock of this element + -@obj: a #GstElement to query +@factory: +@caps: +@Returns: - + -A helper macro to create a mask function + -@functionname: the name of the mask function -@...: Masks - - - - -Halper macro to create element format functions - - -@functionname: The function name -@...: formats - - - - -Helper macro to create query type functions - - -@functionname: The function name -@...: list of query types. +@factory: +@caps: +@Returns: diff --git a/docs/gst/tmpl/gstenumtypes.sgml b/docs/gst/tmpl/gstenumtypes.sgml new file mode 100644 index 0000000000..1cd3b59858 --- /dev/null +++ b/docs/gst/tmpl/gstenumtypes.sgml @@ -0,0 +1,736 @@ + +gstenumtypes + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + + + diff --git a/docs/gst/tmpl/gsterror.sgml b/docs/gst/tmpl/gsterror.sgml index dbe03e119b..369c59113c 100644 --- a/docs/gst/tmpl/gsterror.sgml +++ b/docs/gst/tmpl/gsterror.sgml @@ -2,7 +2,7 @@ GstError - +Categorized error messages @@ -33,3 +33,146 @@ GstError @GST_CORE_ERROR_TAG: @GST_CORE_ERROR_NUM_ERRORS: + + + + + +@GST_LIBRARY_ERROR_FAILED: +@GST_LIBRARY_ERROR_TOO_LAZY: +@GST_LIBRARY_ERROR_INIT: +@GST_LIBRARY_ERROR_SHUTDOWN: +@GST_LIBRARY_ERROR_SETTINGS: +@GST_LIBRARY_ERROR_ENCODE: +@GST_LIBRARY_ERROR_NUM_ERRORS: + + + + + + +@GST_RESOURCE_ERROR_FAILED: +@GST_RESOURCE_ERROR_TOO_LAZY: +@GST_RESOURCE_ERROR_NOT_FOUND: +@GST_RESOURCE_ERROR_BUSY: +@GST_RESOURCE_ERROR_OPEN_READ: +@GST_RESOURCE_ERROR_OPEN_WRITE: +@GST_RESOURCE_ERROR_OPEN_READ_WRITE: +@GST_RESOURCE_ERROR_CLOSE: +@GST_RESOURCE_ERROR_READ: +@GST_RESOURCE_ERROR_WRITE: +@GST_RESOURCE_ERROR_SEEK: +@GST_RESOURCE_ERROR_SYNC: +@GST_RESOURCE_ERROR_SETTINGS: +@GST_RESOURCE_ERROR_NUM_ERRORS: + + + + + + +@GST_STREAM_ERROR_FAILED: +@GST_STREAM_ERROR_TOO_LAZY: +@GST_STREAM_ERROR_NOT_IMPLEMENTED: +@GST_STREAM_ERROR_TYPE_NOT_FOUND: +@GST_STREAM_ERROR_WRONG_TYPE: +@GST_STREAM_ERROR_CODEC_NOT_FOUND: +@GST_STREAM_ERROR_DECODE: +@GST_STREAM_ERROR_ENCODE: +@GST_STREAM_ERROR_DEMUX: +@GST_STREAM_ERROR_MUX: +@GST_STREAM_ERROR_FORMAT: +@GST_STREAM_ERROR_NUM_ERRORS: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@domain: +@code: +@Returns: + + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@Returns: + + diff --git a/docs/gst/tmpl/gstevent.sgml b/docs/gst/tmpl/gstevent.sgml index 11467fecd0..7f5b255d63 100644 --- a/docs/gst/tmpl/gstevent.sgml +++ b/docs/gst/tmpl/gstevent.sgml @@ -2,7 +2,7 @@ GstEvent -Event definitions. +Structure describing events that are passed up and down a pipeline @@ -50,6 +50,13 @@ The different major types of events. @GST_EVENT_NAVIGATION: @GST_EVENT_TAG: + + +The name used for memory allocation tracing + + + + Get the event type. @@ -58,6 +65,14 @@ Get the event type. @event: The event to query. + + +Get the timestamp of the event. + + +@event: The event to query. + + The source object that generated this event @@ -66,12 +81,54 @@ The source object that generated this event @event: The event to query - + -Get the timestamp of the event. +Check if the event is an interrupt event + + +@event: The event to check + + + + +Shift for the format in the GstSeekType + + + + + + +Shift for the method in the GstSeekType + + + + + + +Shift for the flags in the GstSeekType + + + + + + +Mask for the format in the GstSeekType + + + + + + +Mask for the method in the GstSeekType + + + + + + +Mask for the flags in the GstSeekType -@event: The event to query. @@ -82,6 +139,16 @@ Event flags are used when querying for supported events @GST_EVENT_FLAG_NONE: no value @GST_RATE_FLAG_NEGATIVE: indicates negative rates are supported + + +A convenience macro to create event mask functions + + +@type: The type of the first argument of the function +@functionname: the name of the function +@...: event masks, the last element is marked with 0 + + The different types of seek events. When constructing a seek event a format, @@ -167,6 +234,14 @@ Get the offset of the seek event. @event: The event to query. + + +The event stop position for a segment seek + + +@event: The event to query + + Indicates how accurate the event was performed. @@ -175,48 +250,6 @@ Indicates how accurate the event was performed. @event: The event to query - - -Mask for the flags in the GstSeekType - - - - - - -Shift for the flags in the GstSeekType - - - - - - -Mask for the format in the GstSeekType - - - - - - -Shift for the format in the GstSeekType - - - - - - -Mask for the method in the GstSeekType - - - - - - -Shift for the method in the GstSeekType - - - - Flag that indicates the discont event was because of a new media @@ -244,22 +277,6 @@ Get the number of offset/value pairs this event has. @event: The event to query. - - -Get access to the rate vale field - - -@event: The event to query - - - - -The event stop position for a segment seek - - -@event: The event to query - - The format of the size event. @@ -276,24 +293,17 @@ The value of the size event @event: The event to query - + -Check if the event is an interrupt event - - -@event: The event to check - - - - -The name used for memory allocation tracing +Get access to the rate vale field +@event: The event to query -The event structure + @data: @@ -310,15 +320,6 @@ The event structure @Returns: - - -Copy the event using the event specific copy function - - -@ev: The event to copy -@Returns: A new event that is a copy of the given input event - - Increase the refcount of this event @@ -344,6 +345,25 @@ Decrease the refcount of an event, freeing it if the refcount reaches 0 @ev: The event to unref + + +Copy the event using the event specific copy function + + +@ev: The event to copy +@Returns: A new event that is a copy of the given input event + + + + + + + +@masks: +@mask: +@Returns: + + @@ -386,6 +406,17 @@ Decrease the refcount of an event, freeing it if the refcount reaches 0 @Returns: + + + + + +@new_media: +@format1: +@var_args: +@Returns: + + @@ -411,23 +442,3 @@ Create a new flush event. - - - - - -@masks: -@mask: -@Returns: - - - - -A convenience macro to create event mask functions - - -@type: The type of the first argument of the function -@functionname: the name of the function -@...: event masks, the last element is marked with 0 - - diff --git a/docs/gst/tmpl/gstfakesink.sgml b/docs/gst/tmpl/gstfakesink.sgml index 6e672957c9..aa46096821 100644 --- a/docs/gst/tmpl/gstfakesink.sgml +++ b/docs/gst/tmpl/gstfakesink.sgml @@ -16,6 +16,19 @@ with the buffer. (fakesink) + + + + + +@FAKESINK_STATE_ERROR_NONE: +@FAKESINK_STATE_ERROR_NULL_READY: +@FAKESINK_STATE_ERROR_READY_PAUSED: +@FAKESINK_STATE_ERROR_PAUSED_PLAYING: +@FAKESINK_STATE_ERROR_PLAYING_PAUSED: +@FAKESINK_STATE_ERROR_PAUSED_READY: +@FAKESINK_STATE_ERROR_READY_NULL: + diff --git a/docs/gst/tmpl/gstfakesrc.sgml b/docs/gst/tmpl/gstfakesrc.sgml index afabed4d76..23d8b87040 100644 --- a/docs/gst/tmpl/gstfakesrc.sgml +++ b/docs/gst/tmpl/gstfakesrc.sgml @@ -35,7 +35,6 @@ The GstFakeSrc generates empty buffers. (fakesrc) @FAKESRC_DATA_ALLOCATE: @FAKESRC_DATA_SUBBUFFER: -@FAKESRC_DATA_BUFFERPOOL: diff --git a/docs/gst/tmpl/gstfilesink.sgml b/docs/gst/tmpl/gstfilesink.sgml new file mode 100644 index 0000000000..f0051a8866 --- /dev/null +++ b/docs/gst/tmpl/gstfilesink.sgml @@ -0,0 +1,24 @@ + +GstFileSink + + + + + + + + + + + + + + + + + + + +@GST_FILESINK_OPEN: +@GST_FILESINK_FLAG_LAST: + diff --git a/docs/gst/tmpl/gstfilter.sgml b/docs/gst/tmpl/gstfilter.sgml new file mode 100644 index 0000000000..8f5a2fea6f --- /dev/null +++ b/docs/gst/tmpl/gstfilter.sgml @@ -0,0 +1,41 @@ + +GstFilter + + +Take data in and spit data out + + + +Filters take data in and spit data out. They are the main Element in a filter graph. +Filters have zero or more inputs and zero or more outputs. Filters are linked +together to form filter graphs. A GstFilter is the base class and is not very usefull +on its own. + + + + + + + + + + + + +@obj: +@user_data: +@Returns: + + + + + + + +@list: +@func: +@first: +@user_data: +@Returns: + + diff --git a/docs/gst/tmpl/gstindex.sgml b/docs/gst/tmpl/gstindex.sgml index d828fa3114..b90e080dbc 100644 --- a/docs/gst/tmpl/gstindex.sgml +++ b/docs/gst/tmpl/gstindex.sgml @@ -15,6 +15,13 @@ in a pipeline. #GstIndexFactory + + + + + + + The basic element of an index. @@ -61,38 +68,6 @@ Specify the method to find an index entry in the index. @GST_INDEX_LOOKUP_BEFORE: The exact entry or the one before it @GST_INDEX_LOOKUP_AFTER: The exact entry or the one after it - - -Flags for this index - - -@GST_INDEX_WRITABLE: The index is writable -@GST_INDEX_READABLE: The index is readable -@GST_INDEX_FLAG_LAST: First flag that can be used by subclasses - - - -An invalid index id - - - - - - -Check if the index can be read from - - -@obj: The index to check - - - - -Check if the index can be written to - - -@obj: The index to check - - Get the number of associations in the entry. @@ -161,6 +136,13 @@ Get the key of the format entry @entry: The entry to query + + +An invalid index id + + + + Get the description of the id entry @@ -180,6 +162,15 @@ Function to filter out entries in the index. to the index, FALSE otherwise. + + +The method used to resolve index writers + + +@GST_INDEX_RESOLVER_CUSTOM: Use a custom resolver +@GST_INDEX_RESOLVER_GTYPE: Resolve based on the GType of the object +@GST_INDEX_RESOLVER_PATH: Resolve on the path in graph + Function to resolve ids to writer descriptions. @@ -194,20 +185,30 @@ Function to resolve ids to writer descriptions. @writer_id: A pointer to the id that has to be assigned to this writer - + -The method used to resolve index writers +Flags for this index -@GST_INDEX_RESOLVER_CUSTOM: Use a custom resolver -@GST_INDEX_RESOLVER_GTYPE: Resolve based on the GType of the object -@GST_INDEX_RESOLVER_PATH: Resolve on the path in graph +@GST_INDEX_WRITABLE: The index is writable +@GST_INDEX_READABLE: The index is readable +@GST_INDEX_FLAG_LAST: First flag that can be used by subclasses - + -The GstIndex object +Check if the index can be read from +@obj: The index to check + + + + +Check if the index can be written to + + +@obj: The index to check + @@ -217,6 +218,15 @@ The GstIndex object @Returns: + + + + + +@index: +@id: + + @@ -373,6 +383,23 @@ The GstIndex object @Returns: + + + + + +@Returns: + + + + + + + +@entry: +@Returns: + + @@ -392,13 +419,105 @@ The GstIndex object @Returns: - + -@index: -@id: + + + + + + + +@obj: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@Returns: + + + + + + + +@name: +@longdesc: +@type: +@Returns: + + + + + + + +@factory: + + + + + + + +@name: +@Returns: + + + + + + + +@factory: +@Returns: + + + + + + + +@name: +@Returns: diff --git a/docs/gst/tmpl/gstinfo.sgml b/docs/gst/tmpl/gstinfo.sgml index 3ae7489d62..8461b4895f 100644 --- a/docs/gst/tmpl/gstinfo.sgml +++ b/docs/gst/tmpl/gstinfo.sgml @@ -2,7 +2,7 @@ GstInfo -debugging subsystem +Debugging and logging @@ -68,37 +68,6 @@ categories. These are explained at GST_DEBUG_CATEGORY_INIT(). and environment variables that affect the debugging output. - - -Macro to use when a string must not be NULL, but may be NULL. If the string is -NULL, "(NULL)" is printed instead. -In GStreamer printf string arguments may not be NULL, because on some platforms -(ie Solaris) the libc crashes in that case. This includes debugging strings. - - -@str: The string to check. -@Returns: A string that is guaranteed to be not NULL. - - - - -Evaluates to 2 strings, that describe the pad. Often used in debugging -statements. - - -@pad: The pad to debug. - - - - -This macro should evaluate to the name of the current function and be should -be defined when configuring your project, as it is compiler dependant. If it -is not defined, some default value is used. It is used to provide debugging -output with the function name of the message. - - - - The level defines the importance of a debugging message. The more important a @@ -141,15 +110,6 @@ reset the debugging output to default behaviour. - - - - - -@level: -@Returns: - - These are some terminal-oriented flags you can use when creating your debugging @@ -175,13 +135,25 @@ categories to make them stand out in debugging output. @GST_DEBUG_BOLD: Make the output bold. @GST_DEBUG_UNDERLINE: Underline the output. - + + + + + + + + + + + + + + + -@colorinfo: -@Returns: @@ -191,15 +163,40 @@ This is the struct that describes the categories. Once initialized with - + -The default category that is used when no other category is defined as the -default. If you want to define a default category, do it like this: - - -&hash;define GST_CAT_DEFAULT category_to_be_default - - +Macro to use when a string must not be NULL, but may be NULL. If the string is +NULL, "(NULL)" is printed instead. +In GStreamer printf string arguments may not be NULL, because on some platforms +(ie Solaris) the libc crashes in that case. This includes debugging strings. + + +@str: The string to check. +@Returns: A string that is guaranteed to be not NULL. + + + + +Evaluates to 2 strings, that describe the pad. Often used in debugging +statements. + + +@pad: The pad to debug. + + + + +This macro should evaluate to the name of the current function and be should +be defined when configuring your project, as it is compiler dependant. If it +is not defined, some default value is used. It is used to provide debugging +output with the function name of the message. + + + + + + + @@ -233,6 +230,30 @@ default. If you want to define a default category, do it like this: @Varargs: + + + + + +@category: +@level: +@file: +@function: +@line: +@object: +@format: +@args: + + + + + + + +@message: +@Returns: + + @@ -248,6 +269,15 @@ default. If you want to define a default category, do it like this: @unused: + + + + + +@level: +@Returns: + + @@ -444,6 +474,27 @@ default. If you want to define a default category, do it like this: @Returns: + + + + + +@colorinfo: +@Returns: + + + + +The default category that is used when no other category is defined as the +default. If you want to define a default category, do it like this: + + +&hash;define GST_CAT_DEFAULT category_to_be_default + + + + + GST_CAT_LEVEL_LOG: @@ -458,22 +509,6 @@ below. @...: A printf-style message to output - - -Output an informational message in the default category. - - -@...: printf-style message to output - - - - -Output a debugging message in the default category. - - -@...: printf-style message to output - - Output an error message belonging to the given object in the given category. @@ -543,6 +578,24 @@ Output a warning message in the given category. @...: printf-style message to output + + +Output an informational message in the given category. + + +@cat: category to use +@...: printf-style message to output + + + + +Output a debuggign message in the given category. + + +@cat: category to use +@...: printf-style message to output + + Output a logging message in the given category. @@ -615,21 +668,19 @@ Output a warning message in the default category. @...: printf-style message to output - + -Output an informational message in the given category. +Output an informational message in the default category. -@cat: category to use @...: printf-style message to output - + -Output a debuggign message in the given category. +Output a debugging message in the default category. -@cat: category to use @...: printf-style message to output @@ -641,6 +692,58 @@ Output a logging message in the default category. @...: printf-style message to output + + + + + +@cat: +@obj: +@...: + + + + + + + +@cat: +@obj: +@...: + + + + + + + +@...: + + + + + + + +@...: + + + + + + + +@...: + + + + + + + +@...: + + Register a pointer to a function with its name, so it can later be used by @@ -666,3 +769,44 @@ Make sure you free the string after use. Returns: The name of the function + + + + + +@func: +@data: + + + + + + + +@void: + + + + + + + +@name: +@level: + + + + + + + +@name: + + + + + + + + + diff --git a/docs/gst/tmpl/gstinterface.sgml b/docs/gst/tmpl/gstinterface.sgml index 9bce3c376f..10754ef77f 100644 --- a/docs/gst/tmpl/gstinterface.sgml +++ b/docs/gst/tmpl/gstinterface.sgml @@ -2,7 +2,7 @@ GstInterface - +Core interfaces implemented by #GstElements @@ -14,6 +14,31 @@ GstInterface + + + + + + + + + + + +@obj: +@type: +@cast_t: + + + + + + + +@obj: +@type: + + diff --git a/docs/gst/tmpl/gstlog.sgml b/docs/gst/tmpl/gstlog.sgml index 7605b29b32..3f619613e5 100644 --- a/docs/gst/tmpl/gstlog.sgml +++ b/docs/gst/tmpl/gstlog.sgml @@ -14,3 +14,27 @@ gstlog + + +The variable that holds the GStreamer log domain + + + + + + + + + + + + + + + +@...: + +@format: +@args...: + + diff --git a/docs/gst/tmpl/gstmacros.sgml b/docs/gst/tmpl/gstmacros.sgml new file mode 100644 index 0000000000..6617bc2f04 --- /dev/null +++ b/docs/gst/tmpl/gstmacros.sgml @@ -0,0 +1,37 @@ + +gstmacros + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstmarshal.sgml b/docs/gst/tmpl/gstmarshal.sgml new file mode 100644 index 0000000000..31c8588cfb --- /dev/null +++ b/docs/gst/tmpl/gstmarshal.sgml @@ -0,0 +1,241 @@ + +gstmarshal + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + + + + + + + + + + + + + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + + + + + + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + + + + + + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + + + + + + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + + + + + + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + + + + + + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + + + + + + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + + + + + + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + + + + + + + + + + + + + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + + + + + + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + + + + + + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + + + + + + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + diff --git a/docs/gst/tmpl/gstmd5sink.sgml b/docs/gst/tmpl/gstmd5sink.sgml new file mode 100644 index 0000000000..944ef7a3de --- /dev/null +++ b/docs/gst/tmpl/gstmd5sink.sgml @@ -0,0 +1,25 @@ + +GstMD5Sink + + + + + + + + + + + + + + + + + + + +@factory: +@Returns: + + diff --git a/docs/gst/tmpl/gstmultifilesrc.sgml b/docs/gst/tmpl/gstmultifilesrc.sgml new file mode 100644 index 0000000000..1ee29c961f --- /dev/null +++ b/docs/gst/tmpl/gstmultifilesrc.sgml @@ -0,0 +1,24 @@ + +GstMultiFileSrc + + + + + + + + + + + + + + + + + + + +@GST_MULTIFILESRC_OPEN: +@GST_MULTIFILESRC_FLAG_LAST: + diff --git a/docs/gst/tmpl/gstobject.sgml b/docs/gst/tmpl/gstobject.sgml index 52616a2215..2ecbb414f2 100644 --- a/docs/gst/tmpl/gstobject.sgml +++ b/docs/gst/tmpl/gstobject.sgml @@ -2,7 +2,7 @@ GstObject -Basis for the GST object hierarchy. +Base class for the GStreamer object hierarchy @@ -25,6 +25,21 @@ object. + + + + + +@klass: + + + + + + + + + Flags for an object @@ -34,12 +49,6 @@ Flags for an object @GST_FLOATING: The object is created but has no parent yet to manage it @GST_OBJECT_FLAG_LAST: subclasses can add additional flags starting from this flag - - -The GstObject - - - This macro returns the entire set of flags for the object. @@ -75,6 +84,38 @@ This macro usets the given bits. @flag: Flag to set, must be a single bit in guint32. + + +Get the name of this object + + +@obj: Object to get the name of. + + + + +Get the parent of this object + + +@obj: Object to get the parent of. + + + + +Check if the object has been destroyed. + + +@obj: The Object to check + + + + +Check if the object is floating. + + +@obj: The Object to check + + This macro will obtain a lock on the object, making serialization @@ -109,45 +150,21 @@ Acquire a reference to the mutex of this object. @obj: Object to get the mutex of. - - -Get the parent of this object - - -@obj: Object to get the parent of. - - - - -Get the name of this object - - -@obj: Object to get the name of. - - - - -Check if the object is floating. - - -@obj: The Object to check - - - - -Check if the object has been destroyed. - - -@obj: The Object to check - - - + -@list: +@object: @name: + + + + + + + +@object: @Returns: @@ -169,24 +186,6 @@ Check if the object has been destroyed. @Returns: - - - - - -@object: -@name: - - - - - - - -@object: -@Returns: - - @@ -195,40 +194,27 @@ Check if the object has been destroyed. @object: - + -@object: the object +@object: +@orig: +@pspec: +@excluded_props: + + + + + + + +@list: +@name: @Returns: - - - - - -@object: the object - - - - - - - -@oldobj: -@newobj: - - - - - - - -@object: the object - - @@ -248,6 +234,40 @@ Check if the object has been destroyed. @self: + + + + + +@object: the object +@Returns: + + + + + + + +@object: the object + + + + + + + +@object: the object + + + + + + + +@oldobj: +@newobj: + + @@ -257,27 +277,6 @@ Check if the object has been destroyed. @Returns: - - - - - -@object: -@orig: -@pspec: -@excluded_props: - - - - - - - -@object: -@name: -@self: - - @@ -290,6 +289,16 @@ Check if the object has been destroyed. @Returns: + + + + + +@object: +@name: +@self: + + The deep notify signal is used to be notified of property changes. diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index 4d043c8f7e..91c38de364 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -2,7 +2,7 @@ GstPad -The link between Elements +Object contained by elements that allows links to other elements @@ -57,6 +57,366 @@ Last reviewed on December 13th, 2002 (0.5.0.1) #GstPadTemplate, #GstElement, #GstEvent + + + + + +@obj: + + + + + + + +@klass: + + + + + + + + + + + + + + +@obj: + + + + + + + +@obj: + + + + + + + +@klass: + +@obj: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + + + + + + + + +@obj: + + + + + + + +@obj: + + + + + + + +@klass: + +@obj: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@name_template: +@direction: +@presence: +@static_caps: + + + + + + + + + +The result of a pad link. + + +@GST_PAD_LINK_REFUSED: the link was refused. +@GST_PAD_LINK_DELAYED: the link was delayed, probably because the + element needs more specific pad capabilitiess. +@GST_PAD_LINK_OK: the link succeeded. +@GST_PAD_LINK_DONE: the link succeeded, + any more attempts are not needed. + + + + + + +@ret: + + + + + + + +@ret: + + + + +A convenience macro to construct query type functions + + +@functionname: the name of the function +@...: query types, 0 to mark the last element + + + + +Convenience function to define an array of formats that can be used +as #GstPadGetFormatsFunction. + + +@functionname: The name of the function +@...: comma separated list of formats, 0 to mark the end + + + + +Convenience function to define an array of event masks that can be used +as #GstPadGetEventMaskFunction. + + +@functionname: The name of the function +@...: comma separated list of event maks, { 0, } to mark the end + + + + +A function that will be called when chaining buffers. + + +@pad: the #GstPad that performed the chain. +@data: + +@buf: the #GstBuffer that is chained. + + + + +A function that will be called when pulling a buffer. + + +@pad: the #GstPad to get a buffer from. +@Returns: the #GstBuffer pulled. + + + + +Function signature to handle an event for the pad. + + +@pad: the #GstPad to handle the event. +@event: the #GstEvent to handle. +@Returns: TRUE if the pad could handle the event. + + + + +The signature of a convert function. + + +@pad: the #GstPad to perform the convert on. +@src_format: the source #GstFormat of the conversion. +@src_value: the source value of the conversion. +@dest_format: a pointer to the destination #GstFormat. +@dest_value: a pointer to the destination value. +@Returns: TRUE if the conversion could be performed. + + + + +The signature of the query function. + + +@pad: the #GstPad to query. +@type: the #GstPadQueryType. +@format: a pointer to the target #GstFormat. +@value: a pointer to the target value. +@Returns: TRUE if the query could be performed. + + + + +The signature of the internal pad link function. + + +@pad: The #GstPad to query. +@Returns: a newly allocated #GList of pads that are linked to + the given pad on the inside of the parent element. + The caller must call g_list_free() on it after use. + + + + +The signature of the formats function. + + +@pad: a #GstPad to query +@Returns: an array of formats + + + + +The signature of the eventmask function. + + +@pad: the #GstPad to query +@Returns: an array of event masks + + + + +The signature of the query types function. + + +@pad: a #GstPad to query +@Returns: an array of query types + + + + +Function signature to handle a new link on the pad. + + +@pad: the #GstPad that is linked. +@caps: the peer's #GstCaps. +@Returns: the result of the link with the specified caps. + + + + + + + +@pad: + + + + +Returns the capabilities of the specified pad. By default this function +will return the pad template capabilities, but can optionally be overridden. + + +@pad: the #GstPad to get the capabilities of. +@Returns: the #GstCaps of the pad. + +@caps: the peer's #GstCaps, can be used to filter the capabilities. + + + + + + + +@pad: +@caps: +@Returns: + + + + + + + +@pad: +@offset: +@size: +@Returns: + + + + +A dispatcher function is called for all internally linked pads, see +gst_pad_dispatcher(). + + +@pad: the #GstPad that is dispatched. +@data: the gpointer to optional user data. +@Returns: TRUE if the dispatching procedure has to be stopped. + + + + +The direction of a pad. + + +@GST_PAD_UNKNOWN: direction is unknown. +@GST_PAD_SRC: the pad is a source pad. +@GST_PAD_SINK: the pad is a sink pad. + + + +Flags for the pad. + + +@GST_PAD_DISABLED: the pad is disabled. +@GST_PAD_NEGOTIATING: +@GST_PAD_FLAG_LAST: subclasses can use this number to enumerate their flags. + Gets the name of the pad. @@ -66,15 +426,6 @@ Gets the name of the pad. @Returns: the pad's name. - - -Gets the private data set by the element that owns the pad. - - -@pad: a #GstPad to get the private data of. -#Returns: a gpointer to the private data. - - Gets the parent element of this pad. @@ -84,6 +435,15 @@ Gets the parent element of this pad. @Returns: the parent #GstElement of this pad. + + +Gets the private data set by the element that owns the pad. + + +@pad: a #GstPad to get the private data of. +#Returns: a gpointer to the private data. + + Gets the pad template that was used to create this pad. @@ -94,6 +454,198 @@ Gets the pad template that was used to create this pad. used. + + +Get the direction of the real pad. + + +@pad: the realpad to query. + + + + +Get the caps of the real pad. + + +@pad: the real pad to query. + + + + +Get the application filter for this pad + + +@pad: the pad to query + + + + +Get the peer element of the real pad. + + +@pad: the real pad to query. + + + + +Get the chain function of the real pad. + + +@pad: the real pad to query. + + + + +Get the eventhandler function from the real pad. + + +@pad: the real pad to query. + + + + +Get get getfunction of the real pad. + + +@pad: the real pad to query. + + + + +Get the gethandler function of this real pad. + + +@pad: the real pad to query. + + + + +Get the event function of this real pad. + + +@pad: the real pad to query. + + + + +Get the eventhandler function of this real pad. + + +@pad: the real pad to query. + + + + +Get the convert function of this pad + + +@pad: the pad to query + + + + +Get the query function of this pad + + +@pad: the pad to query + + + + +Get the internal link function of this pad + + +@pad: the pad to query + + + + +Get the formats function of this pad + + +@pad: the pad to query + + + + +Get the query types function of this pad + + +@pad: the pad to query + + + + +Get the event mask function of this pad + + +@pad: the pad to query + + + + +Get the link function of the pad + + +@pad: the pad to query + + + + + + + +@pad: + + + + +Get the getcaps function of this pad + + +@pad: the pad to query + + + + + + + +@pad: + + + + + + + +@pad: + + + + + + + +@pad: + + + + + + + +@pad: + + + + +Get the real pad of this ghost pad. + + +@pad: the real pad to query. + + Returns the real pad of this pad. @@ -131,30 +683,6 @@ element is linked through this pad. @Returns: the peer #GstPad. - - -Checks if buffers can be pulled from this buffer. - - -@pad: a #GstPad to check on if a buffer can be pulled from it. - - - - -Checks if the pad is a sink pad. - - -@pad: a #GstPad to check. - - - - -Checks if the pad is a source pad. - - -@pad: a #GstPad to check. - - Checks if the pad is linked. @@ -171,6 +699,14 @@ Checks if the pad is active. @pad: a #GstPad to check + + + + + +@pad: + + Checks if a pad is usable. A usable pad is both linked and active. @@ -179,197 +715,156 @@ Checks if a pad is usable. A usable pad is both linked and active. @pad: a #GstPad to check - + -The GstPad object +Checks if buffers can be pulled from this buffer. + + +@pad: a #GstPad to check on if a buffer can be pulled from it. + + + + +Checks if the pad is a source pad. + + +@pad: a #GstPad to check. + + + + +Checks if the pad is a sink pad. + + +@pad: a #GstPad to check. + + + + + - + + -A function that will be called when chaining buffers. + -@pad: the #GstPad that performed the chain. -@data: +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: -@buf: the #GstBuffer that is chained. +@obj: - + -A function that will be called when pulling a buffer. +Indicates when this pad will become available. -@pad: the #GstPad to get a buffer from. -@Returns: the #GstBuffer pulled. +@GST_PAD_ALWAYS: the pad is always available +@GST_PAD_SOMETIMES: the pad will become available depending on the media stream +@GST_PAD_REQUEST: th pad is only available on request with +gst_element_request_pad_by_name() or gst_element_request_compatible_pad(). - - + -Returns the capabilities of the specified pad. By default this function -will return the pad template capabilities, but can optionally be overridden. +Get the nametemplate of the padtemplate. -@pad: the #GstPad to get the capabilities of. -@Returns: the #GstCaps of the pad. - -@caps: the peer's #GstCaps, can be used to filter the capabilities. +@templ: the template to query - + -Function signature to handle an event for the pad. +Get the direction of the padtemplate. -@pad: the #GstPad to handle the event. -@event: the #GstEvent to handle. -@Returns: TRUE if the pad could handle the event. +@templ: the template to query - + -Function signature to handle a new link on the pad. +Get the presence of the padtemplate. -@pad: the #GstPad that is linked. -@caps: the peer's #GstCaps. -@Returns: the result of the link with the specified caps. +@templ: the template to query - + -The result of a pad link. +Get a handle to the padtemplate #GstCaps -@GST_PAD_LINK_REFUSED: the link was refused. -@GST_PAD_LINK_DELAYED: the link was delayed, probably because the - element needs more specific pad capabilitiess. -@GST_PAD_LINK_OK: the link succeeded. -@GST_PAD_LINK_DONE: the link succeeded, - any more attempts are not needed. +@templ: the template to query - + + -The signature of a convert function. +Flags for the padtemplate -@pad: the #GstPad to perform the convert on. -@src_format: the source #GstFormat of the conversion. -@src_value: the source value of the conversion. -@dest_format: a pointer to the destination #GstFormat. -@dest_value: a pointer to the destination value. -@Returns: TRUE if the conversion could be performed. +@GST_PAD_TEMPLATE_FIXED: The padtemplate has no variable properties +@GST_PAD_TEMPLATE_FLAG_LAST: first flag that can be used by subclasses. - - + -A dispatcher function is called for all internally linked pads, see -gst_pad_dispatcher(). +Check if the properties of the padtemplate are fixed -@pad: the #GstPad that is dispatched. -@data: the gpointer to optional user data. -@Returns: TRUE if the dispatching procedure has to be stopped. +@templ: the template to query - + -The signature of the internal pad link function. + -@pad: The #GstPad to query. -@Returns: a newly allocated #GList of pads that are linked to - the given pad on the inside of the parent element. - The caller must call g_list_free() on it after use. +@padname: +@dir: +@pres: +@caps: - + -The signature of the query function. + -@pad: the #GstPad to query. -@type: the #GstPadQueryType. -@format: a pointer to the target #GstFormat. -@value: a pointer to the target value. -@Returns: TRUE if the query could be performed. +@Returns: - + -The signature of the eventmask function. + -@pad: the #GstPad to query -@Returns: an array of event masks +@Returns: - - -The signature of the formats function. - - -@pad: a #GstPad to query -@Returns: an array of formats - - - - -The signature of the query types function. - - -@pad: a #GstPad to query -@Returns: an array of query types - - - - -A convenience macro to construct query type functions - - -@functionname: the name of the function -@...: query types, 0 to mark the last element - - - - -Convenience function to define an array of formats that can be used -as #GstPadGetFormatsFunction. - - -@functionname: The name of the function -@...: comma separated list of formats, 0 to mark the end - - - - -Convenience function to define an array of event masks that can be used -as #GstPadGetEventMaskFunction. - - -@functionname: The name of the function -@...: comma separated list of event maks, { 0, } to mark the end - - - - -The direction of a pad. - - -@GST_PAD_UNKNOWN: direction is unknown. -@GST_PAD_SRC: the pad is a source pad. -@GST_PAD_SINK: the pad is a sink pad. - - - -Flags for the pad. - - -@GST_PAD_DISABLED: the pad is disabled. -@GST_PAD_NEGOTIATING: -@GST_PAD_FLAG_LAST: subclasses can use this number to enumerate their flags. - @@ -380,6 +875,16 @@ Flags for the pad. @Returns: + + + + + +@templ: +@name: +@Returns: + + @@ -402,13 +907,21 @@ Flags for the pad. @Returns: - + -@templ: +@pad: @name: + + + + + + + +@pad: @Returns: @@ -421,81 +934,16 @@ Flags for the pad. @Returns: - + @pad: -@chain: +@active: - - - - - -@pad: -@get: - - - - - - - -@pad: -@link: - - - - - - - -@pad: -@getcaps: - - - - - - - -@pad: -@caps: -@Returns: - - - - - - - -@pad: -@Returns: - - - - - - - -@srcpad: -@sinkpad: -@Returns: - - - - - - - -@pad: -@name: - - - + @@ -549,6 +997,15 @@ Flags for the pad. @Returns: + + + + + +@pad: +@Returns: + + @@ -576,7 +1033,7 @@ Flags for the pad. @Returns: - + @@ -585,56 +1042,87 @@ Flags for the pad. @Returns: - + -@srcpad: -@sinkpad: +@pad: +@bufferalloc: + + + + + + + +@pad: +@offset: +@size: @Returns: - + -@srcpad: -@sinkpad: -@filtercaps: +@pad: +@chain: + + + + + + + +@pad: +@get: + + + + + + + +@pad: +@event: + + + + + + + +@pad: +@mask_func: + + + + + + + +@pad: @Returns: - + -@srcpad: -@sinkpad: -@filtercaps: +@pad: @Returns: - + -@srcpad: -@sinkpad: -@filtercaps: -@Returns: - - - - - - - -@srcpad: -@sinkpad: +@pad: +@link: @@ -658,18 +1146,46 @@ Flags for the pad. @Returns: - + @pad: -@data: - -@buf: +@unlink: - + + + + + +@srcpad: +@sinkpad: +@Returns: + + + + + + + +@srcpad: +@sinkpad: +@filtercaps: +@Returns: + + + + + + + +@srcpad: +@sinkpad: + + + @@ -678,26 +1194,34 @@ Flags for the pad. @Returns: - - - - - -@self: -@parent: - - - + @pad: -@caps: @Returns: - + + + + + +@pad: +@Returns: + + + + + + + +@pad: +@Returns: + + + @@ -715,12 +1239,119 @@ Flags for the pad. @Returns: - + @pad: +@caps: +@Returns: + + + + + + + +@pad: +@caps: +@Returns: + + + + + + + +@srcpad: +@sinkpad: +@Returns: + + + + + + + +@pad: +@getcaps: + + + + + + + +@pad: +@fixate: + + + + + + + +@pad: +@Returns: + + + + + + + +@pad: +@caps: +@Returns: + + + + + + + +@pad: +@caps: +@Returns: + + + + + + + +@pad: +@caps: +@Returns: + + + + + + + +@pad: +@caps: +@Returns: + + + + + + + +@pad: + + + + + + + +@srcpad: +@sinkpad: +@filtercaps: @Returns: @@ -734,48 +1365,78 @@ Flags for the pad. @Returns: - + @pad: -@parent: @Returns: - + @pad: -@Varargs: + + + + + + + +@srcpad: +@sinkpad: +@filtercaps: @Returns: - -@padlist: - + -@padlist: +@pad: @Returns: - -@pad: -@Varargs: - + + + + + +@pad: + + + + + + + +@pad: +@allowed: +@Returns: + + + @pad: -@dispatch: @data: + +@buf: + + + + + + + +@pad: @Returns: @@ -799,16 +1460,50 @@ Flags for the pad. @Returns: - + + + + + +@padlist: +@Returns: + +@pad: +@Varargs: + + + @pad: -@event: +@Varargs: +@Returns: + +@padlist: - + + + + + +@pad: +@varargs: +@Returns: + + + + + + + +@pad: +@formats: + + + @@ -817,7 +1512,7 @@ Flags for the pad. @Returns: - + @@ -826,15 +1521,6 @@ Flags for the pad. @Returns: - - - - - -@pad: -@mask_func: - - @@ -870,60 +1556,6 @@ Flags for the pad. @Returns: - - - - - -@pad: -@Returns: - - - - - - - -@pad: -@Returns: - - - - - - - -@pad: -@formats: - - - - - - - -@pad: -@Returns: - - - - - - - -@pad: -@Returns: - - - - - - - -@pad: -@intlink: - - @@ -933,6 +1565,33 @@ Flags for the pad. @query: + + + + + +@pad: +@type_func: + + + + + + + +@pad: +@Returns: + + + + + + + +@pad: +@Returns: + + @@ -957,7 +1616,16 @@ Flags for the pad. @Returns: - + + + + + +@pad: +@intlink: + + + @@ -966,7 +1634,7 @@ Flags for the pad. @Returns: - + @@ -975,13 +1643,15 @@ Flags for the pad. @Returns: - + @pad: -@type_func: +@dispatch: +@data: +@Returns: @@ -1002,195 +1672,13 @@ Remove the probe from the pad @probe: The probe to remove - + -@pad: -@Returns: - - - - - - - -@pad: -@active: - - - - - - - -@pad: -@Returns: - - - - -The realpad object - - - - - -Get the direction of the real pad. - - -@pad: the realpad to query. - - - - -Get the caps of the real pad. - - -@pad: the real pad to query. - - - - -Get the peer element of the real pad. - - -@pad: the real pad to query. - - - - -Get the chain function of the real pad. - - -@pad: the real pad to query. - - - - -Get the application filter for this pad - - -@pad: the pad to query - - - - -Get get getfunction of the real pad. - - -@pad: the real pad to query. - - - - -Get the eventhandler function from the real pad. - - -@pad: the real pad to query. - - - - -Get the event function of this real pad. - - -@pad: the real pad to query. - - - - -Get the eventhandler function of this real pad. - - -@pad: the real pad to query. - - - - -Get the gethandler function of this real pad. - - -@pad: the real pad to query. - - - - -Get the link function of the pad - - -@pad: the pad to query - - - - -Get the getcaps function of this pad - - -@pad: the pad to query - - - - -Get the convert function of this pad - - -@pad: the pad to query - - - - -Get the internal link function of this pad - - -@pad: the pad to query - - - - -Get the query function of this pad - - -@pad: the pad to query - - - - -Get the event mask function of this pad - - -@pad: the pad to query - - - - -Get the formats function of this pad - - -@pad: the pad to query - - - - -Get the query types function of this pad - - -@pad: the pad to query - - - - -Get the real pad of this ghost pad. - - -@pad: the real pad to query. - - - - -The Ghostpad object - +@self: +@parent: @@ -1203,3 +1691,63 @@ The Ghostpad object @Returns: + + + + + +@Returns: + + + + + + + +@name_template: +@direction: +@presence: +@caps: +@Returns: + +@Varargs: + + + + + + + +@templ: +@Returns: + + + + + + + +@templ: +@Returns: + + + + + + + +@templ: +@name: +@Returns: + + + + + + + +@pad: +@parent: +@Returns: + + diff --git a/docs/gst/tmpl/gstparse.sgml b/docs/gst/tmpl/gstparse.sgml index bcaffe3b00..2543f2e360 100644 --- a/docs/gst/tmpl/gstparse.sgml +++ b/docs/gst/tmpl/gstparse.sgml @@ -2,7 +2,7 @@ GstParse -Parses commandline syntax into a pipeline. +Parses pipeline syntax into elements @@ -44,6 +44,21 @@ can be made with . + + +Get the error quark passed in the GError messages. + + +@Returns: The parse error quark + + + + +The error quark + + + + The parsing errors. @@ -57,21 +72,6 @@ The parsing errors. @GST_PARSE_ERROR_EMPTY_BIN: @GST_PARSE_ERROR_EMPTY: - - -The error quark - - - - - - -Get the error quark passed in the GError messages. - - -@Returns: The parse error quark - - diff --git a/docs/gst/tmpl/gstpipeline.sgml b/docs/gst/tmpl/gstpipeline.sgml index ce9c33cc36..12ab71c9ba 100644 --- a/docs/gst/tmpl/gstpipeline.sgml +++ b/docs/gst/tmpl/gstpipeline.sgml @@ -21,12 +21,6 @@ the pipeline, use gst_element_unref() to free its resources. #GstBin - - -The pipeline object - - - diff --git a/docs/gst/tmpl/gstplugin.sgml b/docs/gst/tmpl/gstplugin.sgml index e265e785b0..4b014d425a 100644 --- a/docs/gst/tmpl/gstplugin.sgml +++ b/docs/gst/tmpl/gstplugin.sgml @@ -2,7 +2,7 @@ GstPlugin -Dynamically loadable Elements +Container for features loaded from a shared object module @@ -34,13 +34,6 @@ to bring the plugin into memory. #GstPluginFeature, #GstType, #GstAutoplug, #GstElementFactory - - -The error quark - - - - Get the error quark @@ -49,6 +42,13 @@ Get the error quark @Returns: The error quark used in GError messages + + +The error quark + + + + The plugin loading errors @@ -58,6 +58,14 @@ The plugin loading errors @GST_PLUGIN_ERROR_DEPENDENCIES: The plugin has unresolved dependencies @GST_PLUGIN_ERROR_NAME_MISMATCH: + + + + + +@plugin: + + The plugin object @@ -71,18 +79,6 @@ The plugin object @module: @_gst_reserved: - - -A plugin should provide a pointer to a function of this type in the plugin_desc struct. -It will be called by the loader at statup. - - -@plugin: The plugin object that can be used to register stuff for this plugin. -@Returns: A boolean indicating success or failure. - -@module: The GModule it was loaded from - - A plugins should export a variable of this type called plugin_desc. This plugin @@ -101,6 +97,90 @@ loaded will use this variable to initialize the plugin. @origin: @_gst_reserved: + + +A plugin should provide a pointer to a function of this type in the plugin_desc struct. +It will be called by the loader at statup. + + +@plugin: The plugin object that can be used to register stuff for this plugin. +@Returns: A boolean indicating success or failure. + +@module: The GModule it was loaded from + + + + + + + +@plugin: + + + + + + + +@major: +@minor: +@name: +@description: +@init: +@version: +@license: +@package: +@origin: + + + + + + + +@major: +@minor: +@name: +@description: +@init: +@version: +@license: +@package: +@origin: + + + + + + + + + + + + + + +@plugin: +@user_data: +@Returns: + + + + + + + + + + + + + + +@Returns: + + @@ -110,6 +190,15 @@ loaded will use this variable to initialize the plugin. @Returns: + + + + + +@plugin: +@Returns: + + @@ -119,6 +208,42 @@ loaded will use this variable to initialize the plugin. @Returns: + + + + + +@plugin: +@Returns: + + + + + + + +@plugin: +@Returns: + + + + + + + +@plugin: +@Returns: + + + + + + + +@plugin: +@Returns: + + @@ -128,6 +253,40 @@ loaded will use this variable to initialize the plugin. @Returns: + + + + + +@plugin: +@filter: +@first: +@user_data: +@Returns: + + + + + + + +@list: +@filter: +@first: +@user_data: +@Returns: + + + + + + + +@plugin: +@name: +@Returns: + + @@ -148,6 +307,16 @@ loaded will use this variable to initialize the plugin. @Returns: + + + + + +@filename: +@error: +@Returns: + + diff --git a/docs/gst/tmpl/gstpluginfeature.sgml b/docs/gst/tmpl/gstpluginfeature.sgml index c19812b1c5..12d6199349 100644 --- a/docs/gst/tmpl/gstpluginfeature.sgml +++ b/docs/gst/tmpl/gstpluginfeature.sgml @@ -2,7 +2,7 @@ GstPluginFeature -The base class for plugable objects. +Base class for contents of a GstPlugin @@ -22,6 +22,22 @@ Get the name of the feature @feature: The feature to query + + + + + + + + + + + +@feature: +@user_data: +@Returns: + + @@ -39,3 +55,49 @@ Get the name of the feature @feature: + + + + + +@feature: +@data: +@Returns: + + + + + + + +@feature: +@rank: + + + + + + + +@feature: +@name: + + + + + + + +@feature: +@Returns: + + + + + + + +@feature: +@Returns: + + diff --git a/docs/gst/tmpl/gstqueue.sgml b/docs/gst/tmpl/gstqueue.sgml index 6de503a687..87d54cc408 100644 --- a/docs/gst/tmpl/gstqueue.sgml +++ b/docs/gst/tmpl/gstqueue.sgml @@ -25,9 +25,3 @@ The queue blocks by default. - - - - - - diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index 08314d1509..3778433a11 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -1,3 +1,123 @@ + + + + + + + + + + + + + + + + + +GstBin + + + + + + + + + + + + + + + + + + + +GstBuffer + + + + + + + + + + + + + + + + + + + +GstCaps + + + + + + + + + + + + + + + + + + + +GstClock + + + + + + + + + + + + + + + + + + + +GstCompat + + + + + + + + + + + + + + + + + + + +GstData + + @@ -18,6 +138,86 @@ GstElement + + + + + + + + + + + + + + + + + +GstEvent + + + + + + + + + + + + + + + + + + + +GstIndexFactory + + + + + + + + + + + + + + + + + + + +GstStructure + + + + + + + + + + + + + + + + + + + +GstTag + + Information about audio buffers. @@ -38,26 +238,6 @@ Information about audio buffers. audioraw - - - - - - - - - - - - - - - - - -cothreads_compat - - @@ -78,67 +258,6 @@ cothreads_compat GObject - - - - - - - - - - - - - - - - - -grammar.tab - - - - - - - - - - - - - - - - - - - -gst_private - - - - -The aggregator is mainly used for testing purposes. It has several -methods to request buffers from its pads. - - - - - - - - - - -Combine buffers. - - - -GstAggregator - - Reads data from a file. You can seek to a specific location by setting @@ -392,26 +511,6 @@ GstCacheFactory GstColorSpace - - - - - - - - - - - - - - - - - -gstdata_private - - The disksink write to a file. The filename can be given as an argument. @@ -473,24 +572,64 @@ GstDiskSrc GstElementFactory - + +GstElementFactory is used to create instances of elements. A GstElementfactory +can be added to a #GstPlugin as it is also a #GstPluginFeature. + + +Use gst_element_factory_new() to create a new factory which can be added to a plugin +with gst_plugin_add_feature(). + + +gst_element_factory_add_pad_template() is used to add a padtemplate to the factory. +This function will enable the application to query for elementfactories that handle +a specific media type. + + +Use the gst_element_factory_find() and gst_element_factory_create() functions +to create element instances or use gst_element_factory_make() as a convenient +shortcut. + + +The following code example shows you how to create a GstFileSrc element. + + + + #include <gst/gst.h> + + GstElement *src; + GstElementFactory *srcfactory; + + gst_init(&argc,&argv); + + srcfactory = gst_element_factory_find("filesrc"); + g_return_if_fail(srcfactory != NULL); + + src = gst_element_factory_create(srcfactory,"src"); + g_return_if_fail(src != NULL); + ... + + + +An elementfactory can be assigned a rank with gst_element_factory_set_rank() +so that the autopluggers can select a plugin more appropriatly - + - +#GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate. - + +Create GstElements from a factory - - -gstenumtypes + +GstElementFactory @@ -533,152 +672,6 @@ GstEsdSink GstExtraTypes - - -Take a buffer and gst_buffer_unref() it. This element does nothing -with the buffer. (fakesink) - - - - - - - - - - - -Sources a buffer without doing anything with it. (fakesink) - - - -GstFakeSink - - - - -The GstFakeSrc generates empty buffers. (fakesrc) - - - - - - - - - - -Generate empty buffers. (fakesrc) - - - -GstFakeSrc - - - - -Write data to a file descriptor. - - - - - - - - - - -Write data to a file descriptor. (fdsink) - - - -GstFdSink - - - - -Read buffers from a file descriptor. - - - - - - - - - - -Read buffers from a file descriptor. (fdsrc) - - - -GstFdSrc - - - - - - - - - - - - - - - - - - - -GstFileSink - - - - -FileSrc is used to read buffers from a file. It efficiently uses mmap -and subbuffers. - - - - - - - - - - -Read data from a file - - - -GstFileSrc - - - - -Filters take data in and spit data out. They are the main Element in a filter graph. -Filters have zero or more inputs and zero or more outputs. Filters are linked -together to form filter graphs. A GstFilter is the base class and is not very usefull -on its own. - - - - - - - - - - -Take data in and spit data out - - - -GstFilter - - @@ -719,24 +712,24 @@ Reads data from a URL. (httpsrc) GstHttpSrc - + -Pass data without modification. +GstIndexFactory is used to dynamically create GstIndex implementations. - + - +#GstIndex - -Pass data without modification. (identity) + +Create GstIndexes from a factory - -GstIdentity + +GstIndexFactory @@ -761,66 +754,6 @@ Generic link between elements. GstLink - - - - - - - - - - - - - - - - - -gstmacros - - - - - - - - - - - - - - - - - - - -gstmarshal - - - - - - - - - - - - - - - - - - - -GstMD5Sink - - The point of the metadata is to provide some context for each buffer. In @@ -954,76 +887,117 @@ GstMeta GstMultiDiskSrc - + -A GstPipefilter pipes data to an external program and creates -buffers from its output. +Padtemplates describe the possible media types a pad or an elementfactory can +handle. + + +Pad and PadTemplates have #GstCaps attached to it to describe the media type they +are capable of dealing with. gst_pad_template_get_caps() is used to get the +caps of a padtemplate. It's not possible to modify the caps of a padtemplate after +creation. + + +Padtemplates can be created with gst_pad_template_new() or with the convenient +GST_PAD_TEMPLATE_FACTORY() macro. A padtemplate can be used to create a pad or +to add to an elementfactory. + + +The following code example shows the code to create a pad from a padtemplate. + + GstStaticPadTemplate my_template = + GST_STATIC_PAD_TEMPLATE ( + "sink", /* the name of the pad */ + GST_PAD_SINK, /* the direction of the pad */ + GST_PAD_ALWAYS, /* when this pad will be present */ + GST_STATIC_CAPS ( /* the capabilities of the padtemplate */ + "audio/x-raw-int, " + "channels = (int) [ 1, 6 ]" + ) + ) + + void + my_method (void) + { + GstPad *pad; + + pad = gst_pad_new_from_template (GST_PAD_TEMPLATE_GET (my_template_factory), "sink"); + ... + } + + + +The following example shows you how to add the padtemplate to an elementfactory: + + gboolean + my_factory_init (GstPlugin *plugin) + { + GstElementFactory *factory; + + factory = gst_element_factory_new ("my_factory", GST_TYPE_MYFACTORY, &gst_myfactory_details); + g_return_val_if_fail (factory != NULL, FALSE); + + gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (my_template_factory)); + + gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory)); + + return TRUE; + } + + - + + +#GstPad, #GstElementFactory + + + + +Describe the media type of a pad. + + + +GstPadTemplate + + + + +A schedulerfactory is used to create instances of a scheduler. It +can be added to a #GstPlugin as it extends #GstPluginFeature. + + +Use gst_scheduler_factory_new() to create a new scheduler which can be registered +to a plugin with gst_plugin_add_feature(). + + +Use gst_scheduler_factory_find() to find the named schedulerfactory. +or use gst_scheduler_factory_get_list() to get a list of all available schedulers. + + +Once an schedulerfactory has been obtained use gst_scheduler_factory_create() to +instantiate a real scheduler. Optionally gst_scheduler_factory_make() to create +a scheduler from the named factory. + + +Use gst_scheduler_factory_destroy() to remove the factory from the global list. + + + + - -A wrapper around every stdin/stdout capable program + +Create schedulers from a factory - -GstPipefilter - - - - -Simple data queue. Data is queued till max_level buffers any subsequent buffers -sent to this filter will block until free space becomes available in the buffer. -The queue is typically used in conjunction with a thread. - - -You can query how many buffers are queued with the level argument. - - -The default queue length is set to 100. - - -The queue blocks by default. - - - - - - - - - - -Simple asynchronous data queue. - - - -GstQueue - - - - - - - - - - - - - - - - - - - -gstsearchfuncs + +GstSchedulerFactory @@ -1068,46 +1042,6 @@ The end point of a filter graph GstSink - - - - - - - - - - - - - - - - - -GstSpider - - - - - - - - - - - - - - - - - - - -GstSpiderIdentity - - A GstSrc is the start of a filter graph. It typically is a file or an @@ -1172,47 +1106,6 @@ An autoplugger made for media playback GstStaticAutoplugRender - - -The plugin doesn't alter the data but provides statistics about -the data stream, such as buffers/bytes/events etc. - - - - - - - - - - -Provide statistics about data that passes this plugin - - - -GstStatistics - - - - -A tee can be used to split out the filter graph. - - - - - - - - - - -1-to-N pipe fitting - - - -GstTee - - This class is used by plugins to manage time vs byte offsets. It is mainly @@ -1234,84 +1127,77 @@ Cache time and byteoffsets. GstTimeCache - + - +These functions allow querying informations about registered typefind +functions. How to create and register these functions is described in +the section +"Writing typefind functions". + + +how to write a simple typefinder + +/* FIXME: compile this? ;) */ +typedef struct { + guint8 *data; + guint size; + guint probability; + GstCaps *data; +} MyTypeFind; +static void +my_peek (gpointer data, gint64 offset, guint size) +{ + MyTypeFind *find = (MyTypeFind *) data; + if (offset >= 0 && offset + size <= find->size) { + return find->data + offset; + } + return NULL; +} +static void +my_suggest (gpointer data, guint probability, GstCaps *caps) +{ + MyTypeFind *find = (MyTypeFind *) data; + if (probability > find->probability) { + find->probability = probability; + gst_caps_replace (&find->caps, caps); + } +} +static GstCaps * +find_type (guint8 *data, guint size) +{ + GList *walk, *type_list; + MyTypeFind find = {data, size, 0, NULL}; + GstTypeFind gst_find = {my_peek, my_suggest, &find, }; + + walk = type_list = gst_type_find_factory_get_list (); + while (walk) { + GstTypeFindFactory *factory = GST_TYPE_FIND_FACTORY (walk->data); + walk = g_list_next (walk) + gst_type_find_factory_call_function (factory, &gst_find); + } + g_list_free (type_list); + return find.caps; +}; + + + +The above example shows how to write a very simple typefinder that identifies +the given data. You can get quite a bit more complicated than that though. - + - +Writing typefind functions - + +information about registered typefind functions - - -gsttypes - - - - - - - - - - - - - - - - - - - -GstValue - - - - - - - - - - - - - - - - - - - -gstversion - - - - - - - - - - - - - - - - - - - -GstXMLRegistry + +GstTypeFindFactory @@ -1355,26 +1241,6 @@ Frequencies of a spectrum analysis. spectrum - - - - - - - - - - - - - - - - - -types - - Information about video buffers. @@ -1401,18 +1267,6 @@ videoraw - - - - - - - - - - - - The maximum number of cothreads we are going to support. @@ -1547,24 +1401,6 @@ g_print messages. - - - - - - - - - - - - - - - - - - @@ -1743,12 +1579,6 @@ Get the value of a #GstAtomicSwap @klass: - - - - - - @@ -1763,13 +1593,6 @@ Get the value of a #GstAtomicSwap @obj: - - - - - -@klass: - @@ -1777,6 +1600,14 @@ Get the value of a #GstAtomicSwap @klass: + + +Casts an object to a GstBuffer. + + +@buf: an object to cast. +@Returns: the #GstBuffer to which the given object points. + Gets the bufferpool for this buffer. @@ -1955,6 +1786,22 @@ A flag indicating that SSE instructions are supported. + + +Check if a given flag is set on the data + + +@data: The data to check +@flag: The flag to check for + + + +Set the flag on the data + + +@data: The data to set the flag on +@flag: The flag to set + Query if the GstData is READONLY @@ -2067,13 +1914,6 @@ to the current function, i.e. "('element')" @obj: - - - - - -@klass: - @@ -2081,20 +1921,6 @@ to the current function, i.e. "('element')" @klass: - - - - - -@obj: - - - - - - -@klass: - Queries whether the cothread holding this element needs to be stopped. @@ -2246,13 +2072,6 @@ subclass use this to start their flag enumeration - - - - - -@obj: - @@ -2260,13 +2079,6 @@ subclass use this to start their flag enumeration @obj: - - - - - -@klass: - @@ -2274,12 +2086,6 @@ subclass use this to start their flag enumeration @klass: - - - - - - @@ -2378,6 +2184,13 @@ subclass use this to start their flag enumeration @obj: + + +Checks if the pointer is a GstBuffer. + + +@buf: a pointer to query. + @@ -2420,20 +2233,6 @@ subclass use this to start their flag enumeration @obj: - - - - - -@obj: - - - - - - -@klass: - @@ -2518,27 +2317,6 @@ subclass use this to start their flag enumeration @obj: - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - @@ -2609,27 +2387,6 @@ subclass use this to start their flag enumeration @obj: - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - @@ -2658,41 +2415,6 @@ subclass use this to start their flag enumeration @obj: - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - @@ -2829,13 +2551,6 @@ Clear a flag in the meta data. @obj: - - - - - -@klass: - @@ -2863,13 +2578,6 @@ subclasses can use this value to start the enumeration of their flags @obj: - - - - - -@klass: - @@ -2877,30 +2585,6 @@ subclasses can use this value to start the enumeration of their flags @klass: - - - - - - - - - - - - - - - - - - - - - - - - Indicate that this pad will always be available. @@ -2955,20 +2639,6 @@ Is this pad linked. @pad: the pad to check - - - - - -@obj: - - - - - - -@klass: - Get the flag indicating the properties are fixed from the template. @@ -2990,13 +2660,6 @@ Get the flag indicating the properties are fixed from the template. @klass: - - - - - -@plugin: - A handy macro to define a plugin description. This macro handles with all the issues @@ -3042,13 +2705,6 @@ A macro used to define a statically linked plugin. @klass: - - - - - -@obj: - @@ -3056,13 +2712,6 @@ A macro used to define a statically linked plugin. @obj: - - - - - -@klass: - @@ -3147,20 +2796,6 @@ Get the type of the region that is being pulled. @pad: the real pad to query. - - - - - -@obj: - - - - - - -@klass: - Fast macro to add an element to the scheduler. @@ -3250,12 +2885,6 @@ Get the parent #GstElement of this scheduler. @sched: the scheduler to query. - - - - - - @@ -3407,12 +3036,6 @@ This macro unsets the given state on the element. @klass: - - - - - - @@ -3449,18 +3072,6 @@ This macro unsets the given state on the element. - - - - - - - - - - - - @@ -3491,42 +3102,6 @@ This macro unsets the given state on the element. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -3539,48 +3114,12 @@ This macro unsets the given state on the element. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -3617,18 +3156,6 @@ A type that can be used to indicate a filename. - - - - - - - - - - - - @@ -3653,138 +3180,36 @@ A type that can be used to indicate a filename. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -3815,47 +3240,6 @@ A type that can be used to indicate a filename. - - - - - - - - - - - -@x: - - - - - - -@x: - - - - - - -@x: - - - - - - -@x: - - - - - - -@x: - @@ -4297,15 +3681,6 @@ A type that can be used to indicate a filename. - - - - - -@AGGREGATOR_LOOP: -@AGGREGATOR_LOOP_SELECT: -@AGGREGATOR_CHAIN: - @@ -4487,17 +3862,6 @@ The type of the autoplugger. @GST_AUTOPLUG_TO_RENDERER: @GST_AUTOPLUG_FLAG_LAST: - - - - - -@prev: -@fac: -@templ: -@cost: -@endpoint: - is signaled whenever a new GstElement is added to the GstBin @@ -4507,12 +3871,6 @@ is signaled whenever a new GstElement is added to the - - - - - This supplied function is used to copy the buffer contents. @@ -4657,6 +4015,12 @@ can perform necessary cleanup. + + + + + + Is emited after the buffer has been written to the disk. @@ -4783,12 +4147,6 @@ Is trigered whenever a new ghost pad is added to an element @gstelement: the object which received the signal. @arg1: the new ghost pad that was added - - - - - - This factory is used when registering the element, and contains the name @@ -4997,49 +4355,6 @@ Sync on the clock - - - - - -@FAKESRC_DATA_ALLOCATE: -@FAKESRC_DATA_SUBBUFFER: -@FAKESRC_DATA_BUFFERPOOL: - - - - - - -@FAKESRC_FILLTYPE_NOTHING: -@FAKESRC_FILLTYPE_NULL: -@FAKESRC_FILLTYPE_RANDOM: -@FAKESRC_FILLTYPE_PATTERN: -@FAKESRC_FILLTYPE_PATTERN_CONT: - - - - - - -@FAKESRC_FIRST_LAST_LOOP: -@FAKESRC_LAST_FIRST_LOOP: -@FAKESRC_PING_PONG: -@FAKESRC_ORDERED_RANDOM: -@FAKESRC_RANDOM: -@FAKESRC_PATTERN_LOOP: -@FAKESRC_PING_PONG_PATTERN: -@FAKESRC_GET_ALWAYS_SUCEEDS: - - - - - - -@FAKESRC_SIZETYPE_NULL: -@FAKESRC_SIZETYPE_FIXED: -@FAKESRC_SIZETYPE_RANDOM: - @@ -5088,14 +4403,6 @@ Get the current offset in the file. - - - - - -@GST_FILESINK_OPEN: -@GST_FILESINK_FLAG_LAST: - The size of the buffers to pass to the peer element. @@ -5138,14 +4445,6 @@ Indicates the mmapped area should be touched to bring it into memory. - - - - - -@GST_FILESRC_OPEN: -@GST_FILESRC_FLAG_LAST: - @@ -5158,6 +4457,12 @@ Indicates the mmapped area should be touched to bring it into memory. + + +The Ghostpad object + + + @@ -5263,6 +4568,18 @@ Specify the location of the file. The location must be a fully qualified URL. + + +The GstIndex object + + + + + +The GstIndexFactory object + + + @@ -5314,36 +4631,12 @@ Flags indicating properties about the meta data. @GST_MULTIDISKSRC_OPEN: @GST_MULTIDISKSRC_FLAG_LAST: - - - - - - Indicates this pad is active - - - - - - - - - - - - - - - - - - The signature of the dispatcher callback. @@ -5468,11 +4761,14 @@ The different supported query types. executing segment. @GST_PAD_QUERY_RATE: Query at which rate this pad will process data. - + - +This signal is fired when an element creates a pad from this +template. +@gstpadtemplate: the object which received the signal. +@arg1: The pad that was created. @@ -5485,20 +4781,18 @@ The different supported query types. @GST_PARSE_ERROR_INTERNAL: @GST_PARSE_ERROR_LINK: - - - - - -@GST_PIPEFILTER_OPEN: -@GST_PIPEFILTER_FLAG_LAST: - Sets the command to be executed. + + +The pipeline object + + + @@ -5560,6 +4854,12 @@ blocks. + + +The realpad object + + + the region types for #gst_pad_pullregion. @@ -5569,6 +4869,12 @@ the region types for #gst_pad_pullregion. @GST_REGION_OFFSET_LEN: an offet/length pair @GST_REGION_TIME_LEN: a time start/length pair + + +The registry object + + + @@ -5586,15 +4892,6 @@ the region types for #gst_pad_pullregion. @file: @tmp_file: - - - - - -@GST_RESULT_OK: -@GST_RESULT_NOK: -@GST_RESULT_NOT_IMPL: - @@ -5608,27 +4905,6 @@ the region types for #gst_pad_pullregion. @cothreaded_elements: @schedule: - - - - - -@object: -@parent: -@parent_sched: -@state: -@clock: -@current_clock: -@clock_providers: -@clock_receivers: -@schedulers: - - - - - - - @@ -5834,6 +5110,12 @@ Flags for the GstSrc element + + +The GstThread object + + + TRUE if the thread should be created. @@ -5880,27 +5162,6 @@ TRUE if the thread should be created. @minlocation: @maxlocation: - - - - - -@filename: -@fd: -@buf: -@bufsize: -@bufoffset: - - - - - - -@timestamp: -@sequence: -@data: -@message: - The signal to indicate the mime type was detected. @@ -5921,101 +5182,25 @@ Query the element for the current mime type + + +Object that stores information about a typefind function + + + + + +Class belonging to #GstTypeFindFactory. + + +@parent: + - - - - - -@registry: - - - - - - -@registry: -@Returns: - - - - - - -@registry: - - - - - - -@registry: -@dest: -@size: -@Returns: - - - - - - -@GST_XML_REGISTRY_READ: -@GST_XML_REGISTRY_WRITE: - - - - - - -@registry: -@mode: -@Returns: - - - - - - -@context: -@tag: -@text: -@text_len: -@registry: -@error: -@Returns: - - - - - - -@registry: -@format: -@Varargs: -@Returns: - - - - - - -@GST_XML_REGISTRY_NONE: -@GST_XML_REGISTRY_TOP: -@GST_XML_REGISTRY_PATHS: -@GST_XML_REGISTRY_PATH: -@GST_XML_REGISTRY_PATHS_DONE: -@GST_XML_REGISTRY_PLUGIN: -@GST_XML_REGISTRY_FEATURE: -@GST_XML_REGISTRY_PADTEMPLATE: -@GST_XML_REGISTRY_CAPS: -@GST_XML_REGISTRY_CAPSCOMP: -@GST_XML_REGISTRY_PROPERTIES: - @@ -6025,12 +5210,6 @@ Query the element for the current mime type @arg1: @arg2: - - - - - - @@ -6050,30 +5229,6 @@ Query the element for the current mime type @format: @args...: - - - - - - - - - - - - - - - - - - - - - - - - @@ -6136,13 +5291,6 @@ Query the element for the current mime type @overlay_info: @dga_info: - - - - - -@String: - @@ -6153,24 +5301,6 @@ Query the element for the current mime type @y1: @y2: - - - - - - - - - - - - - - - - - - @@ -6195,27 +5325,6 @@ must be defined to activate the tracing functionality. - - - - - -@String: - - - - - - -@Domain: -@Directory: - - - - - - - @@ -6247,114 +5356,6 @@ must be defined to activate the tracing functionality. @key: @data: - - - - - -@Domain: -@String: -@Type: - - - - - - -@Domain: -@String: - - - - - - -@context: - - - - - - - - - - - - -@new_cothread: -@context: -@func: -@argc: -@argv: - - - - - - -@cothread: - - - - - - - - - - - - -@context: - - - - - - -@cothread: - - - - - - -@cothread: -@context: -@func: -@argc: -@argv: - - - - - - -@to: - - - - - - -@cothread: - - - - - - -@x: - - - - - - -@stack: -@size: - @@ -7137,49 +6138,12 @@ must be defined to activate the tracing functionality. @val: - - - - - -@String: - - - - - - -@first: -@current: -@parent: -@current_bin_type: -@elements: -@links: -@links_pending: -@bins: -@bin: - - - - - - -@factory: -@Returns: - - - - - - -@Returns: - @@ -7281,24 +6245,6 @@ must be defined to activate the tracing functionality. @src: @Returns: - - - - - -@src: -@dest: -@Returns: - - - - - - -@src: -@sink: -@Returns: - @@ -7312,48 +6258,6 @@ must be defined to activate the tracing functionality. @srccaps: @sinkcaps: - - - - - -@factories: -@dir: -@maxtemplates: -@Returns: - - - - - - -@factories: -@Returns: - - - - - - -@factories: -@Returns: - - - - - - -@factories: -@Returns: - - - - - - -@factories: -@Returns: - @@ -7391,29 +6295,6 @@ must be defined to activate the tracing functionality. @Returns: - - - - - -@fac: -@dir: -@Returns: - - - - - - -@fac: - - - - - - -@fac: - @@ -7456,13 +6337,6 @@ must be defined to activate the tracing functionality. @Returns: - - - - - -@fac: - @@ -7471,16 +6345,6 @@ must be defined to activate the tracing functionality. @autoplug: @object: - - - - - -@src_caps: -@sink_caps: -@factories: -@Returns: - @@ -7539,13 +6403,6 @@ Free the memory allocated by this bin - - - - - -@Returns: - @@ -7619,13 +6476,6 @@ Free the memory allocated by this bin @buffer: - - - - - -@Returns: - Frees the given buffer, regardless of the refcount. @@ -8079,27 +6929,6 @@ safely be modified. @clock: @id: - - - - - -@Returns: - - - - - - -@Returns: - - - - - - -@Returns: - @@ -8134,13 +6963,6 @@ safely be modified. @clock: @id: - - - - - -@Returns: - @@ -8180,13 +7002,6 @@ safely be modified. @jitter: @Returns: - - - - - -@Returns: - @@ -8202,13 +7017,6 @@ safely be modified. @data: - - - - - -@Returns: - @@ -8238,12 +7046,6 @@ safely be modified. @format: @args: - - - - - - @@ -8260,50 +7062,6 @@ safely be modified. @state: @Returns: - - - - - -@klass: -@first_name: -@Varargs: - - - - - - -@a: -@b: - - - - - - -@a: -@b: -@c: - - - - - - -@a: -@...: - - - - - - -@a: -@b: -@c: -@d: - Destroys the element (without taking the refcount into account). @@ -8313,14 +7071,6 @@ of an element he doesn't need anymore. @element: a #GstElement to destroy - - - - - -@a: -@b: - @@ -8384,13 +7134,6 @@ of an element he doesn't need anymore. @elementfactory: - - - - - -@Returns: - @@ -8442,13 +7185,6 @@ of an element he doesn't need anymore. @factory: @rank: - - - - - -@Returns: - @@ -8632,20 +7368,6 @@ of an element he doesn't need anymore. @element: - - - - - -@Returns: - - - - - - -@Returns: - @@ -8700,13 +7422,6 @@ of an element he doesn't need anymore. @esdsink: - - - - - -@Returns: - @@ -8729,13 +7444,6 @@ of an element he doesn't need anymore. - - - - - -@Returns: - @@ -8751,14 +7459,6 @@ of an element he doesn't need anymore. @pad: @buf: - - - - - -@factory: -@Returns: - @@ -8774,14 +7474,6 @@ of an element he doesn't need anymore. @name: @Returns: - - - - - -@factory: -@Returns: - @@ -8858,20 +7550,6 @@ of an element he doesn't need anymore. @name: @Returns: - - - - - -@Returns: - - - - - - -@Returns: - @@ -8902,15 +7580,6 @@ of an element he doesn't need anymore. @name: @Returns: - - - - - -@...: -@format: -@args...: - @@ -8933,110 +7602,6 @@ of an element he doesn't need anymore. @link: - - - - - - - - - - - - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - - - - - - - - - - - - - - - - - - - -@factory: -@Returns: - Create new meta data. @@ -9073,13 +7638,6 @@ Create new meta data. @object: the object - - - - - -@Returns: - @@ -9102,23 +7660,6 @@ Create new meta data. @pad: @parent: - - - - - -@a: -@b: - - - - - - -@a: -@b: -@c: - Destroy the pad. @@ -9126,21 +7667,6 @@ Destroy the pad. @pad: the pad to destroy - - - - - -@Returns: - - - - - - -@a: -@b: - Call the EOS function of the pad @@ -9167,13 +7693,6 @@ Call the EOS function of the pad @data: @Returns: - - - - - -@Returns: - @@ -9248,13 +7767,6 @@ Call the EOS function of the pad @format: @Returns: - - - - - -@Returns: - @@ -9267,13 +7779,6 @@ Call the EOS function of the pad @counter: @count: - - - - - -@Returns: - @@ -9300,14 +7805,6 @@ Call the EOS function of the pad @data: @Returns: - - - - - -@a: -@b: - @@ -9345,14 +7842,6 @@ Call the EOS function of the pad @pad: @parent: - - - - - -@pad: -@Returns: - @@ -9379,14 +7868,6 @@ Call the EOS function of the pad @pad: @caps: - - - - - -@a: -@b: - @@ -9462,13 +7943,6 @@ Call the EOS function of the pad @caps: @Returns: - - - - - -@Returns: - @@ -9495,13 +7969,6 @@ Call the EOS function of the pad @sinkpad: @Returns: - - - - - -@Returns: - Destroys the pipeline. @@ -9560,13 +8027,6 @@ Destroys the pipeline. @plugin: @factory: - - - - - -@Returns: - @@ -9830,20 +8290,6 @@ Destroys the pipeline. @link: - - - - - -@Returns: - - - - - - -@Returns: - @@ -9858,13 +8304,6 @@ Destroys the pipeline. @Returns: - - - - - -@Returns: - @@ -9872,13 +8311,6 @@ Destroys the pipeline. @Returns: - - - - - -@Returns: - @@ -9991,20 +8423,6 @@ Destroy the scheduler @Returns: - - - - - -@Returns: - - - - - - -@Returns: - @@ -10015,27 +8433,6 @@ Destroy the scheduler @size: @Returns: - - - - - -@Returns: - - - - - - -@Returns: - - - - - - -@Returns: - @@ -10073,52 +8470,6 @@ Destroy the scheduler @name: @Returns: - - - - - - - - - - - -@name: -@Returns: - - - - - - -@name: -@Returns: - - - - - - -@ident: - - - - - - -@element: -@templ: -@name: -@Returns: - - - - - - -@ident: - @@ -10149,6 +8500,13 @@ Destroy the scheduler @src: + + + + + +@Returns: + @@ -10163,14 +8521,6 @@ Destroy the scheduler - - - - - -@factory: -@Returns: - @@ -10221,13 +8571,6 @@ Destroy the scheduler @arg: - - - - - -@Returns: - @@ -10305,81 +8648,6 @@ Destroy the scheduler @groupnum: @Returns: - - - - - -@trace: -@seq: -@data: -@msg: - - - - - - -@trace: - - - - - - -@trace: - - - - - - -@trace: - - - - - - -@trace: - - - - - - -@trace: - - - - - - -@filename: -@size: -@Returns: - - - - - - -@dst: - - - - - - -@trace: - - - - - - -@trace: - @@ -10637,237 +8905,6 @@ Destroy the scheduler @arg_type: @Returns: - - - - - -@value1: -@value2: -@Returns: - - - - - - -@value1: -@value2: -@Returns: - - - - - - -@value1: -@value2: -@Returns: - - - - - - -@value1: -@value2: -@Returns: - - - - - - -@dest: -@src: -@Returns: - - - - - - -@value: -@Returns: - - - - - - -@value: -@Returns: - - - - - - -@value: -@Returns: - - - - - - -@value: -@Returns: - - - - - - -@value: -@Returns: - - - - - - -@value: -@Returns: - - - - - - -@dest: -@src: - - - - - - -@dest: -@value1: -@value2: -@Returns: - - - - - - -@value: -@append_value: - - - - - - -@dest: -@value1: -@value2: - - - - - - -@value: -@Returns: - - - - - - -@value: -@index: -@Returns: - - - - - - -@value: -@prepend_value: - - - - - - -@table: - - - - - - -@type1: -@type2: -@func: - - - - - - -@type1: -@type2: -@func: - - - - - - -@value: -@Returns: - - - - - - -@value: -@caps: -@calue: - - - - - - -@value: -@start: -@end: - - - - - - -@value: -@fourcc: - - - - - - -@value: -@start: -@end: - - - - - - -@dest: -@value1: -@value2: -@Returns: - @@ -10878,21 +8915,6 @@ Destroy the scheduler @root: @Returns: - - - - - -@name: -@location: -@Returns: - - - - - - - @@ -10927,19 +8949,3 @@ Destroy the scheduler - - - - - -@buffers: -@bytes: -@events: - - - - - - -@String: - diff --git a/docs/gst/tmpl/gstregistry.sgml b/docs/gst/tmpl/gstregistry.sgml index 8a58d32b35..49afce4f45 100644 --- a/docs/gst/tmpl/gstregistry.sgml +++ b/docs/gst/tmpl/gstregistry.sgml @@ -2,7 +2,7 @@ GstRegistry -Abstract class for managing plugins. +Abstract base class for management of #GstPlugin objects @@ -14,6 +14,69 @@ The registry holds the available plugins in the system. #GstPlugin, #GstPluginFeature + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The return value of registry operations @@ -36,12 +99,6 @@ Flags for the registry @GST_REGISTRY_REMOTE: The registry is remote and might be slower @GST_REGISTRY_DELAYED_LOADING: The registry will be loaded on demand. - - -The registry object - - - @@ -132,6 +189,30 @@ The registry object @plugin: + + + + + +@registry: +@filter: +@first: +@user_data: +@Returns: + + + + + + + +@registry: +@filter: +@first: +@user_data: +@Returns: + + diff --git a/docs/gst/tmpl/gstregistrypool.sgml b/docs/gst/tmpl/gstregistrypool.sgml index b268b638ba..82b21c6f2e 100644 --- a/docs/gst/tmpl/gstregistrypool.sgml +++ b/docs/gst/tmpl/gstregistrypool.sgml @@ -2,7 +2,7 @@ GstRegistryPool -Manage a list of plugins and registries +Management of a group of #GstRegistry objects @@ -55,6 +55,28 @@ GstRegistry + + + + + +@filter: +@first: +@user_data: +@Returns: + + + + + + + +@filter: +@first: +@user_data: +@Returns: + + diff --git a/docs/gst/tmpl/gstscheduler.sgml b/docs/gst/tmpl/gstscheduler.sgml index bbcc721065..0fd6265e8d 100644 --- a/docs/gst/tmpl/gstscheduler.sgml +++ b/docs/gst/tmpl/gstscheduler.sgml @@ -2,7 +2,7 @@ GstScheduler -An abstract class for plugable schedulers. +Abstract class for objects that manage the scheduling of groups of elements @@ -14,6 +14,15 @@ This is a base class for custom schedulers. + + +Flags for the scheduler + + +@GST_SCHEDULER_FLAG_FIXED_CLOCK: The scheduler has a fixed clock +@GST_SCHEDULER_FLAG_LAST: subclasses can start numbering their flags starting + from here. + Get the parent object of this scheduler. @@ -40,15 +49,6 @@ The state of the scheduler @GST_SCHEDULER_STATE_STOPPED: the scheduler is stopped @GST_SCHEDULER_STATE_ERROR: the scheduler is in error - - -Flags for the scheduler - - -@GST_SCHEDULER_FLAG_FIXED_CLOCK: The scheduler has a fixed clock -@GST_SCHEDULER_FLAG_LAST: subclasses can start numbering their flags starting - from here. - @@ -83,6 +83,24 @@ Flags for the scheduler @element: + + + + + +@sched: +@sched2: + + + + + + + +@sched: +@sched2: + + @@ -180,59 +198,6 @@ Flags for the scheduler @Returns: - - - - - -@sched: -@sched2: - - - - - - - -@sched: -@sched2: - - - - - - - -@sched: - - - - - - - -@sched: -@Returns: - - - - - - - -@sched: -@clock: - - - - - - - -@sched: -@clock: - - @@ -257,6 +222,41 @@ Flags for the scheduler @Returns: + + + + + +@sched: +@clock: + + + + + + + +@sched: +@clock: + + + + + + + +@sched: +@Returns: + + + + + + + +@sched: + + @@ -265,3 +265,131 @@ Flags for the scheduler @sched: + + + + + + + + + + + + +@obj: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@klass: + +@obj: + + + + + + + +@obj: + + + + + + + + + + + + + + +@Returns: + + + + + + + +@name: +@longdesc: +@type: +@Returns: + + + + + + + +@factory: + + + + + + + +@name: +@Returns: + + + + + + + +@factory: +@parent: +@Returns: + + + + + + + +@name: +@parent: +@Returns: + + + + + + + +@name: + + + + + + + +@Returns: + + diff --git a/docs/gst/tmpl/gstsearchfuncs.sgml b/docs/gst/tmpl/gstsearchfuncs.sgml new file mode 100644 index 0000000000..c940b6f99f --- /dev/null +++ b/docs/gst/tmpl/gstsearchfuncs.sgml @@ -0,0 +1,166 @@ + +gstsearchfuncs + + + + + + + + + + + + + + + + + + + + + + + + + + +@prev: +@fac: +@templ: +@cost: +@endpoint: + + + + + + +@src: +@sink: +@Returns: + + + + + + + +@fac: +@src: +@Returns: + + + + + + + +@fac: +@sink: +@Returns: + + + + + + + +@src: +@dest: +@Returns: + + + + + + + +@fac: +@dir: +@Returns: + + + + + + + +@fac: + + + + + + + +@fac: + + + + + + + +@fac: + + + + + + + +@factories: +@Returns: + + + + + + + +@factories: +@Returns: + + + + + + + +@factories: +@Returns: + + + + + + + +@factories: +@Returns: + + + + + + + +@factories: +@dir: +@maxtemplates: +@Returns: + + + + + + + +@src_caps: +@sink_caps: +@factories: +@Returns: + + diff --git a/docs/gst/tmpl/gstshaper.sgml b/docs/gst/tmpl/gstshaper.sgml new file mode 100644 index 0000000000..a4e521f627 --- /dev/null +++ b/docs/gst/tmpl/gstshaper.sgml @@ -0,0 +1,33 @@ + +GstShaper + + + + + + + + + + + + + + + + + + + +@SHAPER_POLICY_TIMESTAMPS: +@SHAPER_POLICY_BUFFERSIZE: + + + + + + +@factory: +@Returns: + + diff --git a/docs/gst/tmpl/gstspider.sgml b/docs/gst/tmpl/gstspider.sgml new file mode 100644 index 0000000000..1eb9c6c5ee --- /dev/null +++ b/docs/gst/tmpl/gstspider.sgml @@ -0,0 +1,44 @@ + +GstSpider + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@ident: + + + + + + + +@ident: + + diff --git a/docs/gst/tmpl/gstspideridentity.sgml b/docs/gst/tmpl/gstspideridentity.sgml new file mode 100644 index 0000000000..0479f05818 --- /dev/null +++ b/docs/gst/tmpl/gstspideridentity.sgml @@ -0,0 +1,45 @@ + +GstSpiderIdentity + + + + + + + + + + + + + + + + + + + +@name: +@Returns: + + + + + + + +@name: +@Returns: + + + + + + + +@element: +@templ: +@name: +@Returns: + + diff --git a/docs/gst/tmpl/gststructure.sgml b/docs/gst/tmpl/gststructure.sgml index 6ab33061b0..9f98fb5567 100644 --- a/docs/gst/tmpl/gststructure.sgml +++ b/docs/gst/tmpl/gststructure.sgml @@ -2,7 +2,7 @@ GstStructure - +Generic structure containing fields of names and values @@ -14,6 +14,27 @@ GstStructure + + + + + +@type: +@name: +@fields: +@_gst_reserved: + + + + + + +@field_id: +@value: +@user_data: +@Returns: + + diff --git a/docs/gst/tmpl/gstsystemclock.sgml b/docs/gst/tmpl/gstsystemclock.sgml index cfb3ad1cf9..0d4f3492a3 100644 --- a/docs/gst/tmpl/gstsystemclock.sgml +++ b/docs/gst/tmpl/gstsystemclock.sgml @@ -2,7 +2,7 @@ GstSystemClock -A default clock that uses the current system time +Default clock that uses the current system time diff --git a/docs/gst/tmpl/gsttag.sgml b/docs/gst/tmpl/gsttag.sgml index 568ed82e68..dbbf5f049e 100644 --- a/docs/gst/tmpl/gsttag.sgml +++ b/docs/gst/tmpl/gsttag.sgml @@ -2,7 +2,7 @@ GstTag - +List of tags and values used to describe media metadata @@ -39,6 +39,35 @@ GstTag @GST_TAG_FLAG_DECODED: @GST_TAG_FLAG_COUNT: + + + + + + + + + + + +@x: + + + + + + + +@x: + + + + + + + + + @@ -151,6 +180,15 @@ GstTag @Returns: + + + + + +@p: +@Returns: + + @@ -583,3 +621,259 @@ GstTag @Returns: + + + + + +@list: +@Returns: + + + + + + + +@tag_event: +@Returns: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gsttaginterface.sgml b/docs/gst/tmpl/gsttaginterface.sgml index eb8cc0144a..0dc5abbd2d 100644 --- a/docs/gst/tmpl/gsttaginterface.sgml +++ b/docs/gst/tmpl/gsttaginterface.sgml @@ -2,7 +2,7 @@ GstTagInterface - +Element interface that allows setting and retrieval of media metadata @@ -14,13 +14,18 @@ GstTagInterface - + -@Returns: + + + + + +@g_iface: diff --git a/docs/gst/tmpl/gsttee.sgml b/docs/gst/tmpl/gsttee.sgml index ad5d8acd70..f76a91780d 100644 --- a/docs/gst/tmpl/gsttee.sgml +++ b/docs/gst/tmpl/gsttee.sgml @@ -14,3 +14,12 @@ A tee can be used to split out the filter graph. + + + + + +@factory: +@Returns: + + diff --git a/docs/gst/tmpl/gstthread.sgml b/docs/gst/tmpl/gstthread.sgml index 6d7021906d..db4ddda4ac 100644 --- a/docs/gst/tmpl/gstthread.sgml +++ b/docs/gst/tmpl/gstthread.sgml @@ -2,7 +2,7 @@ GstThread -A bin that will become a thread +A #GstBin that executes automatically using a separate thread @@ -18,6 +18,12 @@ A Thread can act as a toplevel bin as it has its own scheduler. #GstBin, #GstPipeline + + + + + + Thread flags: @@ -28,12 +34,6 @@ Thread flags: @GST_THREAD_MUTEX_LOCKED: @GST_THREAD_FLAG_LAST: subclass use this to start their enumeration - - -The GstThread object - - - @@ -43,6 +43,23 @@ The GstThread object @Returns: + + + + + +@thread: +@priority: + + + + + + + +@Returns: + + diff --git a/docs/gst/tmpl/gsttrace.sgml b/docs/gst/tmpl/gsttrace.sgml index bf6b236e67..6ccaa7925c 100644 --- a/docs/gst/tmpl/gsttrace.sgml +++ b/docs/gst/tmpl/gsttrace.sgml @@ -14,6 +14,101 @@ Tracing functionality + + + + + +@filename: +@fd: +@buf: +@bufsize: +@bufoffset: + + + + + + +@timestamp: +@sequence: +@data: +@message: + + + + + + +@filename: +@size: +@Returns: + + + + + + + +@trace: + + + + + + + +@trace: + + + + + + + +@trace: + + + + + + + +@trace: + + + + + + + +@trace: + + + + + + + +@trace: + + + + + + + +@trace: + + + + + + + +@dst: + + Flags indicating which tracing feature to enable. @@ -48,6 +143,14 @@ The main tracing object @Returns: + + + + + +@Returns: + + @@ -115,3 +218,14 @@ Trace a memory free operation @mem: The memory that is freed + + + + + +@trace: +@seq: +@data: +@msg: + + diff --git a/docs/gst/tmpl/gsttrashstack.sgml b/docs/gst/tmpl/gsttrashstack.sgml new file mode 100644 index 0000000000..81bb80fdc3 --- /dev/null +++ b/docs/gst/tmpl/gsttrashstack.sgml @@ -0,0 +1,51 @@ + +gsttrashstack + + + + + + + + + + + + + + + + + + + +@head: +@count: +@lock: + + + + + + +@next: + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gsttypefind.sgml b/docs/gst/tmpl/gsttypefind.sgml index 6cd2b8bb88..79d3b35d38 100644 --- a/docs/gst/tmpl/gsttypefind.sgml +++ b/docs/gst/tmpl/gsttypefind.sgml @@ -1,100 +1,18 @@ -Writing typefind functions +GstTypeFindElement -Using the type finding subsystem from plugins + -The typefinding subsystem in GStreamer is used to find the matching #GstCaps -for an unidentified stream. This works similar to the unix file - command. - - -There are a number of elements which output unidentified data streams, such as -a file source. Some other elements such as an autoplugger require a proper -identification of the data, so they can create the right pipeline. To find the -right type, they use typefinding elements, the most notable being the typefind -element. These elements take a list of all registered typefind functions and -try them on the data to see if any of these functions can identify the data. - - -The functions in this section provide the simple framework for writing these -typefind functions. The job of a typefind function is to identify the type of -the data good enough so that plugins using this type can understand them while -make sure no other type is misidentified. - -a typefind function for Ogg data - -static void -ogg_type_find (GstTypeFind *tf, gpointer unused) -{ - guint8 *data = gst_type_find_peek (tf, 0, 4); - - if (data && memcmp (data, "OggS", 4) == 0) { - gst_type_find_suggest (tf, GST_TYPE_FIND_MAXIMUM, - gst_caps_new ("ogg_type_find", "application/ogg", NULL)); - } -}; - - + + -GstTypeFactory - querying registered typefind -functions - - - - -This structure is filled by the caller of the typefind function. Typefind -functions must treat this as an opaque structure. - - -@peek: function called to get data. See gst_type_find_peek() -@suggest: function called to suggest a caps. See gst_type_find_suggest() -@data: caller defined data, that is passed when calling the functions -@get_length: function called to query the length of the stream. See -gst_type_find_get_length(). Providing this function is optional. - - - -This is the prototype for a typefind function. - - -@find: The #GstTypeFind data -@data: the user defined data that was provided on -gst_type_find_factory_register() - - - - -@find: -@offset: -@size: -@Returns: - - - - - - - -@find: -@probability: -@caps: - - - - - - - -@find: -@Returns: - diff --git a/docs/gst/tmpl/gsttypes.sgml b/docs/gst/tmpl/gsttypes.sgml new file mode 100644 index 0000000000..2ba16cfa1b --- /dev/null +++ b/docs/gst/tmpl/gsttypes.sgml @@ -0,0 +1,249 @@ + +gsttypes + + + + + + + + + + + + + + + + +The GstObject + + + + + + + + +@parent_class: +@path_string_separator: +@signal_object: +@parent_set: +@parent_unset: +@object_saved: +@deep_notify: +@destroy: +@save_thyself: +@restore_thyself: +@_gst_reserved: + + + +The GstPad object + + + + + + + + +@parent_class: +@_gst_reserved: + + + +The padtemplate object. + + + + + + + + +@parent_class: +@pad_created: +@_gst_reserved: + + + +The element object + + + + + + + + +@parent_class: +@details: +@elementfactory: +@padtemplates: +@numpadtemplates: +@state_change: +@new_pad: +@pad_removed: +@error: +@eos: +@found_tag: +@set_property: +@get_property: +@release_locks: +@get_event_masks: +@send_event: +@get_formats: +@convert: +@get_query_types: +@query: +@change_state: +@request_new_pad: +@release_pad: +@get_clock: +@set_clock: +@get_index: +@set_index: +@set_state: +@_gst_reserved: + + + +The GstBin object + + + + + + + + +@parent_class: +@add_element: +@remove_element: +@child_state_change: +@iterate: +@element_added: +@element_removed: +@_gst_reserved: + + + + + + + + + + + + +@parent_class: +@setup: +@reset: +@add_element: +@remove_element: +@add_scheduler: +@remove_scheduler: +@state_transition: +@scheduling_change: +@lock_element: +@unlock_element: +@yield: +@interrupt: +@error: +@pad_link: +@pad_unlink: +@pad_select: +@clock_wait: +@iterate: +@show: +@object_sync: +@_gst_reserved: + + + + + + +@data: +@type: +@timestamp: +@src: + + + +This enum defines the standard states an element may be in. You will normally +use gst_element_set_state() to change the state of an element. + + + +@GST_STATE_VOID_PENDING: +@GST_STATE_NULL: Reset the state of an element. +@GST_STATE_READY: will make the element ready to start processing data. some +elements might have a non trivial way to initialize themselves. +@GST_STATE_PAUSED: means there really is data flowing temporary stops the data flow. +@GST_STATE_PLAYING: means there really is data flowing through the graph. + + + +This enum defines the standard return values that an element +can return after a state change. + + + +@GST_STATE_FAILURE: the element could not perform the state change +@GST_STATE_SUCCESS: the element successfully changed its state +@GST_STATE_ASYNC: the element will asynchronously change its state as soon as possible + + + + + + +@GST_RESULT_OK: +@GST_RESULT_NOK: +@GST_RESULT_NOT_IMPL: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gsturi.sgml b/docs/gst/tmpl/gsturi.sgml index 1488c3db79..89646ae08f 100644 --- a/docs/gst/tmpl/gsturi.sgml +++ b/docs/gst/tmpl/gsturi.sgml @@ -2,7 +2,7 @@ GstURIHandler -Register URIs and the elements that can handle them. +Plugin feature that describes URI types and the element that handles it @@ -15,3 +15,173 @@ and the element property that can handle a given URI. + + + + + +@GST_URI_UNKNOWN: +@GST_URI_SINK: +@GST_URI_SRC: + + + + + + + + + + + + + +@obj: + + + + + + + +@obj: + + + + + + + +@obj: + + + + + + + +@obj: + + + + + + + + + + + + + +@parent: +@new_uri: +@get_type: +@get_protocols: +@get_uri: +@set_uri: +@_gst_reserved: + + + + + + +@protocol: +@Returns: + + + + + + + +@uri: +@Returns: + + + + + + + +@uri: +@Returns: + + + + + + + +@uri: +@Returns: + + + + + + + +@protocol: +@location: +@Returns: + + + + + + + +@type: +@uri: +@elementname: +@Returns: + + + + + + + +@handler: +@Returns: + + + + + + + +@handler: +@Returns: + + + + + + + +@handler: +@Returns: + + + + + + + +@handler: +@uri: +@Returns: + + + + + + + +@handler: +@uri: + + diff --git a/docs/gst/tmpl/gsturitype.sgml b/docs/gst/tmpl/gsturitype.sgml new file mode 100644 index 0000000000..15ad3c748c --- /dev/null +++ b/docs/gst/tmpl/gsturitype.sgml @@ -0,0 +1,31 @@ + +GstURIType + + + + + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + diff --git a/docs/gst/tmpl/gstutils.sgml b/docs/gst/tmpl/gstutils.sgml index a61c50cdd7..d496e03d54 100644 --- a/docs/gst/tmpl/gstutils.sgml +++ b/docs/gst/tmpl/gstutils.sgml @@ -14,6 +14,15 @@ Some convenience functions + + + + + +@value: +@value_str: + + @@ -24,15 +33,6 @@ Some convenience functions @value: - - - - - -@value: -@value_str: - - @@ -42,16 +42,6 @@ Some convenience functions @size: - - - - - -@buf: -@indent: -@element: - - @@ -62,3 +52,68 @@ Some convenience functions @pad: + + + + + +@buf: +@indent: +@element: + + + + + + + +@type: +@type_as_function: +@parent_type: +@\ + parent_type_macro: +@\ + parent_type_macro: +@\ + parent_type_macro: +@\ + parent_type_macro: +@\ + parent_type_macro: +@\ + parent_type_macro: +@additional_initializations: + + + + + + + +@type: +@type_as_function: +@parent_type: +@parent_type_macro: + + + + + + + +@parent_class_cast: +@name: +@args: + + + + + + + +@parent_class_cast: +@name: +@args: +@def_return: + + diff --git a/docs/gst/tmpl/gstvalue.sgml b/docs/gst/tmpl/gstvalue.sgml index 86421afd75..5bad0e5f17 100644 --- a/docs/gst/tmpl/gstvalue.sgml +++ b/docs/gst/tmpl/gstvalue.sgml @@ -14,13 +14,256 @@ GstValue - + + + + + +@a: +@b: +@c: +@d: + + + + + + + +@f: + + + + + + + + + + + + + + +@fourcc: + + + + + + + +@x: + + + + + + + +@x: + + + + + + + +@x: + + + + + + + +@x: + + + + + + + +@x: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@value1: +@value2: +@Returns: + + + + + + + +@value1: +@Returns: + + + + + + + +@dest: +@s: +@Returns: + + + + + + + +@dest: +@value1: +@value2: +@Returns: + + + + + + + +@dest: +@value1: +@value2: +@Returns: + + + + + + + +@type: +@compare: +@serialize: +@deserialize: +@_gst_reserved: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@table: + + + + + + + +@dest: +@src: + + + @value: -@prepend_value: +@Returns: + + + + + + + +@dest: +@src: +@Returns: @@ -32,6 +275,25 @@ GstValue @append_value: + + + + + +@value: +@prepend_value: + + + + + + + +@dest: +@value1: +@value2: + + @@ -51,16 +313,6 @@ GstValue @Returns: - - - - - -@dest: -@value1: -@value2: - - @@ -155,16 +407,6 @@ GstValue @calue: - - - - - -@value1: -@value2: -@Returns: - - @@ -175,7 +417,7 @@ GstValue @Returns: - + @@ -196,6 +438,16 @@ GstValue @Returns: + + + + + +@value1: +@value2: +@Returns: + + @@ -206,16 +458,6 @@ GstValue @func: - - - - - -@value1: -@value2: -@Returns: - - @@ -227,6 +469,16 @@ GstValue @Returns: + + + + + +@value1: +@value2: +@Returns: + + @@ -237,79 +489,3 @@ GstValue @func: - - - - - -@table: - - - - - - - -@dest: -@src: - - - - - - - -@value: -@Returns: - - - - - - - -@dest: -@src: -@Returns: - - - - - - - -@x: - - - - - - - -@x: - - - - - - - -@x: - - - - - - - -@x: - - - - - - - -@x: - - diff --git a/docs/gst/tmpl/gstversion.sgml b/docs/gst/tmpl/gstversion.sgml new file mode 100644 index 0000000000..004a212829 --- /dev/null +++ b/docs/gst/tmpl/gstversion.sgml @@ -0,0 +1,47 @@ + +gstversion + + + + + + + + + + + + + + + + +The major version of GStreamer at compile time + + + + + + +The minor version of GStreamer at compile time + + + + + + +The micro version of GStreamer at compile time + + + + + + + + + +@major: +@minor: +@micro: + + diff --git a/docs/gst/tmpl/gstxml.sgml b/docs/gst/tmpl/gstxml.sgml index d0248f2143..06f83d762a 100644 --- a/docs/gst/tmpl/gstxml.sgml +++ b/docs/gst/tmpl/gstxml.sgml @@ -14,6 +14,31 @@ GstXML + + + + + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@out: +@Returns: + + @@ -33,18 +58,6 @@ GstXML @Returns: - - - - - -@xml: -@buffer: -@size: -@root: -@Returns: - - @@ -56,22 +69,15 @@ GstXML @Returns: - + -@element: -@Returns: - - - - - - - -@element: -@out: +@xml: +@buffer: +@size: +@root: @Returns: diff --git a/docs/gst/tmpl/gstxmlregistry.sgml b/docs/gst/tmpl/gstxmlregistry.sgml new file mode 100644 index 0000000000..088ca4a3eb --- /dev/null +++ b/docs/gst/tmpl/gstxmlregistry.sgml @@ -0,0 +1,122 @@ + +GstXMLRegistry + + + + + + + + + + + + + + + + + + + +@GST_XML_REGISTRY_NONE: +@GST_XML_REGISTRY_TOP: +@GST_XML_REGISTRY_PATHS: +@GST_XML_REGISTRY_PATH: +@GST_XML_REGISTRY_PATHS_DONE: +@GST_XML_REGISTRY_PLUGIN: +@GST_XML_REGISTRY_FEATURE: +@GST_XML_REGISTRY_PADTEMPLATE: +@GST_XML_REGISTRY_CAPS: +@GST_XML_REGISTRY_STRUCTURE: +@GST_XML_REGISTRY_PROPERTIES: + + + + + + +@GST_XML_REGISTRY_READ: +@GST_XML_REGISTRY_WRITE: + + + + + + +@registry: + + + + + + + +@registry: + + + + + + + +@context: +@tag: +@text: +@text_len: +@registry: +@error: +@Returns: + + + + + + + +@registry: +@mode: +@Returns: + + + + + + + +@registry: +@dest: +@size: +@Returns: + + + + + + + +@registry: +@format: +@Varargs: +@Returns: + + + + + + + +@registry: +@Returns: + + + + + + + +@name: +@location: +@Returns: + + diff --git a/docs/gst/tmpl/gthread-cothreads.sgml b/docs/gst/tmpl/gthread-cothreads.sgml new file mode 100644 index 0000000000..05e274ce55 --- /dev/null +++ b/docs/gst/tmpl/gthread-cothreads.sgml @@ -0,0 +1,101 @@ + +gthread-cothreads + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@argc: +@argv: +@Returns: + + + + + + + + + + + + + +@cothreads: +@main: +@current: +@mutex: +@gst_thread: + + + + + + +@new_cothread: +@context: +@func: +@argc: +@argv: + + + + + + + +@cothread: + + + + + + + +@cothread: + + + + + + + +@context: + + + + + + + +@context: + + diff --git a/docs/gst/tmpl/types.sgml b/docs/gst/tmpl/types.sgml new file mode 100644 index 0000000000..e0a1158fa6 --- /dev/null +++ b/docs/gst/tmpl/types.sgml @@ -0,0 +1,79 @@ + +types + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@chain: +@links: +@error: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +