From 659512b26831819acb0ef08f163559c21fe4dfcc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20Dr=C3=B6ge?= Date: Thu, 31 Aug 2017 12:02:21 +0300 Subject: [PATCH] Fixup documentation and work around rust-stripper bug https://github.com/GuillaumeGomez/rustdoc-stripper/issues/46 --- docs/gstreamer/docs.md | 1039 +++++++++++++++++++++++++--------------- 1 file changed, 651 insertions(+), 388 deletions(-) diff --git a/docs/gstreamer/docs.md b/docs/gstreamer/docs.md index d81509c81..57b369e00 100644 --- a/docs/gstreamer/docs.md +++ b/docs/gstreamer/docs.md @@ -423,7 +423,7 @@ Typically, `ParentBufferMeta` is used when the child buffer is directly using the `Memory` of the parent buffer, and wants to prevent the parent buffer from being returned to a buffer pool until the `Memory` is available for re-use. (Since 1.6) - + Creates a newly allocated buffer without any data. MT safe. @@ -431,7 +431,7 @@ MT safe. # Returns the new `Buffer`. - + Tries to create a newly allocated buffer with data of the given size and extra parameters from `allocator`. If the requested amount of memory can't be allocated, `None` will be returned. The allocated buffer memory is not cleared. @@ -453,7 +453,7 @@ optional parameters a new `Buffer`, or `None` if the memory couldn't be allocated. - + Creates a new buffer that wraps the given `data`. The memory will be freed with g_free and will be marked writable. @@ -466,7 +466,7 @@ allocated size of `data` # Returns a new `Buffer` - + Allocate 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. @@ -493,7 +493,7 @@ called with `user_data` when the memory is freed # Returns a new `Buffer` - + Add metadata for `info` to `self` using the parameters in `params`. ## `info` a `MetaInfo` @@ -503,7 +503,7 @@ params for `info` # Returns the metadata for the api in `info` on `self`. - + Add a `ParentBufferMeta` to `self` that holds a reference on `ref_` until the buffer is freed. ## `ref_` @@ -512,7 +512,7 @@ a `Buffer` to ref # Returns The `ParentBufferMeta` that was added to the buffer - + Attaches protection metadata to a `Buffer`. ## `info` a `Structure` holding cryptographic @@ -523,7 +523,7 @@ a `Structure` holding cryptographic a pointer to the added `ProtectionMeta` if successful; `None` if unsuccessful. - + Append all the memory from `buf2` to `self`. The result buffer will contain a concatenation of the memory of `self` and `buf2`. ## `buf2` @@ -533,7 +533,7 @@ the second source `Buffer` to append. the new `Buffer` that contains the memory of the two source buffers. - + Append the memory block `mem` to `self`. This function takes ownership of `mem` and thus doesn't increase its refcount. @@ -541,7 +541,7 @@ This function is identical to `Buffer::insert_memory` with an index of -1. See `Buffer::insert_memory` for more details. ## `mem` a `Memory`. - + Append `size` bytes at `offset` from `buf2` to `self`. The result buffer will contain a concatenation of the memory of `self` and the requested region of `buf2`. @@ -556,14 +556,14 @@ the size or -1 of `buf2` the new `Buffer` that contains the memory of the two source buffers. - + Create a copy of the given buffer. This will make a newly allocated copy of the data the source buffer contains. # Returns a new copy of `self`. - + Copies the information from `src` into `self`. If `self` already contains memory and `flags` contains GST_BUFFER_COPY_MEMORY, @@ -582,7 +582,7 @@ total size to copy. If -1, all data is copied. # Returns `true` if the copying succeeded, `false` otherwise. - + Creates a sub-buffer from `self` at `offset` and `size`. This sub-buffer uses the actual memory space of the parent buffer. This function will copy the offset and timestamp fields when the @@ -606,7 +606,7 @@ the size of the new `Buffer` sub-buffer, in bytes. If -1, all the new `Buffer` or `None` if the arguments were invalid. - + Copy `size` bytes starting from `offset` in `self` to `dest`. ## `offset` the offset to extract @@ -619,7 +619,7 @@ the size to extract The amount of bytes extracted. This value can be lower than `size` when `self` did not contain enough data. - + Extracts a copy of at most `size` bytes the data at `offset` into newly-allocated memory. `dest` must be freed using `g_free` when done. ## `offset` @@ -631,7 +631,7 @@ A pointer where the destination array will be written. ## `dest_size` A location where the size of `dest` can be written - + Copy `size` bytes from `src` to `self` at `offset`. ## `offset` the offset to fill @@ -644,7 +644,7 @@ the size to fill The amount of bytes copied. This value can be lower than `size` when `self` did not contain enough data. - + Find the memory blocks that span `size` bytes starting from `offset` in `self`. @@ -670,7 +670,7 @@ pointer to skip `true` when `size` bytes starting from `offset` could be found in `self` and `idx`, `length` and `skip` will be filled. - + Call `func` with `user_data` for each meta in `self`. `func` can modify the passed meta pointer or its contents. The return value @@ -684,7 +684,7 @@ user data passed to `func` # Returns `false` when `func` returned `false` for one of the metadata. - + Get all the memory block in `self`. The memory blocks will be merged into one large `Memory`. @@ -692,7 +692,7 @@ into one large `Memory`. a `Memory` that contains the merged memory. Use gst_memory_unref () after usage. - + Get the `BufferFlags` flags set on this buffer. Feature: `v1_10` @@ -701,7 +701,7 @@ Feature: `v1_10` # Returns the flags set on this buffer. - + Get the memory block at index `idx` in `self`. ## `idx` an index @@ -710,7 +710,7 @@ an index a `Memory` that contains the data of the memory block at `idx`. Use gst_memory_unref () after usage. - + Get `length` memory blocks in `self` starting at `idx`. The memory blocks will be merged into one large `Memory`. @@ -724,7 +724,7 @@ a length a `Memory` that contains the merged data of `length` blocks starting at `idx`. Use gst_memory_unref () after usage. - + Get the metadata for `api` on buffer. When there is no such metadata, `None` 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 @@ -737,13 +737,13 @@ the `glib::Type` of an API the metadata for `api` on `self`. - + Get the total size of the memory blocks in `self`. # Returns total size of the memory blocks in `self`. - + Get the total size of the memory blocks in `b`. When not `None`, `offset` will contain the offset of the data in the @@ -759,7 +759,7 @@ a pointer to the maxsize # Returns total size of the memory blocks in `self`. - + Get the total size of `length` memory blocks stating from `idx` in `self`. When not `None`, `offset` will contain the offset of the data in the @@ -780,7 +780,7 @@ a pointer to the maxsize # Returns total size of `length` memory blocks starting at `idx` in `self`. - + Insert the memory block `mem` to `self` at `idx`. This function takes ownership of `mem` and thus doesn't increase its refcount. @@ -791,7 +791,7 @@ the new memory. the index to add the memory at, or -1 to append it to the end ## `mem` a `Memory`. - + Check if all memory blocks in `self` are writable. Note that this function does not check if `self` is writable, use @@ -800,7 +800,7 @@ Note that this function does not check if `self` is writable, use # Returns `true` if all memory blocks in `self` are writable - + Check if `length` memory blocks in `self` starting from `idx` are writable. `length` can be -1 to check all the memory blocks after `idx`. @@ -815,7 +815,7 @@ a length should not be 0 # Returns `true` if the memory range is writable - + Retrieve the next `Meta` after `current`. If `state` points to `None`, the first metadata is returned. @@ -827,7 +827,7 @@ an opaque state pointer The next `Meta` or `None` when there are no more items. - + Retrieve the next `Meta` of type `meta_api_type` after the current one according to `state`. If `state` points to `None`, the first metadata of type `meta_api_type` is returned. @@ -845,7 +845,7 @@ only return `Meta` of this type The next `Meta` of type `meta_api_type` or `None` when there are no more items. - + This function fills `info` with the `MapInfo` of all merged memory blocks in `self`. @@ -867,7 +867,7 @@ flags for the mapping # Returns `true` if the map succeeded and `info` contains valid data. - + This function fills `info` with the `MapInfo` of `length` merged memory blocks starting at `idx` in `self`. When `length` is -1, all memory blocks starting from `idx` are merged and mapped. @@ -894,7 +894,7 @@ flags for the mapping `true` if the map succeeded and `info` contains valid data. - + Compare `size` bytes starting from `offset` in `self` with the memory in `mem`. ## `offset` the offset in `self` @@ -906,7 +906,7 @@ the size to compare # Returns 0 if the memory is equal. - + Fill `buf` with `size` bytes with `val` starting from `offset`. ## `offset` the offset in `self` @@ -919,14 +919,14 @@ the size to set The amount of bytes filled. This value can be lower than `size` when `self` did not contain enough data. - + Get the amount of memory blocks that this buffer has. This amount is never larger than what `Buffer::get_max_memory` returns. # Returns the number of memory blocks this buffer is made of. - + Get the memory block at `idx` in `self`. The memory block stays valid until the memory block in `self` is removed, replaced or merged, typically with any call that modifies the memory in `self`. @@ -936,7 +936,7 @@ an index # Returns the `Memory` at `idx`. - + Prepend the memory block `mem` to `self`. This function takes ownership of `mem` and thus doesn't increase its refcount. @@ -944,13 +944,13 @@ This function is identical to `Buffer::insert_memory` with an index of 0. See `Buffer::insert_memory` for more details. ## `mem` a `Memory`. - + Remove all the memory blocks in `self`. - + Remove the memory block in `b` at index `i`. ## `idx` an index - + Remove `length` memory blocks in `self` starting from `idx`. `length` can be -1, in which case all memory starting from `idx` is removed. @@ -958,7 +958,7 @@ Remove `length` memory blocks in `self` starting from `idx`. an index ## `length` a length - + Remove the metadata for `meta` on `self`. ## `meta` a `Meta` @@ -967,17 +967,17 @@ a `Meta` `true` if the metadata existed and was removed, `false` if no such metadata was on `self`. - + Replaces all memory in `self` with `mem`. ## `mem` a `Memory` - + Replaces the memory block at index `idx` in `self` with `mem`. ## `idx` an index ## `mem` a `Memory` - + Replaces `length` memory blocks in `self` starting at `idx` with `mem`. If `length` is -1, all memory starting from `idx` will be removed and @@ -990,13 +990,13 @@ an index a length should not be 0 ## `mem` a `Memory` - + Set the offset and total size of the memory blocks in `self`. ## `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 `self` ## `idx` @@ -1011,7 +1011,7 @@ the new size or -1 to just adjust the offset # Returns `true` if resizing succeeded, `false` otherwise. - + Sets one or more buffer flags on a buffer. Feature: `v1_10` @@ -1022,15 +1022,15 @@ the `BufferFlags` to set. # Returns `true` if `flags` were successfully set on buffer. - + Set the total size of the memory blocks in `self`. ## `size` the new size - + Release the memory previously mapped with `Buffer::map`. ## `info` a `MapInfo` - + Clears one or more buffer flags. Feature: `v1_10` @@ -1041,7 +1041,7 @@ the `BufferFlags` to clear # Returns true if `flags` is successfully cleared from buffer. - + Get the maximum amount of memory blocks that a buffer can hold. This is a compile time constant that can be queried with the function. @@ -1051,6 +1051,92 @@ together to make room for the new block. # Returns the maximum amount of memory blocks that a buffer can hold. + +Buffer lists are an object containing a list of buffers. + +Buffer lists are created with `BufferList::new` and filled with data +using a `BufferList::insert`. + +Buffer lists can be pushed on a srcpad with `PadExt::push_list`. This is +interesting when multiple buffers need to be pushed in one go because it +can reduce the amount of overhead for pushing each buffer individually. + +Creates a new, empty `BufferList`. The caller is responsible for unreffing +the returned `BufferList`. + +Free-function: gst_buffer_list_unref + +# Returns + +the new `BufferList`. `gst_buffer_list_unref` + after usage. + +Creates a new, empty `BufferList`. The caller is responsible for unreffing +the returned `BufferList`. The list will have `size` space preallocated so +that memory reallocations can be avoided. + +Free-function: gst_buffer_list_unref +## `size` +an initial reserved size + +# Returns + +the new `BufferList`. `gst_buffer_list_unref` + after usage. + +Create a copy of the given buffer list. This will make a newly allocated +copy of the buffer that the source buffer list contains. + +# Returns + +a new copy of `self`. + +Call `func` with `data` for each buffer in `self`. + +`func` can modify the passed buffer pointer or its contents. The return value +of `func` define if this function returns or if the remaining buffers in +the list should be skipped. +## `func` +a `GstBufferListFunc` to call +## `user_data` +user data passed to `func` + +# Returns + +`true` when `func` returned `true` for each buffer in `self` or when +`self` is empty. + +Get the buffer at `idx`. +## `idx` +the index + +# Returns + +the buffer at `idx` in `group` + or `None` when there is no buffer. The buffer remains valid as + long as `self` is valid and buffer is not removed from the list. + +Insert `buffer` at `idx` in `self`. Other buffers are moved to make room for +this new buffer. + +A -1 value for `idx` will append the buffer at the end. +## `idx` +the index +## `buffer` +a `Buffer` + +Returns the number of buffers in `self`. + +# Returns + +the number of buffers in the buffer list + +Remove `length` buffers starting from `idx` in `self`. The following buffers +are moved to close the gap. +## `idx` +the index +## `length` +the amount to remove The different types of buffering methods. @@ -1489,14 +1575,14 @@ has limited support for nested `Caps` / `Structure` fields. It can only support one level of nesting. Using more levels will lead to unexpected behavior when using serialization features, such as `Caps::to_string` or `gst_value_serialize` and their counterparts. - + Creates a new `Caps` that indicates that it is compatible with any media format. # Returns the new `Caps` - + Creates a new `Caps` that is empty. That is, the returned `Caps` contains no media formats. The `Caps` is guaranteed to be writable. @@ -1505,7 +1591,7 @@ Caller is responsible for unreffing the returned caps. # Returns the new `Caps` - + Creates a new `Caps` that contains one `Structure` with name `media_type`. Caller is responsible for unreffing the returned caps. @@ -1515,7 +1601,7 @@ the media type of the structure # Returns the new `Caps` - + Creates a new `Caps` and adds all the structures listed as arguments. The list must be `None`-terminated. The structures are not copied; the returned `Caps` owns the structures. @@ -1525,7 +1611,7 @@ the first structure to add # Returns the new `Caps` - + Creates a new `Caps` and adds all the structures listed as arguments. The list must be `None`-terminated. The structures are not copied; the returned `Caps` owns the structures. @@ -1537,7 +1623,7 @@ additional structures to add # Returns the new `Caps` - + Creates a new `Caps` that contains one `Structure`. The structure is defined by the arguments, which have the same format as `Structure::new`. @@ -1550,25 +1636,25 @@ first field to set # Returns the new `Caps` - + Appends the structures contained in `caps2` to `self`. The structures in `caps2` are not copied -- they are transferred to `self`, and then `caps2` is freed. If either caps is ANY, the resulting caps will be ANY. ## `caps2` the `Caps` to append - + Appends `structure` to `self`. The structure is not copied; `self` becomes the owner of `structure`. ## `structure` the `Structure` to append - + Appends `structure` with `features` to `self`. The structure is not copied; `self` becomes the owner of `structure`. ## `structure` the `Structure` to append ## `features` the `CapsFeatures` to append - + Tries intersecting `self` and `caps2` and reports whether the result would not be empty ## `caps2` @@ -1577,7 +1663,7 @@ a `Caps` to intersect # Returns `true` if intersection would be not empty - + Creates a new `Caps` and appends a copy of the nth structure contained in `self`. ## `nth` @@ -1586,7 +1672,7 @@ the nth structure to copy # Returns the new `Caps` - + Calls the provided function once for each structure and caps feature in the `Caps`. In contrast to `Caps::foreach`, the function may modify the structure and features. In contrast to `Caps::filter_and_map_in_place`, @@ -1597,7 +1683,7 @@ The caps must be mutable. a function to call for each field ## `user_data` private data - + Modifies the given `self` into a representation with only fixed values. First the caps will be truncated and then the first structure will be fixated with `Structure::fixate`. @@ -1609,7 +1695,7 @@ reference to it with `gst_caps_ref`. # Returns the fixated caps - + Calls the provided function once for each structure and caps feature in the `Caps`. The function must not modify the fields. Also see `Caps::map_in_place` and `Caps::filter_and_map_in_place`. @@ -1622,7 +1708,7 @@ private data `true` if the supplied function returns `true` for each call, `false` otherwise. - + Finds the features in `self` that has the index `index`, and returns it. @@ -1644,13 +1730,13 @@ the index of the structure a pointer to the `CapsFeatures` corresponding to `index` - + Gets the number of structures contained in `self`. # Returns the number of structures that `self` contains - + Finds the structure in `self` that has the index `index`, and returns it. @@ -1672,7 +1758,7 @@ the index of the structure a pointer to the `Structure` corresponding to `index` - + Creates a new `Caps` that contains all the formats that are common to both `self` and `caps2`. Defaults to `CapsIntersectMode::ZigZag` mode. ## `caps2` @@ -1681,7 +1767,7 @@ a `Caps` to intersect # Returns the new `Caps` - + Creates a new `Caps` that contains all the formats that are common to both `self` and `caps2`, the order is defined by the `CapsIntersectMode` used. @@ -1693,7 +1779,7 @@ The intersection algorithm/mode to use # Returns the new `Caps` - + A given `Caps` structure is always compatible with another if every media format that is in the first is also contained in the second. That is, `self` is a subset of `caps2`. @@ -1703,19 +1789,19 @@ the `Caps` to test # Returns `true` if `self` is a subset of `caps2`. - + Determines if `self` represents any media format. # Returns `true` if `self` represents any format. - + Determines if `self` represents no media formats. # Returns `true` if `self` represents no formats. - + Checks if the given caps represent the same set of caps. ## `caps2` another `Caps` @@ -1723,7 +1809,7 @@ another `Caps` # Returns `true` if both caps are equal. - + Tests if two `Caps` are equal. This function only works on fixed `Caps`. ## `caps2` @@ -1732,7 +1818,7 @@ the `Caps` to test # Returns `true` if the arguments represent the same format - + Fixed `Caps` describe exactly one format, that is, they have exactly one structure, and each field in the structure describes a fixed type. Examples of non-fixed types are GST_TYPE_INT_RANGE and GST_TYPE_LIST. @@ -1740,7 +1826,7 @@ Examples of non-fixed types are GST_TYPE_INT_RANGE and GST_TYPE_LIST. # Returns `true` if `self` is fixed - + Checks if the given caps are exactly the same set of caps. ## `caps2` another `Caps` @@ -1748,7 +1834,7 @@ another `Caps` # Returns `true` if both caps are strictly equal. - + Checks if all caps represented by `self` are also represented by `superset`. ## `superset` a potentially greater `Caps` @@ -1756,7 +1842,7 @@ a potentially greater `Caps` # Returns `true` if `self` is a subset of `superset` - + Checks if `structure` is a subset of `self`. See `Caps::is_subset` for more information. ## `structure` @@ -1765,7 +1851,7 @@ a potential `Structure` subset of `self` # Returns `true` if `structure` is a subset of `self` - + Checks if `structure` is a subset of `self`. See `Caps::is_subset` for more information. ## `structure` @@ -1776,7 +1862,7 @@ a `CapsFeatures` for `structure` # Returns `true` if `structure` is a subset of `self` - + Calls the provided function once for each structure and caps feature in the `Caps`. In contrast to `Caps::foreach`, the function may modify but not delete the structures and features. The caps must be mutable. @@ -1789,7 +1875,7 @@ private data `true` if the supplied function returns `true` for each call, `false` otherwise. - + Appends the structures contained in `caps2` to `self` if they are not yet expressed by `self`. The structures in `caps2` are not copied -- they are transferred to a writable copy of `self`, and then `caps2` is freed. @@ -1800,7 +1886,7 @@ the `Caps` to merge in # Returns the merged caps. - + Appends `structure` to `self` if its not already expressed by `self`. ## `structure` the `Structure` to merge @@ -1808,7 +1894,7 @@ the `Structure` to merge # Returns the merged caps. - + Appends `structure` with `features` to `self` if its not already expressed by `self`. ## `structure` the `Structure` to merge @@ -1818,7 +1904,7 @@ the `CapsFeatures` to merge # Returns the merged caps. - + Returns a `Caps` that represents the same set of formats as `self`, but contains no lists. Each list is expanded into separate `GstStructures`. @@ -1830,30 +1916,30 @@ reference to it with `gst_caps_ref`. # Returns the normalized `Caps` - + removes the structure with the given index from the list of structures contained in `self`. ## `idx` Index of the structure to remove - + Sets the `CapsFeatures` `features` for the structure at `index`. ## `index` the index of the structure ## `features` the `CapsFeatures` to set - + Sets fields in a `Caps`. The arguments must be passed in the same manner as `Structure::set`, and be `None`-terminated. ## `field` first field to set - + Sets fields in a `Caps`. The arguments must be passed in the same manner as `Structure::set`, and be `None`-terminated. ## `field` first field to set ## `varargs` additional parameters - + Sets the given `field` on all structures of `self` to the given `value`. This is a convenience function for calling `Structure::set_value` on all structures of `self`. @@ -1861,7 +1947,7 @@ all structures of `self`. name of the field to set ## `value` value to set the field to - + Converts the given `self` into a representation that represents the same set of formats, but in a simpler form. Component structures that are identical are merged. Component structures that have values that can be @@ -1876,7 +1962,7 @@ This method does not preserve the original order of `self`. # Returns The simplified caps. - + Retrieves the structure with the given index from the list of structures contained in `self`. The caller becomes the owner of the returned structure. ## `index` @@ -1886,7 +1972,7 @@ Index of the structure to retrieve a pointer to the `Structure` corresponding to `index`. - + Subtracts the `subtrahend` from the `self`. > This function does not work reliably if optional properties for caps > are included on one caps and omitted on the other. @@ -1896,7 +1982,7 @@ Subtracts the `subtrahend` from the `self`. # Returns the resulting caps - + Converts `self` to a string representation. This string representation can be converted back to a `Caps` by `Caps::from_string`. @@ -1913,7 +1999,7 @@ when there are nested `Caps` / `Structure` deeper than one level. # Returns a newly allocated string representing `self`. - + Discard all but the first structure from `self`. Useful when fixating. @@ -1924,7 +2010,7 @@ additional reference to it with `gst_caps_ref`. # Returns truncated caps - + Converts `caps` from a string representation. The current implementation of serialization will lead to unexpected results @@ -2661,7 +2747,7 @@ A persistent `Context` is kept in elements when they reach `State::Null`, non-persistent ones will be removed. Also, a non-persistent context won't override a previous persistent context set to an element. - + Create a new context. ## `context_type` Context type @@ -2671,13 +2757,13 @@ Persistent context # Returns The new context. - + Get the type of `self`. # Returns The type of the context. - + Access the structure of the context. # Returns @@ -2685,7 +2771,7 @@ Access the structure of the context. The structure of the context. The structure is still owned by the context, which means that you should not modify it, free it and that the pointer becomes invalid when you free the context. - + Checks if `self` has `context_type`. ## `context_type` Context type to check. @@ -2693,13 +2779,13 @@ Context type to check. # Returns `true` if `self` has `context_type`. - + Check if `self` is persistent. # Returns `true` if the context is persistent. - + Get a writable version of the structure. # Returns @@ -4773,7 +4859,7 @@ the needed parameters to specify seeking time and mode. g_warning ("seek failed"); ... ``` - + Create a new buffersize event. The event is sent downstream and notifies elements that they should provide a buffer of the specified dimensions. @@ -4790,7 +4876,7 @@ thread behavior # Returns a new `Event` - + Create a new CAPS event for `caps`. The caps event can only travel downstream synchronized with the buffer flow and contains the format of the buffers that will follow after the event. @@ -4800,7 +4886,7 @@ a `Caps` # Returns the new CAPS event. - + Create a new custom-typed event. This can be used for anything not handled by other event-specific functions to pass an event to another element. @@ -4820,7 +4906,7 @@ the structure for the event. The event will # Returns the new custom event. - + Create a new EOS event. The eos event can only travel downstream synchronized with the buffer flow. Elements that receive the EOS event on a pad can return `FlowReturn::Eos` as a `FlowReturn` @@ -4838,7 +4924,7 @@ The EOS event itself will not cause any state transitions of the pipeline. # Returns the new EOS event. - + Allocate a new flush start event. The flush start event can be sent upstream and downstream and travels out-of-bounds with the dataflow. @@ -4857,7 +4943,7 @@ in the pipeline so that the new media is played as soon as possible. # Returns a new flush start event. - + Allocate a new flush stop event. The flush stop event can be sent upstream and downstream and travels serialized with the dataflow. It is typically sent after sending a FLUSH_START event to make the @@ -4874,7 +4960,7 @@ if time should be reset # Returns a new flush stop event. - + Create a new GAP event. A gap event can be thought of as conceptually equivalent to a buffer to signal that there is no data for a certain amount of time. This is useful to signal a gap to downstream elements @@ -4888,7 +4974,7 @@ the duration of the gap # Returns the new GAP event. - + Create a new latency event. The event is sent upstream from the sinks and notifies elements that they should add an additional `latency` to the running time before synchronising against the clock. @@ -4901,7 +4987,7 @@ the new latency value # Returns a new `Event` - + Create a new navigation event from the given description. ## `structure` description of the event. The event will take @@ -4910,7 +4996,7 @@ description of the event. The event will take # Returns a new `Event` - + Creates a new event containing information specific to a particular protection system (uniquely identified by `system_id`), by which that protection system can acquire key(s) to decrypt a protected stream. @@ -4955,7 +5041,7 @@ of this string will depend upon the protection scheme. a `EventType::Protection` event, if successful; `None` if unsuccessful. - + Allocate a new qos event with the given values. The QOS event is generated in an element that wants an upstream element to either reduce or increase its rate because of @@ -5010,7 +5096,7 @@ The timestamp of the buffer # Returns a new QOS event. - + Create a new reconfigure event. The purpose of the reconfigure event is to travel upstream and make elements renegotiate their caps or reconfigure their buffer pools. This is useful when changing properties on elements @@ -5019,7 +5105,7 @@ or changing the topology of the pipeline. # Returns a new `Event` - + Allocate a new seek event with the given parameters. The seek event configures playback of the pipeline between `start` to `stop` @@ -5069,7 +5155,7 @@ The value of the new stop position # Returns a new seek event. - + Create a new SEGMENT event for `segment`. The segment event can only travel downstream synchronized with the buffer flow and contains timing information and playback properties for the buffers that will follow. @@ -5107,7 +5193,7 @@ a `Segment` # Returns the new SEGMENT event. - + Create a new segment-done event. This event is sent by elements that finish playback of a segment as a result of a segment seek. ## `format` @@ -5118,7 +5204,7 @@ The position of the segment being done # Returns a new `Event` - + Allocate a new select-streams event. The select-streams event requests the specified `streams` to be activated. @@ -5137,7 +5223,7 @@ activate # Returns a new select-streams event. - + Create a new sink-message event. The purpose of the sink-message event is to instruct a sink to post the message contained in the event synchronized with the stream. @@ -5151,7 +5237,7 @@ the `Message` to be posted # Returns a new `Event` - + Create a new step event. The purpose of the step event is to instruct a sink to skip `amount` (expressed in `format`) of media. It can be used to implement stepping through the video frame by frame or for doing fast trick modes. @@ -5179,7 +5265,7 @@ intermediate steps # Returns a new `Event` - + Create a new STREAM_COLLECTION event. The stream collection event can only travel downstream synchronized with the buffer flow. @@ -5197,7 +5283,7 @@ Active collection for this data flow # Returns the new STREAM_COLLECTION event. - + Create a new Stream Group Done event. The stream-group-done event can only travel downstream synchronized with the buffer flow. Elements that receive the event on a pad should handle it mostly like EOS, @@ -5216,7 +5302,7 @@ the group id of the stream group which is ending # Returns the new stream-group-done event. - + Create a new STREAM_START event. The stream start event can only travel downstream synchronized with the buffer flow. It is expected to be the first event that is sent for a new stream. @@ -5244,7 +5330,7 @@ Identifier for this stream # Returns the new STREAM_START event. - + Generates a metadata tag event from the given `taglist`. The scope of the taglist specifies if the taglist applies to the @@ -5259,7 +5345,7 @@ metadata list. The event will take ownership # Returns a new `Event` - + Generate a TOC event from the given `toc`. The purpose of the TOC event is to inform elements that some kind of the TOC was found. ## `toc` @@ -5270,7 +5356,7 @@ whether `toc` was updated or not. # Returns a new `Event`. - + Generate a TOC select event with the given `uid`. The purpose of the TOC select event is to start playback based on the TOC's entry with the given `uid`. @@ -5280,12 +5366,12 @@ UID in the TOC to start playback from. # Returns a new `Event`. - + Parses a segment `self` and copies the `Segment` into the location given by `segment`. ## `segment` a pointer to a `Segment` - + Retrieve the accumulated running time offset of the event. Events passing through `GstPads` that have a running time @@ -5301,7 +5387,7 @@ before usage with this offset. The event's running time offset MT safe. - + Retrieve the sequence number of a event. Events have ever-incrementing sequence numbers, which may also be set @@ -5320,7 +5406,7 @@ that correspondence was made explicitly. The event's sequence number. MT safe. - + Access the structure of the event. # Returns @@ -5330,7 +5416,7 @@ owned by the event, which means that you should not free it and that the pointer becomes invalid when you free the event. MT safe. - + Checks if `self` has the given `name`. This function is usually used to check the name of a custom event. ## `name` @@ -5339,7 +5425,7 @@ name to check # Returns `true` if `name` matches the name of the event structure. - + Get the format, minsize, maxsize and async-flag in the buffersize event. ## `format` A pointer to store the format in @@ -5349,16 +5435,16 @@ A pointer to store the minsize in A pointer to store the maxsize in ## `async` A pointer to store the async-flag in - + Get the caps from `self`. The caps remains valid as long as `self` remains valid. ## `caps` A pointer to the caps - + Parse the FLUSH_STOP event and retrieve the `reset_time` member. ## `reset_time` if time should be reset - + Extract timestamp and duration from a new GAP event. ## `timestamp` location where to store the @@ -5366,7 +5452,7 @@ location where to store the ## `duration` location where to store the duration of the gap, or `None` - + ## `group_id` address of variable where to store the group id @@ -5374,11 +5460,11 @@ address of variable where to store the group id `true` if a group id was set on the event and could be parsed, `false` otherwise. - + Get the latency in the latency event. ## `latency` A pointer to store the latency in. - + Parses an event containing protection system specific information and stores the results in `system_id`, `data` and `origin`. The data stored in `system_id`, `origin` and `data` are valid until `self` is released. @@ -5392,7 +5478,7 @@ holding protection system specific information. pointer to store a value that indicates where the protection information carried by `self` was extracted from. - + Get the type, proportion, diff and timestamp in the qos event. See `Event::new_qos` for more information about the different QoS values. @@ -5405,7 +5491,7 @@ A pointer to store the proportion in A pointer to store the diff in ## `timestamp` A pointer to store the timestamp in - + Parses a seek `self` and stores the results in the given result locations. ## `rate` result location for the rate @@ -5421,30 +5507,30 @@ result location for the start position expressed in `format` result location for the `SeekType` of the stop position ## `stop` result location for the stop position expressed in `format` - + Parses a segment `self` and stores the result in the given `segment` location. `segment` remains valid only until the `self` is freed. Don't modify the segment and make a copy if you want to modify it or store it for later use. ## `segment` a pointer to a `Segment` - + Extracts the position and format from the segment done message. ## `format` Result location for the format, or `None` ## `position` Result location for the position, or `None` - + Parse the SELECT_STREAMS event and retrieve the contained streams. Feature: `v1_10` ## `streams` the streams - + Parse the sink-message event. Unref `msg` after usage. ## `msg` a pointer to store the `Message` in. - + Parse the step event. ## `format` a pointer to store the format in @@ -5457,24 +5543,24 @@ a pointer to store the flush boolean in ## `intermediate` a pointer to store the intermediate boolean in - + Parse a stream-start `self` and extract the `Stream` from it. Feature: `v1_10` ## `stream` adress of variable to store the stream - + Retrieve new `StreamCollection` from STREAM_COLLECTION event `self`. Feature: `v1_10` ## `collection` pointer to store the collection - + ## `flags` address of variable where to store the stream flags - + Parse a stream-group-done `self` and store the result in the given `group_id` location. @@ -5482,31 +5568,31 @@ Feature: `v1_10` ## `group_id` address of variable to store the group id into - + Parse a stream-id `self` and store the result in the given `stream_id` location. The string stored in `stream_id` must not be modified and will remain valid only until `self` gets freed. Make a copy if you want to modify it or store it for later use. ## `stream_id` pointer to store the stream-id - + Parses a tag `self` and stores the results in the given `taglist` location. No reference to the taglist will be returned, it remains valid only until the `self` is freed. Don't modify or free the taglist, make a copy if you want to modify it or store it for later use. ## `taglist` pointer to metadata list - + Parse a TOC `self` and store the results in the given `toc` and `updated` locations. ## `toc` pointer to `Toc` structure. ## `updated` pointer to store TOC updated flag. - + Parse a TOC select `self` and store the results in the given `uid` location. ## `uid` storage for the selection UID. - + All streams that have the same group id are supposed to be played together, i.e. all streams inside a container file should have the same group id but different stream ids. The group id should change @@ -5516,14 +5602,14 @@ each time a file is played for example. Use `gst_util_group_id_next` to get a new group id. ## `group_id` the group id to set - + Set the running time offset of a event. See `Event::get_running_time_offset` for more information. MT safe. ## `offset` A the new running time offset - + Set the sequence number of a event. This function might be called by the creator of a event to indicate that the @@ -5533,17 +5619,17 @@ more information. MT safe. ## `seqnum` A sequence number. - + Set the `stream` on the stream-start `self` Feature: `v1_10` ## `stream` the stream object to set - + ## `flags` the stream flags to set - + Get a writable version of the structure. # Returns @@ -6149,7 +6235,7 @@ The basic use pattern of posting a message on a `Bus` is as follows: A `Element` usually posts messages on the bus provided by the parent container using `ElementExt::post_message`. - + Create a new application-typed message. GStreamer will never create these messages; they are a gift from us to you. Enjoy. ## `src` @@ -6163,7 +6249,7 @@ the structure for the message. The message The new application message. MT safe. - + The message is posted when elements completed an ASYNC state change. `running_time` contains the time of the desired running_time when this elements goes to PLAYING. A value of `GST_CLOCK_TIME_NONE` for `running_time` @@ -6179,7 +6265,7 @@ the desired running_time The new async_done message. MT safe. - + This message is posted by elements when they start an ASYNC state change. ## `src` The object originating the message. @@ -6189,7 +6275,7 @@ The object originating the message. The new async_start message. MT safe. - + Create a new buffering message. This message can be posted by an element that needs to buffer data before it can continue processing. `percent` should be a value between 0 and 100. A value of 100 means that the buffering completed. @@ -6210,7 +6296,7 @@ The buffering percent # Returns The new buffering message. - + Create a clock lost message. This message is posted whenever the clock is not valid anymore. @@ -6227,7 +6313,7 @@ the clock that was lost The new clock lost message. MT safe. - + Create a clock provide message. This message is posted whenever an element is ready to provide a clock or lost its ability to provide a clock (maybe because it paused or became EOS). @@ -6246,7 +6332,7 @@ the clock it provides the new provide clock message. MT safe. - + Create a new custom-typed message. This can be used for anything not handled by other message-specific functions to pass a message to the app. The structure field can be `None`. @@ -6263,7 +6349,7 @@ the structure for the The new message. MT safe. - + Creates a new device-added message. The device-added message is produced by `DeviceProvider` or a `DeviceMonitor`. They announce the appearance of monitored devices. @@ -6275,7 +6361,7 @@ The new `Device` # Returns a newly allocated `Message` - + Creates a new device-removed message. The device-removed message is produced by `DeviceProvider` or a `DeviceMonitor`. They announce the disappearance of monitored devices. @@ -6287,7 +6373,7 @@ The removed `Device` # Returns a newly allocated `Message` - + Create a new duration changed message. This message is posted by elements that know the duration of a stream when the duration changes. This message is received by bins and is used to calculate the total duration of a @@ -6300,7 +6386,7 @@ The object originating the message. The new duration-changed message. MT safe. - + Create a new element-specific message. This is meant as a generic way of allowing one-way communication from an element to an application, for example "the firewire cable was unplugged". The format of the message should be @@ -6316,7 +6402,7 @@ The structure for the The new element message. MT safe. - + Create a new eos message. This message is generated and posted in the sink elements of a GstBin. The bin will only forward the EOS message to the application if all sinks have posted an EOS message. @@ -6328,7 +6414,7 @@ The object originating the message. The new eos message. MT safe. - + Create a new error message. The message will copy `error` and `debug`. This message is posted by element when a fatal event occurred. The pipeline will probably (partially) stop. The application @@ -6345,7 +6431,7 @@ A debugging string. the new error message. MT safe. - + Create a new error message. The message will copy `error` and `debug`. This message is posted by element when a fatal event occurred. The pipeline will probably (partially) stop. The application @@ -6365,7 +6451,7 @@ A debugging string. # Returns the new error message. - + This message is posted when an element has a new local `Context`. ## `src` The object originating the message. @@ -6377,7 +6463,7 @@ the context The new have-context message. MT safe. - + Create a new info message. The message will make copies of `error` and `debug`. ## `src` @@ -6392,7 +6478,7 @@ A debugging string. the new info message. MT safe. - + Create a new info message. The message will make copies of `error` and `debug`. @@ -6410,7 +6496,7 @@ A debugging string. # Returns the new warning message. - + This message can be posted by elements when their latency requirements have changed. ## `src` @@ -6421,7 +6507,7 @@ The object originating the message. The new latency message. MT safe. - + This message is posted when an element needs a specific `Context`. ## `src` The object originating the message. @@ -6433,7 +6519,7 @@ The context type that is needed The new need-context message. MT safe. - + Create a new clock message. This message is posted whenever the pipeline selects a new clock for the pipeline. ## `src` @@ -6446,7 +6532,7 @@ the new selected clock The new new clock message. MT safe. - + Progress messages are posted by elements when they use an asynchronous task to perform actions triggered by a state change. @@ -6464,7 +6550,7 @@ free, user visible text describing the progress # Returns The new qos message. - + Feature: `v1_10` @@ -6478,7 +6564,7 @@ new property value, or `None` # Returns a newly allocated `Message` - + A QOS message is posted on the bus whenever an element decides to drop a buffer because of QoS reasons or whenever it changes its processing strategy because of QoS reasons (quality adjustments such as processing at lower @@ -6510,7 +6596,7 @@ the duration of the buffer that generated the message The new qos message. MT safe. - + Creates a new redirect message and adds a new entry to it. Redirect messages are posted when an element detects that the actual data has to be retrieved from a different location. This is useful if such a redirection cannot be @@ -6551,7 +6637,7 @@ structure for the new entry # Returns a newly allocated `Message` - + This message can be posted by elements when they want to have their state changed. A typical use case would be an audio server that wants to pause the pipeline because a higher priority stream is being played. @@ -6565,7 +6651,7 @@ The new requested state the new request state message. MT safe. - + This message is posted when the pipeline running-time should be reset to `running_time`, like after a flushing seek. ## `src` @@ -6578,7 +6664,7 @@ the requested running-time The new reset_time message. MT safe. - + Create a new segment done message. This message is posted by elements that finish playback of a segment as a result of a segment seek. This message is received by the application after all elements that posted a segment_start @@ -6595,7 +6681,7 @@ The position of the segment being done the new segment done message. MT safe. - + Create a new segment message. This message is posted by elements that start playback of a segment as a result of a segment seek. This message is not received by the application but is used for maintenance reasons in @@ -6612,7 +6698,7 @@ The position of the segment being played the new segment start message. MT safe. - + Create a state change message. This message is posted whenever an element changed its state. ## `src` @@ -6629,7 +6715,7 @@ the pending (target) state the new state change message. MT safe. - + Create a state dirty message. This message is posted whenever an element changed its state asynchronously and is used internally to update the states of container objects. @@ -6641,7 +6727,7 @@ The object originating the message the new state dirty message. MT safe. - + This message is posted by elements when they complete a part, when `intermediate` set to `true`, or a complete step operation. @@ -6669,7 +6755,7 @@ the step caused EOS the new step_done message. MT safe. - + This message is posted by elements when they accept or activate a new step event for `amount` in `format`. @@ -6700,7 +6786,7 @@ is this an intermediate step The new step_start message. MT safe. - + Creates a new stream-collection message. The message is used to announce new `StreamCollection` @@ -6714,7 +6800,7 @@ The `StreamCollection` # Returns a newly allocated `Message` - + Create a new stream_start message. This message is generated and posted in the sink elements of a GstBin. The bin will only forward the STREAM_START message to the application if all sinks have posted an STREAM_START message. @@ -6726,7 +6812,7 @@ The object originating the message. The new stream_start message. MT safe. - + Create a new stream status message. This message is posted when a streaming thread is created/destroyed or when the state changed. ## `src` @@ -6741,7 +6827,7 @@ the owner element of `src`. the new stream status message. MT safe. - + Creates a new steams-selected message. The message is used to announce that an array of streams has been selected. This is generally in response to a `EventType::SelectStreams` event, or when an element (such as decodebin3) @@ -6763,7 +6849,7 @@ The `StreamCollection` # Returns a newly allocated `Message` - + Create a new structure change message. This message is posted when the structure of a pipeline is in the process of being changed, for example when pads are linked or unlinked. @@ -6783,7 +6869,7 @@ Whether the structure change is busy. the new structure change message. MT safe. - + Create a new tag message. The message will take ownership of the tag list. The message is posted by elements that discovered a new taglist. ## `src` @@ -6796,7 +6882,7 @@ the tag list for the message. the new tag message. MT safe. - + Create a new TOC message. The message is posted by elements that discovered or updated a TOC. ## `src` @@ -6811,7 +6897,7 @@ whether TOC was updated or not. a new TOC message. MT safe. - + Create a new warning message. The message will make copies of `error` and `debug`. ## `src` @@ -6826,7 +6912,7 @@ A debugging string. the new warning message. MT safe. - + Create a new warning message. The message will make copies of `error` and `debug`. @@ -6844,7 +6930,7 @@ A debugging string. # Returns the new warning message. - + Creates and appends a new entry. The specified location string is copied. However, ownership over the tag @@ -6858,7 +6944,7 @@ location string for the new entry tag list for the new entry ## `entry_struct` structure for the new entry - + Feature: `v1_10` @@ -6866,7 +6952,7 @@ Feature: `v1_10` # Returns the number of entries stored in the message - + Retrieve the sequence number of a message. Messages have ever-incrementing sequence numbers, which may also be set @@ -6885,7 +6971,7 @@ that correspondence was made explicitly. The message's sequence number. MT safe. - + Extracts the object managing the streaming thread from `self`. # Returns @@ -6893,7 +6979,7 @@ Extracts the object managing the streaming thread from `self`. a GValue containing the object that manages the streaming thread. This object is usually of type GstTask but other types can be added in the future. The object remains valid as long as `self` is valid. - + Access the structure of the message. # Returns @@ -6903,7 +6989,7 @@ still owned by the message, which means that you should not free it and that the pointer becomes invalid when you free the message. MT safe. - + Checks if `self` has the given `name`. This function is usually used to check the name of a custom message. ## `name` @@ -6912,20 +6998,20 @@ name to check # Returns `true` if `name` matches the name of the message structure. - + Extract the running_time from the async_done message. MT safe. ## `running_time` Result location for the running_time or `None` - + Extracts the buffering percent from the GstMessage. see also `Message::new_buffering`. MT safe. ## `percent` Return location for the percent. - + Extracts the buffering stats values from `self`. ## `mode` a buffering mode, or `None` @@ -6936,14 +7022,14 @@ the average output rate, or `None` ## `buffering_left` amount of buffering time left in milliseconds, or `None` - + Extracts the lost clock from the GstMessage. The clock object returned remains valid until the message is freed. MT safe. ## `clock` a pointer to hold the lost clock - + Extracts the clock and ready flag from the GstMessage. The clock object returned remains valid until the message is freed. @@ -6953,7 +7039,7 @@ a pointer to hold a clock object, or `None` ## `ready` a pointer to hold the ready flag, or `None` - + Parse a context type from an existing GST_MESSAGE_NEED_CONTEXT message. ## `context_type` the context type, or `None` @@ -6961,21 +7047,21 @@ the context type, or `None` # Returns a `gboolean` indicating if the parsing succeeded. - + Parses a device-added message. The device-added message is produced by `DeviceProvider` or a `DeviceMonitor`. It announces the appearance of monitored devices. ## `device` A location where to store a pointer to the new `Device`, or `None` - + Parses a device-removed message. The device-removed message is produced by `DeviceProvider` or a `DeviceMonitor`. It announces the disappearance of monitored devices. ## `device` A location where to store a pointer to the removed `Device`, or `None` - + Extracts the GError and debug string from the GstMessage. The values returned in the output arguments are copies; the caller must free them when done. @@ -7007,7 +7093,7 @@ location for the GError ## `debug` location for the debug message, or `None` - + Returns the optional details structure, may be NULL if none. The returned structure must not be freed. @@ -7015,7 +7101,7 @@ Feature: `v1_10` ## `structure` A pointer to the returned details - + Extract the group from the STREAM_START message. ## `group_id` Result location for the group id or @@ -7026,14 +7112,14 @@ Result location for the group id or `true` if the message had a group id set, `false` otherwise MT safe. - + Extract the context from the HAVE_CONTEXT message. MT safe. ## `context` Result location for the context or `None` - + Extracts the GError and debug string from the GstMessage. The values returned in the output arguments are copies; the caller must free them when done. @@ -7043,7 +7129,7 @@ location for the GError ## `debug` location for the debug message, or `None` - + Returns the optional details structure, may be NULL if none The returned structure must not be freed. @@ -7051,7 +7137,7 @@ Feature: `v1_10` ## `structure` A pointer to the returned details structure - + Extracts the new clock from the GstMessage. The clock object returned remains valid until the message is freed. @@ -7059,7 +7145,7 @@ MT safe. ## `clock` a pointer to hold the selected new clock - + Parses the progress `type_`, `code` and `text`. ## `type_` location for the type @@ -7067,7 +7153,7 @@ location for the type location for the code ## `text` location for the text - + Parses a property-notify message. These will be posted on the bus only when set up with `ElementExt::add_property_notify_watch` or `ElementExt::add_property_deep_notify_watch`. @@ -7084,7 +7170,7 @@ return location for the name of the return location for the new value of the property that got changed, or `None`. This will only be set if the property notify watch was told to include the value when it was set up - + Extract the timestamps and live status from the QoS message. The returned values give the running_time, stream_time, timestamp and @@ -7106,7 +7192,7 @@ the timestamps of the buffer that ## `duration` the duration of the buffer that generated the message - + Extract the QoS stats representing the history of the current continuous pipeline playback period. @@ -7125,7 +7211,7 @@ Total number of units correctly processed ## `dropped` Total number of units dropped since the last state change to READY or a flushing operation. - + Extract the QoS values that have been calculated/analysed from the QoS data MT safe. @@ -7139,7 +7225,7 @@ Long term prediction of the ideal rate An element dependent integer value that specifies the current quality level of the element. The default maximum quality is 1000000. - + Parses the location and/or structure from the entry with the given index. The index must be between 0 and `Message::get_num_redirect_entries` - 1. Returned pointers are valid for as long as this message exists. @@ -7157,20 +7243,20 @@ return location for ## `entry_struct` return location for the pointer to the entry's structure, or `None` - + Extract the requested state from the request_state message. MT safe. ## `state` Result location for the requested state or `None` - + Extract the running-time from the RESET_TIME message. MT safe. ## `running_time` Result location for the running_time or `None` - + Extracts the position and format from the segment done message. MT safe. @@ -7178,7 +7264,7 @@ MT safe. Result location for the format, or `None` ## `position` Result location for the position, or `None` - + Extracts the position and format from the segment start message. MT safe. @@ -7186,7 +7272,7 @@ MT safe. Result location for the format, or `None` ## `position` Result location for the position, or `None` - + Extracts the old and new states from the GstMessage. Typical usage of this function might be: @@ -7216,7 +7302,7 @@ the previous state, or `None` the new (current) state, or `None` ## `pending` the pending (target) state, or `None` - + Extract the values the step_done message. MT safe. @@ -7234,7 +7320,7 @@ result location for the intermediate flag result location for the duration ## `eos` result location for the EOS flag - + Extract the values from step_start message. MT safe. @@ -7250,7 +7336,7 @@ result location for the rate result location for the flush flag ## `intermediate` result location for the intermediate flag - + Parses a stream-collection message. Feature: `v1_10` @@ -7258,7 +7344,7 @@ Feature: `v1_10` ## `collection` A location where to store a pointer to the `StreamCollection`, or `None` - + Extracts the stream status type and owner the GstMessage. The returned owner remains valid for as long as the reference to `self` is valid and should thus not be unreffed. @@ -7268,7 +7354,7 @@ MT safe. A pointer to hold the status type ## `owner` The owner element of the message source - + Parses a streams-selected message. Feature: `v1_10` @@ -7276,7 +7362,7 @@ Feature: `v1_10` ## `collection` A location where to store a pointer to the `StreamCollection`, or `None` - + Extracts the change type and completion status from the GstMessage. MT safe. @@ -7288,7 +7374,7 @@ The owner element of the ## `busy` a pointer to hold whether the change is in progress or has been completed - + Extracts the tag list from the GstMessage. The tag list returned in the output argument is a copy; the caller must free it when done. @@ -7314,7 +7400,7 @@ Typical usage of this function might be: MT safe. ## `tag_list` return location for the tag-list. - + Extract the TOC from the `Message`. The TOC returned in the output argument is a copy; the caller must free it with `gst_toc_unref` when done. @@ -7324,7 +7410,7 @@ MT safe. return location for the TOC. ## `updated` return location for the updated flag. - + Extracts the GError and debug string from the GstMessage. The values returned in the output arguments are copies; the caller must free them when done. @@ -7334,7 +7420,7 @@ location for the GError ## `debug` location for the debug message, or `None` - + Returns the optional details structure, may be NULL if none The returned structure must not be freed. @@ -7342,7 +7428,7 @@ Feature: `v1_10` ## `structure` A pointer to the returned details structure - + Configures the buffering stats values in `self`. ## `mode` a buffering mode @@ -7352,7 +7438,7 @@ the average input rate the average output rate ## `buffering_left` amount of buffering time left in milliseconds - + Sets the group id on the stream-start message. All streams that have the same group id are supposed to be played @@ -7364,7 +7450,7 @@ each time a file is played for example. MT safe. ## `group_id` the group id - + Set the QoS stats representing the history of the current continuous pipeline playback period. @@ -7382,7 +7468,7 @@ change to READY or a flushing operation. ## `dropped` Total number of units dropped since the last state change to READY or a flushing operation. - + Set the QoS values that have been calculated/analysed from the QoS data MT safe. @@ -7394,7 +7480,7 @@ to get optimal quality. ## `quality` An element dependent integer value that specifies the current quality level of the element. The default maximum quality is 1000000. - + Set the sequence number of a message. This function might be called by the creator of a message to indicate that @@ -7404,19 +7490,19 @@ for more information. MT safe. ## `seqnum` A sequence number. - + Configures the object handling the streaming thread. This is usually a GstTask object but other objects might be added in the future. ## `object` the object controlling the streaming - + Adds the `stream` to the `self`. Feature: `v1_10` ## `stream` a `Stream` to add to `self` - + Returns the number of streams contained in the `self`. Feature: `v1_10` @@ -7425,7 +7511,7 @@ Feature: `v1_10` # Returns The number of streams contained within. - + Retrieves the `Stream` with index `index` from the `self`. Feature: `v1_10` @@ -9999,7 +10085,7 @@ The following example shows how to query the duration of a pipeline: } gst_query_unref (query); ``` - + Constructs a new query object for querying if `caps` are accepted. Free-function: `gst_query_unref` @@ -10009,7 +10095,7 @@ a fixed `Caps` # Returns a new `Query` - + Constructs a new query object for querying the allocation properties. Free-function: `gst_query_unref` @@ -10021,7 +10107,7 @@ return a pool # Returns a new `Query` - + Constructs a new query object for querying the buffering status of a stream. @@ -10032,7 +10118,7 @@ the default `Format` for the new query # Returns a new `Query` - + Constructs a new query object for querying the caps. The CAPS query should return the allowable caps for a pad in the context @@ -10059,7 +10145,7 @@ a filter # Returns a new `Query` - + Constructs a new query object for querying the pipeline-local context. Free-function: `gst_query_unref` @@ -10069,7 +10155,7 @@ Context type to query # Returns a new `Query` - + Constructs a new convert query object. Use `gst_query_unref` when done with it. A convert query is used to ask for a conversion between one format and another. @@ -10085,7 +10171,7 @@ the target `Format` # Returns a `Query` - + Constructs a new custom query object. Use `gst_query_unref` when done with it. @@ -10098,7 +10184,7 @@ a structure for the query # Returns a new `Query` - + Constructs a new query object for querying the drain state. Free-function: `gst_query_unref` @@ -10106,7 +10192,7 @@ Free-function: `gst_query_unref` # Returns a new `Query` - + Constructs a new stream duration query object to query in the given format. Use `gst_query_unref` when done with it. A duration query will give the total length of the stream. @@ -10118,7 +10204,7 @@ the `Format` for this duration query # Returns a new `Query` - + Constructs a new query object for querying formats of the stream. @@ -10127,7 +10213,7 @@ Free-function: `gst_query_unref` # Returns a new `Query` - + Constructs a new latency query object. Use `gst_query_unref` when done with it. A latency query is usually performed by sinks to compensate for additional latency introduced by elements in the @@ -10138,7 +10224,7 @@ Free-function: `gst_query_unref` # Returns a `Query` - + Constructs a new query stream position query object. Use `gst_query_unref` when done with it. A position query is used to query the current position of playback in the streams, in some format. @@ -10150,7 +10236,7 @@ the default `Format` for the new query # Returns a new `Query` - + Constructs a new query object for querying the scheduling properties. Free-function: `gst_query_unref` @@ -10158,7 +10244,7 @@ Free-function: `gst_query_unref` # Returns a new `Query` - + Constructs a new query object for querying seeking properties of the stream. @@ -10169,7 +10255,7 @@ the default `Format` for the new query # Returns a new `Query` - + Constructs a new segment query object. Use `gst_query_unref` when done with it. A segment query is used to discover information about the currently configured segment for playback. @@ -10181,7 +10267,7 @@ the `Format` for the new query # Returns a new `Query` - + Constructs a new query URI query object. Use `gst_query_unref` when done with it. An URI query is used to query the current URI that is used by the source or sink. @@ -10191,19 +10277,19 @@ Free-function: `gst_query_unref` # Returns a new `Query` - + Add `api` with `params` as one of the supported metadata API to `self`. ## `api` the metadata API ## `params` API specific parameters - + Add `allocator` and its `params` as a supported memory allocator. ## `allocator` the memory allocator ## `params` a `AllocationParams` - + Set the pool parameters in `self`. ## `pool` the `BufferPool` @@ -10213,7 +10299,7 @@ the buffer size the min buffers ## `max_buffers` the max buffers - + Set the buffering-ranges array field in `self`. The current last start position of the array should be inferior to `start`. ## `start` @@ -10224,11 +10310,11 @@ stop position of the range # Returns a `gboolean` indicating if the range was added or not. - + Add `mode` as one of the supported scheduling modes to `self`. ## `mode` a `PadMode` - + Check if `self` has metadata `api` set. When this function returns `true`, `index` will contain the index where the requested API and the parameters can be found. @@ -10240,14 +10326,14 @@ the index # Returns `true` when `api` is in the list of metadata. - + Retrieve the number of values currently stored in the meta API array of the query's structure. # Returns the metadata API array size as a `guint`. - + Retrieve the number of values currently stored in the allocator params array of the query's structure. @@ -10259,28 +10345,28 @@ allocators should be ordered by preference with the preferred one first. # Returns the allocator array size as a `guint`. - + Retrieve the number of values currently stored in the pool array of the query's structure. # Returns the pool array size as a `guint`. - + Retrieve the number of values currently stored in the buffered-ranges array of the query's structure. # Returns the range array size as a `guint`. - + Retrieve the number of values currently stored in the scheduling mode array of the query's structure. # Returns the scheduling mode array size as a `guint`. - + Get the structure of a query. # Returns @@ -10288,7 +10374,7 @@ Get the structure of a query. the `Structure` of the query. The structure is still owned by the query and will therefore be freed when the query is unreffed. - + Check if `self` has scheduling mode set. > When checking if upstream supports pull mode, it is usually not @@ -10302,7 +10388,7 @@ the scheduling mode # Returns `true` when `mode` is in the list of scheduling modes. - + Check if `self` has scheduling mode set and `flags` is set in query scheduling flags. ## `mode` @@ -10314,16 +10400,16 @@ the scheduling mode `true` when `mode` is in the list of scheduling modes and `flags` are compatible with query flags. - + Get the caps from `self`. The caps remains valid as long as `self` remains valid. ## `caps` A pointer to the caps - + Parse the result from `self` and store in `result`. ## `result` location for the result - + Parse an allocation query, writing the requested caps in `caps` and whether a pool is needed in `need_pool`, if the respective parameters are non-`None`. @@ -10334,14 +10420,14 @@ Pool details can be retrieved using `Query::get_n_allocation_pools` and The `Caps` ## `need_pool` Whether a `BufferPool` is needed - + Get the percentage of buffered data. This is a value between 0 and 100. The `busy` indicator is `true` when the buffering is in progress. ## `busy` if buffering is busy, or `None` ## `percent` a buffering percent, or `None` - + Parse an available query, writing the format into `format`, and other results into the passed parameters, if the respective parameters are non-`None` @@ -10355,7 +10441,7 @@ the stop to set, or `None` ## `estimated_total` estimated total amount of download time remaining in milliseconds, or `None` - + Extracts the buffering stats values from `self`. ## `mode` a buffering mode, or `None` @@ -10366,22 +10452,22 @@ the average output rat, or `None` ## `buffering_left` amount of buffering time left in milliseconds, or `None` - + Get the filter from the caps `self`. The caps remains valid as long as `self` remains valid. ## `filter` A pointer to the caps filter - + Get the caps result from `self`. The caps remains valid as long as `self` remains valid. ## `caps` A pointer to the caps - + Get the context from the context `self`. The context remains valid as long as `self` remains valid. ## `context` A pointer to store the `Context` - + Parse a context type from an existing GST_QUERY_CONTEXT query. ## `context_type` the context type, or `None` @@ -10389,7 +10475,7 @@ the context type, or `None` # Returns a `gboolean` indicating if the parsing succeeded. - + Parse a convert query answer. Any of `src_format`, `src_value`, `dest_format`, and `dest_value` may be `None`, in which case that value is omitted. ## `src_format` @@ -10403,7 +10489,7 @@ the storage for the `Format` of the ## `dest_value` the storage for the destination value, or `None` - + Parse a duration query answer. Write the format of the duration into `format`, and the value into `duration`, if the respective variables are non-`None`. ## `format` @@ -10411,7 +10497,7 @@ the storage for the `Format` of the duration value, or `None`. ## `duration` the storage for the total duration, or `None`. - + Parse a latency query answer. ## `live` storage for live or `None` @@ -10419,11 +10505,11 @@ storage for live or `None` the storage for the min latency or `None` ## `max_latency` the storage for the max latency or `None` - + Parse the number of formats in the formats `self`. ## `n_formats` the number of formats in this query. - + Parse an available query and get the metadata API at `index` of the metadata API array. ## `index` @@ -10434,7 +10520,7 @@ API specific parameters # Returns a `glib::Type` of the metadata API at `index`. - + Parse an available query and get the allocator and its params at `index` of the allocator array. ## `index` @@ -10443,7 +10529,7 @@ position in the allocator array to read variable to hold the result ## `params` parameters for the allocator - + Get the pool parameters in `self`. Unref `pool` with `GstObjectExt::unref` when it's not needed any more. @@ -10457,7 +10543,7 @@ the buffer size the min buffers ## `max_buffers` the max buffers - + Parse an available query and get the start and stop values stored at the `index` of the buffered ranges array. ## `index` @@ -10470,7 +10556,7 @@ the stop position to set, or `None` # Returns a `gboolean` indicating if the parsing succeeded. - + Parse the format query and retrieve the `nth` format from it into `format`. If the list contains less elements than `nth`, `format` will be set to GST_FORMAT_UNDEFINED. @@ -10478,7 +10564,7 @@ set to GST_FORMAT_UNDEFINED. the nth format to retrieve. ## `format` a pointer to store the nth format - + Parse an available query and get the scheduling mode at `index` of the scheduling modes array. ## `index` @@ -10487,7 +10573,7 @@ position in the scheduling modes array to read # Returns a `PadMode` of the scheduling mode at `index`. - + Parse a position query, writing the format into `format`, and the position into `cur`, if the respective parameters are non-`None`. ## `format` @@ -10495,7 +10581,7 @@ the storage for the `Format` of the position values (may be `None`) ## `cur` the storage for the current position (may be `None`) - + Set the scheduling properties. ## `flags` `SchedulingFlags` @@ -10505,7 +10591,7 @@ the suggested minimum size of pull requests the suggested maximum size of pull requests: ## `align` the suggested alignment of pull requests - + Parse a seeking query, writing the format into `format`, and other results into the passed parameters, if the respective parameters are non-`None` @@ -10518,7 +10604,7 @@ the seekable flag to set, or `None` the segment_start to set, or `None` ## `segment_end` the segment_end to set, or `None` - + Parse a segment query answer. Any of `rate`, `format`, `start_value`, and `stop_value` may be `None`, which will cause this value to be omitted. @@ -10532,21 +10618,21 @@ the storage for the `Format` of the values, the storage for the start value, or `None` ## `stop_value` the storage for the stop value, or `None` - + Parse an URI query, writing the URI into `uri` as a newly allocated string, if the respective parameters are non-`None`. Free the string with `g_free` after usage. ## `uri` the storage for the current URI (may be `None`) - + Parse an URI query, writing the URI into `uri` as a newly allocated string, if the respective parameters are non-`None`. Free the string with `g_free` after usage. ## `uri` the storage for the redirect URI (may be `None`) - + Parse an URI query, and set `permanent` to `true` if there is a redirection and it should be considered permanent. If a redirection is permanent, applications should update their internal storage of the URI, otherwise @@ -10554,30 +10640,30 @@ they should make all future requests to the original URI. ## `permanent` if the URI redirection is permanent (may be `None`) - + Remove the metadata API at `index` of the metadata API array. ## `index` position in the metadata API array to remove - + Remove the allocation param at `index` of the allocation param array. ## `index` position in the allocation param array to remove - + Remove the allocation pool at `index` of the allocation pool array. ## `index` position in the allocation pool array to remove - + Set `result` as the result for the `self`. ## `result` the result to set - + Set the percentage of buffered data. This is a value between 0 and 100. The `busy` indicator is `true` when the buffering is in progress. ## `busy` if buffering is busy ## `percent` a buffering percent - + Set the available query result fields in `self`. ## `format` the format to set for the `start` and `stop` values @@ -10588,7 +10674,7 @@ the stop to set ## `estimated_total` estimated total amount of download time remaining in milliseconds - + Configures the buffering stats values in `self`. ## `mode` a buffering mode @@ -10598,15 +10684,15 @@ the average input rate the average output rate ## `buffering_left` amount of buffering time left in milliseconds - + Set the `caps` result in `self`. ## `caps` A pointer to the caps - + Answer a context query by setting the requested context. ## `context` the requested `Context` - + Answer a convert query by setting the requested values. ## `src_format` the source `Format` @@ -10616,18 +10702,18 @@ the source value the destination `Format` ## `dest_value` the destination value - + Answer a duration query by setting the requested value in the given format. ## `format` the `Format` for the duration ## `duration` the duration of the stream - + Set the formats query result fields in `self`. The number of formats passed must be equal to `n_formats`. ## `n_formats` the number of formats to set. - + Set the formats query result fields in `self`. The number of formats passed in the `formats` array must be equal to `n_formats`. ## `n_formats` @@ -10635,7 +10721,7 @@ the number of formats to set. ## `formats` an array containing `n_formats` `Format` values. - + Answer a latency query by setting the requested values in the given format. ## `live` if there is a live element upstream @@ -10643,7 +10729,7 @@ if there is a live element upstream the minimal latency of the upstream elements ## `max_latency` the maximal latency of the upstream elements - + Parse an available query and get the allocator and its params at `index` of the allocator array. ## `index` @@ -10652,7 +10738,7 @@ position in the allocator array to set new allocator to set ## `params` parameters for the allocator - + Set the pool parameters in `self`. ## `index` index to modify @@ -10664,13 +10750,13 @@ the size the min buffers ## `max_buffers` the max buffers - + Answer a position query by setting the requested value in the given format. ## `format` the requested `Format` ## `cur` the position to set - + Set the scheduling properties. ## `flags` `SchedulingFlags` @@ -10680,7 +10766,7 @@ the suggested minimum size of pull requests the suggested maximum size of pull requests ## `align` the suggested alignment of pull requests - + Set the seeking query result fields in `self`. ## `format` the format to set for the `segment_start` and `segment_end` values @@ -10690,7 +10776,7 @@ the seekable flag to set the segment_start to set ## `segment_end` the segment_end to set - + Answer a segment query by setting the requested values. The normal playback segment of a pipeline is 0 to duration at the default rate of 1.0. If a seek was performed on the pipeline to play a different @@ -10710,20 +10796,20 @@ the `Format` of the segment values (`start_value` and `stop_value`) the start value ## `stop_value` the stop value - + Answer a URI query by setting the requested URI. ## `uri` the URI to set - + Answer a URI query by setting the requested URI redirection. ## `uri` the URI to set - + Answer a URI query by setting the requested URI redirection to permanent or not. ## `permanent` whether the redirect is permanent or not - + Get the structure of a query. This method should be called with a writable `self` so that the returned structure is guaranteed to be writable. @@ -10789,6 +10875,71 @@ used when the resource can't be opened (Since 1.2.4) the number of resource error types. + +A `Sample` is a small object containing data, a type, timing and +extra arbitrary information. + +Create a new `Sample` with the provided details. + +Free-function: gst_sample_unref +## `buffer` +a `Buffer`, or `None` +## `caps` +a `Caps`, or `None` +## `segment` +a `Segment`, or `None` +## `info` +a `Structure`, or `None` + +# Returns + +the new `Sample`. `gst_sample_unref` + after usage. + +Get the buffer associated with `self` + +# Returns + +the buffer of `self` or `None` + when there is no buffer. The buffer remains valid as long as + `self` is valid. If you need to hold on to it for longer than + that, take a ref to the buffer with `gst_buffer_ref`. + +Get the buffer list associated with `self` + +# Returns + +the buffer list of `self` or `None` + when there is no buffer list. The buffer list remains valid as long as + `self` is valid. If you need to hold on to it for longer than + that, take a ref to the buffer list with gst_mini_object_ref (). + +Get the caps associated with `self` + +# Returns + +the caps of `self` or `None` + when there is no caps. The caps remain valid as long as `self` is + valid. If you need to hold on to the caps for longer than that, + take a ref to the caps with `gst_caps_ref`. + +Get extra information associated with `self`. + +# Returns + +the extra info of `self`. + The info remains valid as long as `self` is valid. + +Get the segment associated with `self` + +# Returns + +the segment of `self`. + The segment remains valid as long as `self` is valid. + +Set the buffer list associated with `self` +## `buffer_list` +a `BufferList` The different types of seek events. When constructing a seek event with `Event::new_seek` or when doing gst_segment_do_seek (). @@ -12377,7 +12528,7 @@ List of tags and values used to describe media metadata. Strings in structures must be ASCII or UTF-8 encoded. Other encodings are not allowed. Strings must not be empty or `None`. - + Creates a new taglist and appends the values for the given tags. It expects tag-value pairs like `TagList::add`, and a `None` terminator after the last pair. The type of the values is implicit and is documented in the API @@ -12398,7 +12549,7 @@ tag a new `TagList`. Free with `gst_tag_list_unref` when no longer needed. - + Creates a new empty GstTagList. Free-function: gst_tag_list_unref @@ -12406,7 +12557,7 @@ Free-function: gst_tag_list_unref # Returns An empty tag list - + Deserializes a tag list. ## `str` a string created with `TagList::to_string` @@ -12415,7 +12566,7 @@ a string created with `TagList::to_string` a new `TagList`, or `None` in case of an error. - + Just like `TagList::new`, only that it takes a va_list argument. Useful mostly for language bindings. @@ -12427,13 +12578,13 @@ tag / value pairs to set a new `TagList`. Free with `gst_tag_list_unref` when no longer needed. - + Sets the values for the given tags using the specified mode. ## `mode` the mode to use ## `tag` tag - + Sets the values for the given tags using the specified mode. ## `mode` the mode to use @@ -12441,7 +12592,7 @@ the mode to use tag ## `var_args` tag / value pairs to set - + Sets the GValues for the given tags using the specified mode. ## `mode` the mode to use @@ -12449,7 +12600,7 @@ the mode to use tag ## `var_args` tag / GValue pairs to set - + Sets the GValue for a given tag using the specified mode. ## `mode` the mode to use @@ -12457,20 +12608,20 @@ the mode to use tag ## `value` GValue for this tag - + Sets the GValues for the given tags using the specified mode. ## `mode` the mode to use ## `tag` tag - + Calls the given function for each tag inside the tag list. Note that if there is no tag, the function won't be called at all. ## `func` function to be called for each tag ## `user_data` user specified data - + Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. ## `tag` @@ -12482,7 +12633,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Gets the value that is at the given index for the given tag in the given list. ## `tag` @@ -12496,7 +12647,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Copies the first date for the given tag in the taglist into the variable pointed to by `value`. Free the date with `glib::Date::free` when it is no longer needed. @@ -12512,7 +12663,7 @@ address of a GDate pointer `true`, if a date was copied, `false` if the tag didn't exist in the given list or if it was `None`. - + Gets the date that is at the given index for the given tag in the given list and copies it into the variable pointed to by `value`. Free the date with `glib::Date::free` when it is no longer needed. @@ -12529,7 +12680,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list or if it was `None`. - + Copies the first datetime for the given tag in the taglist into the variable pointed to by `value`. Unref the date with `DateTime::unref` when it is no longer needed. @@ -12545,7 +12696,7 @@ address of a `DateTime` `true`, if a datetime was copied, `false` if the tag didn't exist in the given list or if it was `None`. - + Gets the datetime that is at the given index for the given tag in the given list and copies it into the variable pointed to by `value`. Unref the datetime with `DateTime::unref` when it is no longer needed. @@ -12562,7 +12713,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list or if it was `None`. - + Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. ## `tag` @@ -12574,7 +12725,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Gets the value that is at the given index for the given tag in the given list. ## `tag` @@ -12588,7 +12739,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. ## `tag` @@ -12600,7 +12751,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Gets the value that is at the given index for the given tag in the given list. ## `tag` @@ -12614,7 +12765,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. ## `tag` @@ -12626,7 +12777,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Gets the value that is at the given index for the given tag in the given list. ## `tag` @@ -12640,7 +12791,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Gets the value that is at the given index for the given tag in the given list. ## `tag` @@ -12654,7 +12805,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. ## `tag` @@ -12666,7 +12817,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Gets the value that is at the given index for the given tag in the given list. ## `tag` @@ -12680,7 +12831,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Copies the first sample for the given tag in the taglist into the variable pointed to by `sample`. Free the sample with `gst_sample_unref` when it is no longer needed. You can retrieve the buffer from the sample using @@ -12698,7 +12849,7 @@ address of a GstSample `true`, if a sample was returned, `false` if the tag didn't exist in the given list or if it was `None`. - + Gets the sample that is at the given index for the given tag in the given list and copies it into the variable pointed to by `sample`. Free the sample with `gst_sample_unref` when it is no longer needed. You can retrieve the @@ -12718,13 +12869,13 @@ address of a GstSample `true`, if a sample was copied, `false` if the tag didn't exist in the given list or if it was `None`. - + Gets the scope of `self`. # Returns The scope of `self` - + Copies the contents for the given tag into the value, possibly merging multiple values into one if multiple values are associated with the tag. @@ -12745,7 +12896,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Gets the value that is at the given index for the given tag in the given list. @@ -12765,7 +12916,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Checks how many value are stored in this tag list for the given tag. ## `tag` the tag to query @@ -12773,7 +12924,7 @@ the tag to query # Returns The number of tags stored - + Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. ## `tag` @@ -12785,7 +12936,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. ## `tag` @@ -12797,7 +12948,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Gets the value that is at the given index for the given tag in the given list. ## `tag` @@ -12811,7 +12962,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Gets the value that is at the given index for the given tag in the given list. ## `tag` @@ -12825,7 +12976,7 @@ location for the result `true`, if a value was copied, `false` if the tag didn't exist in the given list. - + Gets the value that is at the given index for the given tag in the given list. ## `tag` @@ -12838,19 +12989,19 @@ number of entry to read out The GValue for the specified entry or `None` if the tag wasn't available or the tag doesn't have as many entries - + Inserts the tags of the `from` list into the first list using the given mode. ## `from` list to merge from ## `mode` the mode to use - + Checks if the given taglist is empty. # Returns `true` if the taglist is empty, otherwise `false`. - + Checks if the two given taglists are equal. ## `list2` a `TagList`. @@ -12858,7 +13009,7 @@ a `TagList`. # Returns `true` if the taglists are equal, otherwise `false` - + Merges the two given lists into a new list. If one of the lists is `None`, a copy of the other is returned. If both lists are `None`, `None` is returned. @@ -12871,13 +13022,13 @@ the mode to use # Returns the new list - + Get the number of tags in `self`. # Returns The number of tags in `self`. - + Get the name of the tag in `self` at `index`. ## `index` the index @@ -12885,7 +13036,7 @@ the index # Returns The name of the tag at `index`. - + Peeks at the value that is at the given index for the given tag in the given list. @@ -12903,16 +13054,16 @@ location for the result `true`, if a value was set, `false` if the tag didn't exist in the given list. - + Removes the given tag from the taglist. ## `tag` tag to remove - + Sets the scope of `self` to `scope`. By default the scope of a taglist is stream scope. ## `scope` new scope for `self` - + Serializes a tag list to a string. # Returns @@ -12920,7 +13071,7 @@ Serializes a tag list to a string. a newly-allocated string, or `None` in case of an error. The string must be freed with `g_free` when no longer needed. - + Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. @@ -13189,7 +13340,7 @@ alternative type entry) with track entries underneath that node; or even multiple top-level edition nodes (or some other alternative type entries) each with track entries underneath, in case the source file has extracted a track listing from different sources). - + Create a new `Toc` structure. ## `scope` scope of this TOC @@ -13198,11 +13349,11 @@ scope of this TOC newly allocated `Toc` structure, free it with `gst_toc_unref`. - + Appends the `TocEntry` `entry` to `self`. ## `entry` A `TocEntry` - + Find `TocEntry` with given `uid` in the `self`. ## `uid` UID to find `TocEntry` with. @@ -13211,30 +13362,142 @@ UID to find `TocEntry` with. `TocEntry` with specified `uid` from the `self`, or `None` if not found. - + Gets the list of `TocEntry` of `self`. # Returns A `glib::List` of `TocEntry` for `entry` - + # Returns scope of `self` - + Gets the tags for `self`. # Returns A `TagList` for `entry` - + Merge `tags` into the existing tags of `self` using `mode`. ## `tags` A `TagList` or `None` ## `mode` A `TagMergeMode` - + +Set a `TagList` with tags for the complete `self`. +## `tags` +A `TagList` or `None` + + +Create new `TocEntry` structure. +## `type_` +entry type. +## `uid` +unique ID (UID) in the whole TOC. + +# Returns + +newly allocated `TocEntry` structure, free it with `gst_toc_entry_unref`. + +Appends the `TocEntry` `subentry` to `self`. +## `subentry` +A `TocEntry` + + +# Returns + +`self`'s entry type + +Get `loop_type` and `repeat_count` values from the `self` and write them into +appropriate storages. Loops are e.g. used by sampled instruments. GStreamer +is not automatically applying the loop. The application can process this +meta data and use it e.g. to send a seek-event to loop a section. +## `loop_type` +the storage for the loop_type + value, leave `None` if not need. +## `repeat_count` +the storage for the repeat_count + value, leave `None` if not need. + +# Returns + +`true` if all non-`None` storage pointers were filled with appropriate +values, `false` otherwise. + +Gets the parent `TocEntry` of `self`. + +# Returns + +The parent `TocEntry` of `self` + +Get `start` and `stop` values from the `self` and write them into appropriate +storages. +## `start` +the storage for the start value, leave + `None` if not need. +## `stop` +the storage for the stop value, leave + `None` if not need. + +# Returns + +`true` if all non-`None` storage pointers were filled with appropriate +values, `false` otherwise. + +Gets the sub-entries of `self`. + +# Returns + +A `glib::List` of `TocEntry` of `self` + +Gets the tags for `self`. + +# Returns + +A `TagList` for `self` + +Gets the parent `Toc` of `self`. + +# Returns + +The parent `Toc` of `self` + +Gets the UID of `self`. + +# Returns + +The UID of `self` + + +# Returns + +`true` if `self`'s type is an alternative type, otherwise `false` + + +# Returns + +`true` if `self`'s type is a sequence type, otherwise `false` + +Merge `tags` into the existing tags of `self` using `mode`. +## `tags` +A `TagList` or `None` +## `mode` +A `TagMergeMode` + +Set `loop_type` and `repeat_count` values for the `self`. +## `loop_type` +loop_type value to set. +## `repeat_count` +repeat_count value to set. + +Set `start` and `stop` values for the `self`. +## `start` +start value to set. +## `stop` +stop value to set. + Set a `TagList` with tags for the complete `self`. ## `tags` A `TagList` or `None`