Commit 8a1f401d authored by Wim Taymans's avatar Wim Taymans

docs: fix docs

parent 52cb6498
......@@ -157,7 +157,7 @@ GstBusPrivate
<FILE>gstbuffer</FILE>
<TITLE>GstBuffer</TITLE>
GstBuffer
GstBufferFlag
GstBufferFlags
GstBufferCopyFlags
GST_BUFFER_FLAGS
GST_BUFFER_FLAG_IS_SET
......@@ -180,10 +180,14 @@ GST_BUFFER_TRACE_NAME
gst_buffer_new
gst_buffer_new_and_alloc
gst_buffer_new_allocate
gst_buffer_new_wrapped
gst_buffer_new_wrapped_full
gst_buffer_ref
gst_buffer_unref
gst_buffer_get_sizes
gst_buffer_get_size
gst_buffer_resize
gst_buffer_set_size
......@@ -195,14 +199,15 @@ gst_buffer_remove_memory
gst_buffer_remove_memory_range
gst_buffer_join
gst_buffer_memcmp
gst_buffer_merge
gst_buffer_map
gst_buffer_unmap
gst_buffer_memcmp
gst_buffer_extract
gst_buffer_fill
gst_buffer_memset
GST_BUFFER_COPY_METADATA
GST_BUFFER_COPY_ALL
......@@ -230,11 +235,12 @@ GstBufferClass
GST_BUFFER
GST_IS_BUFFER
GST_TYPE_BUFFER
GST_TYPE_BUFFER_FLAG
GST_TYPE_BUFFER_FLAGS
GST_TYPE_BUFFER_COPY_FLAGS
GST_BUFFER_CAST
<SUBSECTION Private>
gst_buffer_flag_get_type
gst_buffer_get_type
gst_buffer_flags_get_type
gst_buffer_copy_flags_get_type
</SECTION>
......@@ -259,16 +265,25 @@ gst_meta_get_info
GstBufferPool
GstBufferPoolClass
GstBufferPoolFlags
GST_BUFFER_POOL_IS_FLUSHING
GstBufferPoolParams
gst_buffer_pool_new
gst_buffer_pool_config_get
gst_buffer_pool_config_set
gst_buffer_pool_config_add_option
gst_buffer_pool_config_get_option
gst_buffer_pool_config_has_option
gst_buffer_pool_config_n_options
gst_buffer_pool_get_options
gst_buffer_pool_has_option
gst_buffer_pool_get_config
gst_buffer_pool_set_config
gst_buffer_pool_set_active
gst_buffer_pool_is_active
gst_buffer_pool_acquire_buffer
gst_buffer_pool_release_buffer
......@@ -348,6 +363,7 @@ gst_caps_is_writable
gst_caps_copy
gst_caps_copy_nth
gst_static_caps_get
gst_static_caps_cleanup
gst_caps_append
gst_caps_merge
gst_caps_append_structure
......@@ -380,6 +396,7 @@ gst_caps_subtract
gst_caps_make_writable
gst_caps_ref
gst_caps_truncate
gst_caps_fixate
gst_caps_unref
<SUBSECTION Standard>
GST_CAPS
......@@ -387,6 +404,7 @@ GST_IS_CAPS
GST_TYPE_CAPS
GST_TYPE_CAPS_FLAGS
GST_TYPE_CAPS_INTERSECT_MODE
GST_CAPS_CAST
<SUBSECTION Private>
gst_caps_flags_get_type
gst_caps_get_type
......@@ -824,6 +842,7 @@ GST_EVENT_TRACE_NAME
GST_EVENT_TYPE
GST_EVENT_TYPE_NAME
GST_EVENT_TIMESTAMP
GST_EVENT_SEQNUM
GST_EVENT_IS_UPSTREAM
GST_EVENT_IS_DOWNSTREAM
......@@ -908,6 +927,11 @@ GST_TYPE_QOS_TYPE
GST_TYPE_EVENT_TYPE_FLAGS
<SUBSECTION Private>
GST_EVENT_TYPE_SHIFT
GST_EVENT_MAX_STICKY
GST_EVENT_NUM_SHIFT
GST_EVENT_STICKY_IDX
GST_EVENT_STICKY_IDX_TYPE
GST_EVENT_STICKY_SHIFT
FLAG
gst_event_get_type
gst_event_type_get_type
......@@ -1255,7 +1279,7 @@ gst_iterator_result_get_type
<TITLE>GstMemory</TITLE>
GstMemory
GstMemoryInfo
GstMemoryAllocator
GstAllocator
GST_MEMORY_IS_WRITABLE
GstMemoryFlags
GstMapFlags
......@@ -1269,7 +1293,10 @@ GstMemoryFreeFunction
GstMemoryCopyFunction
GstMemoryShareFunction
GstMemoryIsSpanFunction
gst_memory_allocator_alloc
gst_memory_alignment
gst_allocator_alloc
gst_memory_new_wrapped
gst_memory_ref
......@@ -1286,9 +1313,10 @@ gst_memory_share
gst_memory_is_span
gst_memory_allocator_find
gst_memory_allocator_register
gst_memory_allocator_set_default
GST_ALLOCATOR_SYSMEM
gst_allocator_find
gst_allocator_register
gst_allocator_set_default
<SUBSECTION Standard>
GST_MEMORY_TRACE_NAME
GST_TYPE_MAP_FLAGS
......@@ -1330,9 +1358,7 @@ gst_message_parse_warning
gst_message_new_info
gst_message_parse_info
gst_message_new_tag
gst_message_new_tag_full
gst_message_parse_tag
gst_message_parse_tag_full
gst_message_new_buffering
gst_message_parse_buffering
gst_message_set_buffering_stats
......@@ -1433,7 +1459,7 @@ GST_MINI_OBJECT_REFCOUNT
GST_MINI_OBJECT_REFCOUNT_VALUE
GST_MINI_OBJECT_SIZE
gst_mini_object_register
GST_DEFINE_MINI_OBJECT_TYPE
gst_mini_object_init
gst_mini_object_copy
......@@ -1547,7 +1573,6 @@ gst_pad_can_link
gst_pad_get_caps
gst_pad_get_caps_reffed
gst_pad_get_allowed_caps
gst_pad_get_negotiated_caps
gst_pad_get_current_caps
gst_pad_get_pad_template_caps
gst_pad_set_caps
......@@ -1617,6 +1642,9 @@ gst_pad_set_activatepush_function
gst_pad_set_activatepull_function
GstPadActivateModeFunction
gst_pad_check_reconfigure
gst_pad_mark_reconfigure
gst_pad_push
gst_pad_push_event
gst_pad_push_list
......@@ -1729,23 +1757,25 @@ GST_PAD_SET_FLUSHING
GST_PAD_TASK
GST_PAD_UNSET_FLUSHING
GST_PAD_GETCAPSFUNC
GST_PAD_FIXATECAPSFUNC
GST_PAD_ACCEPTCAPSFUNC
GST_PAD_IS_ACTIVE
GST_PAD_ACTIVATEFUNC
GST_PAD_ACTIVATEPULLFUNC
GST_PAD_ACTIVATEPUSHFUNC
GST_PAD_BUFFERALLOCFUNC
GST_PAD_CHAINFUNC
GST_PAD_CHAINLISTFUNC
GST_PAD_EVENTFUNC
GST_PAD_FIXATECAPSFUNC
GST_PAD_GETCAPSFUNC
GST_PAD_GETRANGEFUNC
GST_PAD_ITERINTLINKFUNC
GST_PAD_IS_FLUSHING
GST_PAD_LINKFUNC
GST_PAD_UNLINKFUNC
GST_PAD_QUERYFUNC
GST_PAD_QUERYTYPEFUNC
GST_PAD_UNLINKFUNC
GST_PAD_PREROLL_BROADCAST
GST_PAD_GET_PREROLL_COND
......@@ -2114,6 +2144,7 @@ gst_query_parse_nth_allocation_meta
gst_query_set_allocation_params
gst_query_add_allocation_memory
gst_query_add_allocation_meta
gst_query_has_allocation_meta
gst_query_get_n_allocation_memories
gst_query_get_n_allocation_metas
......@@ -2263,7 +2294,6 @@ gst_structure_id_has_field_typed
gst_structure_get_boolean
gst_structure_get_int
gst_structure_get_uint
gst_structure_get_fourcc
gst_structure_get_double
gst_structure_get_string
gst_structure_get_date
......@@ -2276,6 +2306,8 @@ gst_structure_nth_field_name
gst_structure_set_parent_refcount
gst_structure_to_string
gst_structure_from_string
gst_structure_fixate
gst_structure_fixate_field
gst_structure_fixate_field_nearest_int
gst_structure_fixate_field_nearest_double
gst_structure_fixate_field_nearest_fraction
......@@ -2727,6 +2759,17 @@ GST_ROUND_DOWN_8
GST_ROUND_DOWN_16
GST_ROUND_DOWN_32
GST_ROUND_DOWN_64
GDOUBLE_FROM_BE
GDOUBLE_FROM_LE
GDOUBLE_SWAP_LE_BE
GDOUBLE_TO_BE
GDOUBLE_TO_LE
GFLOAT_FROM_BE
GFLOAT_FROM_LE
GFLOAT_SWAP_LE_BE
GFLOAT_TO_BE
GFLOAT_TO_LE
gst_flow_get_name
gst_flow_to_quark
......@@ -2791,14 +2834,10 @@ gst_date_time_unref
<TITLE>GstValue</TITLE>
<SUBSECTION fourcc>
GST_VALUE_HOLDS_FOURCC
GST_MAKE_FOURCC
GST_STR_FOURCC
GST_FOURCC_FORMAT
GST_FOURCC_ARGS
GST_TYPE_FOURCC
gst_value_set_fourcc
gst_value_get_fourcc
<SUBSECTION intrange>
GST_VALUE_HOLDS_INT_RANGE
......@@ -2916,7 +2955,6 @@ gst_value_fixate
gst_date_get_type
gst_date_time_get_type
gst_double_range_get_type
gst_fourcc_get_type
gst_fraction_get_type
gst_fraction_range_get_type
gst_int_range_get_type
......
......@@ -632,7 +632,7 @@ gst_buffer_n_memory (GstBuffer * buffer)
* gst_buffer_take_memory:
* @buffer: a #GstBuffer.
* @idx: the index to add the memory at, or -1 to append it to the end
* @mem: (transfer: full): a #GstMemory.
* @mem: (transfer full): a #GstMemory.
*
* Add the memory block @mem to @buffer at @idx. This function takes ownership
* of @mem and thus doesn't increase its refcount.
......@@ -673,10 +673,15 @@ _get_memory (GstBuffer * buffer, guint idx, gboolean write)
* gst_buffer_peek_memory:
* @buffer: a #GstBuffer.
* @idx: an index
* @flags: #GstMapFlags
*
* Get the memory block in @buffer at @idx. This function does not return a
* refcount to the memory block. The memory block stays valid for as long as the
* caller has a valid reference to @buffer.
* Get the memory block in @buffer at @idx for memory access in @flags.
* This function does not return a refcount to the memory block. The memory
* block stays valid for as long as the caller has a valid reference to @buffer.
*
* @buffer should be writable when @flags contains #GST_MAP_WRITE. If the memory
* at @idx is not writable, a new writable copy will be installed in @buffer and
* returned.
*
* Returns: a #GstMemory at @idx.
*/
......
......@@ -184,7 +184,6 @@ typedef struct _GstBufferPool GstBufferPool;
* stream, for example to reduce bandwidth.
* @GST_BUFFER_FLAG_DELTA_UNIT: this unit cannot be decoded independently.
* @GST_BUFFER_FLAG_IN_CAPS: the buffer has been added as a field in a #GstCaps.
*
* @GST_BUFFER_FLAG_LAST: additional media specific flags can be added starting from
* this flag.
*
......@@ -244,7 +243,7 @@ GType gst_buffer_get_type (void);
/* allocation */
GstBuffer * gst_buffer_new (void);
GstBuffer * gst_buffer_new_allocate (const GstAllocator * allocator, gsize maxsize, gsize align);
GstBuffer * gst_buffer_new_allocate (const GstAllocator * allocator, gsize size, gsize align);
GstBuffer * gst_buffer_new_wrapped_full (gpointer data, GFreeFunc free_func, gsize offset, gsize size);
GstBuffer * gst_buffer_new_wrapped (gpointer data, gsize size);
......
......@@ -28,7 +28,7 @@
* Buffer lists are an object containing a list of buffers.
*
* Buffer lists are created with gst_buffer_list_new() and filled with data
* using a gst_buffer_list_take().
* using a gst_buffer_list_insert().
*
*/
#include "gst_private.h"
......
......@@ -57,6 +57,8 @@ typedef struct _GstBufferPoolClass GstBufferPoolClass;
* @GST_BUFFER_POOL_FLAG_DONTWAIT: don't wait for buffer. This makes the
* acquire_buffer method return GST_FLOW_UNEXPECTED.
* @GST_BUFFER_POOL_FLAG_DISCONT: buffer is discont
* @GST_BUFFER_POOL_FLAG_LAST: last flag, subclasses can use private flags
* starting from this value.
*
* Additional flags to control the allocation of a buffer
*/
......@@ -169,6 +171,7 @@ struct _GstBufferPoolClass {
void (*release_buffer) (GstBufferPool *pool, GstBuffer *buffer);
void (*free_buffer) (GstBufferPool *pool, GstBuffer *buffer);
/*< private >*/
gpointer _gst_reserved[GST_PADDING];
};
......
......@@ -163,7 +163,7 @@ typedef struct _GstStaticCaps GstStaticCaps;
/**
* GST_CAPS_FLAG_IS_SET:
* @caps: a #GstCaps.
* @flag: the #GstCapsFlag to check.
* @flag: the #GstCapsFlags to check.
*
* Gives the status of a specific flag on a caps.
*/
......@@ -171,7 +171,7 @@ typedef struct _GstStaticCaps GstStaticCaps;
/**
* GST_CAPS_FLAG_SET:
* @caps: a #GstCaps.
* @flag: the #GstCapsFlag to set.
* @flag: the #GstCapsFlags to set.
*
* Sets a caps flag on a caps.
*/
......@@ -179,7 +179,7 @@ typedef struct _GstStaticCaps GstStaticCaps;
/**
* GST_CAPS_FLAG_UNSET:
* @caps: a #GstCaps.
* @flag: the #GstCapsFlag to clear.
* @flag: the #GstCapsFlags to clear.
*
* Clears a caps flag.
*/
......
......@@ -82,8 +82,7 @@ typedef enum {
* from the pipeline and unblock all streaming threads.
* @GST_EVENT_FLUSH_STOP: Stop a flush operation. This event resets the
* running-time of the pipeline.
* @GST_EVENT_EOS: End-Of-Stream. No more data is to be expected to follow
* without a SEGMENT event.
* @GST_EVENT_CAPS: #GstCaps event. Notify the pad of a new media type.
* @GST_EVENT_SEGMENT: A new media segment follows in the dataflow. The
* segment events contains information for clipping buffers and
* converting buffer timestamps to running-time and
......@@ -95,6 +94,8 @@ typedef enum {
* send messages that should be emitted in sync with
* rendering.
* Since: 0.10.26
* @GST_EVENT_EOS: End-Of-Stream. No more data is to be expected to follow
* without a SEGMENT event.
* @GST_EVENT_QOS: A quality message. Used to indicate to upstream elements
* that the downstream elements should adjust their processing
* rate.
......@@ -340,6 +341,7 @@ typedef enum {
* @mini_object: the parent structure
* @type: the #GstEventType of the event
* @timestamp: the timestamp of the event
* @seqnum: the sequence number of the event
*
* A #GstEvent.
*/
......
......@@ -188,6 +188,7 @@ typedef gboolean (*GstIteratorFoldFunction) (const GValue * item, GValue *
/**
* GstIterator:
* @copy: The function to copy the iterator
* @next: The function to get the next item in the iterator
* @item: The function to be called for each item retrieved
* @resync: The function to call when a resync is needed.
......@@ -198,6 +199,7 @@ typedef gboolean (*GstIteratorFoldFunction) (const GValue * item, GValue *
* @cookie: The cookie; the value of the master_cookie when this iterator was
* created.
* @master_cookie: A pointer to the master cookie.
* @size: the size of the iterator
*
* #GstIterator base structure. The values of this structure are
* protected for subclasses, use the methods to use the #GstIterator.
......
......@@ -52,8 +52,7 @@
* memory with an existing memory block at a custom offset and with a custom
* size.
*
* Memory can be efficiently merged when gst_memory_is_span() returns TRUE and
* with the function gst_memory_span().
* Memory can be efficiently merged when gst_memory_is_span() returns TRUE.
*
* Last reviewed on 2011-06-08 (0.11.0)
*/
......
......@@ -276,6 +276,7 @@ typedef enum {
* @type: the #GstMessageType of the message
* @timestamp: the timestamp of the message
* @src: the src of the message
* @seqnum: the sequence number of the message
*
* A #GstMessage.
*/
......
......@@ -49,6 +49,7 @@ struct _GstMeta {
/**
* GstMetaInitFunction:
* @meta: a #GstMeta
* @params: parameters passed to the init function
* @buffer: a #GstBuffer
*
* Function called when @meta is initialized in @buffer.
......@@ -123,6 +124,16 @@ typedef struct _GstMetaTiming GstMetaTiming;
const GstMetaInfo *gst_meta_timing_get_info(void);
#define GST_META_TIMING_INFO (gst_meta_timing_get_info())
/**
* GstMetaTiming:
* @meta: parent metadata
* @dts: the decoding timestamp
* @pts: the presentation timestamp
* @duration: the duration
* @clock_rate: the clock rate of the dts, pts and duration values
*
* Extra timing metadata
*/
struct _GstMetaTiming {
GstMeta meta; /* common meta header */
......
......@@ -315,6 +315,7 @@ gst_mini_object_steal (GstMiniObject ** olddata)
* gst_mini_object_take:
* @olddata: (inout) (transfer full): pointer to a pointer to a mini-object to
* be replaced
* @newdata: pointer to new mini-object
*
* Modifies a pointer to point to a new mini-object. The modification
* is done atomically. This version is similar to gst_mini_object_replace()
......
......@@ -159,8 +159,10 @@ typedef enum
/**
* GstMiniObject:
* @type: the GType of the object
* @refcount: atomic refcount
* @flags: extra flags.
* @size: the size of the structure
* @copy: a copy function
* @dispose: a dispose function
* @free: the free function
......
......@@ -583,19 +583,22 @@ typedef enum {
* the data used in streaming.
* @task: task for this pad if the pad is actively driving dataflow.
* @block_cond: conditional to signal pad block
* @probes: installed probes
* @getcapsfunc: function to get caps of the pad
* @acceptcapsfunc: function to check if pad can accept caps
* @fixatecapsfunc: function to fixate caps
* @mode: current activation mode of the pad
* @activatefunc: pad activation function
* @activatepushfunc: function to activate/deactivate pad in push mode
* @activatepullfunc: function to activate/deactivate pad in pull mode
* @peer: the pad this pad is linked to
* @linkfunc: function called when pad is linked
* @unlinkfunc: function called when pad is unlinked
* @peer: the pad this pad is linked to
* @chainfunc: function to chain buffer to pad
* @chainlistfunc: function to chain a list of buffers to pad
* @getrangefunc: function to get a range of data from a pad
* @eventfunc: function to send an event to a pad
* @mode: current activation mode of the pad
* @offset: the pad offset
* @querytypefunc: get list of supported queries
* @queryfunc: perform a query on the pad
* @iterintlinkfunc: get the internal links iterator of this pad
......@@ -653,11 +656,11 @@ struct _GstPad {
/* internal links */
GstPadIterIntLinkFunction iterintlinkfunc;
/*< private >*/
/* counts number of probes attached. */
gint num_probes;
gint num_blocked;
/*< private >*/
GstPadPrivate *priv;
gpointer _gst_reserved[GST_PADDING];
......
......@@ -1947,7 +1947,7 @@ gst_query_new_scheduling (void)
* @random_access: if random access is possible
* @sequential: if sequential access is recommended
* @minsize: the suggested minimum size of pull requests
* @maxsize the suggested maximum size of pull requests:
* @maxsize: the suggested maximum size of pull requests:
* @align: the suggested alignment of pull requests
*
* Set the scheduling properties.
......@@ -1979,7 +1979,7 @@ gst_query_set_scheduling (GstQuery * query, gboolean pull_mode,
* @random_access: if random access is possible
* @sequential: if sequential access is recommended
* @minsize: the suggested minimum size of pull requests
* @maxsize the suggested maximum size of pull requests:
* @maxsize: the suggested maximum size of pull requests:
* @align: the suggested alignment of pull requests
*
* Set the scheduling properties.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment