mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-28 19:20:35 +00:00
1e4ad29e52
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:
220 lines
3.5 KiB
Text
220 lines
3.5 KiB
Text
<!-- ##### SECTION Title ##### -->
|
|
GstData
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Abstract structure for information that is passed among elements
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
This abstract structure provides a common base for #GstBuffer, #GstBufferPool
|
|
and #GstEvent. It is the main data type that is passed along in a pipeline.
|
|
GstData provides refcounting, freeing and copying for its child classes.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
#GstBuffer, #GstBufferPool, #GstEvent
|
|
</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:
|
|
|
|
|