mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-11 01:45:33 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs/gst/tmpl/old/: I didn't intend to add these or check them in.

Browse source 
Original commit message from CVS:
* docs/gst/tmpl/old/GstBin.sgml:
* docs/gst/tmpl/old/GstBuffer.sgml:
* docs/gst/tmpl/old/GstCaps.sgml:
* docs/gst/tmpl/old/GstClock.sgml:
* docs/gst/tmpl/old/GstCompat.sgml:
* docs/gst/tmpl/old/GstData.sgml:
* docs/gst/tmpl/old/GstElement.sgml:
* docs/gst/tmpl/old/GstEvent.sgml:
* docs/gst/tmpl/old/GstIndex.sgml:
* docs/gst/tmpl/old/GstStructure.sgml:
* docs/gst/tmpl/old/GstTag.sgml:
* docs/gst/tmpl/old/cothreads.sgml:
* docs/gst/tmpl/old/cothreads_compat.sgml:
* docs/gst/tmpl/old/gettext.sgml:
* docs/gst/tmpl/old/gobject2gtk.sgml:
* docs/gst/tmpl/old/grammar.tab.sgml:
* docs/gst/tmpl/old/gst-i18n-app.sgml:
* docs/gst/tmpl/old/gst-i18n-lib.sgml:
* docs/gst/tmpl/old/gst_private.sgml:
* docs/gst/tmpl/old/gstaggregator.sgml:
* docs/gst/tmpl/old/gstarch.sgml:
* docs/gst/tmpl/old/gstatomic_impl.sgml:
* docs/gst/tmpl/old/gstbufferstore.sgml:
* docs/gst/tmpl/old/gstdata_private.sgml:
* docs/gst/tmpl/old/gstdisksink.sgml:
* docs/gst/tmpl/old/gstdisksrc.sgml:
* docs/gst/tmpl/old/gstelementfactory.sgml:
* docs/gst/tmpl/old/gstextratypes.sgml:
* docs/gst/tmpl/old/gstfakesink.sgml:
* docs/gst/tmpl/old/gstfakesrc.sgml:
* docs/gst/tmpl/old/gstfdsink.sgml:
* docs/gst/tmpl/old/gstfdsrc.sgml:
* docs/gst/tmpl/old/gstfilesink.sgml:
* docs/gst/tmpl/old/gstfilesrc.sgml:
* docs/gst/tmpl/old/gsthttpsrc.sgml:
* docs/gst/tmpl/old/gstidentity.sgml:
* docs/gst/tmpl/old/gstindexfactory.sgml:
* docs/gst/tmpl/old/gstmarshal.sgml:
* docs/gst/tmpl/old/gstmd5sink.sgml:
* docs/gst/tmpl/old/gstmultidisksrc.sgml:
* docs/gst/tmpl/old/gstmultifilesrc.sgml:
* docs/gst/tmpl/old/gstpadtemplate.sgml:
* docs/gst/tmpl/old/gstpipefilter.sgml:
* docs/gst/tmpl/old/gstschedulerfactory.sgml:
* docs/gst/tmpl/old/gstsearchfuncs.sgml:
* docs/gst/tmpl/old/gstshaper.sgml:
* docs/gst/tmpl/old/gstspider.sgml:
* docs/gst/tmpl/old/gstspideridentity.sgml:
* docs/gst/tmpl/old/gststatistics.sgml:
* docs/gst/tmpl/old/gsttee.sgml:
* docs/gst/tmpl/old/gsttimecache.sgml:
* docs/gst/tmpl/old/gsttypefindfactory.sgml:
* docs/gst/tmpl/old/gstxmlregistry.sgml:
* docs/gst/tmpl/old/gthread-cothreads.sgml:
* docs/gst/tmpl/old/types.sgml:
I didn't intend to add these or check them in.
This commit is contained in:
David Schleef 2005-05-22 04:26:41 +00:00
parent 650d98a466
commit 489398a1db
56 changed files with 59 additions and 7713 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
ChangeLog
View file

@ -1,3 +1,62 @@
2005-05-21 David Schleef <ds@schleef.org>
* docs/gst/tmpl/old/GstBin.sgml:
* docs/gst/tmpl/old/GstBuffer.sgml:
* docs/gst/tmpl/old/GstCaps.sgml:
* docs/gst/tmpl/old/GstClock.sgml:
* docs/gst/tmpl/old/GstCompat.sgml:
* docs/gst/tmpl/old/GstData.sgml:
* docs/gst/tmpl/old/GstElement.sgml:
* docs/gst/tmpl/old/GstEvent.sgml:
* docs/gst/tmpl/old/GstIndex.sgml:
* docs/gst/tmpl/old/GstStructure.sgml:
* docs/gst/tmpl/old/GstTag.sgml:
* docs/gst/tmpl/old/cothreads.sgml:
* docs/gst/tmpl/old/cothreads_compat.sgml:
* docs/gst/tmpl/old/gettext.sgml:
* docs/gst/tmpl/old/gobject2gtk.sgml:
* docs/gst/tmpl/old/grammar.tab.sgml:
* docs/gst/tmpl/old/gst-i18n-app.sgml:
* docs/gst/tmpl/old/gst-i18n-lib.sgml:
* docs/gst/tmpl/old/gst_private.sgml:
* docs/gst/tmpl/old/gstaggregator.sgml:
* docs/gst/tmpl/old/gstarch.sgml:
* docs/gst/tmpl/old/gstatomic_impl.sgml:
* docs/gst/tmpl/old/gstbufferstore.sgml:
* docs/gst/tmpl/old/gstdata_private.sgml:
* docs/gst/tmpl/old/gstdisksink.sgml:
* docs/gst/tmpl/old/gstdisksrc.sgml:
* docs/gst/tmpl/old/gstelementfactory.sgml:
* docs/gst/tmpl/old/gstextratypes.sgml:
* docs/gst/tmpl/old/gstfakesink.sgml:
* docs/gst/tmpl/old/gstfakesrc.sgml:
* docs/gst/tmpl/old/gstfdsink.sgml:
* docs/gst/tmpl/old/gstfdsrc.sgml:
* docs/gst/tmpl/old/gstfilesink.sgml:
* docs/gst/tmpl/old/gstfilesrc.sgml:
* docs/gst/tmpl/old/gsthttpsrc.sgml:
* docs/gst/tmpl/old/gstidentity.sgml:
* docs/gst/tmpl/old/gstindexfactory.sgml:
* docs/gst/tmpl/old/gstmarshal.sgml:
* docs/gst/tmpl/old/gstmd5sink.sgml:
* docs/gst/tmpl/old/gstmultidisksrc.sgml:
* docs/gst/tmpl/old/gstmultifilesrc.sgml:
* docs/gst/tmpl/old/gstpadtemplate.sgml:
* docs/gst/tmpl/old/gstpipefilter.sgml:
* docs/gst/tmpl/old/gstschedulerfactory.sgml:
* docs/gst/tmpl/old/gstsearchfuncs.sgml:
* docs/gst/tmpl/old/gstshaper.sgml:
* docs/gst/tmpl/old/gstspider.sgml:
* docs/gst/tmpl/old/gstspideridentity.sgml:
* docs/gst/tmpl/old/gststatistics.sgml:
* docs/gst/tmpl/old/gsttee.sgml:
* docs/gst/tmpl/old/gsttimecache.sgml:
* docs/gst/tmpl/old/gsttypefindfactory.sgml:
* docs/gst/tmpl/old/gstxmlregistry.sgml:
* docs/gst/tmpl/old/gthread-cothreads.sgml:
* docs/gst/tmpl/old/types.sgml:
I didn't intend to add these or check them in.
2005-05-19 David Schleef <ds@schleef.org>
* configure.ac: Use -no-common everywhere. In a sane world, it

246
docs/gst/tmpl/old/GstBin.sgml
View file

@ -1,246 +0,0 @@
<!-- ##### 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/old/GstBuffer.sgml
View file

@ -1,419 +0,0 @@
<!-- ##### 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/old/GstCaps.sgml
View file

@ -1,413 +0,0 @@
<!-- ##### 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/old/GstClock.sgml
View file

@ -1,425 +0,0 @@
<!-- ##### 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/old/GstCompat.sgml
View file

@ -1,152 +0,0 @@
<!-- ##### 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/old/GstData.sgml
View file

@ -1,220 +0,0 @@
<!-- ##### 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/old/GstElement.sgml
View file

File diff suppressed because it is too large Load diff

433
docs/gst/tmpl/old/GstEvent.sgml
View file

@ -1,433 +0,0 @@
<!-- ##### 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/old/GstIndex.sgml
View file

@ -1,523 +0,0 @@
<!-- ##### 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/old/GstStructure.sgml
View file

@ -1,366 +0,0 @@
<!-- ##### 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/old/GstTag.sgml
View file

@ -1,881 +0,0 @@
<!-- ##### 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>

223
docs/gst/tmpl/old/cothreads.sgml
View file

@ -1,223 +0,0 @@
<!-- ##### SECTION Title ##### -->
cothreads
<!-- ##### SECTION Short_Description ##### -->
userspace threads
<!-- ##### SECTION Long_Description ##### -->
<para>
Cothreads are a simple user-space method for switching between
subtasks. They're based on setjmp()/longjmp() in their current form.
</para>
<para>
Cothreads are used for loop-based elements that pull data instead
of being fed with data. Cothreads are usually used by a #GstScheduler.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstScheduler
</para>
<!-- ##### STRUCT cothread_state ##### -->
<para>
The cothread state structure
</para>
@ctx:
@cothreadnum:
@priv:
@func:
@argc:
@argv:
@flags:
@sp:
@jmp:
@stack_base:
@stack_size:
@magic_number:
<!-- ##### STRUCT cothread_context ##### -->
<para>
</para>
@cothreads:
@main:
@current:
@mutex:
@gst_thread:
<!-- ##### USER_FUNCTION cothread_func ##### -->
<para>
</para>
@argc:
@argv:
@Returns:
<!-- ##### MACRO COTHREAD_STARTED ##### -->
<para>
Indicates the cothread is started.
</para>
<!-- ##### MACRO COTHREAD_DESTROYED ##### -->
<para>
Indicates the cothread is destroyed.
</para>
<!-- ##### FUNCTION cothread_context_init ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION cothread_context_free ##### -->
<para>
</para>
@ctx:
<!-- ##### FUNCTION cothread_context_set_data ##### -->
<para>
</para>
@cothread:
@key:
@data:
<!-- ##### FUNCTION cothread_context_get_data ##### -->
<para>
</para>
@cothread:
@key:
@Returns:
<!-- ##### FUNCTION cothread_create ##### -->
<para>
</para>
@ctx:
@Returns:
<!-- ##### FUNCTION cothread_free ##### -->
<para>
</para>
@cothread:
<!-- ##### FUNCTION cothread_setfunc ##### -->
<para>
</para>
@cothread:
@func:
@argc:
@argv:
<!-- ##### FUNCTION cothread_stop ##### -->
<para>
</para>
@cothread:
<!-- ##### FUNCTION cothread_switch ##### -->
<para>
</para>
@cothread:
<!-- ##### FUNCTION cothread_set_private ##### -->
<para>
</para>
@cothread:
@data:
<!-- ##### FUNCTION cothread_get_private ##### -->
<para>
</para>
@cothread:
@Returns:
<!-- ##### FUNCTION cothread_lock ##### -->
<para>
</para>
@cothread:
<!-- ##### FUNCTION cothread_trylock ##### -->
<para>
</para>
@cothread:
@Returns:
<!-- ##### FUNCTION cothread_unlock ##### -->
<para>
</para>
@cothread:
<!-- ##### FUNCTION cothread_main ##### -->
<para>
</para>
@ctx:
@Returns:
<!-- ##### FUNCTION cothread_current_main ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION cothread_current ##### -->
<para>
</para>
@Returns:

147
docs/gst/tmpl/old/cothreads_compat.sgml
View file

@ -1,147 +0,0 @@
<!-- ##### SECTION Title ##### -->
cothreads_compat
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO COTHREADS_TYPE ##### -->
<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/old/gettext.sgml
View file

@ -1,124 +0,0 @@
<!-- ##### 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:

16
docs/gst/tmpl/old/gobject2gtk.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GObject
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

79
docs/gst/tmpl/old/grammar.tab.sgml
View file

@ -1,79 +0,0 @@
<!-- ##### 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/old/gst-i18n-app.sgml
View file

@ -1,32 +0,0 @@
<!-- ##### 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/old/gst-i18n-lib.sgml
View file

@ -1,32 +0,0 @@
<!-- ##### 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:

178
docs/gst/tmpl/old/gst_private.sgml
View file

@ -1,178 +0,0 @@
<!-- ##### 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>

17
docs/gst/tmpl/old/gstaggregator.sgml
View file

@ -1,17 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstAggregator
<!-- ##### SECTION Short_Description ##### -->
Combine buffers.
<!-- ##### SECTION Long_Description ##### -->
<para>
The aggregator is mainly used for testing purposes. It has several
methods to request buffers from its pads.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

58
docs/gst/tmpl/old/gstarch.sgml
View file

@ -1,58 +0,0 @@
<!-- ##### SECTION Title ##### -->
gstarch
<!-- ##### SECTION Short_Description ##### -->
Architecural specific macros and functions.
<!-- ##### SECTION Long_Description ##### -->
<para>
This file contains various macros and function for performing common
GStreamer tasks that requires some knowledge of the underlaying architecture.
Porting to other CPU architectures will typically require adding appropriate
implementations in this file.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_ARCH_SET_SP ##### -->
<para>
Sets the stackpointer.
</para>
@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?
</para>
@sp: the stackpointer to modify.
<!-- ##### MACRO GST_ARCH_PRESETJMP ##### -->
<para>
Do something funny, which is required on some archs..
</para>
<!-- ##### MACRO USE_MAKECONTEXT ##### -->
<para>
</para>

46
docs/gst/tmpl/old/gstatomic_impl.sgml
View file

@ -1,46 +0,0 @@
<!-- ##### 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:

16
docs/gst/tmpl/old/gstbufferstore.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstBufferStore
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

16
docs/gst/tmpl/old/gstdata_private.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
gstdata_private
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

16
docs/gst/tmpl/old/gstdisksink.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstDiskSink
<!-- ##### SECTION Short_Description ##### -->
Write to a file
<!-- ##### SECTION Long_Description ##### -->
<para>
The disksink write to a file. The filename can be given as an argument.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstFdSink
</para>

54
docs/gst/tmpl/old/gstdisksrc.sgml
View file

@ -1,54 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstDiskSrc
<!-- ##### SECTION Short_Description ##### -->
Asynchronous read from a file (disksrc)
<!-- ##### SECTION Long_Description ##### -->
<para>
Asynchonously read buffers from a file.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GstDiskSrcFlags ##### -->
<para>
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GST_DISKSRC_OPEN</entry>
<entry>the disksrc is open for reading</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@GST_DISKSRC_OPEN:
@GST_DISKSRC_FLAG_LAST:
<!-- ##### ARG GstDiskSrc:location ##### -->
<para>
Specify the location of the file to read.
</para>
<!-- ##### ARG GstDiskSrc:bytesperread ##### -->
<para>
Specify how many bytes to read at a time.
</para>
<!-- ##### ARG GstDiskSrc:offset ##### -->
<para>
Get/set the current offset in the file.
</para>
<!-- ##### ARG GstDiskSrc:filesize ##### -->
<para>
</para>

117
docs/gst/tmpl/old/gstelementfactory.sgml
View file

@ -1,117 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstElementFactory
<!-- ##### SECTION Short_Description ##### -->
Create GstElements from a factory
<!-- ##### SECTION Long_Description ##### -->
<para>
GstElementFactory is used to create instances of elements. A GstElementfactory
can be added to a #GstPlugin as it is also a #GstPluginFeature.
</para>
<para>
Use gst_element_factory_new() to create a new factory which can be added to a plugin
with gst_plugin_add_feature().
</para>
<para>
gst_element_factory_add_pad_template() is used to add a padtemplate to the factory.
This function will enable the application to query for elementfactories that handle
a specific media type.
</para>
<para>
Use the gst_element_factory_find() and gst_element_factory_create() functions
to create element instances or use gst_element_factory_make() as a convenient
shortcut.
</para>
<para>
The following code example shows you how to create a GstFileSrc element.
</para>
<para>
<programlisting role="C">
#include &lt;gst/gst.h&gt;
GstElement *src;
GstElementFactory *srcfactory;
gst_init(&amp;argc,&amp;argv);
srcfactory = gst_element_factory_find("filesrc");
g_return_if_fail(srcfactory != NULL);
src = gst_element_factory_create(srcfactory,"src");
g_return_if_fail(src != NULL);
...
</programlisting>
</para>
<para>
An elementfactory can be assigned a rank with gst_element_factory_set_rank()
so that the autopluggers can select a plugin more appropriatly
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
</para>
<!-- ##### STRUCT GstElementDetails ##### -->
<para>
This struct is used to define public information about the element. It
describes the element, mostly for the benefit of editors.
</para>
@longname:
@klass:
@description:
@author:
@_gst_reserved:
<!-- ##### FUNCTION gst_element_factory_find ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_element_factory_can_src_caps ##### -->
<para>
</para>
@factory:
@caps:
@Returns:
<!-- ##### FUNCTION gst_element_factory_can_sink_caps ##### -->
<para>
</para>
@factory:
@caps:
@Returns:
<!-- ##### FUNCTION gst_element_factory_create ##### -->
<para>
</para>
@factory:
@name:
@Returns:
<!-- ##### FUNCTION gst_element_factory_make ##### -->
<para>
</para>
@factoryname:
@name:
@Returns:

31
docs/gst/tmpl/old/gstextratypes.sgml
View file

@ -1,31 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstExtraTypes
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_FILENAME ##### -->
<para>
A type that can be used to indicate a filename.
</para>
<!-- ##### FUNCTION gst_extra_get_filename_type ##### -->
<para>
</para>
@Returns:

18
docs/gst/tmpl/old/gstfakesink.sgml
View file

@ -1,18 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstFakeSink
<!-- ##### SECTION Short_Description ##### -->
Sources a buffer without doing anything with it. (fakesink)
<!-- ##### SECTION Long_Description ##### -->
<para>
Take a buffer and gst_buffer_unref() it. This element does nothing
with the buffer. (fakesink)
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

16
docs/gst/tmpl/old/gstfakesrc.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstFakeSrc
<!-- ##### SECTION Short_Description ##### -->
Generate empty buffers. (fakesrc)
<!-- ##### SECTION Long_Description ##### -->
<para>
The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

16
docs/gst/tmpl/old/gstfdsink.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstFdSink
<!-- ##### SECTION Short_Description ##### -->
Write data to a file descriptor. (fdsink)
<!-- ##### SECTION Long_Description ##### -->
<para>
Write data to a file descriptor.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

16
docs/gst/tmpl/old/gstfdsrc.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstFdSrc
<!-- ##### SECTION Short_Description ##### -->
Read buffers from a file descriptor. (fdsrc)
<!-- ##### SECTION Long_Description ##### -->
<para>
Read buffers from a file descriptor.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

16
docs/gst/tmpl/old/gstfilesink.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstFileSink
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

17
docs/gst/tmpl/old/gstfilesrc.sgml
View file

@ -1,17 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstFileSrc
<!-- ##### SECTION Short_Description ##### -->
Read data from a file
<!-- ##### SECTION Long_Description ##### -->
<para>
FileSrc is used to read buffers from a file. It efficiently uses mmap
and subbuffers.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

16
docs/gst/tmpl/old/gsthttpsrc.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstHttpSrc
<!-- ##### SECTION Short_Description ##### -->
Reads data from a URL. (httpsrc)
<!-- ##### SECTION Long_Description ##### -->
<para>
Reads data from a URL.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

16
docs/gst/tmpl/old/gstidentity.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstIdentity
<!-- ##### SECTION Short_Description ##### -->
Pass data without modification. (identity)
<!-- ##### SECTION Long_Description ##### -->
<para>
Pass data without modification.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

68
docs/gst/tmpl/old/gstindexfactory.sgml
View file

@ -1,68 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstIndexFactory
<!-- ##### SECTION Short_Description ##### -->
Create GstIndexes from a factory
<!-- ##### SECTION Long_Description ##### -->
<para>
GstIndexFactory is used to dynamically create GstIndex implementations.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstIndex
</para>
<!-- ##### STRUCT GstIndexFactory ##### -->
<para>
The GstIndexFactory object
</para>
<!-- ##### 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:

16
docs/gst/tmpl/old/gstmarshal.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
gstmarshal
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

16
docs/gst/tmpl/old/gstmd5sink.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstMD5Sink
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

24
docs/gst/tmpl/old/gstmultidisksrc.sgml
View file

@ -1,24 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstMultiDiskSrc
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GstMultiDiskSrcFlags ##### -->
<para>
</para>
@GST_MULTIDISKSRC_OPEN:
@GST_MULTIDISKSRC_FLAG_LAST:

16
docs/gst/tmpl/old/gstmultifilesrc.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstMultiFileSrc
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

178
docs/gst/tmpl/old/gstpadtemplate.sgml
View file

@ -1,178 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstPadTemplate
<!-- ##### SECTION Short_Description ##### -->
Describe the media type of a pad.
<!-- ##### SECTION Long_Description ##### -->
<para>
Padtemplates describe the possible media types a pad or an elementfactory can
handle.
</para>
<para>
Pad and PadTemplates have #GstCaps attached to it to describe the media type they
are capable of dealing with. gst_pad_template_get_caps() is used to get the
caps of a padtemplate. It's not possible to modify the caps of a padtemplate after
creation.
</para>
<para>
Padtemplates can be created with gst_pad_template_new() or with the convenient
GST_PAD_TEMPLATE_FACTORY() macro. A padtemplate can be used to create a pad or
to add to an elementfactory.
</para>
<para>
The following code example shows the code to create a pad from a padtemplate.
<programlisting>
GstStaticPadTemplate my_template =
GST_STATIC_PAD_TEMPLATE (
"sink", /* the name of the pad */
GST_PAD_SINK, /* the direction of the pad */
GST_PAD_ALWAYS, /* when this pad will be present */
GST_STATIC_CAPS ( /* the capabilities of the padtemplate */
"audio/x-raw-int, "
"channels = (int) [ 1, 6 ]"
)
)
void
my_method (void)
{
GstPad *pad;
pad = gst_pad_new_from_template (GST_PAD_TEMPLATE_GET (my_template_factory), "sink");
...
}
</programlisting>
</para>
<para>
The following example shows you how to add the padtemplate to an elementfactory:
<programlisting>
gboolean
my_factory_init (GstPlugin *plugin)
{
GstElementFactory *factory;
factory = gst_element_factory_new ("my_factory", GST_TYPE_MYFACTORY, &amp;gst_myfactory_details);
g_return_val_if_fail (factory != NULL, FALSE);
gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (my_template_factory));
gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory));
return TRUE;
}
</programlisting>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstPad, #GstElementFactory
</para>
<!-- ##### ENUM GstPadPresence ##### -->
<para>
Indicates when this pad will become available.
</para>
@GST_PAD_ALWAYS: the pad is always available
@GST_PAD_SOMETIMES: the pad will become available depending on the media stream
@GST_PAD_REQUEST: th pad is only available on request with
gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
<!-- ##### STRUCT GstPadTemplate ##### -->
<para>
The padtemplate object.
</para>
<!-- ##### ENUM GstPadTemplateFlags ##### -->
<para>
Flags for the padtemplate
</para>
@GST_PAD_TEMPLATE_FIXED: The padtemplate has no variable properties
@GST_PAD_TEMPLATE_FLAG_LAST: first flag that can be used by subclasses.
<!-- ##### MACRO GST_PAD_TEMPLATE_CAPS ##### -->
<para>
Get a handle to the padtemplate #GstCaps
</para>
@templ: the template to query
<!-- ##### MACRO GST_PAD_TEMPLATE_DIRECTION ##### -->
<para>
Get the direction of the padtemplate.
</para>
@templ: the template to query
<!-- ##### MACRO GST_PAD_TEMPLATE_NAME_TEMPLATE ##### -->
<para>
Get the nametemplate of the padtemplate.
</para>
@templ: the template to query
<!-- ##### MACRO GST_PAD_TEMPLATE_PRESENCE ##### -->
<para>
Get the presence of the padtemplate.
</para>
@templ: the template to query
<!-- ##### MACRO GST_PAD_TEMPLATE_IS_FIXED ##### -->
<para>
Check if the properties of the padtemplate are fixed
</para>
@templ: the template to query
<!-- ##### FUNCTION gst_pad_template_new ##### -->
<para>
</para>
@name_template:
@direction:
@presence:
@caps:
@Returns:
<!-- # Unused Parameters # -->
@Varargs:
<!-- ##### FUNCTION gst_pad_template_get_caps ##### -->
<para>
</para>
@templ:
@Returns:
<!-- ##### FUNCTION gst_pad_template_get_caps_by_name ##### -->
<para>
</para>
@templ:
@name:
@Returns:
<!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
<para>
This signal is fired when an element creates a pad from this
template.
</para>
@gstpadtemplate: the object which received the signal.
@arg1: The pad that was created.

17
docs/gst/tmpl/old/gstpipefilter.sgml
View file

@ -1,17 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstPipefilter
<!-- ##### SECTION Short_Description ##### -->
A wrapper around every stdin/stdout capable program
<!-- ##### SECTION Long_Description ##### -->
<para>
A GstPipefilter pipes data to an external program and creates
buffers from its output.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

97
docs/gst/tmpl/old/gstschedulerfactory.sgml
View file

@ -1,97 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstSchedulerFactory
<!-- ##### SECTION Short_Description ##### -->
Create schedulers from a factory
<!-- ##### SECTION Long_Description ##### -->
<para>
A schedulerfactory is used to create instances of a scheduler. It
can be added to a #GstPlugin as it extends #GstPluginFeature.
</para>
<para>
Use gst_scheduler_factory_new() to create a new scheduler which can be registered
to a plugin with gst_plugin_add_feature().
</para>
<para>
Use gst_scheduler_factory_find() to find the named schedulerfactory.
or use gst_scheduler_factory_get_list() to get a list of all available schedulers.
</para>
<para>
Once an schedulerfactory has been obtained use gst_scheduler_factory_create() to
instantiate a real scheduler. Optionally gst_scheduler_factory_make() to create
a scheduler from the named factory.
</para>
<para>
Use gst_scheduler_factory_destroy() to remove the factory from the global list.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_scheduler_factory_create ##### -->
<para>
</para>
@factory:
@parent:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_destroy ##### -->
<para>
</para>
@factory:
<!-- ##### FUNCTION gst_scheduler_factory_find ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_make ##### -->
<para>
</para>
@name:
@parent:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_new ##### -->
<para>
</para>
@name:
@longdesc:
@type:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_get_default_name ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_set_default_name ##### -->
<para>
</para>
@name:

16
docs/gst/tmpl/old/gstsearchfuncs.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
gstsearchfuncs
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

16
docs/gst/tmpl/old/gstshaper.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstShaper
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

16
docs/gst/tmpl/old/gstspider.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstSpider
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

16
docs/gst/tmpl/old/gstspideridentity.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstSpiderIdentity
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

17
docs/gst/tmpl/old/gststatistics.sgml
View file

@ -1,17 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstStatistics
<!-- ##### SECTION Short_Description ##### -->
Provide statistics about data that passes this plugin
<!-- ##### SECTION Long_Description ##### -->
<para>
The plugin doesn't alter the data but provides statistics about
the data stream, such as buffers/bytes/events etc.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

16
docs/gst/tmpl/old/gsttee.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstTee
<!-- ##### SECTION Short_Description ##### -->
1-to-N pipe fitting
<!-- ##### SECTION Long_Description ##### -->
<para>
A tee can be used to split out the filter graph.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

17
docs/gst/tmpl/old/gsttimecache.sgml
View file

@ -1,17 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstTimeCache
<!-- ##### SECTION Short_Description ##### -->
Cache time and byteoffsets.
<!-- ##### SECTION Long_Description ##### -->
<para>
This class is used by plugins to manage time vs byte offsets. It is mainly
used for efficient seeking.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

117
docs/gst/tmpl/old/gsttypefindfactory.sgml
View file

@ -1,117 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstTypeFindFactory
<!-- ##### SECTION Short_Description ##### -->
information about registered typefind functions
<!-- ##### SECTION Long_Description ##### -->
<para>
These functions allow querying informations about registered typefind
functions. How to create and register these functions is described in
the section <link linkend="gstreamer-Writing-typefind-functions">
"Writing typefind functions"</link>.
</para>
<example>
<title>how to write a simple typefinder</title>
<programlisting>
/* FIXME: compile this? ;) */
typedef struct {
guint8 *data;
guint size;
guint probability;
GstCaps *data;
} MyTypeFind;
static void
my_peek (gpointer data, gint64 offset, guint size)
{
MyTypeFind *find = (MyTypeFind *) data;
if (offset &gt;= 0 &amp;&amp; offset + size &lt;= find->size) {
return find->data + offset;
}
return NULL;
}
static void
my_suggest (gpointer data, guint probability, GstCaps *caps)
{
MyTypeFind *find = (MyTypeFind *) data;
if (probability &gt; find->probability) {
find->probability = probability;
gst_caps_replace (&amp;find->caps, caps);
}
}
static GstCaps *
find_type (guint8 *data, guint size)
{
GList *walk, *type_list;
MyTypeFind find = {data, size, 0, NULL};
GstTypeFind gst_find = {my_peek, my_suggest, &amp;find, };
walk = type_list = gst_type_find_factory_get_list ();
while (walk) {
GstTypeFindFactory *factory = GST_TYPE_FIND_FACTORY (walk->data);
walk = g_list_next (walk)
gst_type_find_factory_call_function (factory, &amp;gst_find);
}
g_list_free (type_list);
return find.caps;
};
</programlisting>
</example>
<para>
The above example shows how to write a very simple typefinder that identifies
the given data. You can get quite a bit more complicated than that though.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<link linkend="gstreamer-Writing-typefind-functions">Writing typefind functions</link>
</para>
<!-- ##### STRUCT GstTypeFindFactory ##### -->
<para>
Object that stores information about a typefind function
</para>
<!-- ##### STRUCT GstTypeFindFactoryClass ##### -->
<para>
Class belonging to #GstTypeFindFactory.
</para>
@parent:
<!-- ##### FUNCTION gst_type_find_factory_get_list ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_type_find_factory_get_extensions ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_type_find_factory_get_caps ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_type_find_factory_call_function ##### -->
<para>
</para>
@factory:
@find:

122
docs/gst/tmpl/old/gstxmlregistry.sgml
View file

@ -1,122 +0,0 @@
<!-- ##### 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:

123
docs/gst/tmpl/old/gthread-cothreads.sgml
View file

@ -1,123 +0,0 @@
<!-- ##### SECTION Title ##### -->
gthread-cothreads
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO COTHREADS_TYPE ##### -->
<para>
</para>
<!-- ##### MACRO COTHREADS_NAME ##### -->
<para>
</para>
<!-- ##### MACRO COTHREADS_NAME_CAPITAL ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION cothread_func ##### -->
<para>
</para>
@Varargs:
@Param2:
@Returns:
<!-- # Unused Parameters # -->
@argc:
@argv:
<!-- ##### 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:
<!-- ##### MACRO do_cothread_setfunc ##### -->
<para>
</para>
@cothread:
@context:
@func:
@argc:
@argv:

79
docs/gst/tmpl/old/types.sgml
View file

@ -1,79 +0,0 @@
<!-- ##### 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>