mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-26 11:41:09 +00:00
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:
This commit is contained in:
David Schleef
parent
b988d58ab2
commit
1e4ad29e52
86 changed files with 15902 additions and 5839 deletions
93
ChangeLog
93
ChangeLog
|
|
@ -1,3 +1,96 @@
|
|||
2004-03-24 David Schleef <ds@schleef.org>
|
||||
|
||||
* 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 <rbultje@ronald.bitfreak.net>
|
||||
|
||||
* docs/pwg/other-sink.xml:
|
||||
|
|
|
|||
|
|
@ -78,7 +78,7 @@
|
|||
<chapter id="gstreamer">
|
||||
<title>GStreamer Core Library</title>
|
||||
|
||||
<para>libgst.la provides all the core GStreamer services,
|
||||
<para>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.</para>
|
||||
|
|
@ -92,7 +92,7 @@ with some more specialized elements.</para>
|
|||
&GstCpu;
|
||||
&GstData;
|
||||
&GstElement;
|
||||
&GstElementFactory;
|
||||
<!-- &GstElementFactory; -->
|
||||
&GstError;
|
||||
&GstEvent;
|
||||
&GstFormat;
|
||||
|
|
@ -118,7 +118,7 @@ with some more specialized elements.</para>
|
|||
&GstTagInterface;
|
||||
&GstThread;
|
||||
&GstTypeFind;
|
||||
&GstTypeFindFactory;
|
||||
<!-- &GstTypeFindFactory; -->
|
||||
&GstUri;
|
||||
&GstUtils;
|
||||
<!-- not commented properly yet
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
246
docs/gst/tmpl/GstBin.sgml
Normal file
246
docs/gst/tmpl/GstBin.sgml
Normal file
|
|
@ -0,0 +1,246 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstBin
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BIN_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@klass:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstBinPrePostIterateFunction ##### -->
|
||||
<para>
|
||||
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().
|
||||
</para>
|
||||
|
||||
@bin: The bin that performed the callback
|
||||
@user_data: user data
|
||||
|
||||
|
||||
<!-- ##### ENUM GstBinFlags ##### -->
|
||||
<para>
|
||||
Flags for a bin.
|
||||
</para>
|
||||
|
||||
@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:
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_add ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@element:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_add_many ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@element_1:
|
||||
@Varargs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_remove ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@element:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_remove_many ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@element_1:
|
||||
@Varargs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_get_by_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_get_by_name_recurse_up ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_get_list ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_get_by_interface ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@interface:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_get_all_by_interface ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@interface:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_iterate ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_use_clock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@clock:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_get_clock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_auto_clock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_sync_children_state ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_child_state_change ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@oldstate:
|
||||
@newstate:
|
||||
@child:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_set_pre_iterate_function ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@func:
|
||||
@user_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_set_post_iterate_function ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@func:
|
||||
@user_data:
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstBin::element-added ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@gstbin: the object which received the signal.
|
||||
@arg1: the element that was added to the bin
|
||||
|
||||
<!-- ##### SIGNAL GstBin::element-removed ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@gstbin: the object which received the signal.
|
||||
@arg1: the element that was removed from the bin
|
||||
|
||||
<!-- ##### SIGNAL GstBin::iterate ##### -->
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
|
||||
@gstbin: the object which received the signal.
|
||||
@Returns: TRUE if the state of the bin was advanced.
|
||||
|
||||
419
docs/gst/tmpl/GstBuffer.sgml
Normal file
419
docs/gst/tmpl/GstBuffer.sgml
Normal file
|
|
@ -0,0 +1,419 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstBuffer
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstBuffer ##### -->
|
||||
<para>
|
||||
The basic structure of a buffer.
|
||||
</para>
|
||||
|
||||
@data_type:
|
||||
@data:
|
||||
@size:
|
||||
@maxsize:
|
||||
@timestamp:
|
||||
@duration:
|
||||
@offset:
|
||||
@offset_end:
|
||||
@free_data:
|
||||
@buffer_private:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### USER_FUNCTION GstBufferFreeDataFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_TRACE_NAME ##### -->
|
||||
<para>
|
||||
The name used for tracing memory allocations
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_REFCOUNT ##### -->
|
||||
<para>
|
||||
Gets a handle to the refcount structure of the buffer.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to get the refcount structure of.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_REFCOUNT_VALUE ##### -->
|
||||
<para>
|
||||
Gets the current refcount value of the buffer.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to get the refcount value of.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_COPY_FUNC ##### -->
|
||||
<para>
|
||||
Calls the buffer-specific copy function on the given buffer.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to copy.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_FREE_FUNC ##### -->
|
||||
<para>
|
||||
Calls the buffer-specific free function on the given buffer.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to free.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_FLAGS ##### -->
|
||||
<para>
|
||||
Gets the flags from this buffer.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to retrieve the flags from.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_FLAG_IS_SET ##### -->
|
||||
<para>
|
||||
Gives the status of a given flag of a buffer.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to query flags of.
|
||||
@flag: the #GstBufferFlag to check.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_FLAG_SET ##### -->
|
||||
<para>
|
||||
Sets a buffer flag.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to modify flags of.
|
||||
@flag: the #GstBufferFlag to set.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_FLAG_UNSET ##### -->
|
||||
<para>
|
||||
Clears a buffer flag.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to modify flags of.
|
||||
@flag: the #GstBufferFlag to clear.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_DATA ##### -->
|
||||
<para>
|
||||
Retrieves a pointer to the data element of this buffer.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to get data pointer of.
|
||||
@Returns: the pointer to the actual data contents of the buffer.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_SIZE ##### -->
|
||||
<para>
|
||||
Gets the size of the data in this buffer.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to get data size of.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_MAXSIZE ##### -->
|
||||
<para>
|
||||
Gets the maximum size of this buffer.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to get maximum size of.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_TIMESTAMP ##### -->
|
||||
<para>
|
||||
Gets the timestamp for this buffer.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to get timestamp of.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_DURATION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_FORMAT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_OFFSET ##### -->
|
||||
<para>
|
||||
Gets the offset in the source file of this buffer.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to get offset of.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_OFFSET_END ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_FREE_DATA_FUNC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_PRIVATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_OFFSET_NONE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_MAXSIZE_NONE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_DURATION_IS_VALID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_TIMESTAMP_IS_VALID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_OFFSET_IS_VALID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_OFFSET_END_IS_VALID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_MAXSIZE_IS_VALID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### ENUM GstBufferFlag ##### -->
|
||||
<para>
|
||||
A set of buffer flags used to describe properties of a #GstBuffer.
|
||||
</para>
|
||||
|
||||
@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.
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_new_and_alloc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@size:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_buffer_set_data ##### -->
|
||||
<para>
|
||||
A convenience function to set the data and size on a buffer
|
||||
</para>
|
||||
|
||||
@buf: The buffer to modify
|
||||
@data: The data to set on the buffer
|
||||
@size: The size to set on the buffer
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_buffer_ref ##### -->
|
||||
<para>
|
||||
Increases the refcount of the given buffer by one.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to increase the refcount of.
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_buffer_ref_by_count ##### -->
|
||||
<para>
|
||||
Increases the refcount of the buffer by the given value.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to increase the refcount of.
|
||||
@c: the value to add to the refcount.
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_buffer_unref ##### -->
|
||||
<para>
|
||||
Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
|
||||
will be freed.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to unref.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_stamp ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@src:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_buffer_copy ##### -->
|
||||
<para>
|
||||
Copies the given buffer using the copy function of the parent GstData structure.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to copy.
|
||||
@Returns: a new #GstBuffer copy of the buffer.
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_buffer_is_writable ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_buffer_copy_on_write ##### -->
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
|
||||
@buf: a #GstBuffer to copy
|
||||
@Returns: the #GstBuffer that can safely be written to.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_create_sub ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent:
|
||||
@offset:
|
||||
@size:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_merge ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf1:
|
||||
@buf2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_is_span_fast ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf1:
|
||||
@buf2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_span ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf1:
|
||||
@offset:
|
||||
@buf2:
|
||||
@len:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_default_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_default_copy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@Returns:
|
||||
|
||||
|
||||
413
docs/gst/tmpl/GstCaps.sgml
Normal file
413
docs/gst/tmpl/GstCaps.sgml
Normal file
|
|
@ -0,0 +1,413 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstCaps
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_FLAGS_ANY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_ANY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_NONE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_STATIC_CAPS_ANY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_STATIC_CAPS_NONE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_IS_SIMPLE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_caps_is_simple ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_CAPS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@caps:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_STATIC_CAPS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstCaps ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@flags:
|
||||
@structs:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### STRUCT GstStaticCaps ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@string:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_new_empty ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_new_any ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_new_simple ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@media_type:
|
||||
@fieldname:
|
||||
@Varargs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_new_full ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@struct1:
|
||||
@Varargs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_new_full_valist ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@var_args:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_copy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_static_caps_get ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_append ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps1:
|
||||
@caps2:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_append_structure ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps1:
|
||||
@structure:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_split_one ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_get_size ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_get_structure ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@index:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_copy_1 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_set_simple ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@field:
|
||||
@Varargs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_set_simple_valist ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@field:
|
||||
@varargs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_is_any ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_is_empty ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_is_chained ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_is_fixed ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_is_equal_fixed ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps1:
|
||||
@caps2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_is_always_compatible ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps1:
|
||||
@caps2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_intersect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps1:
|
||||
@caps2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_union ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps1:
|
||||
@caps2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_normalize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_simplify ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_save_thyself ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@parent:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_load_thyself ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_replace ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@newcaps:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_to_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_from_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_int ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@field_name:
|
||||
@target:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_double ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@field_name:
|
||||
@target:
|
||||
@Returns:
|
||||
|
||||
|
||||
425
docs/gst/tmpl/GstClock.sgml
Normal file
425
docs/gst/tmpl/GstClock.sgml
Normal file
|
|
@ -0,0 +1,425 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstClock
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF GstClockTime ##### -->
|
||||
<para>
|
||||
A datatype to hold a time, measured in nanoseconds.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF GstClockTimeDiff ##### -->
|
||||
<para>
|
||||
A datatype to hold a timedifference, measured in nanoseconds.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF GstClockID ##### -->
|
||||
<para>
|
||||
A detatype to hold the handle to an outstanding async clock callback
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CLOCK_TIME_NONE ##### -->
|
||||
<para>
|
||||
Constant to define an undefined clock time
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CLOCK_TIME_IS_VALID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@time:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SECOND ##### -->
|
||||
<para>
|
||||
Constant that defines one GStreamer second
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_MSECOND ##### -->
|
||||
<para>
|
||||
Constant that defines one GStreamer millisecond
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_USECOND ##### -->
|
||||
<para>
|
||||
Constant that defines one GStreamer microsecond
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_NSECOND ##### -->
|
||||
<para>
|
||||
Constant that defines one GStreamer nanosecond
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CLOCK_DIFF ##### -->
|
||||
<para>
|
||||
Calculate a difference between to clock times.
|
||||
</para>
|
||||
|
||||
@s: the first time
|
||||
@e: the second time
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TIMEVAL_TO_TIME ##### -->
|
||||
<para>
|
||||
Convert a GTimeVal to a GstClockTime
|
||||
</para>
|
||||
|
||||
@tv: the timeval to convert
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TIME_TO_TIMEVAL ##### -->
|
||||
<para>
|
||||
Convert a GstClockTime to a GTimeVal
|
||||
</para>
|
||||
|
||||
@t: The GstClockTime to convert
|
||||
@tv: The target timeval
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CLOCK_ENTRY_TRACE_NAME ##### -->
|
||||
<para>
|
||||
The name used for tracing clock entry allocations.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstClockEntry ##### -->
|
||||
<para>
|
||||
All pending timeouts or periodic notifies are converted into
|
||||
an entry.
|
||||
</para>
|
||||
|
||||
@clock:
|
||||
@type:
|
||||
@time:
|
||||
@interval:
|
||||
@status:
|
||||
@func:
|
||||
@user_data:
|
||||
|
||||
<!-- ##### USER_FUNCTION GstClockCallback ##### -->
|
||||
<para>
|
||||
The function prototype of the callback.
|
||||
</para>
|
||||
|
||||
@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:
|
||||
|
||||
|
||||
<!-- ##### ENUM GstClockEntryStatus ##### -->
|
||||
<para>
|
||||
The status of a clock timeout.
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
<!-- ##### ENUM GstClockEntryType ##### -->
|
||||
<para>
|
||||
The type of the clock entry
|
||||
</para>
|
||||
|
||||
@GST_CLOCK_ENTRY_SINGLE: a single shot timeout
|
||||
@GST_CLOCK_ENTRY_PERIODIC: a periodic timeout request
|
||||
|
||||
<!-- ##### MACRO GST_CLOCK_ENTRY ##### -->
|
||||
<para>
|
||||
Cast to a clock entry
|
||||
</para>
|
||||
|
||||
@entry: the entry to cast
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CLOCK_ENTRY_CLOCK ##### -->
|
||||
<para>
|
||||
Get the owner clock of the entry
|
||||
</para>
|
||||
|
||||
@entry: the entry to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CLOCK_ENTRY_TYPE ##### -->
|
||||
<para>
|
||||
Get the type of the clock entry
|
||||
</para>
|
||||
|
||||
@entry: the entry to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CLOCK_ENTRY_TIME ##### -->
|
||||
<para>
|
||||
Get the requested time of this entry
|
||||
</para>
|
||||
|
||||
@entry: the entry to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CLOCK_ENTRY_INTERVAL ##### -->
|
||||
<para>
|
||||
Get the interval of this periodic entry
|
||||
</para>
|
||||
|
||||
@entry: the entry to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CLOCK_ENTRY_STATUS ##### -->
|
||||
<para>
|
||||
The status of the entry
|
||||
</para>
|
||||
|
||||
@entry: the entry to query
|
||||
|
||||
|
||||
<!-- ##### ENUM GstClockReturn ##### -->
|
||||
<para>
|
||||
The return value of a clock operation.
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
<!-- ##### ENUM GstClockFlags ##### -->
|
||||
<para>
|
||||
The capabilities of this clock
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
<!-- ##### MACRO GST_CLOCK_FLAGS ##### -->
|
||||
<para>
|
||||
Get the clock flags
|
||||
</para>
|
||||
|
||||
@clock: the clock to query
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_set_speed ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@clock:
|
||||
@speed:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_get_speed ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@clock:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_set_resolution ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@clock:
|
||||
@resolution:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_get_resolution ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@clock:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_set_active ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@clock:
|
||||
@active:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_is_active ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@clock:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_reset ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@clock:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_handle_discont ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@clock:
|
||||
@time:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_get_time ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@clock:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_get_event_time ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@clock:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_get_next_id ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@clock:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_new_single_shot_id ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@clock:
|
||||
@time:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_new_periodic_id ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@clock:
|
||||
@start_time:
|
||||
@interval:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_id_get_time ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@id:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_id_wait ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@id:
|
||||
@jitter:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_id_wait_async ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@id:
|
||||
@func:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_id_unschedule ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@id:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_id_unlock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@id:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_id_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@id:
|
||||
|
||||
|
||||
<!-- ##### ARG GstClock:event-diff ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstClock:max-diff ##### -->
|
||||
<para>
|
||||
Maximum allowed diff for clock sync requests against the real time.
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstClock:stats ##### -->
|
||||
<para>
|
||||
Boolean property to activate stat generation on the clock.
|
||||
</para>
|
||||
|
||||
152
docs/gst/tmpl/GstCompat.sgml
Normal file
152
docs/gst/tmpl/GstCompat.sgml
Normal file
|
|
@ -0,0 +1,152 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstCompat
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_element_connect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_element_connect_pads ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
@c:
|
||||
@d:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_element_connect_many ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@...:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_element_connect_filtered ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
@c:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_element_disconnect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_pad_connect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_pad_connect_filtered ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
@c:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_pad_disconnect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_pad_proxy_connect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_pad_set_connect_function ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PAD_CONNECT_REFUSED ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PAD_CONNECT_DELAYED ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PAD_CONNECT_OK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PAD_CONNECT_DONE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF GstPadConnectReturn ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF GstPadConnectFunction ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
220
docs/gst/tmpl/GstData.sgml
Normal file
220
docs/gst/tmpl/GstData.sgml
Normal file
|
|
@ -0,0 +1,220 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstData
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DATA ##### -->
|
||||
<para>
|
||||
Cast a pointer to a GstData
|
||||
</para>
|
||||
|
||||
@data: The pointer to cast
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DATA_TYPE ##### -->
|
||||
<para>
|
||||
Get the type of the GstData
|
||||
</para>
|
||||
|
||||
@data: The data to get the type of
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DATA_FLAGS ##### -->
|
||||
<para>
|
||||
Get the flags of this GstData
|
||||
</para>
|
||||
|
||||
@data: The data to get the flags of
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DATA_FLAG_SHIFT ##### -->
|
||||
<para>
|
||||
Shift a given flag so that it can be used in an or operation
|
||||
</para>
|
||||
|
||||
@flag: The flag to shift
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DATA_FLAG_UNSET ##### -->
|
||||
<para>
|
||||
Unset the given flag
|
||||
</para>
|
||||
|
||||
@data: The data to unset the flag of
|
||||
@flag: The flag to unset
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_DATA ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstData ##### -->
|
||||
<para>
|
||||
The base structure
|
||||
</para>
|
||||
|
||||
@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:
|
||||
|
||||
<!-- ##### USER_FUNCTION GstDataFreeFunction ##### -->
|
||||
<para>
|
||||
The signature of the free function. Subclasses should provide a free function
|
||||
with this signature and pass it in the gst_data_init() function.
|
||||
</para>
|
||||
|
||||
@data: The GstData to free
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstDataCopyFunction ##### -->
|
||||
<para>
|
||||
The signature of the copy function. Subclasses should provide a copy function
|
||||
with this signature and pass it in the gst_data_init() function.
|
||||
</para>
|
||||
|
||||
@data: The GstData to copy
|
||||
@Returns: A new GstData that is a copy of data
|
||||
|
||||
|
||||
<!-- ##### ENUM GstDataFlags ##### -->
|
||||
<para>
|
||||
Various flags that can be set on a GstData
|
||||
</para>
|
||||
|
||||
@GST_DATA_READONLY: The data is readonly
|
||||
@GST_DATA_FLAG_LAST: Subclasses can add additional flags starting from this offset
|
||||
|
||||
<!-- ##### MACRO GST_DATA_REFCOUNT ##### -->
|
||||
<para>
|
||||
Get access to the refcount field of the GstData
|
||||
</para>
|
||||
|
||||
@data: The GstData to get the refcount field of
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DATA_REFCOUNT_VALUE ##### -->
|
||||
<para>
|
||||
Get the current refcount value
|
||||
</para>
|
||||
|
||||
@data: The GstData to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DATA_COPY_FUNC ##### -->
|
||||
<para>
|
||||
Get access to the copy function of the data
|
||||
</para>
|
||||
|
||||
@data: The data to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DATA_FREE_FUNC ##### -->
|
||||
<para>
|
||||
Get access to the free function of the data
|
||||
</para>
|
||||
|
||||
@data: The data to query
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_data_init ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@data:
|
||||
@type:
|
||||
@flags:
|
||||
@free:
|
||||
@copy:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_data_dispose ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_data_copy_into ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@data:
|
||||
@target:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_data_copy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_data_is_writable ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_data_copy_on_write ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_data_ref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_data_ref_by_count ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@data:
|
||||
@count:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_data_unref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@data:
|
||||
|
||||
|
||||
1315
docs/gst/tmpl/GstElement.sgml
Normal file
1315
docs/gst/tmpl/GstElement.sgml
Normal file
File diff suppressed because it is too large
Load diff
433
docs/gst/tmpl/GstEvent.sgml
Normal file
433
docs/gst/tmpl/GstEvent.sgml
Normal file
|
|
@ -0,0 +1,433 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstEvent
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### ENUM GstEventType ##### -->
|
||||
<para>
|
||||
The different major types of events.
|
||||
</para>
|
||||
|
||||
@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:
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_TRACE_NAME ##### -->
|
||||
<para>
|
||||
The name used for memory allocation tracing
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_TYPE ##### -->
|
||||
<para>
|
||||
Get the event type.
|
||||
</para>
|
||||
|
||||
@event: The event to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_TIMESTAMP ##### -->
|
||||
<para>
|
||||
Get the timestamp of the event.
|
||||
</para>
|
||||
|
||||
@event: The event to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SRC ##### -->
|
||||
<para>
|
||||
The source object that generated this event
|
||||
</para>
|
||||
|
||||
@event: The event to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_IS_INTERRUPT ##### -->
|
||||
<para>
|
||||
Check if the event is an interrupt event
|
||||
</para>
|
||||
|
||||
@event: The event to check
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_FORMAT_SHIFT ##### -->
|
||||
<para>
|
||||
Shift for the format in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_METHOD_SHIFT ##### -->
|
||||
<para>
|
||||
Shift for the method in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_FLAGS_SHIFT ##### -->
|
||||
<para>
|
||||
Shift for the flags in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_FORMAT_MASK ##### -->
|
||||
<para>
|
||||
Mask for the format in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_METHOD_MASK ##### -->
|
||||
<para>
|
||||
Mask for the method in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_FLAGS_MASK ##### -->
|
||||
<para>
|
||||
Mask for the flags in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### ENUM GstEventFlag ##### -->
|
||||
<para>
|
||||
Event flags are used when querying for supported events
|
||||
</para>
|
||||
|
||||
@GST_EVENT_FLAG_NONE: no value
|
||||
@GST_RATE_FLAG_NEGATIVE: indicates negative rates are supported
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_MASK_FUNCTION ##### -->
|
||||
<para>
|
||||
A convenience macro to create event mask functions
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
|
||||
<!-- ##### ENUM GstSeekType ##### -->
|
||||
<para>
|
||||
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().
|
||||
|
||||
<informalexample>
|
||||
Following example illustrates how to insert a seek event (1 second in the stream)
|
||||
in a pipeline.
|
||||
|
||||
<programlisting>
|
||||
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");
|
||||
}
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
<!-- ##### ENUM GstSeekAccuracy ##### -->
|
||||
<para>
|
||||
The seekaccuracy gives more information of how the seek was performed,
|
||||
if the seek was accurate or fuzzy.
|
||||
</para>
|
||||
|
||||
@GST_SEEK_CERTAIN: The seek was exact
|
||||
@GST_SEEK_FUZZY: The seek was fuzzy, exact position can not be guaranteed
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SEEK_TYPE ##### -->
|
||||
<para>
|
||||
Get the seektype of the GST_EVENT_SEEK.
|
||||
</para>
|
||||
|
||||
@event: The event to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SEEK_FORMAT ##### -->
|
||||
<para>
|
||||
The format of the seek value
|
||||
</para>
|
||||
|
||||
@event: The event operate on
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SEEK_METHOD ##### -->
|
||||
<para>
|
||||
The seek method to use as one of #GstSeekType
|
||||
</para>
|
||||
|
||||
@event: The event operate on
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SEEK_FLAGS ##### -->
|
||||
<para>
|
||||
The optional seek flags
|
||||
</para>
|
||||
|
||||
@event: The event operate on
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SEEK_OFFSET ##### -->
|
||||
<para>
|
||||
Get the offset of the seek event.
|
||||
</para>
|
||||
|
||||
@event: The event to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SEEK_ENDOFFSET ##### -->
|
||||
<para>
|
||||
The event stop position for a segment seek
|
||||
</para>
|
||||
|
||||
@event: The event to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SEEK_ACCURACY ##### -->
|
||||
<para>
|
||||
Indicates how accurate the event was performed.
|
||||
</para>
|
||||
|
||||
@event: The event to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_DISCONT_NEW_MEDIA ##### -->
|
||||
<para>
|
||||
Flag that indicates the discont event was because of a new media
|
||||
type.
|
||||
</para>
|
||||
|
||||
@event: The event to operate on
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_DISCONT_OFFSET ##### -->
|
||||
<para>
|
||||
The offset of the discont event. A discont evetn can hold up to 8 different
|
||||
format/value pairs.
|
||||
</para>
|
||||
|
||||
@event: The event to query
|
||||
@i: The offset/value pair.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_DISCONT_OFFSET_LEN ##### -->
|
||||
<para>
|
||||
Get the number of offset/value pairs this event has.
|
||||
</para>
|
||||
|
||||
@event: The event to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SIZE_FORMAT ##### -->
|
||||
<para>
|
||||
The format of the size event.
|
||||
</para>
|
||||
|
||||
@event: The event to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SIZE_VALUE ##### -->
|
||||
<para>
|
||||
The value of the size event
|
||||
</para>
|
||||
|
||||
@event: The event to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_RATE_VALUE ##### -->
|
||||
<para>
|
||||
Get access to the rate vale field
|
||||
</para>
|
||||
|
||||
@event: The event to query
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstEvent ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@data:
|
||||
@type:
|
||||
@timestamp:
|
||||
@src:
|
||||
|
||||
<!-- ##### FUNCTION gst_event_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_event_ref ##### -->
|
||||
<para>
|
||||
Increase the refcount of this event
|
||||
</para>
|
||||
|
||||
@ev: The event to refcount
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_event_ref_by_count ##### -->
|
||||
<para>
|
||||
Increase the refcount of the event with the given value
|
||||
</para>
|
||||
|
||||
@ev: The event to refcount
|
||||
@c: The value to add to the refcount
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_event_unref ##### -->
|
||||
<para>
|
||||
Decrease the refcount of an event, freeing it if the refcount reaches 0
|
||||
</para>
|
||||
|
||||
@ev: The event to unref
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_event_copy ##### -->
|
||||
<para>
|
||||
Copy the event using the event specific copy function
|
||||
</para>
|
||||
|
||||
@ev: The event to copy
|
||||
@Returns: A new event that is a copy of the given input event
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_masks_contains ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@masks:
|
||||
@mask:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_new_seek ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@offset:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_new_segment_seek ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@start:
|
||||
@stop:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_new_size ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@format:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_new_discontinuous ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@new_media:
|
||||
@format1:
|
||||
@Varargs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_new_discontinuous_valist ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@new_media:
|
||||
@format1:
|
||||
@var_args:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_discont_get_value ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@event:
|
||||
@format:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_event_new_filler ##### -->
|
||||
<para>
|
||||
Create a new dummy event that should be ignored
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_event_new_flush ##### -->
|
||||
<para>
|
||||
Create a new flush event.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
523
docs/gst/tmpl/GstIndex.sgml
Normal file
523
docs/gst/tmpl/GstIndex.sgml
Normal file
|
|
@ -0,0 +1,523 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstIndexFactory
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_INDEX_ENTRY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstIndexEntry ##### -->
|
||||
<para>
|
||||
The basic element of an index.
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@id:
|
||||
|
||||
<!-- ##### STRUCT GstIndexGroup ##### -->
|
||||
<para>
|
||||
A group of related entries in an index.
|
||||
</para>
|
||||
|
||||
@groupnum:
|
||||
@entries:
|
||||
@certainty:
|
||||
@peergroup:
|
||||
|
||||
<!-- ##### ENUM GstIndexCertainty ##### -->
|
||||
<para>
|
||||
The certainty of a group in the index.
|
||||
</para>
|
||||
|
||||
@GST_INDEX_UNKNOWN: accuracy is not known
|
||||
@GST_INDEX_CERTAIN: accuracy is perfect
|
||||
@GST_INDEX_FUZZY: accuracy is fuzzy
|
||||
|
||||
<!-- ##### ENUM GstIndexEntryType ##### -->
|
||||
<para>
|
||||
The different types of entries in the index.
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
<!-- ##### ENUM GstIndexLookupMethod ##### -->
|
||||
<para>
|
||||
Specify the method to find an index entry in the index.
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_NASSOCS ##### -->
|
||||
<para>
|
||||
Get the number of associations in the entry.
|
||||
</para>
|
||||
|
||||
@entry: The entry to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_ASSOC_FLAGS ##### -->
|
||||
<para>
|
||||
Get the flags for this entry
|
||||
</para>
|
||||
|
||||
@entry: The entry to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_ASSOC_FORMAT ##### -->
|
||||
<para>
|
||||
Get the i-th format of the entry.
|
||||
</para>
|
||||
|
||||
@entry: The entry to query
|
||||
@i: The format index
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_ASSOC_VALUE ##### -->
|
||||
<para>
|
||||
Get the i-th value of the entry.
|
||||
</para>
|
||||
|
||||
@entry: The entry to query
|
||||
@i: The value index
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstIndexAssociation ##### -->
|
||||
<para>
|
||||
An association in an entry.
|
||||
</para>
|
||||
|
||||
@format: the format of the association
|
||||
@value: the value of the association
|
||||
|
||||
<!-- ##### ENUM GstAssocFlags ##### -->
|
||||
<para>
|
||||
flags for an association entry
|
||||
</para>
|
||||
|
||||
@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.
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_FORMAT_FORMAT ##### -->
|
||||
<para>
|
||||
Get the format of the format entry
|
||||
</para>
|
||||
|
||||
@entry: The entry to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_FORMAT_KEY ##### -->
|
||||
<para>
|
||||
Get the key of the format entry
|
||||
</para>
|
||||
|
||||
@entry: The entry to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_ID_INVALID ##### -->
|
||||
<para>
|
||||
An invalid index id
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_ID_DESCRIPTION ##### -->
|
||||
<para>
|
||||
Get the description of the id entry
|
||||
</para>
|
||||
|
||||
@entry: The entry to query
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstIndexFilter ##### -->
|
||||
<para>
|
||||
Function to filter out entries in the index.
|
||||
</para>
|
||||
|
||||
@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.
|
||||
|
||||
|
||||
<!-- ##### ENUM GstIndexResolverMethod ##### -->
|
||||
<para>
|
||||
The method used to resolve index writers
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
<!-- ##### USER_FUNCTION GstIndexResolver ##### -->
|
||||
<para>
|
||||
Function to resolve ids to writer descriptions.
|
||||
</para>
|
||||
|
||||
@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.
|
||||
<!-- # Unused Parameters # -->
|
||||
@writer_id: A pointer to the id that has to be assigned to this writer
|
||||
|
||||
|
||||
<!-- ##### ENUM GstIndexFlags ##### -->
|
||||
<para>
|
||||
Flags for this index
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_IS_READABLE ##### -->
|
||||
<para>
|
||||
Check if the index can be read from
|
||||
</para>
|
||||
|
||||
@obj: The index to check
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_IS_WRITABLE ##### -->
|
||||
<para>
|
||||
Check if the index can be written to
|
||||
</para>
|
||||
|
||||
@obj: The index to check
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_commit ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@id:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_get_group ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_new_group ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_set_group ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@groupnum:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_set_certainty ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@certainty:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_get_certainty ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_set_filter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@filter:
|
||||
@user_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_set_resolver ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@resolver:
|
||||
@user_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_get_writer_id ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@writer:
|
||||
@id:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_add_format ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@id:
|
||||
@format:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_add_association ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@id:
|
||||
@flags:
|
||||
@format:
|
||||
@value:
|
||||
@Varargs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_add_object ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@id:
|
||||
@key:
|
||||
@type:
|
||||
@object:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_add_id ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@id:
|
||||
@description:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_get_assoc_entry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@id:
|
||||
@method:
|
||||
@flags:
|
||||
@format:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_get_assoc_entry_full ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@id:
|
||||
@method:
|
||||
@flags:
|
||||
@format:
|
||||
@value:
|
||||
@func:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_entry_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_entry_copy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@entry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_entry_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@entry:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_entry_assoc_map ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@entry:
|
||||
@format:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_INDEX_FACTORY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_FACTORY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_IS_INDEX_FACTORY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_FACTORY_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@klass:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_IS_INDEX_FACTORY_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@klass:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_FACTORY_GET_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_factory_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_factory_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@longdesc:
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_factory_destroy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_factory_find ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_factory_create ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_factory_make ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
366
docs/gst/tmpl/GstStructure.sgml
Normal file
366
docs/gst/tmpl/GstStructure.sgml
Normal file
|
|
@ -0,0 +1,366 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstStructure
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstStructure ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@name:
|
||||
@fields:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### USER_FUNCTION GstStructureForeachFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@field_id:
|
||||
@value:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_empty_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_id_empty_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@quark:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@firstfield:
|
||||
@Varargs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_new_valist ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@firstfield:
|
||||
@varargs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_copy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_get_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_set_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@name:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_id_set_value ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@field:
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_set_value ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@fieldname:
|
||||
@value:
|
||||
<!-- # Unused Parameters # -->
|
||||
@field:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_set ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@fieldname:
|
||||
@Varargs:
|
||||
<!-- # Unused Parameters # -->
|
||||
@field:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_set_valist ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@fieldname:
|
||||
@varargs:
|
||||
<!-- # Unused Parameters # -->
|
||||
@field:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_id_get_value ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@field:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_get_value ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@fieldname:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@field:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_remove_field ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@fieldname:
|
||||
<!-- # Unused Parameters # -->
|
||||
@field:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_remove_fields ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@fieldname:
|
||||
@Varargs:
|
||||
<!-- # Unused Parameters # -->
|
||||
@fieldnamename:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_remove_fields_valist ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@fieldname:
|
||||
@varargs:
|
||||
<!-- # Unused Parameters # -->
|
||||
@fieldnamename:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_remove_all_fields ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_get_field_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@fieldname:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@field:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_foreach ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@func:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_n_fields ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_has_field ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@fieldname:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@field:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_has_field_typed ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@fieldname:
|
||||
@type:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@field:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_get_boolean ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@fieldname:
|
||||
@value:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@field:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_get_int ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@fieldname:
|
||||
@value:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@field:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_get_fourcc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@fieldname:
|
||||
@value:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@field:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_get_double ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@fieldname:
|
||||
@value:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@fieldnamename:
|
||||
@field:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_get_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@fieldname:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@field:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_to_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_from_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@end:
|
||||
@Returns:
|
||||
|
||||
|
||||
881
docs/gst/tmpl/GstTag.sgml
Normal file
881
docs/gst/tmpl/GstTag.sgml
Normal file
|
|
@ -0,0 +1,881 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstTag
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### ENUM GstTagMergeMode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@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:
|
||||
|
||||
<!-- ##### ENUM GstTagFlag ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GST_TAG_FLAG_UNDEFINED:
|
||||
@GST_TAG_FLAG_META:
|
||||
@GST_TAG_FLAG_ENCODED:
|
||||
@GST_TAG_FLAG_DECODED:
|
||||
@GST_TAG_FLAG_COUNT:
|
||||
|
||||
<!-- ##### TYPEDEF GstTagList ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_LIST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@x:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_IS_TAG_LIST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@x:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_TAG_LIST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstTagForeachFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@user_data:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstTagMergeFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@src:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_register ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@flag:
|
||||
@type:
|
||||
@nick:
|
||||
@blurb:
|
||||
@func:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_merge_use_first ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@src:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_merge_strings_with_comma ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@src:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_exists ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tag:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tag:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_get_nick ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tag:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_get_description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tag:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_get_flag ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tag:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_is_fixed ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tag:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_is_tag_list ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@p:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_copy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_insert ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@into:
|
||||
@from:
|
||||
@mode:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_merge ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list1:
|
||||
@list2:
|
||||
@mode:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_tag_size ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_add ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@mode:
|
||||
@tag:
|
||||
@Varargs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_add_values ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@mode:
|
||||
@tag:
|
||||
@Varargs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_add_valist ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@mode:
|
||||
@tag:
|
||||
@var_args:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_add_valist_values ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@mode:
|
||||
@tag:
|
||||
@var_args:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_remove_tag ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_foreach ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@func:
|
||||
@user_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_value_index ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@index:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_copy_value ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@list:
|
||||
@tag:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_char ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_char_index ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@index:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_uchar ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_uchar_index ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@index:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_boolean ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_boolean_index ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@index:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_int ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_int_index ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@index:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_uint ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_uint_index ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@index:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_long ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_long_index ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@index:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_ulong ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_ulong_index ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@index:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_int64 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_int64_index ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@index:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_uint64 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_uint64_index ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@index:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_float ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_float_index ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@index:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_double ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_double_index ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@index:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_string_index ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@index:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_pointer ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_get_pointer_index ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@tag:
|
||||
@index:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_new_tag ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_tag_get_list ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tag_event:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_TITLE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ARTIST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ALBUM ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_DATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_GENRE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_COMMENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_TRACK_NUMBER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_TRACK_COUNT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ALBUM_VOLUME_NUMBER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ALBUM_VOLUME_COUNT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_LOCATION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_DESCRIPTION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_VERSION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ISRC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ORGANIZATION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_COPYRIGHT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_CONTACT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_LICENSE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_PERFORMER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_DURATION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_CODEC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_VIDEO_CODEC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_AUDIO_CODEC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_BITRATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_NOMINAL_BITRATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_MINIMUM_BITRATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_MAXIMUM_BITRATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_SERIAL ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ENCODER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ENCODER_VERSION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_TRACK_GAIN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_TRACK_PEAK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ALBUM_GAIN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ALBUM_PEAK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
|
|
@ -38,21 +38,9 @@ The cothread state structure
|
|||
@stack_size:
|
||||
@magic_number:
|
||||
|
||||
<!-- ##### USER_FUNCTION cothread_func ##### -->
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
|
||||
@argc: a main-like argument count
|
||||
@argv: a main-like array of arguments
|
||||
@Returns: a return code
|
||||
|
||||
|
||||
<!-- ##### STRUCT cothread_context ##### -->
|
||||
<para>
|
||||
The cothread context structure
|
||||
|
||||
</para>
|
||||
|
||||
@cothreads:
|
||||
|
|
@ -61,6 +49,16 @@ The cothread context structure
|
|||
@mutex:
|
||||
@gst_thread:
|
||||
|
||||
<!-- ##### USER_FUNCTION cothread_func ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@argc:
|
||||
@argv:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO COTHREAD_STARTED ##### -->
|
||||
<para>
|
||||
Indicates the cothread is started.
|
||||
|
|
@ -91,24 +89,26 @@ Indicates the cothread is destroyed.
|
|||
@ctx:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cothread_get_private ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cothread:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cothread_set_private ##### -->
|
||||
<!-- ##### FUNCTION cothread_context_set_data ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cothread:
|
||||
@key:
|
||||
@data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cothread_context_get_data ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cothread:
|
||||
@key:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cothread_create ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -153,26 +153,24 @@ Indicates the cothread is destroyed.
|
|||
@cothread:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cothread_context_get_data ##### -->
|
||||
<!-- ##### FUNCTION cothread_set_private ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cothread:
|
||||
@key:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cothread_context_set_data ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cothread:
|
||||
@key:
|
||||
@data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cothread_get_private ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cothread:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cothread_lock ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
140
docs/gst/tmpl/cothreads_compat.sgml
Normal file
140
docs/gst/tmpl/cothreads_compat.sgml
Normal file
|
|
@ -0,0 +1,140 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
cothreads_compat
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO COTHREADS_NAME ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO COTHREADS_NAME_CAPITAL ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF cothread ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothreads_init ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@x:
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothreads_stackquery ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@stack:
|
||||
@size:
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothread_switch ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@to:
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothread_create ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@new_cothread:
|
||||
@context:
|
||||
@func:
|
||||
@argc:
|
||||
@argv:
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothread_setfunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cothread:
|
||||
@context:
|
||||
@func:
|
||||
@argc:
|
||||
@argv:
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothread_destroy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cothread:
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothread_context_init ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothread_context_destroy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothread_lock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cothread:
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothread_unlock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cothread:
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothread_get_current ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothread_get_main ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
|
||||
|
||||
124
docs/gst/tmpl/gettext.sgml
Normal file
124
docs/gst/tmpl/gettext.sgml
Normal file
|
|
@ -0,0 +1,124 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gettext
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO gettext ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Msgid:
|
||||
<!-- # Unused Parameters # -->
|
||||
@String:
|
||||
|
||||
|
||||
<!-- ##### MACRO dgettext ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Domainname:
|
||||
@Msgid:
|
||||
<!-- # Unused Parameters # -->
|
||||
@Domain:
|
||||
@String:
|
||||
|
||||
|
||||
<!-- ##### MACRO dcgettext ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Domainname:
|
||||
@Msgid:
|
||||
@Category:
|
||||
<!-- # Unused Parameters # -->
|
||||
@Domain:
|
||||
@String:
|
||||
@Type:
|
||||
|
||||
|
||||
<!-- ##### MACRO ngettext ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Msgid1:
|
||||
@Msgid2:
|
||||
@N:
|
||||
|
||||
|
||||
<!-- ##### MACRO dngettext ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Domainname:
|
||||
@Msgid1:
|
||||
@Msgid2:
|
||||
@N:
|
||||
|
||||
|
||||
<!-- ##### MACRO dcngettext ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Domainname:
|
||||
@Msgid1:
|
||||
@Msgid2:
|
||||
@N:
|
||||
@Category:
|
||||
|
||||
|
||||
<!-- ##### MACRO textdomain ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Domainname:
|
||||
<!-- # Unused Parameters # -->
|
||||
@String:
|
||||
|
||||
|
||||
<!-- ##### MACRO bindtextdomain ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Domainname:
|
||||
@Dirname:
|
||||
<!-- # Unused Parameters # -->
|
||||
@Domain:
|
||||
@Directory:
|
||||
|
||||
|
||||
<!-- ##### MACRO bind_textdomain_codeset ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Domainname:
|
||||
@Codeset:
|
||||
|
||||
|
||||
<!-- ##### MACRO gettext_noop ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@String:
|
||||
|
||||
|
||||
79
docs/gst/tmpl/grammar.tab.sgml
Normal file
79
docs/gst/tmpl/grammar.tab.sgml
Normal file
|
|
@ -0,0 +1,79 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
grammar.tab
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO PARSE_URL ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO IDENTIFIER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO BINREF ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO PADREF ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO REF ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO ASSIGNMENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO LINK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO yystype ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO YYSTYPE_IS_TRIVIAL ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
32
docs/gst/tmpl/gst-i18n-app.sgml
Normal file
32
docs/gst/tmpl/gst-i18n-app.sgml
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gst-i18n-app
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO _ ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@String:
|
||||
|
||||
|
||||
<!-- ##### MACRO N_ ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@String:
|
||||
|
||||
|
||||
32
docs/gst/tmpl/gst-i18n-lib.sgml
Normal file
32
docs/gst/tmpl/gst-i18n-lib.sgml
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gst-i18n-lib
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO _ ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@String:
|
||||
|
||||
|
||||
<!-- ##### MACRO N_ ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@String:
|
||||
|
||||
|
||||
|
|
@ -90,11 +90,13 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
|
|||
@argv:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_init_get_popt_table ##### -->
|
||||
<!-- ##### FUNCTION gst_init_check ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@argc:
|
||||
@argv:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
@ -111,16 +113,6 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_init_check ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@argc:
|
||||
@argv:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_init_check_with_popt_table ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -134,14 +126,28 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
|
|||
@Param3:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_version ##### -->
|
||||
<!-- ##### FUNCTION gst_init_get_popt_table ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@major:
|
||||
@minor:
|
||||
@micro:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_use_threads ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@use_threads:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_has_threads ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_main ##### -->
|
||||
|
|
@ -158,46 +164,3 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
|
|||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_has_threads ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_use_threads ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@use_threads:
|
||||
|
||||
|
||||
<!-- ##### VARIABLE g_log_domain_gstreamer ##### -->
|
||||
<para>
|
||||
The variable that holds the GStreamer log domain
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VERSION_MAJOR ##### -->
|
||||
<para>
|
||||
The major version of GStreamer at compile time
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VERSION_MINOR ##### -->
|
||||
<para>
|
||||
The minor version of GStreamer at compile time
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VERSION_MICRO ##### -->
|
||||
<para>
|
||||
The micro version of GStreamer at compile time
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
178
docs/gst/tmpl/gst_private.sgml
Normal file
178
docs/gst/tmpl/gst_private.sgml
Normal file
|
|
@ -0,0 +1,178 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gst_private
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_GST_INIT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_COTHREADS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_COTHREAD_SWITCH ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_AUTOPLUG ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_AUTOPLUG_ATTEMPT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_PARENTAGE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_STATES ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_PLANNING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_SCHEDULING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_DATAFLOW ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_BUFFER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_CAPS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_CLOCK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_ELEMENT_PADS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_PADS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_PIPELINE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_PLUGIN_LOADING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_PLUGIN_INFO ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_PROPERTIES ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_THREAD ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_XML ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_NEGOTIATION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_REFCOUNTING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_ERROR_SYSTEM ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_EVENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_PARAMS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_CALL_TRACE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
|
@ -15,12 +15,6 @@ methods to request buffers from its pads.
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### VARIABLE gst_aggregator_details ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### ENUM GstAggregatorSchedType ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
|
|
@ -18,14 +18,6 @@ implementations in this file.
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GST_ARCH_CALL ##### -->
|
||||
<para>
|
||||
Jumps to a specific location in memory.
|
||||
</para>
|
||||
|
||||
@target: the memory to jump to.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_ARCH_SET_SP ##### -->
|
||||
<para>
|
||||
Sets the stackpointer.
|
||||
|
|
@ -34,6 +26,14 @@ Sets the stackpointer.
|
|||
@stackpointer: the stackpointer to set.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_ARCH_CALL ##### -->
|
||||
<para>
|
||||
Jumps to a specific location in memory.
|
||||
</para>
|
||||
|
||||
@target: the memory to jump to.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_ARCH_SETUP_STACK ##### -->
|
||||
<para>
|
||||
Make toom on the stack?
|
||||
|
|
@ -49,3 +49,10 @@ Do something funny, which is required on some archs..
|
|||
|
||||
|
||||
|
||||
<!-- ##### MACRO USE_MAKECONTEXT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -19,6 +19,12 @@ as external methods.
|
|||
#GstMemChunk
|
||||
</para>
|
||||
|
||||
<!-- ##### TYPEDEF gst_vgint ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstAtomicInt ##### -->
|
||||
<para>
|
||||
A structure that contains an integer that can be modified
|
||||
|
|
|
|||
46
docs/gst/tmpl/gstatomic_impl.sgml
Normal file
46
docs/gst/tmpl/gstatomic_impl.sgml
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gstatomic_impl
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO SMP_LOCK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO SMP_SYNC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO SMP_ISYNC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO PPC405_ERR77 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@ra:
|
||||
@rb:
|
||||
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
GstBin
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Base container element
|
||||
Base class for elements that contain other elements
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -55,21 +55,12 @@ clock providers in the bin.
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GstBinFlags ##### -->
|
||||
<!-- ##### MACRO GST_BIN_CLASS ##### -->
|
||||
<para>
|
||||
Flags for a bin.
|
||||
|
||||
</para>
|
||||
|
||||
@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:
|
||||
|
||||
<!-- ##### STRUCT GstBin ##### -->
|
||||
<para>
|
||||
The GstBin object
|
||||
</para>
|
||||
@klass:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstBinPrePostIterateFunction ##### -->
|
||||
|
|
@ -82,6 +73,17 @@ gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function().
|
|||
@user_data: user data
|
||||
|
||||
|
||||
<!-- ##### ENUM GstBinFlags ##### -->
|
||||
<para>
|
||||
Flags for a bin.
|
||||
</para>
|
||||
|
||||
@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:
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_new ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -158,55 +160,27 @@ gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function().
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_iterate ##### -->
|
||||
<!-- ##### FUNCTION gst_bin_get_by_interface ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@interface:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_set_post_iterate_function ##### -->
|
||||
<!-- ##### FUNCTION gst_bin_get_all_by_interface ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@func:
|
||||
@user_data:
|
||||
@interface:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_set_pre_iterate_function ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@func:
|
||||
@user_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_child_state_change ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@oldstate:
|
||||
@newstate:
|
||||
@child:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_auto_clock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_get_clock ##### -->
|
||||
<!-- ##### FUNCTION gst_bin_iterate ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
|
@ -224,6 +198,63 @@ gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function().
|
|||
@clock:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_get_clock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_auto_clock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_sync_children_state ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_child_state_change ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@oldstate:
|
||||
@newstate:
|
||||
@child:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_set_pre_iterate_function ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@func:
|
||||
@user_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_set_post_iterate_function ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
@func:
|
||||
@user_data:
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstBin::element-added ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
|
|
@ -82,6 +82,31 @@ Last reviewed on August 30th, 2002 (0.4.0.1)
|
|||
#GstBufferPool, #GstPad, #GstData
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstBuffer ##### -->
|
||||
<para>
|
||||
The basic structure of a buffer.
|
||||
</para>
|
||||
|
||||
@data_type:
|
||||
@data:
|
||||
@size:
|
||||
@maxsize:
|
||||
@timestamp:
|
||||
@duration:
|
||||
@offset:
|
||||
@offset_end:
|
||||
@free_data:
|
||||
@buffer_private:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### USER_FUNCTION GstBufferFreeDataFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_TRACE_NAME ##### -->
|
||||
<para>
|
||||
The name used for tracing memory allocations
|
||||
|
|
@ -89,23 +114,6 @@ The name used for tracing memory allocations
|
|||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER ##### -->
|
||||
<para>
|
||||
Casts an object to a GstBuffer.
|
||||
</para>
|
||||
|
||||
@buf: an object to cast.
|
||||
@Returns: the #GstBuffer to which the given object points.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_IS_BUFFER ##### -->
|
||||
<para>
|
||||
Checks if the pointer is a GstBuffer.
|
||||
</para>
|
||||
|
||||
@buf: a pointer to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_REFCOUNT ##### -->
|
||||
<para>
|
||||
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.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_DURATION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_FORMAT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_OFFSET ##### -->
|
||||
<para>
|
||||
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.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_OFFSET_END ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_FREE_DATA_FUNC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_PRIVATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_OFFSET_NONE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_MAXSIZE_NONE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_DURATION_IS_VALID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_TIMESTAMP_IS_VALID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_OFFSET_IS_VALID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_OFFSET_END_IS_VALID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_MAXSIZE_IS_VALID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### ENUM GstBufferFlag ##### -->
|
||||
<para>
|
||||
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.
|
||||
|
||||
<!-- ##### STRUCT GstBuffer ##### -->
|
||||
<para>
|
||||
The basic structure of a buffer.
|
||||
</para>
|
||||
|
||||
@data_type:
|
||||
@data:
|
||||
@size:
|
||||
@maxsize:
|
||||
@timestamp:
|
||||
@duration:
|
||||
@offset:
|
||||
@offset_end:
|
||||
@free_data:
|
||||
@buffer_private:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_new ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -274,23 +359,6 @@ A convenience function to set the data and size on a buffer
|
|||
@size: The size to set on the buffer
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_default_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_default_copy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_buffer_ref ##### -->
|
||||
<para>
|
||||
Increases the refcount of the given buffer by one.
|
||||
|
|
@ -317,6 +385,15 @@ will be freed.
|
|||
@buf: a #GstBuffer to unref.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_stamp ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@src:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_buffer_copy ##### -->
|
||||
<para>
|
||||
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.
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_buffer_is_writable ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_buffer_copy_on_write ##### -->
|
||||
<para>
|
||||
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:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_default_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_default_copy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
|
|||
63
docs/gst/tmpl/gstbufferstore.sgml
Normal file
63
docs/gst/tmpl/gstbufferstore.sgml
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstBufferStore
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_store_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_store_clear ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@store:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_store_add_buffer ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@store:
|
||||
@buffer:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_store_get_buffer ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@store:
|
||||
@offset:
|
||||
@size:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_store_get_size ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@store:
|
||||
@offset:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
@ -2,111 +2,89 @@
|
|||
GstCaps
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Capabilities of pads
|
||||
Structure describing sets of media formats
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
<para>
|
||||
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.
|
||||
<programlisting>
|
||||
GstCaps *caps;
|
||||
|
||||
caps = gst_caps_new (
|
||||
"audio/x-raw-int", /* mime type */
|
||||
"channels", G_TYPE_INT, 5,
|
||||
NULL);
|
||||
</programlisting>
|
||||
|
||||
The following code example is equivalent to the above example:
|
||||
<programlisting>
|
||||
GstCaps *caps;
|
||||
|
||||
caps = gst_caps_from_string ("audio/x-raw-int, channels = (int) 5");
|
||||
</programlisting>
|
||||
</para>
|
||||
<para>
|
||||
GstCaps are refcounted with gst_caps_ref() and gst_caps_unref().
|
||||
</para>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
<para>
|
||||
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.
|
||||
|
||||
<programlisting>
|
||||
GstCaps *caps;
|
||||
....
|
||||
|
||||
gst_caps_set_simple (caps, "channels", G_TYPE_INT, 20, NULL);
|
||||
|
||||
</programlisting>
|
||||
</para>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
<para>
|
||||
If you need a unique instance of a GstCaps you can use the convenient
|
||||
GST_CAPS_FACTORY() macro as shown below.
|
||||
<programlisting>
|
||||
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));
|
||||
|
||||
...
|
||||
}
|
||||
</programlisting>
|
||||
</para>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
#GstStructure, #GstPad
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_CAPS ##### -->
|
||||
<!-- ##### MACRO GST_CAPS_FLAGS_ANY ##### -->
|
||||
<para>
|
||||
The GType of the caps boxed type, for use in GValues.
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_ANY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_NONE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_STATIC_CAPS_ANY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_STATIC_CAPS_NONE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_IS_SIMPLE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_caps_is_simple ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_CAPS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@caps:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_STATIC_CAPS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstCaps ##### -->
|
||||
<para>
|
||||
The gstcaps structure
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
|
|
@ -114,6 +92,62 @@ The gstcaps structure
|
|||
@structs:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### STRUCT GstStaticCaps ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@string:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_new_empty ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_new_any ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_new_simple ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@media_type:
|
||||
@fieldname:
|
||||
@Varargs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_new_full ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@struct1:
|
||||
@Varargs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_new_full_valist ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@var_args:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_copy ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -123,7 +157,15 @@ The gstcaps structure
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_copy_1 ##### -->
|
||||
<!-- ##### FUNCTION gst_caps_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_static_caps_get ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
|
@ -139,21 +181,118 @@ The gstcaps structure
|
|||
|
||||
@caps1:
|
||||
@caps2:
|
||||
<!-- # Unused Parameters # -->
|
||||
@caps:
|
||||
@capstoadd:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_replace ##### -->
|
||||
<!-- ##### FUNCTION gst_caps_append_structure ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps1:
|
||||
@structure:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_split_one ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@newcaps:
|
||||
<!-- # Unused Parameters # -->
|
||||
@oldcaps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_get_size ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_get_structure ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@index:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_copy_1 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_set_simple ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@field:
|
||||
@Varargs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_set_simple_valist ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@field:
|
||||
@varargs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_is_any ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_is_empty ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_is_chained ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_is_fixed ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_is_equal_fixed ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps1:
|
||||
@caps2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_is_always_compatible ##### -->
|
||||
|
|
@ -164,9 +303,26 @@ The gstcaps structure
|
|||
@caps1:
|
||||
@caps2:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@fromcaps:
|
||||
@tocaps:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_intersect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps1:
|
||||
@caps2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_union ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps1:
|
||||
@caps2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_normalize ##### -->
|
||||
|
|
@ -178,13 +334,12 @@ The gstcaps structure
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_intersect ##### -->
|
||||
<!-- ##### FUNCTION gst_caps_simplify ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps1:
|
||||
@caps2:
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
@ -207,13 +362,52 @@ The gstcaps structure
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_union ##### -->
|
||||
<!-- ##### FUNCTION gst_caps_replace ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps1:
|
||||
@caps2:
|
||||
@caps:
|
||||
@newcaps:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_to_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_from_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_int ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@field_name:
|
||||
@target:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_double ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@structure:
|
||||
@field_name:
|
||||
@target:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -46,6 +46,14 @@ Constant to define an undefined clock time
|
|||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CLOCK_TIME_IS_VALID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@time:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SECOND ##### -->
|
||||
<para>
|
||||
Constant that defines one GStreamer second
|
||||
|
|
@ -100,6 +108,13 @@ Convert a GstClockTime to a GTimeVal
|
|||
@tv: The target timeval
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CLOCK_ENTRY_TRACE_NAME ##### -->
|
||||
<para>
|
||||
The name used for tracing clock entry allocations.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstClockEntry ##### -->
|
||||
<para>
|
||||
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
|
||||
|
||||
<!-- ##### MACRO GST_CLOCK_ENTRY_TRACE_NAME ##### -->
|
||||
<para>
|
||||
The name used for tracing clock entry allocations.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CLOCK_ENTRY ##### -->
|
||||
<para>
|
||||
Cast to a clock entry
|
||||
|
|
@ -229,12 +237,6 @@ Get the clock flags
|
|||
@clock: the clock to query
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstClock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_set_speed ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -318,6 +320,15 @@ Get the clock flags
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_get_event_time ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@clock:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_get_next_id ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
|
|
@ -14,3 +14,137 @@ gstcompat
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO gst_element_connect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_element_connect_pads ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
@c:
|
||||
@d:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_element_connect_many ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@...:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_element_connect_filtered ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
@c:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_element_disconnect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_pad_connect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_pad_connect_filtered ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
@c:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_pad_disconnect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_pad_proxy_connect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_pad_set_connect_function ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PAD_CONNECT_REFUSED ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PAD_CONNECT_DELAYED ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PAD_CONNECT_OK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PAD_CONNECT_DONE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF GstPadConnectReturn ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF GstPadConnectFunction ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
GstConfig
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
configuration options
|
||||
Configuration options
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -37,14 +37,7 @@ If a subsystem is disabled in GStreamer, a value is defined in
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GST_DISABLE_ALLOC_TRACE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DISABLE_ENUMTYPES ##### -->
|
||||
<!-- ##### MACRO GST_DISABLE_LOADSAVE_REGISTRY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
|
@ -59,13 +52,6 @@ If this is defined, the <link linkend="gstreamer-gstinfo">debugging subsystem
|
|||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DISABLE_INDEX ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DISABLE_LOADSAVE ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -73,13 +59,6 @@ If this is defined, the <link linkend="gstreamer-gstinfo">debugging subsystem
|
|||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DISABLE_LOADSAVE_REGISTRY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DISABLE_PARSE ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -87,13 +66,6 @@ If this is defined, the <link linkend="gstreamer-gstinfo">debugging subsystem
|
|||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DISABLE_PLUGIN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DISABLE_TRACE ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -101,7 +73,7 @@ If this is defined, the <link linkend="gstreamer-gstinfo">debugging subsystem
|
|||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DISABLE_URI ##### -->
|
||||
<!-- ##### MACRO GST_DISABLE_ALLOC_TRACE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
|
@ -115,3 +87,38 @@ If this is defined, the <link linkend="gstreamer-gstinfo">debugging subsystem
|
|||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DISABLE_ENUMTYPES ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DISABLE_INDEX ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DISABLE_PLUGIN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DISABLE_URI ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PTR_FORMAT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2,8 +2,7 @@
|
|||
GstCpu
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
Request the features of the CPU.
|
||||
Descripe CPU features
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
GstData
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Common structure for GstBuffer, GstBufferPool, and GstEvent
|
||||
Abstract structure for information that is passed among elements
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -48,24 +48,6 @@ Shift a given flag so that it can be used in an or operation
|
|||
@flag: The flag to shift
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DATA_FLAG_IS_SET ##### -->
|
||||
<para>
|
||||
Check if a given flag is set on the data
|
||||
</para>
|
||||
|
||||
@data: The data to check
|
||||
@flag: The flag to check for
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DATA_FLAG_SET ##### -->
|
||||
<para>
|
||||
Set the flag on the data
|
||||
</para>
|
||||
|
||||
@data: The data to set the flag on
|
||||
@flag: The flag to set
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DATA_FLAG_UNSET ##### -->
|
||||
<para>
|
||||
Unset the given flag
|
||||
|
|
@ -75,6 +57,13 @@ Unset the given flag
|
|||
@flag: The flag to unset
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_DATA ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstData ##### -->
|
||||
<para>
|
||||
The base structure
|
||||
|
|
@ -184,6 +173,15 @@ Get access to the free function of the data
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_data_is_writable ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_data_copy_on_write ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
16
docs/gst/tmpl/gstdata_private.sgml
Normal file
16
docs/gst/tmpl/gstdata_private.sgml
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gstdata_private
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
File diff suppressed because it is too large
Load diff
736
docs/gst/tmpl/gstenumtypes.sgml
Normal file
736
docs/gst/tmpl/gstenumtypes.sgml
Normal file
|
|
@ -0,0 +1,736 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gstenumtypes
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gst_object_flags_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_OBJECT_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_flags_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_BIN_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_flag_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_BUFFER_FLAG ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_entry_status_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_CLOCK_ENTRY_STATUS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_entry_type_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_CLOCK_ENTRY_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_return_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_CLOCK_RETURN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_flags_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_CLOCK_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_cpu_flags_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_CPU_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_data_flags_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_DATA_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_element_flags_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_ELEMENT_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_core_error_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_CORE_ERROR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_library_error_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_LIBRARY_ERROR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_resource_error_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_RESOURCE_ERROR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_stream_error_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_STREAM_ERROR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_type_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_EVENT_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_flag_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_EVENT_FLAG ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_seek_type_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_SEEK_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_seek_accuracy_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_SEEK_ACCURACY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_format_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_FORMAT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_certainty_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_INDEX_CERTAINTY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_entry_type_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_INDEX_ENTRY_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_lookup_method_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_INDEX_LOOKUP_METHOD ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_assoc_flags_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_ASSOC_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_resolver_method_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_INDEX_RESOLVER_METHOD ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_flags_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_INDEX_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_debug_level_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_DEBUG_LEVEL ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_debug_color_flags_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_DEBUG_COLOR_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_link_return_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_PAD_LINK_RETURN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_direction_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_PAD_DIRECTION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_flags_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_PAD_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_presence_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_PAD_PRESENCE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_template_flags_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_PAD_TEMPLATE_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_error_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_PLUGIN_ERROR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_query_type_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_QUERY_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_flags_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_SCHEDULER_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_state_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_SCHEDULER_STATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_merge_mode_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_TAG_MERGE_MODE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_flag_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_TAG_FLAG ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_thread_state_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_THREAD_STATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_alloc_trace_flags_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_ALLOC_TRACE_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_type_find_probability_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_TYPE_FIND_PROBABILITY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_element_state_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_ELEMENT_STATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_element_state_return_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_ELEMENT_STATE_RETURN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_result_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_RESULT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_uri_type_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_URI_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_registry_return_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_REGISTRY_RETURN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_registry_flags_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_REGISTRY_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_parse_error_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_PARSE_ERROR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
GstError
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
Categorized error messages
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -33,3 +33,146 @@ GstError
|
|||
@GST_CORE_ERROR_TAG:
|
||||
@GST_CORE_ERROR_NUM_ERRORS:
|
||||
|
||||
<!-- ##### ENUM GstLibraryError ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@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:
|
||||
|
||||
<!-- ##### ENUM GstResourceError ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@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:
|
||||
|
||||
<!-- ##### ENUM GstStreamError ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@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:
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_G_ERROR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_LIBRARY_ERROR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_RESOURCE_ERROR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CORE_ERROR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_STREAM_ERROR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_ERROR_SYSTEM ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_g_error_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_error_get_message ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@domain:
|
||||
@code:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_stream_error_quark ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_core_error_quark ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_resource_error_quark ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_library_error_quark ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
GstEvent
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Event definitions.
|
||||
Structure describing events that are passed up and down a pipeline
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -50,6 +50,13 @@ The different major types of events.
|
|||
@GST_EVENT_NAVIGATION:
|
||||
@GST_EVENT_TAG:
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_TRACE_NAME ##### -->
|
||||
<para>
|
||||
The name used for memory allocation tracing
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_TYPE ##### -->
|
||||
<para>
|
||||
Get the event type.
|
||||
|
|
@ -58,6 +65,14 @@ Get the event type.
|
|||
@event: The event to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_TIMESTAMP ##### -->
|
||||
<para>
|
||||
Get the timestamp of the event.
|
||||
</para>
|
||||
|
||||
@event: The event to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SRC ##### -->
|
||||
<para>
|
||||
The source object that generated this event
|
||||
|
|
@ -66,12 +81,54 @@ The source object that generated this event
|
|||
@event: The event to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_TIMESTAMP ##### -->
|
||||
<!-- ##### MACRO GST_EVENT_IS_INTERRUPT ##### -->
|
||||
<para>
|
||||
Get the timestamp of the event.
|
||||
Check if the event is an interrupt event
|
||||
</para>
|
||||
|
||||
@event: The event to check
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_FORMAT_SHIFT ##### -->
|
||||
<para>
|
||||
Shift for the format in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_METHOD_SHIFT ##### -->
|
||||
<para>
|
||||
Shift for the method in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_FLAGS_SHIFT ##### -->
|
||||
<para>
|
||||
Shift for the flags in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_FORMAT_MASK ##### -->
|
||||
<para>
|
||||
Mask for the format in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_METHOD_MASK ##### -->
|
||||
<para>
|
||||
Mask for the method in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_FLAGS_MASK ##### -->
|
||||
<para>
|
||||
Mask for the flags in the GstSeekType
|
||||
</para>
|
||||
|
||||
@event: The event to query.
|
||||
|
||||
|
||||
<!-- ##### ENUM GstEventFlag ##### -->
|
||||
|
|
@ -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
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_MASK_FUNCTION ##### -->
|
||||
<para>
|
||||
A convenience macro to create event mask functions
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
|
||||
<!-- ##### ENUM GstSeekType ##### -->
|
||||
<para>
|
||||
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.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SEEK_ENDOFFSET ##### -->
|
||||
<para>
|
||||
The event stop position for a segment seek
|
||||
</para>
|
||||
|
||||
@event: The event to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SEEK_ACCURACY ##### -->
|
||||
<para>
|
||||
Indicates how accurate the event was performed.
|
||||
|
|
@ -175,48 +250,6 @@ Indicates how accurate the event was performed.
|
|||
@event: The event to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_FLAGS_MASK ##### -->
|
||||
<para>
|
||||
Mask for the flags in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_FLAGS_SHIFT ##### -->
|
||||
<para>
|
||||
Shift for the flags in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_FORMAT_MASK ##### -->
|
||||
<para>
|
||||
Mask for the format in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_FORMAT_SHIFT ##### -->
|
||||
<para>
|
||||
Shift for the format in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_METHOD_MASK ##### -->
|
||||
<para>
|
||||
Mask for the method in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SEEK_METHOD_SHIFT ##### -->
|
||||
<para>
|
||||
Shift for the method in the GstSeekType
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_DISCONT_NEW_MEDIA ##### -->
|
||||
<para>
|
||||
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.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_RATE_VALUE ##### -->
|
||||
<para>
|
||||
Get access to the rate vale field
|
||||
</para>
|
||||
|
||||
@event: The event to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SEEK_ENDOFFSET ##### -->
|
||||
<para>
|
||||
The event stop position for a segment seek
|
||||
</para>
|
||||
|
||||
@event: The event to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SIZE_FORMAT ##### -->
|
||||
<para>
|
||||
The format of the size event.
|
||||
|
|
@ -276,24 +293,17 @@ The value of the size event
|
|||
@event: The event to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_IS_INTERRUPT ##### -->
|
||||
<!-- ##### MACRO GST_EVENT_RATE_VALUE ##### -->
|
||||
<para>
|
||||
Check if the event is an interrupt event
|
||||
</para>
|
||||
|
||||
@event: The event to check
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_TRACE_NAME ##### -->
|
||||
<para>
|
||||
The name used for memory allocation tracing
|
||||
Get access to the rate vale field
|
||||
</para>
|
||||
|
||||
@event: The event to query
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstEvent ##### -->
|
||||
<para>
|
||||
The event structure
|
||||
|
||||
</para>
|
||||
|
||||
@data:
|
||||
|
|
@ -310,15 +320,6 @@ The event structure
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_event_copy ##### -->
|
||||
<para>
|
||||
Copy the event using the event specific copy function
|
||||
</para>
|
||||
|
||||
@ev: The event to copy
|
||||
@Returns: A new event that is a copy of the given input event
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_event_ref ##### -->
|
||||
<para>
|
||||
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
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_event_copy ##### -->
|
||||
<para>
|
||||
Copy the event using the event specific copy function
|
||||
</para>
|
||||
|
||||
@ev: The event to copy
|
||||
@Returns: A new event that is a copy of the given input event
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_masks_contains ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@masks:
|
||||
@mask:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_new_seek ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -386,6 +406,17 @@ Decrease the refcount of an event, freeing it if the refcount reaches 0
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_new_discontinuous_valist ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@new_media:
|
||||
@format1:
|
||||
@var_args:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_discont_get_value ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -411,23 +442,3 @@ Create a new flush event.
|
|||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_masks_contains ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@masks:
|
||||
@mask:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_MASK_FUNCTION ##### -->
|
||||
<para>
|
||||
A convenience macro to create event mask functions
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -16,6 +16,19 @@ with the buffer. (fakesink)
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GstFakeSinkStateError ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@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:
|
||||
|
||||
<!-- ##### FUNCTION gst_fakesink_factory_init ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,6 @@ The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
|
|||
|
||||
@FAKESRC_DATA_ALLOCATE:
|
||||
@FAKESRC_DATA_SUBBUFFER:
|
||||
@FAKESRC_DATA_BUFFERPOOL:
|
||||
|
||||
<!-- ##### ENUM GstFakeSrcSizeType ##### -->
|
||||
<para>
|
||||
|
|
|
|||
24
docs/gst/tmpl/gstfilesink.sgml
Normal file
24
docs/gst/tmpl/gstfilesink.sgml
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstFileSink
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GstFileSinkFlags ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GST_FILESINK_OPEN:
|
||||
@GST_FILESINK_FLAG_LAST:
|
||||
|
||||
41
docs/gst/tmpl/gstfilter.sgml
Normal file
41
docs/gst/tmpl/gstfilter.sgml
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstFilter
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Take data in and spit data out
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### USER_FUNCTION GstFilterFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_filter_run ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@func:
|
||||
@first:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
@ -15,6 +15,13 @@ in a pipeline.
|
|||
#GstIndexFactory
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_INDEX_ENTRY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstIndexEntry ##### -->
|
||||
<para>
|
||||
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
|
||||
|
||||
<!-- ##### ENUM GstIndexFlags ##### -->
|
||||
<para>
|
||||
Flags for this index
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_ID_INVALID ##### -->
|
||||
<para>
|
||||
An invalid index id
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_IS_READABLE ##### -->
|
||||
<para>
|
||||
Check if the index can be read from
|
||||
</para>
|
||||
|
||||
@obj: The index to check
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_IS_WRITABLE ##### -->
|
||||
<para>
|
||||
Check if the index can be written to
|
||||
</para>
|
||||
|
||||
@obj: The index to check
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_NASSOCS ##### -->
|
||||
<para>
|
||||
Get the number of associations in the entry.
|
||||
|
|
@ -161,6 +136,13 @@ Get the key of the format entry
|
|||
@entry: The entry to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_ID_INVALID ##### -->
|
||||
<para>
|
||||
An invalid index id
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_ID_DESCRIPTION ##### -->
|
||||
<para>
|
||||
Get the description of the id entry
|
||||
|
|
@ -180,6 +162,15 @@ Function to filter out entries in the index.
|
|||
to the index, FALSE otherwise.
|
||||
|
||||
|
||||
<!-- ##### ENUM GstIndexResolverMethod ##### -->
|
||||
<para>
|
||||
The method used to resolve index writers
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
<!-- ##### USER_FUNCTION GstIndexResolver ##### -->
|
||||
<para>
|
||||
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
|
||||
|
||||
|
||||
<!-- ##### ENUM GstIndexResolverMethod ##### -->
|
||||
<!-- ##### ENUM GstIndexFlags ##### -->
|
||||
<para>
|
||||
The method used to resolve index writers
|
||||
Flags for this index
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
<!-- ##### STRUCT GstIndex ##### -->
|
||||
<!-- ##### MACRO GST_INDEX_IS_READABLE ##### -->
|
||||
<para>
|
||||
The GstIndex object
|
||||
Check if the index can be read from
|
||||
</para>
|
||||
|
||||
@obj: The index to check
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_IS_WRITABLE ##### -->
|
||||
<para>
|
||||
Check if the index can be written to
|
||||
</para>
|
||||
|
||||
@obj: The index to check
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_new ##### -->
|
||||
<para>
|
||||
|
|
@ -217,6 +218,15 @@ The GstIndex object
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_commit ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@id:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_get_group ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -373,6 +383,23 @@ The GstIndex object
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_entry_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_entry_copy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@entry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_entry_free ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -392,13 +419,105 @@ The GstIndex object
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_commit ##### -->
|
||||
<!-- ##### MACRO GST_TYPE_INDEX_FACTORY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@id:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_FACTORY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_IS_INDEX_FACTORY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_FACTORY_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@klass:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_IS_INDEX_FACTORY_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@klass:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INDEX_FACTORY_GET_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_factory_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_factory_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@longdesc:
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_factory_destroy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_factory_find ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_factory_create ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_factory_make ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstIndex::entry-added ##### -->
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
GstInfo
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
debugging subsystem
|
||||
Debugging and logging
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -68,37 +68,6 @@ categories. These are explained at GST_DEBUG_CATEGORY_INIT().
|
|||
and environment variables that affect the debugging output.
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GST_STR_NULL ##### -->
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
|
||||
@str: The string to check.
|
||||
@Returns: A string that is guaranteed to be not NULL.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_PAD_NAME ##### -->
|
||||
<para>
|
||||
Evaluates to 2 strings, that describe the pad. Often used in debugging
|
||||
statements.
|
||||
</para>
|
||||
|
||||
@pad: The pad to debug.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_FUNCTION ##### -->
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### ENUM GstDebugLevel ##### -->
|
||||
<para>
|
||||
The level defines the importance of a debugging message. The more important a
|
||||
|
|
@ -141,15 +110,6 @@ reset the debugging output to default behaviour.
|
|||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_debug_level_get_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@level:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### ENUM GstDebugColorFlags ##### -->
|
||||
<para>
|
||||
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.
|
||||
|
||||
<!-- ##### FUNCTION gst_debug_construct_term_color ##### -->
|
||||
<!-- ##### MACRO GST_DEBUG_FG_MASK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_BG_MASK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_FORMAT_MASK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colorinfo:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstDebugCategory ##### -->
|
||||
|
|
@ -191,15 +163,40 @@ This is the struct that describes the categories. Once initialized with
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_DEFAULT ##### -->
|
||||
<!-- ##### MACRO GST_STR_NULL ##### -->
|
||||
<para>
|
||||
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:
|
||||
<informalexample>
|
||||
<programlisting>
|
||||
&hash;define GST_CAT_DEFAULT category_to_be_default
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
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.
|
||||
</para>
|
||||
|
||||
@str: The string to check.
|
||||
@Returns: A string that is guaranteed to be not NULL.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_PAD_NAME ##### -->
|
||||
<para>
|
||||
Evaluates to 2 strings, that describe the pad. Often used in debugging
|
||||
statements.
|
||||
</para>
|
||||
|
||||
@pad: The pad to debug.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_FUNCTION ##### -->
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstDebugMessage ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
|
@ -233,6 +230,30 @@ default. If you want to define a default category, do it like this:
|
|||
@Varargs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_debug_log_valist ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@category:
|
||||
@level:
|
||||
@file:
|
||||
@function:
|
||||
@line:
|
||||
@object:
|
||||
@format:
|
||||
@args:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_debug_message_get ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@message:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_debug_log_default ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -248,6 +269,15 @@ default. If you want to define a default category, do it like this:
|
|||
@unused:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_debug_level_get_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@level:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_debug_add_log_function ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -444,6 +474,27 @@ default. If you want to define a default category, do it like this:
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_debug_construct_term_color ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colorinfo:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### VARIABLE GST_CAT_DEFAULT ##### -->
|
||||
<para>
|
||||
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:
|
||||
<informalexample>
|
||||
<programlisting>
|
||||
&hash;define GST_CAT_DEFAULT category_to_be_default
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAT_LEVEL_LOG ##### -->
|
||||
<para>
|
||||
GST_CAT_LEVEL_LOG:
|
||||
|
|
@ -458,22 +509,6 @@ below.
|
|||
@...: A printf-style message to output
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INFO ##### -->
|
||||
<para>
|
||||
Output an informational message in the default category.
|
||||
</para>
|
||||
|
||||
@...: printf-style message to output
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG ##### -->
|
||||
<para>
|
||||
Output a debugging message in the default category.
|
||||
</para>
|
||||
|
||||
@...: printf-style message to output
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAT_ERROR_OBJECT ##### -->
|
||||
<para>
|
||||
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
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAT_INFO ##### -->
|
||||
<para>
|
||||
Output an informational message in the given category.
|
||||
</para>
|
||||
|
||||
@cat: category to use
|
||||
@...: printf-style message to output
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAT_DEBUG ##### -->
|
||||
<para>
|
||||
Output a debuggign message in the given category.
|
||||
</para>
|
||||
|
||||
@cat: category to use
|
||||
@...: printf-style message to output
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAT_LOG ##### -->
|
||||
<para>
|
||||
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
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAT_INFO ##### -->
|
||||
<!-- ##### MACRO GST_INFO ##### -->
|
||||
<para>
|
||||
Output an informational message in the given category.
|
||||
Output an informational message in the default category.
|
||||
</para>
|
||||
|
||||
@cat: category to use
|
||||
@...: printf-style message to output
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAT_DEBUG ##### -->
|
||||
<!-- ##### MACRO GST_DEBUG ##### -->
|
||||
<para>
|
||||
Output a debuggign message in the given category.
|
||||
Output a debugging message in the default category.
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INFO_ELEMENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cat:
|
||||
@obj:
|
||||
@...:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_ELEMENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cat:
|
||||
@obj:
|
||||
@...:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_ENTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@...:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_LEAVE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@...:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INFO_ENTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@...:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INFO_LEAVE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@...:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_FUNCPTR ##### -->
|
||||
<para>
|
||||
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
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_debug_set_log_function ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@func:
|
||||
@data:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_debug_reset_log_function ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@void:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_debug_category_set_threshold_for_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@level:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_debug_category_unset_threshold_for_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_debug_print_stack_trace ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
GstInterface
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
Core interfaces implemented by #GstElements
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -14,6 +14,31 @@ GstInterface
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstImplementsInterface ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_CAST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
@type:
|
||||
@cast_t:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_element_implements_interface ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
|
|
@ -14,3 +14,27 @@ gstlog
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### VARIABLE g_log_domain_gstreamer ##### -->
|
||||
<para>
|
||||
The variable that holds the GStreamer log domain
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SHOW_INFO ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_info ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@...:
|
||||
<!-- # Unused Parameters # -->
|
||||
@format:
|
||||
@args...:
|
||||
|
||||
|
||||
|
|
|
|||
37
docs/gst/tmpl/gstmacros.sgml
Normal file
37
docs/gst/tmpl/gstmacros.sgml
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gstmacros
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GST_GNUC_CONSTRUCTOR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_INLINE_FUNC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAN_INLINE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
241
docs/gst/tmpl/gstmarshal.sgml
Normal file
241
docs/gst/tmpl/gstmarshal.sgml
Normal file
|
|
@ -0,0 +1,241 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gstmarshal
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO gst_marshal_VOID__VOID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_marshal_VOID__BOOLEAN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_marshal_VOID__INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_marshal_VOID__STRING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_marshal_VOID__BOXED ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_marshal_VOID__POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_marshal_VOID__POINTER_OBJECT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@closure:
|
||||
@return_value:
|
||||
@n_param_values:
|
||||
@param_values:
|
||||
@invocation_hint:
|
||||
@marshal_data:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_marshal_VOID__OBJECT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_marshal_VOID__OBJECT_PARAM ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@closure:
|
||||
@return_value:
|
||||
@n_param_values:
|
||||
@param_values:
|
||||
@invocation_hint:
|
||||
@marshal_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_marshal_VOID__OBJECT_POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@closure:
|
||||
@return_value:
|
||||
@n_param_values:
|
||||
@param_values:
|
||||
@invocation_hint:
|
||||
@marshal_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_marshal_VOID__OBJECT_BOXED ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@closure:
|
||||
@return_value:
|
||||
@n_param_values:
|
||||
@param_values:
|
||||
@invocation_hint:
|
||||
@marshal_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_marshal_VOID__OBJECT_OBJECT_STRING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@closure:
|
||||
@return_value:
|
||||
@n_param_values:
|
||||
@param_values:
|
||||
@invocation_hint:
|
||||
@marshal_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_marshal_VOID__OBJECT_STRING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@closure:
|
||||
@return_value:
|
||||
@n_param_values:
|
||||
@param_values:
|
||||
@invocation_hint:
|
||||
@marshal_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_marshal_VOID__INT_INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@closure:
|
||||
@return_value:
|
||||
@n_param_values:
|
||||
@param_values:
|
||||
@invocation_hint:
|
||||
@marshal_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_marshal_VOID__INT64 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@closure:
|
||||
@return_value:
|
||||
@n_param_values:
|
||||
@param_values:
|
||||
@invocation_hint:
|
||||
@marshal_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_marshal_VOID__UINT_BOXED ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@closure:
|
||||
@return_value:
|
||||
@n_param_values:
|
||||
@param_values:
|
||||
@invocation_hint:
|
||||
@marshal_data:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_marshal_VOID__UINT_POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_marshal_BOOLEAN__VOID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@closure:
|
||||
@return_value:
|
||||
@n_param_values:
|
||||
@param_values:
|
||||
@invocation_hint:
|
||||
@marshal_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_marshal_BOOLEAN__POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@closure:
|
||||
@return_value:
|
||||
@n_param_values:
|
||||
@param_values:
|
||||
@invocation_hint:
|
||||
@marshal_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_marshal_POINTER__POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@closure:
|
||||
@return_value:
|
||||
@n_param_values:
|
||||
@param_values:
|
||||
@invocation_hint:
|
||||
@marshal_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_marshal_BOXED__BOXED ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@closure:
|
||||
@return_value:
|
||||
@n_param_values:
|
||||
@param_values:
|
||||
@invocation_hint:
|
||||
@marshal_data:
|
||||
|
||||
|
||||
25
docs/gst/tmpl/gstmd5sink.sgml
Normal file
25
docs/gst/tmpl/gstmd5sink.sgml
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstMD5Sink
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gst_md5sink_factory_init ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
@Returns:
|
||||
|
||||
|
||||
24
docs/gst/tmpl/gstmultifilesrc.sgml
Normal file
24
docs/gst/tmpl/gstmultifilesrc.sgml
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstMultiFileSrc
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GstMultiFileSrcFlags ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GST_MULTIFILESRC_OPEN:
|
||||
@GST_MULTIFILESRC_FLAG_LAST:
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
GstObject
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Basis for the GST object hierarchy.
|
||||
Base class for the GStreamer object hierarchy
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -25,6 +25,21 @@ object.
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GST_OBJECT_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@klass:
|
||||
|
||||
|
||||
<!-- ##### MACRO xmlNodePtr ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### ENUM GstObjectFlags ##### -->
|
||||
<para>
|
||||
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
|
||||
|
||||
<!-- ##### STRUCT GstObject ##### -->
|
||||
<para>
|
||||
The GstObject
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_FLAGS ##### -->
|
||||
<para>
|
||||
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.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_OBJECT_NAME ##### -->
|
||||
<para>
|
||||
Get the name of this object
|
||||
</para>
|
||||
|
||||
@obj: Object to get the name of.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_OBJECT_PARENT ##### -->
|
||||
<para>
|
||||
Get the parent of this object
|
||||
</para>
|
||||
|
||||
@obj: Object to get the parent of.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_OBJECT_DESTROYED ##### -->
|
||||
<para>
|
||||
Check if the object has been destroyed.
|
||||
</para>
|
||||
|
||||
@obj: The Object to check
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_OBJECT_FLOATING ##### -->
|
||||
<para>
|
||||
Check if the object is floating.
|
||||
</para>
|
||||
|
||||
@obj: The Object to check
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_LOCK ##### -->
|
||||
<para>
|
||||
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.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_OBJECT_PARENT ##### -->
|
||||
<para>
|
||||
Get the parent of this object
|
||||
</para>
|
||||
|
||||
@obj: Object to get the parent of.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_OBJECT_NAME ##### -->
|
||||
<para>
|
||||
Get the name of this object
|
||||
</para>
|
||||
|
||||
@obj: Object to get the name of.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_OBJECT_FLOATING ##### -->
|
||||
<para>
|
||||
Check if the object is floating.
|
||||
</para>
|
||||
|
||||
@obj: The Object to check
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_OBJECT_DESTROYED ##### -->
|
||||
<para>
|
||||
Check if the object has been destroyed.
|
||||
</para>
|
||||
|
||||
@obj: The Object to check
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_check_uniqueness ##### -->
|
||||
<!-- ##### FUNCTION gst_object_set_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@object:
|
||||
@name:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_get_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
@ -169,24 +186,6 @@ Check if the object has been destroyed.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_set_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@name:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_get_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_unparent ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -195,40 +194,27 @@ Check if the object has been destroyed.
|
|||
@object:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_ref ##### -->
|
||||
<!-- ##### FUNCTION gst_object_default_deep_notify ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object: the object
|
||||
@object:
|
||||
@orig:
|
||||
@pspec:
|
||||
@excluded_props:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_check_uniqueness ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_unref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object: the object
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_replace ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@oldobj:
|
||||
@newobj:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_sink ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object: the object
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_save_thyself ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -248,6 +234,40 @@ Check if the object has been destroyed.
|
|||
@self:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_ref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object: the object
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_unref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object: the object
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_sink ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object: the object
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_replace ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@oldobj:
|
||||
@newobj:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_get_path_string ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -257,27 +277,6 @@ Check if the object has been destroyed.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_default_deep_notify ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@orig:
|
||||
@pspec:
|
||||
@excluded_props:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_class_signal_emit_by_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@name:
|
||||
@self:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_class_signal_connect ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -290,6 +289,16 @@ Check if the object has been destroyed.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_class_signal_emit_by_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@name:
|
||||
@self:
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstObject::deep-notify ##### -->
|
||||
<para>
|
||||
The deep notify signal is used to be notified of property changes.
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -2,7 +2,7 @@
|
|||
GstParse
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Parses commandline syntax into a pipeline.
|
||||
Parses pipeline syntax into elements
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -44,6 +44,21 @@ can be made with <option>{}</option>.
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gst_parse_error_quark ##### -->
|
||||
<para>
|
||||
Get the error quark passed in the GError messages.
|
||||
</para>
|
||||
|
||||
@Returns: The parse error quark
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PARSE_ERROR ##### -->
|
||||
<para>
|
||||
The error quark
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### ENUM GstParseError ##### -->
|
||||
<para>
|
||||
The parsing errors.
|
||||
|
|
@ -57,21 +72,6 @@ The parsing errors.
|
|||
@GST_PARSE_ERROR_EMPTY_BIN:
|
||||
@GST_PARSE_ERROR_EMPTY:
|
||||
|
||||
<!-- ##### MACRO GST_PARSE_ERROR ##### -->
|
||||
<para>
|
||||
The error quark
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_parse_error_quark ##### -->
|
||||
<para>
|
||||
Get the error quark passed in the GError messages.
|
||||
</para>
|
||||
|
||||
@Returns: The parse error quark
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_parse_launch ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
|
|
@ -21,12 +21,6 @@ the pipeline, use gst_element_unref() to free its resources.
|
|||
#GstBin
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstPipeline ##### -->
|
||||
<para>
|
||||
The pipeline object
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pipeline_new ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
GstPlugin
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Dynamically loadable Elements
|
||||
Container for features loaded from a shared object module
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -34,13 +34,6 @@ to bring the plugin into memory.
|
|||
#GstPluginFeature, #GstType, #GstAutoplug, #GstElementFactory
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GST_PLUGIN_ERROR ##### -->
|
||||
<para>
|
||||
The error quark
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_error_quark ##### -->
|
||||
<para>
|
||||
Get the error quark
|
||||
|
|
@ -49,6 +42,13 @@ Get the error quark
|
|||
@Returns: The error quark used in GError messages
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PLUGIN_ERROR ##### -->
|
||||
<para>
|
||||
The error quark
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### ENUM GstPluginError ##### -->
|
||||
<para>
|
||||
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:
|
||||
|
||||
<!-- ##### MACRO GST_PLUGIN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstPlugin ##### -->
|
||||
<para>
|
||||
The plugin object
|
||||
|
|
@ -71,18 +79,6 @@ The plugin object
|
|||
@module:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### USER_FUNCTION GstPluginInitFunc ##### -->
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
|
||||
@plugin: The plugin object that can be used to register stuff for this plugin.
|
||||
@Returns: A boolean indicating success or failure.
|
||||
<!-- # Unused Parameters # -->
|
||||
@module: The <classname>GModule</classname> it was loaded from
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstPluginDesc ##### -->
|
||||
<para>
|
||||
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:
|
||||
|
||||
<!-- ##### USER_FUNCTION GstPluginInitFunc ##### -->
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
|
||||
@plugin: The plugin object that can be used to register stuff for this plugin.
|
||||
@Returns: A boolean indicating success or failure.
|
||||
<!-- # Unused Parameters # -->
|
||||
@module: The <classname>GModule</classname> it was loaded from
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstPluginExitFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PLUGIN_DEFINE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@major:
|
||||
@minor:
|
||||
@name:
|
||||
@description:
|
||||
@init:
|
||||
@version:
|
||||
@license:
|
||||
@package:
|
||||
@origin:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PLUGIN_DEFINE_STATIC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@major:
|
||||
@minor:
|
||||
@name:
|
||||
@description:
|
||||
@init:
|
||||
@version:
|
||||
@license:
|
||||
@package:
|
||||
@origin:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_LICENSE_UNKNOWN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstPluginFilter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_PLUGIN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_get_name ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -110,6 +190,15 @@ loaded will use this variable to initialize the plugin.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_get_description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_get_filename ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -119,6 +208,42 @@ loaded will use this variable to initialize the plugin.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_get_license ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_get_package ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_get_origin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_get_module ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_is_loaded ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -128,6 +253,40 @@ loaded will use this variable to initialize the plugin.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_feature_filter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@filter:
|
||||
@first:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_list_feature_filter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@filter:
|
||||
@first:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_name_filter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_get_feature_list ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -148,6 +307,16 @@ loaded will use this variable to initialize the plugin.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_load_file ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@filename:
|
||||
@error:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_unload_plugin ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
GstPluginFeature
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
The base class for plugable objects.
|
||||
Base class for contents of a GstPlugin
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -22,6 +22,22 @@ Get the name of the feature
|
|||
@feature: The feature to query
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF GstTypeNameData ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstPluginFeatureFilter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@feature:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_feature_ensure_loaded ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -39,3 +55,49 @@ Get the name of the feature
|
|||
@feature:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_feature_type_name_filter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@feature:
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_feature_set_rank ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@feature:
|
||||
@rank:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_feature_set_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@feature:
|
||||
@name:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_feature_get_rank ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@feature:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_feature_get_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@feature:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -25,9 +25,3 @@ The queue blocks by default.
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### VARIABLE gst_queue_details ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -2,7 +2,7 @@
|
|||
GstRegistry
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Abstract class for managing plugins.
|
||||
Abstract base class for management of #GstPlugin objects
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -14,6 +14,69 @@ The registry holds the available plugins in the system.
|
|||
#GstPlugin, #GstPluginFeature
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GLOBAL_REGISTRY_DIR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GLOBAL_REGISTRY_FILE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GLOBAL_REGISTRY_FILE_TMP ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO LOCAL_REGISTRY_DIR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO LOCAL_REGISTRY_FILE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO LOCAL_REGISTRY_FILE_TMP ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO REGISTRY_DIR_PERMS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO REGISTRY_TMPFILE_PERMS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO REGISTRY_FILE_PERMS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### ENUM GstRegistryReturn ##### -->
|
||||
<para>
|
||||
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.
|
||||
|
||||
<!-- ##### STRUCT GstRegistry ##### -->
|
||||
<para>
|
||||
The registry object
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_registry_load ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -132,6 +189,30 @@ The registry object
|
|||
@plugin:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_registry_plugin_filter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@registry:
|
||||
@filter:
|
||||
@first:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_registry_feature_filter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@registry:
|
||||
@filter:
|
||||
@first:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_registry_find_plugin ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
GstRegistryPool
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Manage a list of plugins and registries
|
||||
Management of a group of #GstRegistry objects
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -55,6 +55,28 @@ GstRegistry
|
|||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_registry_pool_plugin_filter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@filter:
|
||||
@first:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_registry_pool_feature_filter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@filter:
|
||||
@first:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_registry_pool_plugin_list ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
GstScheduler
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
An abstract class for plugable schedulers.
|
||||
Abstract class for objects that manage the scheduling of groups of elements
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -14,6 +14,15 @@ This is a base class for custom schedulers.
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GstSchedulerFlags ##### -->
|
||||
<para>
|
||||
Flags for the scheduler
|
||||
</para>
|
||||
|
||||
@GST_SCHEDULER_FLAG_FIXED_CLOCK: The scheduler has a fixed clock
|
||||
@GST_SCHEDULER_FLAG_LAST: subclasses can start numbering their flags starting
|
||||
from here.
|
||||
|
||||
<!-- ##### MACRO GST_SCHEDULER_PARENT ##### -->
|
||||
<para>
|
||||
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
|
||||
|
||||
<!-- ##### ENUM GstSchedulerFlags ##### -->
|
||||
<para>
|
||||
Flags for the scheduler
|
||||
</para>
|
||||
|
||||
@GST_SCHEDULER_FLAG_FIXED_CLOCK: The scheduler has a fixed clock
|
||||
@GST_SCHEDULER_FLAG_LAST: subclasses can start numbering their flags starting
|
||||
from here.
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_setup ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -83,6 +83,24 @@ Flags for the scheduler
|
|||
@element:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_add_scheduler ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@sched2:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_remove_scheduler ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@sched2:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_state_transition ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -180,59 +198,6 @@ Flags for the scheduler
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_add_scheduler ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@sched2:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_remove_scheduler ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@sched2:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_auto_clock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_get_clock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_set_clock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@clock:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_use_clock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@clock:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_clock_wait ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -257,6 +222,41 @@ Flags for the scheduler
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_use_clock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@clock:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_set_clock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@clock:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_get_clock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_auto_clock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_show ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -265,3 +265,131 @@ Flags for the scheduler
|
|||
@sched:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_SCHEDULER_FACTORY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SCHEDULER_FACTORY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_IS_SCHEDULER_FACTORY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SCHEDULER_FACTORY_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@klass:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_IS_SCHEDULER_FACTORY_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@klass:
|
||||
<!-- # Unused Parameters # -->
|
||||
@obj:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SCHEDULER_FACTORY_GET_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SCHEDULER_DEFAULT_NAME ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_factory_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_factory_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@longdesc:
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_factory_destroy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_factory_find ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_factory_create ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
@parent:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_factory_make ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@parent:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_factory_set_default_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_scheduler_factory_get_default_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
|
|||
166
docs/gst/tmpl/gstsearchfuncs.sgml
Normal file
166
docs/gst/tmpl/gstsearchfuncs.sgml
Normal file
|
|
@ -0,0 +1,166 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gstsearchfuncs
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GST_AUTOPLUG_MAX_COST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstAutoplugNode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@prev:
|
||||
@fac:
|
||||
@templ:
|
||||
@cost:
|
||||
@endpoint:
|
||||
|
||||
<!-- ##### FUNCTION gst_autoplug_caps_intersect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@src:
|
||||
@sink:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_autoplug_can_connect_src ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@fac:
|
||||
@src:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_autoplug_can_connect_sink ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@fac:
|
||||
@sink:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_autoplug_can_match ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@src:
|
||||
@dest:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_autoplug_factory_has_direction ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@fac:
|
||||
@dir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_autoplug_factory_has_sink ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@fac:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_autoplug_factory_has_src ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@fac:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_autoplug_get_cost ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@fac:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_autoplug_factories_sinks ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factories:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_autoplug_factories_srcs ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factories:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_autoplug_factories_filters ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factories:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_autoplug_factories_filters_with_sink_caps ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factories:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_autoplug_factories_at_most_templates ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factories:
|
||||
@dir:
|
||||
@maxtemplates:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_autoplug_sp ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@src_caps:
|
||||
@sink_caps:
|
||||
@factories:
|
||||
@Returns:
|
||||
|
||||
|
||||
33
docs/gst/tmpl/gstshaper.sgml
Normal file
33
docs/gst/tmpl/gstshaper.sgml
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstShaper
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GstShaperPolicyType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@SHAPER_POLICY_TIMESTAMPS:
|
||||
@SHAPER_POLICY_BUFFERSIZE:
|
||||
|
||||
<!-- ##### FUNCTION gst_shaper_factory_init ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
@Returns:
|
||||
|
||||
|
||||
44
docs/gst/tmpl/gstspider.sgml
Normal file
44
docs/gst/tmpl/gstspider.sgml
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstSpider
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### VARIABLE gst_spider_details ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF GstSpiderConnection ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_spider_identity_plug ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@ident:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_spider_identity_unplug ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@ident:
|
||||
|
||||
|
||||
45
docs/gst/tmpl/gstspideridentity.sgml
Normal file
45
docs/gst/tmpl/gstspideridentity.sgml
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstSpiderIdentity
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gst_spider_identity_new_sink ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_spider_identity_new_src ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_spider_identity_request_new_pad ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@element:
|
||||
@templ:
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
GstStructure
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
Generic structure containing fields of names and values
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -14,6 +14,27 @@ GstStructure
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstStructure ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@name:
|
||||
@fields:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### USER_FUNCTION GstStructureForeachFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@field_id:
|
||||
@value:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_structure_empty_new ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
GstSystemClock
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
A default clock that uses the current system time
|
||||
Default clock that uses the current system time
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
GstTag
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
List of tags and values used to describe media metadata
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -39,6 +39,35 @@ GstTag
|
|||
@GST_TAG_FLAG_DECODED:
|
||||
@GST_TAG_FLAG_COUNT:
|
||||
|
||||
<!-- ##### TYPEDEF GstTagList ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_LIST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@x:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_IS_TAG_LIST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@x:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_TAG_LIST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstTagForeachFunc ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -151,6 +180,15 @@ GstTag
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_is_tag_list ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@p:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_list_copy ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -583,3 +621,259 @@ GstTag
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_new_tag ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@list:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_tag_get_list ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tag_event:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_TITLE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ARTIST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ALBUM ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_DATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_GENRE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_COMMENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_TRACK_NUMBER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_TRACK_COUNT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ALBUM_VOLUME_NUMBER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ALBUM_VOLUME_COUNT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_LOCATION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_DESCRIPTION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_VERSION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ISRC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ORGANIZATION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_COPYRIGHT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_CONTACT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_LICENSE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_PERFORMER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_DURATION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_CODEC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_VIDEO_CODEC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_AUDIO_CODEC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_BITRATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_NOMINAL_BITRATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_MINIMUM_BITRATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_MAXIMUM_BITRATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_SERIAL ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ENCODER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ENCODER_VERSION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_TRACK_GAIN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_TRACK_PEAK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ALBUM_GAIN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TAG_ALBUM_PEAK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
GstTagInterface
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
Element interface that allows setting and retrieval of media metadata
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -14,13 +14,18 @@ GstTagInterface
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_setter_get_type ##### -->
|
||||
<!-- ##### STRUCT GstTagSetter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
<!-- ##### STRUCT GstTagSetterIFace ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_iface:
|
||||
|
||||
<!-- ##### FUNCTION gst_tag_setter_merge ##### -->
|
||||
<para>
|
||||
|
|
|
|||
|
|
@ -14,3 +14,12 @@ A tee can be used to split out the filter graph.
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gst_tee_factory_init ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
GstThread
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
A bin that will become a thread
|
||||
A #GstBin that executes automatically using a separate thread
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -18,6 +18,12 @@ A Thread can act as a toplevel bin as it has its own scheduler.
|
|||
#GstBin, #GstPipeline
|
||||
</para>
|
||||
|
||||
<!-- ##### VARIABLE gst_thread_current ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### ENUM GstThreadState ##### -->
|
||||
<para>
|
||||
Thread flags:
|
||||
|
|
@ -28,12 +34,6 @@ Thread flags:
|
|||
@GST_THREAD_MUTEX_LOCKED:
|
||||
@GST_THREAD_FLAG_LAST: subclass use this to start their enumeration
|
||||
|
||||
<!-- ##### STRUCT GstThread ##### -->
|
||||
<para>
|
||||
The GstThread object
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_thread_new ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -43,6 +43,23 @@ The GstThread object
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_thread_set_priority ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@thread:
|
||||
@priority:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_thread_get_current ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstThread::shutdown ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
|||
|
|
@ -14,6 +14,101 @@ Tracing functionality
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstTrace ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@filename:
|
||||
@fd:
|
||||
@buf:
|
||||
@bufsize:
|
||||
@bufoffset:
|
||||
|
||||
<!-- ##### STRUCT GstTraceEntry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@timestamp:
|
||||
@sequence:
|
||||
@data:
|
||||
@message:
|
||||
|
||||
<!-- ##### FUNCTION gst_trace_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@filename:
|
||||
@size:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_trace_destroy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@trace:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_trace_flush ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@trace:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_trace_text_flush ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@trace:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_trace_get_size ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@trace:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_trace_get_offset ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@trace:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_trace_get_remaining ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@trace:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_trace_set_default ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@trace:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_trace_read_tsc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dst:
|
||||
|
||||
|
||||
<!-- ##### ENUM GstAllocTraceFlags ##### -->
|
||||
<para>
|
||||
Flags indicating which tracing feature to enable.
|
||||
|
|
@ -48,6 +143,14 @@ The main tracing object
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_alloc_trace_live_all ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_alloc_trace_print_all ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -115,3 +218,14 @@ Trace a memory free operation
|
|||
@mem: The memory that is freed
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_trace_add_entry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@trace:
|
||||
@seq:
|
||||
@data:
|
||||
@msg:
|
||||
|
||||
|
||||
|
|
|
|||
51
docs/gst/tmpl/gsttrashstack.sgml
Normal file
51
docs/gst/tmpl/gsttrashstack.sgml
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gsttrashstack
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstTrashStack ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@head:
|
||||
@count:
|
||||
@lock:
|
||||
|
||||
<!-- ##### STRUCT GstTrashStackElement ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@next:
|
||||
|
||||
<!-- ##### TYPEDEF gst_vgpointer ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF gst_vgulong ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO SMP_LOCK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
|
|
@ -1,100 +1,18 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
Writing typefind functions
|
||||
GstTypeFindElement
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Using the type finding subsystem from plugins
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The typefinding subsystem in GStreamer is used to find the matching #GstCaps
|
||||
for an unidentified stream. This works similar to the unix <emphasis>file
|
||||
</emphasis> command.
|
||||
</para>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
<para>
|
||||
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.
|
||||
<example>
|
||||
<title>a typefind function for Ogg data</title>
|
||||
<programlisting>
|
||||
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));
|
||||
}
|
||||
};
|
||||
</programlisting>
|
||||
</example>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<link linkend="GstTypeFindFactory">GstTypeFactory - querying registered typefind
|
||||
functions</link>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstTypeFind ##### -->
|
||||
<para>
|
||||
This structure is filled by the caller of the typefind function. Typefind
|
||||
functions must treat this as an opaque structure.
|
||||
</para>
|
||||
|
||||
@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.
|
||||
|
||||
<!-- ##### USER_FUNCTION GstTypeFindFunction ##### -->
|
||||
<para>
|
||||
This is the prototype for a typefind function.
|
||||
</para>
|
||||
|
||||
@find: The #GstTypeFind data
|
||||
@data: the user defined data that was provided on
|
||||
gst_type_find_factory_register()
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_type_find_peek ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@find:
|
||||
@offset:
|
||||
@size:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_type_find_suggest ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@find:
|
||||
@probability:
|
||||
@caps:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_type_find_get_length ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@find:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
|
|||
249
docs/gst/tmpl/gsttypes.sgml
Normal file
249
docs/gst/tmpl/gsttypes.sgml
Normal file
|
|
@ -0,0 +1,249 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gsttypes
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstObject ##### -->
|
||||
<para>
|
||||
The GstObject
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstObjectClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_class:
|
||||
@path_string_separator:
|
||||
@signal_object:
|
||||
@parent_set:
|
||||
@parent_unset:
|
||||
@object_saved:
|
||||
@deep_notify:
|
||||
@destroy:
|
||||
@save_thyself:
|
||||
@restore_thyself:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### STRUCT GstPad ##### -->
|
||||
<para>
|
||||
The GstPad object
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstPadClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_class:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### STRUCT GstPadTemplate ##### -->
|
||||
<para>
|
||||
The padtemplate object.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstPadTemplateClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_class:
|
||||
@pad_created:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### STRUCT GstElement ##### -->
|
||||
<para>
|
||||
The element object
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstElementClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@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:
|
||||
|
||||
<!-- ##### STRUCT GstBin ##### -->
|
||||
<para>
|
||||
The GstBin object
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstBinClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_class:
|
||||
@add_element:
|
||||
@remove_element:
|
||||
@child_state_change:
|
||||
@iterate:
|
||||
@element_added:
|
||||
@element_removed:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### STRUCT GstScheduler ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstSchedulerClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@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:
|
||||
|
||||
<!-- ##### STRUCT GstEvent ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@data:
|
||||
@type:
|
||||
@timestamp:
|
||||
@src:
|
||||
|
||||
<!-- ##### ENUM GstElementState ##### -->
|
||||
<para>
|
||||
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.
|
||||
|
||||
</para>
|
||||
|
||||
@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.
|
||||
|
||||
<!-- ##### ENUM GstElementStateReturn ##### -->
|
||||
<para>
|
||||
This enum defines the standard return values that an element
|
||||
can return after a state change.
|
||||
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
<!-- ##### ENUM GstResult ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GST_RESULT_OK:
|
||||
@GST_RESULT_NOK:
|
||||
@GST_RESULT_NOT_IMPL:
|
||||
|
||||
<!-- ##### MACRO GST_RANK_PRIMARY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_RANK_SECONDARY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_RANK_MARGINAL ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_RANK_NONE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PADDING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PADDING_INIT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
GstURIHandler
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Register URIs and the elements that can handle them.
|
||||
Plugin feature that describes URI types and the element that handles it
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
@ -15,3 +15,173 @@ and the element property that can handle a given URI.
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GstURIType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GST_URI_UNKNOWN:
|
||||
@GST_URI_SINK:
|
||||
@GST_URI_SRC:
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_URI_HANDLER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_URI_HANDLER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_IS_URI_HANDLER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_URI_HANDLER_GET_INTERFACE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_URI_HANDLER_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstURIHandler ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstURIHandlerInterface ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent:
|
||||
@new_uri:
|
||||
@get_type:
|
||||
@get_protocols:
|
||||
@get_uri:
|
||||
@set_uri:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### FUNCTION gst_uri_protocol_is_valid ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@protocol:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_uri_is_valid ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@uri:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_uri_get_protocol ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@uri:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_uri_get_location ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@uri:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_uri_construct ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@protocol:
|
||||
@location:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_element_make_from_uri ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@uri:
|
||||
@elementname:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_uri_handler_get_uri_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@handler:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_uri_handler_get_protocols ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@handler:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_uri_handler_get_uri ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@handler:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_uri_handler_set_uri ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@handler:
|
||||
@uri:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_uri_handler_new_uri ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@handler:
|
||||
@uri:
|
||||
|
||||
|
||||
|
|
|
|||
31
docs/gst/tmpl/gsturitype.sgml
Normal file
31
docs/gst/tmpl/gsturitype.sgml
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstURIType
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_URI ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_uri_get_uri_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
@ -14,6 +14,15 @@ Some convenience functions
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gst_util_set_value_from_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@value_str:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_util_set_object_arg ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -24,15 +33,6 @@ Some convenience functions
|
|||
@value:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_util_set_value_from_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@value_str:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_util_dump_mem ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -42,16 +42,6 @@ Some convenience functions
|
|||
@size:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_print_element_args ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
@indent:
|
||||
@element:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_print_pad_caps ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -62,3 +52,68 @@ Some convenience functions
|
|||
@pad:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_print_element_args ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
@indent:
|
||||
@element:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BOILERPLATE_FULL ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@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:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BOILERPLATE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@type_as_function:
|
||||
@parent_type:
|
||||
@parent_type_macro:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CALL_PARENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_class_cast:
|
||||
@name:
|
||||
@args:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CALL_PARENT_WITH_DEFAULT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_class_cast:
|
||||
@name:
|
||||
@args:
|
||||
@def_return:
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -14,13 +14,256 @@ GstValue
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gst_value_list_prepend_value ##### -->
|
||||
<!-- ##### MACRO GST_MAKE_FOURCC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
@c:
|
||||
@d:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_STR_FOURCC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@f:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_FOURCC_FORMAT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_FOURCC_ARGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@fourcc:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VALUE_HOLDS_FOURCC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@x:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VALUE_HOLDS_INT_RANGE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@x:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VALUE_HOLDS_DOUBLE_RANGE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@x:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VALUE_HOLDS_LIST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@x:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VALUE_HOLDS_CAPS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@x:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_FOURCC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_INT_RANGE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_DOUBLE_RANGE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_LIST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VALUE_LESS_THAN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VALUE_EQUAL ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VALUE_GREATER_THAN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VALUE_UNORDERED ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstValueCompareFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value1:
|
||||
@value2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstValueSerializeFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value1:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstValueDeserializeFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@s:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstValueUnionFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@value1:
|
||||
@value2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstValueIntersectFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@value1:
|
||||
@value2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstValueTable ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@compare:
|
||||
@serialize:
|
||||
@deserialize:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### VARIABLE gst_type_fourcc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE gst_type_int_range ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE gst_type_double_range ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE gst_type_list ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_register ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@table:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_init_and_copy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@src:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_serialize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@prepend_value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_deserialize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@src:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_list_append_value ##### -->
|
||||
|
|
@ -32,6 +275,25 @@ GstValue
|
|||
@append_value:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_list_prepend_value ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@prepend_value:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_list_concat ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@value1:
|
||||
@value2:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_list_get_size ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -51,16 +313,6 @@ GstValue
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_list_concat ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@value1:
|
||||
@value2:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_set_fourcc ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -155,16 +407,6 @@ GstValue
|
|||
@calue:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_can_compare ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value1:
|
||||
@value2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_compare ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -175,7 +417,7 @@ GstValue
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_can_union ##### -->
|
||||
<!-- ##### FUNCTION gst_value_can_compare ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
|
@ -196,6 +438,16 @@ GstValue
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_can_union ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value1:
|
||||
@value2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_register_union_func ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -206,16 +458,6 @@ GstValue
|
|||
@func:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_can_intersect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value1:
|
||||
@value2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_intersect ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -227,6 +469,16 @@ GstValue
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_can_intersect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value1:
|
||||
@value2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_register_intersect_func ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -237,79 +489,3 @@ GstValue
|
|||
@func:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_register ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@table:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_init_and_copy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@src:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_serialize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_value_deserialize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@src:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VALUE_HOLDS_FOURCC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@x:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VALUE_HOLDS_INT_RANGE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@x:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VALUE_HOLDS_DOUBLE_RANGE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@x:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VALUE_HOLDS_LIST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@x:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VALUE_HOLDS_CAPS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@x:
|
||||
|
||||
|
||||
|
|
|
|||
47
docs/gst/tmpl/gstversion.sgml
Normal file
47
docs/gst/tmpl/gstversion.sgml
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gstversion
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GST_VERSION_MAJOR ##### -->
|
||||
<para>
|
||||
The major version of GStreamer at compile time
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VERSION_MINOR ##### -->
|
||||
<para>
|
||||
The minor version of GStreamer at compile time
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VERSION_MICRO ##### -->
|
||||
<para>
|
||||
The micro version of GStreamer at compile time
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_version ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@major:
|
||||
@minor:
|
||||
@micro:
|
||||
|
||||
|
||||
|
|
@ -14,6 +14,31 @@ GstXML
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstXMLNs ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_xml_write ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@element:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_xml_write_file ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@element:
|
||||
@out:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_xml_new ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -33,18 +58,6 @@ GstXML
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_xml_parse_memory ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@xml:
|
||||
@buffer:
|
||||
@size:
|
||||
@root:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_xml_parse_file ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -56,22 +69,15 @@ GstXML
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_xml_write ##### -->
|
||||
<!-- ##### FUNCTION gst_xml_parse_memory ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@element:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_xml_write_file ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@element:
|
||||
@out:
|
||||
@xml:
|
||||
@buffer:
|
||||
@size:
|
||||
@root:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
|
|||
122
docs/gst/tmpl/gstxmlregistry.sgml
Normal file
122
docs/gst/tmpl/gstxmlregistry.sgml
Normal file
|
|
@ -0,0 +1,122 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstXMLRegistry
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GstXMLRegistryState ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@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:
|
||||
|
||||
<!-- ##### ENUM GstXMLRegistryMode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GST_XML_REGISTRY_READ:
|
||||
@GST_XML_REGISTRY_WRITE:
|
||||
|
||||
<!-- ##### USER_FUNCTION GstXMLRegistryGetPerms ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@registry:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstXMLRegistryAddPathList ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@registry:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstXMLRegistryParser ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
@tag:
|
||||
@text:
|
||||
@text_len:
|
||||
@registry:
|
||||
@error:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstXMLRegistryOpen ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@registry:
|
||||
@mode:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstXMLRegistryLoad ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@registry:
|
||||
@dest:
|
||||
@size:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstXMLRegistrySave ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@registry:
|
||||
@format:
|
||||
@Varargs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstXMLRegistryClose ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@registry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_xml_registry_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@location:
|
||||
@Returns:
|
||||
|
||||
|
||||
101
docs/gst/tmpl/gthread-cothreads.sgml
Normal file
101
docs/gst/tmpl/gthread-cothreads.sgml
Normal file
|
|
@ -0,0 +1,101 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gthread-cothreads
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO COTHREADS_NAME ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO COTHREADS_NAME_CAPITAL ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION cothread_func ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@argc:
|
||||
@argv:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF cothread ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT cothread_context ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cothreads:
|
||||
@main:
|
||||
@current:
|
||||
@mutex:
|
||||
@gst_thread:
|
||||
|
||||
<!-- ##### MACRO do_cothread_create ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@new_cothread:
|
||||
@context:
|
||||
@func:
|
||||
@argc:
|
||||
@argv:
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothread_lock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cothread:
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothread_unlock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cothread:
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothread_get_current ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
|
||||
|
||||
<!-- ##### MACRO do_cothread_get_main ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
|
||||
|
||||
79
docs/gst/tmpl/types.sgml
Normal file
79
docs/gst/tmpl/types.sgml
Normal file
|
|
@ -0,0 +1,79 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
types
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### TYPEDEF link_t ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF chain_t ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT graph_t ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@chain:
|
||||
@links:
|
||||
@error:
|
||||
|
||||
<!-- ##### MACRO gst_parse_strdup ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_parse_strfree ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_parse_link_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_parse_link_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_parse_chain_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_parse_chain_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in a new issue