* created one will typically allocate memory for it and add it to the buffer.
* The following example creates a buffer that can hold a given video frame
* with a given width, height and bits per plane.
- * |[<!-- language="C" -->
+ *
+ * ``` C
* GstBuffer *buffer;
* GstMemory *memory;
* gint size, width, height, bpp;
* memory = gst_allocator_alloc (NULL, size, NULL);
* gst_buffer_insert_memory (buffer, -1, memory);
* ...
- * ]|
+ * ```
*
* Alternatively, use gst_buffer_new_allocate() to create a buffer with
* preallocated data of a given size.
*
* If a plug-in wants to modify the buffer data or metadata in-place, it should
* first obtain a buffer that is safe to modify by using
- * gst_buffer_make_writable(). This function is optimized so that a copy will
+ * gst_buffer_make_writable(). This function is optimized so that a copy will
* only be made when it is necessary.
*
* Several flags of the buffer can be set and unset with the
* needed.
*
* Arbitrary extra metadata can be set on a buffer with gst_buffer_add_meta().
- * Metadata can be retrieved with gst_buffer_get_meta(). See also #GstMeta
+ * Metadata can be retrieved with gst_buffer_get_meta(). See also #GstMeta.
*
* An element should either unref the buffer or push it out on a src pad
* using gst_pad_push() (see #GstPad).
* using the #GstMemory of the parent buffer, and wants to prevent the parent
* buffer from being returned to a buffer pool until the #GstMemory is available
* for re-use. (Since: 1.6)
- *
*/
+
#define GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS
#include "gst_private.h"
* gst_buffer_get_flags:
* @buffer: a #GstBuffer
*
- * Get the #GstBufferFlags flags set on this buffer.
+ * Gets the #GstBufferFlags flags set on this buffer.
*
* Returns: the flags set on this buffer.
*
/**
* gst_buffer_get_max_memory:
*
- * Get the maximum amount of memory blocks that a buffer can hold. This is a
+ * Gets the maximum amount of memory blocks that a buffer can hold. This is a
* compile time constant that can be queried with the function.
*
* When more memory blocks are added, existing memory blocks will be merged
* gst_buffer_copy_deep:
* @buf: a #GstBuffer.
*
- * Create a copy of the given buffer. This will make a newly allocated
+ * Creates a copy of the given buffer. This will make a newly allocated
* copy of the data the source buffer contains.
*
* Returns: (transfer full): a new copy of @buf.
*
* Creates a newly allocated buffer without any data.
*
- * MT safe.
- *
* Returns: (transfer full): the new #GstBuffer.
*/
GstBuffer *
*
* Note that when @size == 0, the buffer will not have memory associated with it.
*
- * MT safe.
- *
- * Returns: (transfer full) (nullable): a new #GstBuffer, or %NULL if
- * the memory couldn't be allocated.
+ * Returns: (transfer full) (nullable): a new #GstBuffer
*/
GstBuffer *
gst_buffer_new_allocate (GstAllocator * allocator, gsize size,
* @user_data: (allow-none): user_data
* @notify: (allow-none) (scope async) (closure user_data): called with @user_data when the memory is freed
*
- * Allocate a new buffer that wraps the given memory. @data must point to
+ * Allocates a new buffer that wraps the given memory. @data must point to
* @maxsize of memory, the wrapped buffer will have the region from @offset and
* @size visible.
*
* @size: allocated size of @data
*
* Creates a new buffer that wraps the given @data. The memory will be freed
- * with g_free and will be marked writable.
- *
- * MT safe.
+ * with g_free() and will be marked writable.
*
* Returns: (transfer full): a new #GstBuffer
*/
* Creates a new #GstBuffer that wraps the given @bytes. The data inside
* @bytes cannot be %NULL and the resulting buffer will be marked as read only.
*
- * MT safe.
- *
* Returns: (transfer full): a new #GstBuffer wrapping @bytes
*
* Since: 1.16
* gst_buffer_n_memory:
* @buffer: a #GstBuffer.
*
- * Get the amount of memory blocks that this buffer has. This amount is never
+ * Gets the amount of memory blocks that this buffer has. This amount is never
* larger than what gst_buffer_get_max_memory() returns.
*
* Returns: the number of memory blocks this buffer is made of.
* @buffer: a #GstBuffer.
* @mem: (transfer full): a #GstMemory.
*
- * Prepend the memory block @mem to @buffer. This function takes
+ * Prepends the memory block @mem to @buffer. This function takes
* ownership of @mem and thus doesn't increase its refcount.
*
* This function is identical to gst_buffer_insert_memory() with an index of 0.
* @buffer: a #GstBuffer.
* @mem: (transfer full): a #GstMemory.
*
- * Append the memory block @mem to @buffer. This function takes
+ * Appends the memory block @mem to @buffer. This function takes
* ownership of @mem and thus doesn't increase its refcount.
*
* This function is identical to gst_buffer_insert_memory() with an index of -1.
* @idx: the index to add the memory at, or -1 to append it to the end
* @mem: (transfer full): a #GstMemory.
*
- * Insert the memory block @mem to @buffer at @idx. This function takes ownership
+ * Inserts the memory block @mem into @buffer at @idx. This function takes ownership
* of @mem and thus doesn't increase its refcount.
*
* Only gst_buffer_get_max_memory() can be added to a buffer. If more memory is
* @buffer: a #GstBuffer.
* @idx: an index
*
- * Get the memory block at @idx in @buffer. The memory block stays valid until
+ * Gets the memory block at @idx in @buffer. The memory block stays valid until
* the memory block in @buffer is removed, replaced or merged, typically with
* any call that modifies the memory in @buffer.
*
* @buffer: a #GstBuffer.
* @idx: an index
*
- * Get the memory block at index @idx in @buffer.
+ * Gets the memory block at index @idx in @buffer.
*
* Returns: (transfer full) (nullable): a #GstMemory that contains the data of the
- * memory block at @idx. Use gst_memory_unref () after usage.
+ * memory block at @idx.
*/
GstMemory *
gst_buffer_get_memory (GstBuffer * buffer, guint idx)
* gst_buffer_get_all_memory:
* @buffer: a #GstBuffer.
*
- * Get all the memory block in @buffer. The memory blocks will be merged
+ * Gets all the memory blocks in @buffer. The memory blocks will be merged
* into one large #GstMemory.
*
* Returns: (transfer full) (nullable): a #GstMemory that contains the merged memory.
- * Use gst_memory_unref () after usage.
*/
GstMemory *
gst_buffer_get_all_memory (GstBuffer * buffer)
* @idx: an index
* @length: a length
*
- * Get @length memory blocks in @buffer starting at @idx. The memory blocks will
+ * Gets @length memory blocks in @buffer starting at @idx. The memory blocks will
* be merged into one large #GstMemory.
*
* If @length is -1, all memory starting from @idx is merged.
*
* Returns: (transfer full) (nullable): a #GstMemory that contains the merged data of @length
- * blocks starting at @idx. Use gst_memory_unref () after usage.
+ * blocks starting at @idx.
*/
GstMemory *
gst_buffer_get_memory_range (GstBuffer * buffer, guint idx, gint length)
* gst_buffer_replace_memory_range:
* @buffer: a #GstBuffer.
* @idx: an index
- * @length: a length should not be 0
+ * @length: a length, should not be 0
* @mem: (transfer full): a #GstMemory
*
* Replaces @length memory blocks in @buffer starting at @idx with @mem.
* @buffer: a #GstBuffer.
* @idx: an index
*
- * Remove the memory block in @b at index @i.
+ * Removes the memory block in @b at index @i.
*/
void
gst_buffer_remove_memory (GstBuffer * buffer, guint idx)
* gst_buffer_remove_all_memory:
* @buffer: a #GstBuffer.
*
- * Remove all the memory blocks in @buffer.
+ * Removes all the memory blocks in @buffer.
*/
void
gst_buffer_remove_all_memory (GstBuffer * buffer)
* @idx: an index
* @length: a length
*
- * Remove @length memory blocks in @buffer starting from @idx.
+ * Removes @length memory blocks in @buffer starting from @idx.
*
* @length can be -1, in which case all memory starting from @idx is removed.
*/
* @length: (out): pointer to length
* @skip: (out): pointer to skip
*
- * Find the memory blocks that span @size bytes starting from @offset
+ * Finds the memory blocks that span @size bytes starting from @offset
* in @buffer.
*
* When this function returns %TRUE, @idx will contain the index of the first
* gst_buffer_is_memory_range_writable:
* @buffer: a #GstBuffer.
* @idx: an index
- * @length: a length should not be 0
+ * @length: a length, should not be 0
*
- * Check if @length memory blocks in @buffer starting from @idx are writable.
+ * Checks if @length memory blocks in @buffer starting from @idx are writable.
*
* @length can be -1 to check all the memory blocks after @idx.
*
* gst_buffer_is_all_memory_writable:
* @buffer: a #GstBuffer.
*
- * Check if all memory blocks in @buffer are writable.
+ * Checks if all memory blocks in @buffer are writable.
*
* Note that this function does not check if @buffer is writable, use
* gst_buffer_is_writable() to check that if needed.
* @offset: (out) (allow-none): a pointer to the offset
* @maxsize: (out) (allow-none): a pointer to the maxsize
*
- * Get the total size of the memory blocks in @b.
+ * Gets the total size of the memory blocks in @buffer.
*
* When not %NULL, @offset will contain the offset of the data in the
* first memory block in @buffer and @maxsize will contain the sum of
* gst_buffer_get_size:
* @buffer: a #GstBuffer.
*
- * Get the total size of the memory blocks in @buffer.
+ * Gets the total size of the memory blocks in @buffer.
*
* Returns: total size of the memory blocks in @buffer.
*/
* @offset: (out) (allow-none): a pointer to the offset
* @maxsize: (out) (allow-none): a pointer to the maxsize
*
- * Get the total size of @length memory blocks stating from @idx in @buffer.
+ * Gets the total size of @length memory blocks stating from @idx in @buffer.
*
* When not %NULL, @offset will contain the offset of the data in the
* memory block in @buffer at @idx and @maxsize will contain the sum of the size
* @offset: the offset adjustment
* @size: the new size or -1 to just adjust the offset
*
- * Set the offset and total size of the memory blocks in @buffer.
+ * Sets the offset and total size of the memory blocks in @buffer.
*/
void
gst_buffer_resize (GstBuffer * buffer, gssize offset, gssize size)
* @buffer: a #GstBuffer.
* @size: the new size
*
- * Set the total size of the memory blocks in @buffer.
+ * Sets the total size of the memory blocks in @buffer.
*/
void
gst_buffer_set_size (GstBuffer * buffer, gssize size)
* @offset: the offset adjustment
* @size: the new size or -1 to just adjust the offset
*
- * Set the total size of the @length memory blocks starting at @idx in
+ * Sets the total size of the @length memory blocks starting at @idx in
* @buffer
*
* Returns: %TRUE if resizing succeeded, %FALSE otherwise.
* @info: (out caller-allocates): info about the mapping
* @flags: flags for the mapping
*
- * This function fills @info with the #GstMapInfo of all merged memory
- * blocks in @buffer.
+ * Fills @info with the #GstMapInfo of all merged memory blocks in @buffer.
*
* @flags describe the desired access of the memory. When @flags is
* #GST_MAP_WRITE, @buffer should be writable (as returned from
* @info: (out caller-allocates): info about the mapping
* @flags: flags for the mapping
*
- * This function fills @info with the #GstMapInfo of @length merged memory blocks
+ * Fills @info with the #GstMapInfo of @length merged memory blocks
* starting at @idx in @buffer. When @length is -1, all memory blocks starting
* from @idx are merged and mapped.
*
* @buffer: a #GstBuffer.
* @info: a #GstMapInfo
*
- * Release the memory previously mapped with gst_buffer_map().
+ * Releases the memory previously mapped with gst_buffer_map().
*/
void
gst_buffer_unmap (GstBuffer * buffer, GstMapInfo * info)
* @src: (array length=size) (element-type guint8): the source address
* @size: the size to fill
*
- * Copy @size bytes from @src to @buffer at @offset.
+ * Copies @size bytes from @src to @buffer at @offset.
*
* Returns: The amount of bytes copied. This value can be lower than @size
* when @buffer did not contain enough data.
* the destination address
* @size: the size to extract
*
- * Copy @size bytes starting from @offset in @buffer to @dest.
+ * Copies @size bytes starting from @offset in @buffer to @dest.
*
* Returns: The amount of bytes extracted. This value can be lower than @size
* when @buffer did not contain enough data.
* @mem: (array length=size) (element-type guint8): the memory to compare
* @size: the size to compare
*
- * Compare @size bytes starting from @offset in @buffer with the memory in @mem.
+ * Compares @size bytes starting from @offset in @buffer with the memory in @mem.
*
* Returns: 0 if the memory is equal.
*/
* @val: the value to set
* @size: the size to set
*
- * Fill @buf with @size bytes with @val starting from @offset.
+ * Fills @buf with @size bytes with @val starting from @offset.
*
* Returns: The amount of bytes filled. This value can be lower than @size
* when @buffer did not contain enough data.
* duration and offset end fields are also copied. If not they will be set
* to #GST_CLOCK_TIME_NONE and #GST_BUFFER_OFFSET_NONE.
*
- * MT safe.
- *
* Returns: (transfer full): the new #GstBuffer or %NULL if the arguments were
* invalid.
*/
* @buf1: (transfer full): the first source #GstBuffer to append.
* @buf2: (transfer full): the second source #GstBuffer to append.
*
- * Append all the memory from @buf2 to @buf1. The result buffer will contain a
+ * Appends all the memory from @buf2 to @buf1. The result buffer will contain a
* concatenation of the memory of @buf1 and @buf2.
*
* Returns: (transfer full): the new #GstBuffer that contains the memory
* @offset: the offset in @buf2
* @size: the size or -1 of @buf2
*
- * Append @size bytes at @offset from @buf2 to @buf1. The result buffer will
+ * Appends @size bytes at @offset from @buf2 to @buf1. The result buffer will
* contain a concatenation of the memory of @buf1 and the requested region of
* @buf2.
*
* @buffer: a #GstBuffer
* @api: the #GType of an API
*
- * Get the metadata for @api on buffer. When there is no such metadata, %NULL is
+ * Gets the metadata for @api on buffer. When there is no such metadata, %NULL is
* returned. If multiple metadata with the given @api are attached to this
* buffer only the first one is returned. To handle multiple metadata with a
* given API use gst_buffer_iterate_meta() or gst_buffer_foreach_meta() instead
- * and check the meta->info.api member for the API type.
+ * and check the `meta->info.api` member for the API type.
*
- * Returns: (transfer none) (nullable): the metadata for @api on
- * @buffer.
+ * Returns: (transfer none) (nullable): the metadata for @api on @buffer.
*/
GstMeta *
gst_buffer_get_meta (GstBuffer * buffer, GType api)
* @info: a #GstMetaInfo
* @params: params for @info
*
- * Add metadata for @info to @buffer using the parameters in @params.
+ * Adds metadata for @info to @buffer using the parameters in @params.
*
* Returns: (transfer none) (nullable): the metadata for the api in @info on @buffer.
*/
* @buffer: a #GstBuffer
* @meta: a #GstMeta
*
- * Remove the metadata for @meta on @buffer.
+ * Removes the metadata for @meta on @buffer.
*
* Returns: %TRUE if the metadata existed and was removed, %FALSE if no such
* metadata was on @buffer.
* @buffer: a #GstBuffer
* @state: (out caller-allocates): an opaque state pointer
*
- * Retrieve the next #GstMeta after @current. If @state points
+ * Retrieves the next #GstMeta after @current. If @state points
* to %NULL, the first metadata is returned.
*
* @state will be updated with an opaque state pointer
* @state: (out caller-allocates): an opaque state pointer
* @meta_api_type: only return #GstMeta of this type
*
- * Retrieve the next #GstMeta of type @meta_api_type after the current one
+ * Retrieves the next #GstMeta of type @meta_api_type after the current one
* according to @state. If @state points to %NULL, the first metadata of
* type @meta_api_type is returned.
*
* @func: (scope call): a #GstBufferForeachMetaFunc to call
* @user_data: (closure): user data passed to @func
*
- * Call @func with @user_data for each meta in @buffer.
+ * Calls @func with @user_data for each meta in @buffer.
*
* @func can modify the passed meta pointer or its contents. The return value
- * of @func define if this function returns or if the remaining metadata items
+ * of @func defines if this function returns or if the remaining metadata items
* in the buffer should be skipped.
*
* Returns: %FALSE when @func returned %FALSE for one of the metadata.
* @buffer: (transfer none): a #GstBuffer
* @ref: (transfer none): a #GstBuffer to ref
*
- * Add a #GstParentBufferMeta to @buffer that holds a reference on
+ * Adds a #GstParentBufferMeta to @buffer that holds a reference on
* @ref until the buffer is freed.
*
* Returns: (transfer none) (nullable): The #GstParentBufferMeta that was added to the buffer
/**
* gst_parent_buffer_meta_get_info:
*
- * Get the global #GstMetaInfo describing the #GstParentBufferMeta meta.
+ * Gets the global #GstMetaInfo describing the #GstParentBufferMeta meta.
*
* Returns: (transfer none): The #GstMetaInfo
*
* @timestamp: timestamp
* @duration: duration, or %GST_CLOCK_TIME_NONE
*
- * Add a #GstReferenceTimestampMeta to @buffer that holds a @timestamp and
+ * Adds a #GstReferenceTimestampMeta to @buffer that holds a @timestamp and
* optionally @duration based on a specific timestamp @reference. See the
* documentation of #GstReferenceTimestampMeta for details.
*
* @buffer: a #GstBuffer
* @reference: (allow-none): a reference #GstCaps
*
- * Find the first #GstReferenceTimestampMeta on @buffer that conforms to
+ * Finds the first #GstReferenceTimestampMeta on @buffer that conforms to
* @reference. Conformance is tested by checking if the meta's reference is a
* subset of @reference.
*
/**
* gst_reference_timestamp_meta_get_info:
*
- * Get the global #GstMetaInfo describing the #GstReferenceTimestampMeta meta.
+ * Gets the global #GstMetaInfo describing the #GstReferenceTimestampMeta meta.
*
* Returns: (transfer none): The #GstMetaInfo
*
* @buffer: a #GstBuffer
* @name: the registered name of the custom meta to retrieve.
*
- * Find the first #GstCustomMeta on @buffer for the desired @name.
+ * Finds the first #GstCustomMeta on @buffer for the desired @name.
*
- * Returns: (transfer none) (nullable): the #GstCustomMeta or %NULL when there
- * is no such metadata on @buffer.
+ * Returns: (transfer none) (nullable): the #GstCustomMeta
*
* Since: 1.20
*/
* of @buf and its metadata, see gst_buffer_is_writable().
* It is important to note that keeping additional references to
* GstBuffer instances can potentially increase the number
- * of memcpy operations in a pipeline.
+ * of `memcpy` operations in a pipeline.
*
* Returns: (transfer full): @buf
*/
* gst_buffer_copy: (skip)
* @buf: a #GstBuffer.
*
- * Create a copy of the given buffer. This will only copy the buffer's
+ * Creates a copy of the given buffer. This will only copy the buffer's
* data to a newly allocated memory if needed (if the type of memory
* requires it), otherwise the underlying data is just referenced.
* Check gst_buffer_copy_deep() if you want to force the data
* GST_BUFFER_FLAGS:
* @buf: a #GstBuffer.
*
- * A flags word containing #GstBufferFlags flags set on this buffer.
+ * Returns a flags word containing #GstBufferFlags flags set on this buffer.
*/
#define GST_BUFFER_FLAGS(buf) GST_MINI_OBJECT_FLAGS(buf)
/**
* GST_BUFFER_PTS:
* @buf: a #GstBuffer.:
*
- * The presentation timestamp (pts) in nanoseconds (as a #GstClockTime)
+ * Gets the presentation timestamp (pts) in nanoseconds (as a #GstClockTime)
* of the data in the buffer. This is the timestamp when the media should be
* presented to the user.
+ *
* Value will be %GST_CLOCK_TIME_NONE if the pts is unknown.
*/
#define GST_BUFFER_PTS(buf) (GST_BUFFER_CAST(buf)->pts)
/**
* GST_BUFFER_DTS:
- * @buf: a #GstBuffer.:
+ * @buf: a #GstBuffer.
*
- * The decoding timestamp (dts) in nanoseconds (as a #GstClockTime)
+ * Gets the decoding timestamp (dts) in nanoseconds (as a #GstClockTime)
* of the data in the buffer. This is the timestamp when the media should be
* decoded or processed otherwise.
+ *
* Value will be %GST_CLOCK_TIME_NONE if the dts is unknown.
*/
#define GST_BUFFER_DTS(buf) (GST_BUFFER_CAST(buf)->dts)
/**
* GST_BUFFER_DTS_OR_PTS:
- * @buf: a #GstBuffer.:
+ * @buf: a #GstBuffer.
*
* Returns the buffer decoding timestamp (dts) if valid, else the buffer
* presentation time (pts)
* GST_BUFFER_DURATION:
* @buf: a #GstBuffer.
*
- * The duration in nanoseconds (as a #GstClockTime) of the data in the buffer.
+ * Gets the duration in nanoseconds (as a #GstClockTime) of the data in the buffer.
+ *
* Value will be %GST_CLOCK_TIME_NONE if the duration is unknown.
*/
#define GST_BUFFER_DURATION(buf) (GST_BUFFER_CAST(buf)->duration)
* GST_BUFFER_OFFSET:
* @buf: a #GstBuffer.
*
- * The offset in the source file of the beginning of this buffer.
+ * Gets the offset in the source file of the beginning of this buffer.
*/
#define GST_BUFFER_OFFSET(buf) (GST_BUFFER_CAST(buf)->offset)
/**
* GST_BUFFER_OFFSET_END:
* @buf: a #GstBuffer.
*
- * The offset in the source file of the end of this buffer.
+ * Gets the offset in the source file of the end of this buffer.
*/
#define GST_BUFFER_OFFSET_END(buf) (GST_BUFFER_CAST(buf)->offset_end)
* @GST_BUFFER_FLAG_DELTA_UNIT: this unit cannot be decoded independently.
* @GST_BUFFER_FLAG_TAG_MEMORY: this flag is set when memory of the buffer
* is added/removed
- * @GST_BUFFER_FLAG_SYNC_AFTER: Elements which write to disk or permanent
- * storage should ensure the data is synced after
- * writing the contents of this buffer. (Since: 1.6)
- * @GST_BUFFER_FLAG_NON_DROPPABLE: This buffer is important and should not be dropped.
- * This can be used to mark important buffers, e.g. to flag
- * RTP packets carrying keyframes or codec setup data for RTP
- * Forward Error Correction purposes, or to prevent still video
- * frames from being dropped by elements due to QoS. (Since: 1.14)
* @GST_BUFFER_FLAG_LAST: additional media specific flags can be added starting from
* this flag.
*
GST_BUFFER_FLAG_DROPPABLE = (GST_MINI_OBJECT_FLAG_LAST << 8),
GST_BUFFER_FLAG_DELTA_UNIT = (GST_MINI_OBJECT_FLAG_LAST << 9),
GST_BUFFER_FLAG_TAG_MEMORY = (GST_MINI_OBJECT_FLAG_LAST << 10),
+
+ /**
+ * GST_BUFFER_FLAG_SYNC_AFTER:
+ *
+ * Elements which write to disk or permanent storage should ensure the data
+ * is synced after writing the contents of this buffer.
+ *
+ * Since: 1.6
+ */
GST_BUFFER_FLAG_SYNC_AFTER = (GST_MINI_OBJECT_FLAG_LAST << 11),
+
+ /**
+ * GST_BUFFER_FLAG_NON_DROPPABLE:
+ *
+ * This buffer is important and should not be dropped.
+ *
+ * This can be used to mark important buffers, e.g. to flag RTP packets
+ * carrying keyframes or codec setup data for RTP Forward Error Correction
+ * purposes, or to prevent still video frames from being dropped by elements
+ * due to QoS.
+ *
+ * Since: 1.14
+ */
GST_BUFFER_FLAG_NON_DROPPABLE = (GST_MINI_OBJECT_FLAG_LAST << 12),
GST_BUFFER_FLAG_LAST = (GST_MINI_OBJECT_FLAG_LAST << 16)
* merged
* @GST_BUFFER_COPY_META: flag indicating that buffer meta should be
* copied
- * @GST_BUFFER_COPY_DEEP: flag indicating that memory should always be
- * copied instead of reffed (Since: 1.2)
*
* A set of flags that can be provided to the gst_buffer_copy_into()
* function to specify which items should be copied.
GST_BUFFER_COPY_META = (1 << 2),
GST_BUFFER_COPY_MEMORY = (1 << 3),
GST_BUFFER_COPY_MERGE = (1 << 4),
+
+ /**
+ * @GST_BUFFER_COPY_DEEP:
+ *
+ * flag indicating that memory should always be copied instead of reffed
+ *
+ * Since: 1.2
+ */
GST_BUFFER_COPY_DEEP = (1 << 5)
} GstBufferCopyFlags;
* gst_buffer_get_parent_buffer_meta:
* @b: a #GstBuffer
*
- * Find and return a #GstParentBufferMeta if one exists on the
+ * Finds and returns a #GstParentBufferMeta if one exists on the
* buffer
*/
#define gst_buffer_get_parent_buffer_meta(b) \
* captured.
*
* The reference is stored as a #GstCaps in @reference. Examples of valid
- * references would be "timestamp/x-drivername-stream" for timestamps that are locally
- * generated by some driver named "drivername" when generating the stream,
- * e.g. based on a frame counter, or "timestamp/x-ntp, host=pool.ntp.org,
- * port=123" for timestamps based on a specific NTP server.
+ * references would be `timestamp/x-drivername-stream` for timestamps that are locally
+ * generated by some driver named `drivername` when generating the stream,
+ * e.g. based on a frame counter, or `timestamp/x-ntp, host=pool.ntp.org,
+ * port=123` for timestamps based on a specific NTP server.
*
* Since: 1.14
*/
projects / platform / upstream / gstreamer.git / commitdiff