* or gst_init_check().
*
* Returns: TRUE if initialization has been done, FALSE otherwise.
- *
- * Since: 0.10.31
*/
gboolean
gst_is_initialized (void)
* wants to install its own handler without GStreamer interfering.
*
* Returns: %TRUE if GStreamer is allowed to install a custom SIGSEGV handler.
- *
- * Since: 0.10.10
*/
gboolean
gst_segtrap_is_enabled (void)
*
* Applications might want to disable/enable the SIGSEGV handling of
* the GStreamer core. See gst_segtrap_is_enabled() for more information.
- *
- * Since: 0.10.10
*/
void
gst_segtrap_set_enabled (gboolean enabled)
*
* The #GstAtomicQueue object implements a queue that can be used from multiple
* threads without performing any blocking operations.
- *
- * Since: 0.10.33
*/
G_DEFINE_BOXED_TYPE (GstAtomicQueue, gst_atomic_queue,
* nearest power of 2 and used as the initial size of the queue.
*
* Returns: a new #GstAtomicQueue
- *
- * Since: 0.10.33
*/
GstAtomicQueue *
gst_atomic_queue_new (guint initial_size)
* @queue: a #GstAtomicQueue
*
* Increase the refcount of @queue.
- *
- * Since: 0.10.33
*/
void
gst_atomic_queue_ref (GstAtomicQueue * queue)
* @queue: a #GstAtomicQueue
*
* Unref @queue and free the memory when the refcount reaches 0.
- *
- * Since: 0.10.33
*/
void
gst_atomic_queue_unref (GstAtomicQueue * queue)
*
* Returns: (transfer none): the head element of @queue or NULL when
* the queue is empty.
- *
- * Since: 0.10.33
*/
gpointer
gst_atomic_queue_peek (GstAtomicQueue * queue)
*
* Returns: (transfer full): the head element of @queue or NULL when
* the queue is empty.
- *
- * Since: 0.10.33
*/
gpointer
gst_atomic_queue_pop (GstAtomicQueue * queue)
* @data: the data
*
* Append @data to the tail of the queue.
- *
- * Since: 0.10.33
*/
void
gst_atomic_queue_push (GstAtomicQueue * queue, gpointer data)
* Get the amount of items in the queue.
*
* Returns: the number of elements in the queue.
- *
- * Since: 0.10.33
*/
guint
gst_atomic_queue_length (GstAtomicQueue * queue)
* Opaque atomic data queue.
*
* Use the acessor functions to get the stored values.
- *
- * Since: 0.10.33
*/
typedef struct _GstAtomicQueue GstAtomicQueue;
* If set to #TRUE, the bin will handle asynchronous state changes.
* This should be used only if the bin subclass is modifying the state
* of its children on its own.
- *
- * Since: 0.10.13
*/
g_object_class_install_property (gobject_class, PROP_ASYNC_HANDLING,
g_param_spec_boolean ("async-handling", "Async Handling",
* Connect to this signal if the default latency calculations are not
* sufficient, like when you need different latencies for different sinks in
* the same pipeline.
- *
- * Since: 0.10.22
*/
gst_bin_signals[DO_LATENCY] =
g_signal_new ("do-latency", G_TYPE_FROM_CLASS (klass),
* source. The structure of the message is named 'GstBinForwarded' and contains
* a field named 'message' of type GST_TYPE_MESSAGE that contains the original
* forwarded message.
- *
- * Since: 0.10.31
*/
g_object_class_install_property (gobject_class, PROP_MESSAGE_FORWARD,
g_param_spec_boolean ("message-forward", "Message Forward",
* calculations will be performed.
*
* Returns: %TRUE if the latency could be queried and reconfigured.
- *
- * Since: 0.10.22.
*/
gboolean
gst_bin_recalculate_latency (GstBin * bin)
void (*handle_message) (GstBin *bin, GstMessage *message);
/*< private >*/
- /* signal added 0.10.22 */
+ /* signal */
gboolean (*do_latency) (GstBin *bin);
/*< private >*/
* @buffer: a #GstBuffer
*
* Tests if the buffer marks a discontinuity in the stream.
- *
- * Since: 0.10.9
*/
#define GST_BUFFER_IS_DISCONT(buffer) (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))
* GstBufferList:
*
* Opaque list of grouped buffers.
- *
- * Since: 0.10.24
*/
struct _GstBufferList
{
*
* Returns: (transfer full): the new #GstBufferList. gst_buffer_list_unref()
* after usage.
- *
- * Since: 0.10.24
*/
GstBufferList *
gst_buffer_list_new_sized (guint size)
*
* Returns: (transfer full): the new #GstBufferList. gst_buffer_list_unref()
* after usage.
- *
- * Since: 0.10.24
*/
GstBufferList *
gst_buffer_list_new (void)
* Returns the number of buffers in @list.
*
* Returns: the number of buffers in the buffer list
- *
- * Since: 0.10.24
*/
guint
gst_buffer_list_length (GstBufferList * list)
* @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.
- *
- * Since: 0.10.24
*/
void
gst_buffer_list_foreach (GstBufferList * list, GstBufferListFunc func,
*
* Returns: (transfer none): the buffer at @idx in @group or NULL when there
* is no buffer. The buffer remains valid as long as @list is valid.
- *
- * Since: 0.10.24
*/
GstBuffer *
gst_buffer_list_get (GstBufferList * list, guint idx)
* the number of memcpy operations in a pipeline.
*
* Returns: (transfer full): @list
- *
- * Since: 0.10.24
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC GstBufferList * gst_buffer_list_ref (GstBufferList * list);
*
* Decreases the refcount of the buffer list. If the refcount reaches 0, the
* buffer list will be freed.
- *
- * Since: 0.10.24
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC void gst_buffer_list_unref (GstBufferList * list);
* refcount of buffers pointed to will be increased by one.
*
* Returns: (transfer full): a new copy of @list.
- *
- * Since: 0.10.24
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC GstBufferList * gst_buffer_list_copy (const GstBufferList * list);
* @list: a #GstBufferList
*
* Tests if you can safely add buffers and groups into a buffer list.
- *
- * Since: 0.10.24
*/
#define gst_buffer_list_is_writable(list) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (list))
*
* Returns: (transfer full): a writable list, which may or may not be the
* same as @list
- *
- * Since: 0.10.24
*/
#define gst_buffer_list_make_writable(list) GST_BUFFER_LIST_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (list)))
gobject_class->set_property = gst_bus_set_property;
gobject_class->constructed = gst_bus_constructed;
- /* GstBus:enable-async:
+ /**
+ * GstBus::enable-async:
*
* Enable async message delivery support for bus watches,
* gst_bus_pop() and similar API. Without this only the
*
* This property is used to create the child element buses
* in #GstBin.
- *
- * Since: 0.10.33
*/
g_object_class_install_property (gobject_class, PROP_ENABLE_ASYNC,
g_param_spec_boolean ("enable-async", "Enable Async",
* with gst_message_unref() after usage.
*
* MT safe.
- *
- * Since: 0.10.15
*/
GstMessage *
gst_bus_timed_pop_filtered (GstBus * bus, GstClockTime timeout,
* gst_message_unref() after usage.
*
* MT safe.
- *
- * Since: 0.10.12
*/
GstMessage *
gst_bus_timed_pop (GstBus * bus, GstClockTime timeout)
* gst_message_unref() after usage.
*
* MT safe.
- *
- * Since: 0.10.15
*/
GstMessage *
gst_bus_pop_filtered (GstBus * bus, GstMessageType types)
* @notify: the function to call when the source is removed.
*
* Adds a bus watch to the default main context with the given @priority (e.g.
- * %G_PRIORITY_DEFAULT). Since 0.10.33 it is also possible to use a non-default
- * main context set up using g_main_context_push_thread_default() (before
+ * %G_PRIORITY_DEFAULT). It is also possible to use a non-default main
+ * context set up using g_main_context_push_thread_default() (before
* one had to create a bus watch source and attach it to the desired main
* context 'manually').
*
* @user_data: user data passed to @func.
*
* Adds a bus watch to the default main context with the default priority
- * (%G_PRIORITY_DEFAULT). Since 0.10.33 it is also possible to use a non-default
- * main context set up using g_main_context_push_thread_default() (before
+ * (%G_PRIORITY_DEFAULT). It is also possible to use a non-default main
+ * context set up using g_main_context_push_thread_default() (before
* one had to create a bus watch source and attach it to the desired main
* context 'manually').
*
* @priority: The priority of the watch.
*
* Adds a bus signal watch to the default main context with the given @priority
- * (e.g. %G_PRIORITY_DEFAULT). Since 0.10.33 it is also possible to use a
- * non-default main context set up using g_main_context_push_thread_default()
+ * (e.g. %G_PRIORITY_DEFAULT). It is also possible to use a non-default main
+ * context set up using g_main_context_push_thread_default()
* (before one had to create a bus watch source and attach it to the desired
* main context 'manually').
*
* @bus: a #GstBus on which you want to receive the "message" signal
*
* Adds a bus signal watch to the default main context with the default priority
- * (%G_PRIORITY_DEFAULT). Since 0.10.33 it is also possible to use a non-default
+ * (%G_PRIORITY_DEFAULT). It is also possible to use a non-default
* main context set up using g_main_context_push_thread_default() (before
* one had to create a bus watch source and attach it to the desired main
* context 'manually').
*
* Returns: (transfer full): a pointer to the #GstStructure corresponding
* to @index.
- *
- * Since: 0.10.30
*/
GstStructure *
gst_caps_steal_structure (GstCaps * caps, guint index)
* If either caps is ANY, the resulting caps will be ANY.
*
* Returns: (transfer full): the merged caps.
- *
- * Since: 0.10.10
*/
GstCaps *
gst_caps_merge (GstCaps * caps1, GstCaps * caps2)
* Sets the given @field on all structures of @caps to the given @value.
* This is a convenience function for calling gst_structure_set_value() on
* all structures of @caps.
- *
- * Since: 0.10.26
**/
void
gst_caps_set_value (GstCaps * caps, const char *field, const GValue * value)
*
* Sets fields in a #GstCaps. The arguments must be passed in the same
* manner as gst_structure_set(), and be NULL-terminated.
- * <note>Prior to GStreamer version 0.10.26, this function failed when
- * @caps was not simple. If your code needs to work with those versions
- * of GStreamer, you may only call this function when GST_CAPS_IS_SIMPLE()
- * is %TRUE for @caps.</note>
*/
void
gst_caps_set_simple_valist (GstCaps * caps, const char *field, va_list varargs)
*
* Sets fields in a #GstCaps. The arguments must be passed in the same
* manner as gst_structure_set(), and be NULL-terminated.
- * <note>Prior to GStreamer version 0.10.26, this function failed when
- * @caps was not simple. If your code needs to work with those versions
- * of GStreamer, you may only call this function when GST_CAPS_IS_SIMPLE()
- * is %TRUE for @caps.</note>
*/
void
gst_caps_set_simple (GstCaps * caps, const char *field, ...)
* for more information.
*
* Returns: %TRUE if @structure is a subset of @caps
- *
- * Since: 0.10.36
*/
gboolean
gst_caps_is_subset_structure (const GstCaps * caps,
* Checks if the given caps are exactly the same set of caps.
*
* Returns: TRUE if both caps are strictly equal.
- *
- * Since: 0.10.36
*/
gboolean
gst_caps_is_strictly_equal (const GstCaps * caps1, const GstCaps * caps2)
* be empty
*
* Returns: %TRUE if intersection would be not empty
- *
- * Since: 0.10.25
*/
gboolean
gst_caps_can_intersect (const GstCaps * caps1, const GstCaps * caps2)
* used.
*
* Returns: the new #GstCaps
- * Since: 0.10.33
*/
GstCaps *
gst_caps_intersect_full (GstCaps * caps1, GstCaps * caps2,
* another element's caps priority order when intersecting with its own caps.
* Example: If caps1 is [A, B, C] and caps2 is [E, B, D, A], the result
* would be [A, B], maintaining the first caps priority on the intersection.
- *
- * Since: 0.10.33
*/
typedef enum {
GST_CAPS_INTERSECT_ZIG_ZAG = 0,
*
* Returns: %TRUE if the GstClockID could be reinitialized to the provided
* @time, else %FALSE.
- *
- * Since: 0.10.32
*/
gboolean
gst_clock_single_shot_id_reinit (GstClock * clock, GstClockID id,
*
* Returns: %TRUE if the GstClockID could be reinitialized to the provided
* @time, else %FALSE.
- *
- * Since: 0.10.33
- *
*/
gboolean
gst_clock_periodic_id_reinit (GstClock * clock, GstClockID id,
* Returns: the result of the non blocking wait.
*
* MT safe.
- *
- * Since: 0.10.30
*/
GstClockReturn
gst_clock_id_wait_async (GstClockID id,
* This function is the reverse of gst_clock_adjust_unlocked().
*
* Returns: the internal time of the clock corresponding to @external.
- *
- * Since: 0.10.13
*/
GstClockTime
gst_clock_unadjust_unlocked (GstClock * clock, GstClockTime external)
* @time: the time
*
* Convert a #GstClockTime to seconds.
- *
- * Since: 0.10.16
*/
#define GST_TIME_AS_SECONDS(time) ((time) / GST_SECOND)
/**
* @time: the time
*
* Convert a #GstClockTime to milliseconds (1/1000 of a second).
- *
- * Since: 0.10.16
*/
#define GST_TIME_AS_MSECONDS(time) ((time) / G_GINT64_CONSTANT (1000000))
/**
* @time: the time
*
* Convert a #GstClockTime to microseconds (1/1000000 of a second).
- *
- * Since: 0.10.16
*/
#define GST_TIME_AS_USECONDS(time) ((time) / G_GINT64_CONSTANT (1000))
/**
* @time: the time
*
* Convert a #GstClockTime to nanoseconds (1/1000000000 of a second).
- *
- * Since: 0.10.16
*/
#define GST_TIME_AS_NSECONDS(time) (time)
* @GST_CLOCK_BADTIME: A bad time was provided to a function.
* @GST_CLOCK_ERROR: An error occurred
* @GST_CLOCK_UNSUPPORTED: Operation is not supported
- * @GST_CLOCK_DONE: The ClockID is done waiting (Since: 0.10.32)
+ * @GST_CLOCK_DONE: The ClockID is done waiting
*
* The return value of a clock operation.
*/
*
* printf format type used to debug GStreamer segments.
* This can only be used on pointers to GstSegment structures.
- *
- * Since: 0.10.10
*/
@GST_PRINTF_EXTENSION_SEGMENT_FORMAT_DEFINE@
* Date information is handled using the proleptic Gregorian calendar.
*
* Provides basic creation functions and accessor functions to its fields.
- *
- * Since: 0.10.31
*/
typedef enum
* Call gst_date_time_has_year before, to avoid warnings.
*
* Return value: The year of this #GstDateTime
- * Since: 0.10.31
*/
gint
gst_date_time_get_year (const GstDateTime * datetime)
* Call gst_date_time_has_month before, to avoid warnings.
*
* Return value: The month of this #GstDateTime
- * Since: 0.10.31
*/
gint
gst_date_time_get_month (const GstDateTime * datetime)
* Call gst_date_time_has_day before, to avoid warnings.
*
* Return value: The day of this #GstDateTime
- * Since: 0.10.31
*/
gint
gst_date_time_get_day (const GstDateTime * datetime)
* Call gst_date_time_has_haur before, to avoid warnings.
*
* Return value: the hour of the day
- *
- * Since: 0.10.31
*/
gint
gst_date_time_get_hour (const GstDateTime * datetime)
* Call gst_date_time_has_minute before, to avoid warnings.
*
* Return value: the minute of the hour
- *
- * Since: 0.10.31
*/
gint
gst_date_time_get_minute (const GstDateTime * datetime)
* Call gst_date_time_has_second before, to avoid warnings.
*
* Return value: the second represented by @datetime
- *
- * Since: 0.10.31
*/
gint
gst_date_time_get_second (const GstDateTime * datetime)
* @datetime in the gregorian calendar.
*
* Return value: the microsecond of the second
- *
- * Since: 0.10.31
*/
gint
gst_date_time_get_microsecond (const GstDateTime * datetime)
* If @datetime represents UTC time, then the offset is zero.
*
* Return value: the offset from UTC in hours
- * Since: 0.10.31
*/
gfloat
gst_date_time_get_time_zone_offset (const GstDateTime * datetime)
* Free-function: gst_date_time_unref
*
* Return value: (transfer full): the newly created #GstDateTime
- *
- * Since:
*/
GstDateTime *
gst_date_time_new_y (gint year)
* Free-function: gst_date_time_unref
*
* Return value: (transfer full): the newly created #GstDateTime
- *
- * Since:
*/
GstDateTime *
gst_date_time_new_ym (gint year, gint month)
* Free-function: gst_date_time_unref
*
* Return value: (transfer full): the newly created #GstDateTime
- *
- * Since:
*/
GstDateTime *
gst_date_time_new_ymd (gint year, gint month, gint day)
* Free-function: gst_date_time_unref
*
* Return value: (transfer full): the newly created #GstDateTime
- *
- * Since: 0.10.31
*/
GstDateTime *
gst_date_time_new_from_unix_epoch_local_time (gint64 secs)
* Free-function: gst_date_time_unref
*
* Return value: (transfer full): the newly created #GstDateTime
- *
- * Since: 0.10.31
*/
GstDateTime *
gst_date_time_new_from_unix_epoch_utc (gint64 secs)
* Free-function: gst_date_time_unref
*
* Return value: (transfer full): the newly created #GstDateTime
- *
- * Since: 0.10.31
*/
GstDateTime *
gst_date_time_new_local_time (gint year, gint month, gint day, gint hour,
*
* Return value: (transfer full): the newly created #GstDateTime which should
* be freed with gst_date_time_unref().
- *
- * Since: 0.10.31
*/
GstDateTime *
gst_date_time_new_now_local_time (void)
*
* Return value: (transfer full): the newly created #GstDateTime which should
* be freed with gst_date_time_unref().
- *
- * Since: 0.10.31
*/
GstDateTime *
gst_date_time_new_now_utc (void)
* Free-function: gst_date_time_unref
*
* Return value: (transfer full): the newly created #GstDateTime
- *
- * Since: 0.10.31
*/
GstDateTime *
gst_date_time_new (gfloat tzoffset, gint year, gint month, gint day, gint hour,
* Atomically increments the reference count of @datetime by one.
*
* Return value: (transfer full): the reference @datetime
- *
- * Since: 0.10.31
*/
GstDateTime *
gst_date_time_ref (GstDateTime * datetime)
*
* Atomically decrements the reference count of @datetime by one. When the
* reference count reaches zero, the structure is freed.
- *
- * Since: 0.10.31
*/
void
gst_date_time_unref (GstDateTime * datetime)
*
* Available details for pipeline graphs produced by GST_DEBUG_BIN_TO_DOT_FILE()
* and GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS().
- *
- * Since: 0.10.15
*/
typedef enum {
GST_DEBUG_GRAPH_SHOW_MEDIA_TYPE = (1<<0),
* The macro is only active if gstreamer is configured with
* "--gst-enable-gst-debug" and the environment variable
* GST_DEBUG_DUMP_DOT_DIR is set to a basepath (e.g. /tmp).
- *
- * Since: 0.10.15
*/
#define GST_DEBUG_BIN_TO_DOT_FILE(bin, details, file_name) gst_debug_bin_to_dot_file (bin, details, file_name)
*
* This works like GST_DEBUG_BIN_TO_DOT_FILE(), but adds the current timestamp
* to the filename, so that it can be used to take multiple snapshots.
- *
- * Since: 0.10.15
*/
#define GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS(bin, details, file_name) gst_debug_bin_to_dot_file_with_ts (bin, details, file_name)
* pipelines, and you can also ensure that the pipelines have the same clock.
*
* MT safe.
- *
- * Since: 0.10.24
*/
void
gst_element_set_start_time (GstElement * element, GstClockTime time)
* MT safe.
*
* Returns: the start time of the element.
- *
- * Since: 0.10.24
*/
GstClockTime
gst_element_get_start_time (GstElement * element)
*
* Returns: (transfer full): requested #GstPad if found, otherwise %NULL.
* Release after usage.
- *
- * Since: 0.10.32
*/
GstPad *
gst_element_request_pad (GstElement * element,
* @elem: a #GstElement to return the target state for.
*
* This macro returns the target #GstState of the element.
- *
- * Since: 0.10.13
*/
#define GST_STATE_TARGET(elem) (GST_ELEMENT_CAST(elem)->target_state)
* GstElementFlags:
* @GST_ELEMENT_FLAG_LOCKED_STATE: ignore state changes from parent
* @GST_ELEMENT_FLAG_SINK: the element is a sink
- * @GST_ELEMENT_FLAG_SOURCE: the element is a source. Since 0.10.31
+ * @GST_ELEMENT_FLAG_SOURCE: the element is a source.
* @GST_ELEMENT_FLAG_PROVIDE_CLOCK: the element can provide a clock
* @GST_ELEMENT_FLAG_REQUIRE_CLOCK: the element requires a clock
* @GST_ELEMENT_FLAG_INDEXABLE: the element can use an index
*
* This macro returns the start_time of the @elem. The start_time is the
* running_time of the pipeline when the element went to PAUSED.
- *
- * Since: 0.10.24
*/
#define GST_ELEMENT_START_TIME(elem) (GST_ELEMENT_CAST(elem)->start_time)
* the application of something noteworthy that is not an error.
* The pipeline will post a info message and the
* application will be informed.
- *
- * Since: 0.10.12
*/
#define GST_ELEMENT_INFO(el, domain, code, text, debug) \
G_STMT_START { \
/**
* gst_element_register:
* @plugin: (allow-none): #GstPlugin to register the element with, or NULL for
- * a static element (note that passing NULL only works in GStreamer 0.10.13
- * and later)
+ * a static element.
* @name: name of elements of this type
* @rank: rank of element (higher rank means more importance when autoplugging)
* @type: GType of element to register
* Check if @factory implements the interface with name @interfacename.
*
* Returns: #TRUE when @factory implement the interface.
- *
- * Since: 0.10.14
*/
gboolean
gst_element_factory_has_interface (GstElementFactory * factory,
* Check if @factory is of the given types.
*
* Returns: %TRUE if @factory is of @type.
- *
- * Since: 0.10.31
*/
gboolean
gst_element_factory_list_is_type (GstElementFactory * factory,
* Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
* #GstElementFactory elements. Use gst_plugin_feature_list_free() after
* usage.
- *
- * Since: 0.10.31
*/
GList *
gst_element_factory_list_get_elements (GstElementFactoryListType type,
* Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
* #GstElementFactory elements that match the given requisits.
* Use #gst_plugin_feature_list_free after usage.
- *
- * Since: 0.10.31
*/
GList *
gst_element_factory_list_filter (GList * list,
*
* If one or more of the MEDIA types are specified, then only elements
* matching the specified media types will be selected.
- *
- * Since: 0.10.31
*/
typedef guint64 GstElementFactoryListType;
*
* Elements of any of the defined GST_ELEMENT_FACTORY_LIST types
*
- * Since: 0.10.31
- *
* Value: 562949953421311
* Type: GstElementFactoryListType
*/
* media types. If you wish to do this, simply don't specify any
* GST_ELEMENT_FACTORY_TYPE_MEDIA flag.
*
- * Since: 0.10.31
- *
* Value: 18446462598732840960
* Type: GstElementFactoryListType
*/
*
* All encoders handling video or image media types
*
- * Since: 0.10.31
- *
* Value: 2814749767106562
* Type: GstElementFactoryListType
*/
*
* All encoders handling audio media types
*
- * Since: 0.10.31
- *
* Value: 1125899906842626
* Type: GstElementFactoryListType
*/
*
* All sinks handling audio, video or image media types
*
- * Since: 0.10.31
- *
* Value: 3940649673949188
* Type: GstElementFactoryListType
*/
*
* All elements used to 'decode' streams (decoders, demuxers, parsers, depayloaders)
*
- * Since: 0.10.31
- *
* Value: 353
* Type: GstElementFactoryListType
*/
* @GST_CORE_ERROR_MISSING_PLUGIN: used if a plugin is missing.
* @GST_CORE_ERROR_CLOCK: used for clock related errors.
* @GST_CORE_ERROR_DISABLED: used if functionality has been disabled at
- * compile time (Since: 0.10.13).
+ * compile time.
* @GST_CORE_ERROR_NUM_ERRORS: the number of core error types.
*
* Core errors are errors inside the core GStreamer library.
* @GST_STREAM_ERROR_FORMAT: used when the stream is of the wrong format
* (for example, wrong caps).
* @GST_STREAM_ERROR_DECRYPT: used when the stream is encrypted and can't be
- * decrypted because this is not supported by the element. (Since: 0.10.20)
+ * decrypted because this is not supported by the element.
* @GST_STREAM_ERROR_DECRYPT_NOKEY: used when the stream is encrypted and
- * can't be decrypted because no suitable key is available. (Since: 0.10.20)
+ * can't be decrypted because no suitable key is available.
* @GST_STREAM_ERROR_NUM_ERRORS: the number of stream error types.
*
* Stream errors are for anything related to the stream being processed:
* check the name of a custom event.
*
* Returns: %TRUE if @name matches the name of the event structure.
- *
- * Since: 0.10.20
*/
gboolean
gst_event_has_name (GstEvent * event, const gchar * name)
* Returns: The event's sequence number.
*
* MT safe.
- *
- * Since: 0.10.22
*/
guint32
gst_event_get_seqnum (GstEvent * event)
* more information.
*
* MT safe.
- *
- * Since: 0.10.22
*/
void
gst_event_set_seqnum (GstEvent * event, guint32 seqnum)
* the time format.
*
* Returns: (transfer full): a new #GstEvent
- *
- * Since: 0.10.12
*/
GstEvent *
gst_event_new_latency (GstClockTime latency)
* @latency: (out): A pointer to store the latency in.
*
* Get the latency in the latency event.
- *
- * Since: 0.10.12
*/
void
gst_event_parse_latency (GstEvent * event, GstClockTime * latency)
* part of a larger step operation.
*
* Returns: (transfer full): a new #GstEvent
- *
- * Since: 0.10.24
*/
GstEvent *
gst_event_new_step (GstFormat format, guint64 amount, gdouble rate,
* boolean in
*
* Parse the step event.
- *
- * Since: 0.10.24
*/
void
gst_event_parse_step (GstEvent * event, GstFormat * format, guint64 * amount,
* or changing the topology of the pipeline.
*
* Returns: (transfer full): a new #GstEvent
- *
- * Since: 0.11.0
*/
GstEvent *
gst_event_new_reconfigure (void)
* @name is used to store multiple sticky events on one pad.
*
* Returns: (transfer full): a new #GstEvent
- *
- * Since: 0.10.26
*/
/* FIXME 0.11: take ownership of msg for consistency? */
GstEvent *
* @msg: (out) (transfer full): a pointer to store the #GstMessage in.
*
* Parse the sink-message event. Unref @msg after usage.
- *
- * Since: 0.10.26
*/
void
gst_event_parse_sink_message (GstEvent * event, GstMessage ** msg)
* inform elements that some kind of the TOC was found.
*
* Returns: (transfer full): a new #GstEvent.
- *
- * Since: 0.10.37
*/
GstEvent *
gst_event_new_toc (GstToc * toc, gboolean updated)
* @updated: (out): pointer to store TOC updated flag.
*
* Parse a TOC @event and store the results in the given @toc and @updated locations.
- *
- * Since: 0.10.37
*/
void
gst_event_parse_toc (GstEvent * event, GstToc ** toc, gboolean * updated)
* given @uid.
*
* Returns: a new #GstEvent.
- *
- * Since: 0.10.37
*/
GstEvent *
gst_event_new_toc_select (const gchar * uid)
* @uid: (out): storage for the selection UID.
*
* Parse a TOC select @event and store the results in the given @uid location.
- *
- * Since: 0.10.37
*/
void
gst_event_parse_toc_select (GstEvent * event, gchar ** uid)
* finish playback of a segment as a result of a segment seek.
*
* Returns: (transfer full): a new #GstEvent
- *
- * Since: 0.11.0
*/
GstEvent *
gst_event_new_segment_done (GstFormat format, gint64 position)
* @GST_EVENT_SINK_MESSAGE: An event that sinks turn into a message. Used to
* send messages that should be emitted in sync with
* rendering.
- * Since: 0.10.26
* @GST_EVENT_EOS: End-Of-Stream. No more data is to be expected to follow
* without a SEGMENT event.
* @GST_EVENT_SEGMENT_DONE: Marks the end of a segment playback.
* @GST_EVENT_GAP: Marks a gap in the datastream.
* @GST_EVENT_TOC: An event which indicates that a new table of contents (TOC)
- * was found or updated. Since: 0.10.37
+ * was found or updated.
* @GST_EVENT_QOS: A quality message. Used to indicate to upstream elements
* that the downstream elements should adjust their processing
* rate.
* to upstream elements.
* @GST_EVENT_LATENCY: Notification of new latency adjustment. Sinks will use
* the latency information to adjust their synchronisation.
- * Since: 0.10.12
* @GST_EVENT_STEP: A request for stepping through the media. Sinks will usually
- * execute the step operation. Since: 0.10.24
+ * execute the step operation.
* @GST_EVENT_RECONFIGURE: A request for upstream renegotiating caps and reconfiguring.
- * Since: 0.11.0
* @GST_EVENT_TOC_SELECT: A request for a new playback position based on TOC
- * entry's UID. Since 0.10.37
+ * entry's UID.
* @GST_EVENT_CUSTOM_UPSTREAM: Upstream custom event
* @GST_EVENT_CUSTOM_DOWNSTREAM: Downstream custom event that travels in the
* data flow.
*
* The different types of QoS events that can be given to the
* gst_event_new_qos() method.
- *
- * Since: 0.10.33
*/
typedef enum {
GST_QOS_TYPE_OVERFLOW = 0,
* Invoke the default event of the proxy pad.
*
* Returns: TRUE if the event was handled.
- *
- * Since: 0.10.36
*/
gboolean
gst_proxy_pad_event_default (GstPad * pad, GstObject * parent, GstEvent * event)
* Invoke the default query function of the proxy pad.
*
* Returns: TRUE if the query could be performed.
- *
- * Since: 0.10.36
*/
gboolean
gst_proxy_pad_query_default (GstPad * pad, GstObject * parent, GstQuery * query)
*
* Returns: a #GstIterator of #GstPad, or NULL if @pad has no parent. Unref each
* returned pad with gst_object_unref().
- *
- * Since: 0.10.36
*/
GstIterator *
gst_proxy_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent)
* Invoke the default chain function of the proxy pad.
*
* Returns: a #GstFlowReturn from the pad.
- *
- * Since: 0.10.36
*/
GstFlowReturn
gst_proxy_pad_chain_default (GstPad * pad, GstObject * parent,
* Invoke the default chain list function of the proxy pad.
*
* Returns: a #GstFlowReturn from the pad.
- *
- * Since: 0.10.36
*/
GstFlowReturn
gst_proxy_pad_chain_list_default (GstPad * pad, GstObject * parent,
* Invoke the default getrange function of the proxy pad.
*
* Returns: a #GstFlowReturn from the pad.
- *
- * Since: 0.10.36
*/
GstFlowReturn
gst_proxy_pad_getrange_default (GstPad * pad, GstObject * parent,
*
* Returns: (transfer full): the target #GstProxyPad, can be NULL.
* Unref target pad after usage.
- *
- * Since: 0.10.36
*/
GstProxyPad *
gst_proxy_pad_get_internal (GstProxyPad * pad)
* @pad: a #GstPad to unlink
*
* Invoke the default unlink function of the proxy pad.
- *
- * Since: 0.10.36
*/
void
gst_proxy_pad_unlink_default (GstPad * pad)
* Invoke the default link function of a ghost pad.
*
* Returns: #GstPadLinkReturn of the operation
- *
- * Since: 0.10.36
*/
GstPadLinkReturn
gst_ghost_pad_link_default (GstPad * pad, GstPad * peer)
* @pad: the #GstPad to link.
*
* Invoke the default unlink function of a ghost pad.
- *
- * Since: 0.10.36
*/
void
gst_ghost_pad_unlink_default (GstPad * pad)
* (GST_TYPE_GHOST_PAD, "direction", @dir, ..., NULL).
*
* Returns: %TRUE if the construction succeeds, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
gboolean
gst_ghost_pad_construct (GstGhostPad * gpad)
* Will ref the target.
*
* Returns: (transfer full): a new #GstPad, or NULL in case of an error.
- *
- * Since: 0.10.10
*/
GstPad *
* direction will be taken from the @templ.
*
* Returns: (transfer full): a new #GstPad, or NULL in case of an error.
- *
- * Since: 0.10.10
*/
GstPad *
gst_ghost_pad_new_no_target_from_template (const gchar * name,
* This function returns 0 on non-windows machines.
*
* Returns: an integer containing the color definition
- *
- * Since: 0.10.23
*/
gint
gst_debug_construct_win_color (guint colorinfo)
* in the executed code path is not fully implemented or handled yet. Note
* that this does not replace proper error handling in any way, the purpose
* of this message is to make it easier to spot incomplete/unfinished pieces
- * of code when reading the debug log. (Since: 0.10.23)
+ * of code when reading the debug log.
* @GST_LEVEL_INFO: Informational messages should be used to keep the developer
* updated about what is happening.
* Examples where this should be used are when a typefind function has
* should never output anything else but LOG messages. Use this log level to
* log recurring information in chain functions and loop functions, for
* example.
- * @GST_LEVEL_TRACE: Tracing-related messages (Since: 0.10.30)
+ * @GST_LEVEL_TRACE: Tracing-related messages.
* Examples for this are referencing/dereferencing of objects.
* @GST_LEVEL_MEMDUMP: memory dump messages are used to log (small) chunks of
* data as memory dumps in the log. They will be displayed as hexdump with
- * ASCII characters. (Since: 0.10.23)
+ * ASCII characters.
* @GST_LEVEL_COUNT: The number of defined debugging levels.
*
* The level defines the importance of a debugging message. The more important a
* GST_DEBUG_CATEGORY_INIT (gst_myplugin_debug, "myplugin", 0, "nice element");
* GST_DEBUG_CATEGORY_GET (GST_CAT_PERFORMANCE, "GST_PERFORMANCE");
* ]|
- *
- * Since: 0.10.24
*/
#ifdef GST_CAT_DEFAULT
#define GST_DEBUG_CATEGORY_GET(cat,name) G_STMT_START{\
/* this symbol may not be used */
GST_EXPORT gboolean _gst_debug_enabled;
-/* since 0.10.7, the min debug level, used for quickly discarding debug
+/* the min debug level, used for quickly discarding debug
* messages that fall under the threshold. */
GST_EXPORT GstDebugLevel _gst_debug_min;
* @...: printf-style message to output
*
* Output a fixme message belonging to the given object in the given category.
- *
- * Since: 0.10.23
*/
/**
* GST_CAT_TRACE_OBJECT:
*
* Output a tracing message belonging to the given object in the given
* category.
- *
- * Since: 0.10.30
*/
/**
* GST_CAT_MEMDUMP_OBJECT:
*
* Output a hexdump of @data relating to the given object in the given
* category.
- *
- * Since: 0.10.23
*/
* @...: printf-style message to output
*
* Output an fixme message in the given category.
- *
- * Since: 0.10.23
*/
/**
* GST_CAT_TRACE:
* @...: printf-style message to output
*
* Output a tracing message in the given category.
- *
- * Since: 0.10.30
*/
/**
* GST_CAT_MEMDUMP:
* @length: length of the data to output
*
* Output a hexdump of @data in the given category.
- *
- * Since: 0.10.23
*/
* @...: printf-style message to output
*
* Output a fixme message belonging to the given object in the default category.
- *
- * Since: 0.10.23
*/
/**
* GST_TRACE_OBJECT:
* @...: printf-style message to output
*
* Output a tracing message belonging to the given object in the default category.
- *
- * Since: 0.10.30
*/
/**
* GST_MEMDUMP_OBJECT:
* @length: length of the data to output
*
* Output a logging message belonging to the given object in the default category.
- *
- * Since: 0.10.23
*/
* @...: printf-style message to output
*
* Output a fixme message in the default category.
- *
- * Since: 0.10.23
*/
/**
* GST_TRACE:
* @...: printf-style message to output
*
* Output a tracing message in the default category.
- *
- * Since: 0.10.30
*/
/**
* GST_MEMDUMP:
* @length: length of the data to output
*
* Output a hexdump of @data.
- *
- * Since: 0.10.23
*/
#ifdef G_HAVE_ISO_VARARGS
* GST_DEBUG_FUNCPTR_NAME().
*
* Use this variant of #GST_DEBUG_FUNCPTR if you do not need to use @ptr.
- *
- * Since: 0.10.26
*/
#define GST_DEBUG_REGISTER_FUNCPTR(ptr) \
_gst_debug_register_funcptr((GstDebugFuncPtr)(ptr), #ptr)
* for the #GstPadIterIntLinkFunction.
*
* Returns: the new #GstIterator for @object.
- *
- * Since: 0.10.25
*/
GstIterator *
gst_iterator_new_single (GType type, const GValue * object)
* Returns: The message's sequence number.
*
* MT safe.
- *
- * Since: 0.10.22
*/
guint32
gst_message_get_seqnum (GstMessage * message)
* for more information.
*
* MT safe.
- *
- * Since: 0.10.22
*/
void
gst_message_set_seqnum (GstMessage * message, guint32 seqnum)
* MT safe.
*
* Returns: (transfer full): the new info message.
- *
- * Since: 0.10.12
*/
GstMessage *
gst_message_new_info (GstObject * src, GError * error, const gchar * debug)
* MT safe.
*
* Returns: (transfer full): The new buffering message.
- *
- * Since: 0.10.11
*/
GstMessage *
gst_message_new_buffering (GstObject * src, gint percent)
* Returns: (transfer full): the new structure change message.
*
* MT safe.
- *
- * Since: 0.10.22.
*/
GstMessage *
gst_message_new_structure_change (GstObject * src, GstStructureChangeType type,
* Returns: (transfer full): The new latency message.
*
* MT safe.
- *
- * Since: 0.10.12
*/
GstMessage *
gst_message_new_latency (GstObject * src)
* Returns: (transfer full): the new requst state message.
*
* MT safe.
- *
- * Since: 0.10.23
*/
GstMessage *
gst_message_new_request_state (GstObject * src, GstState state)
* check the name of a custom message.
*
* Returns: %TRUE if @name matches the name of the message structure.
- *
- * Since: 0.10.20
*/
gboolean
gst_message_has_name (GstMessage * message, const gchar * name)
* gst_message_new_buffering().
*
* MT safe.
- *
- * Since: 0.10.11
*/
void
gst_message_parse_buffering (GstMessage * message, gint * percent)
* @buffering_left: amount of buffering time left in milliseconds
*
* Configures the buffering stats values in @message.
- *
- * Since: 0.10.20
*/
void
gst_message_set_buffering_stats (GstMessage * message, GstBufferingMode mode,
* milliseconds, or NULL
*
* Extracts the buffering stats values from @message.
- *
- * Since: 0.10.20
*/
void
gst_message_parse_buffering_stats (GstMessage * message,
* Extracts the change type and completion status from the GstMessage.
*
* MT safe.
- *
- * Since: 0.10.22
*/
void
gst_message_parse_structure_change (GstMessage * message,
* in the output arguments are copies; the caller must free them when done.
*
* MT safe.
- *
- * Since: 0.10.12
*/
void
gst_message_parse_info (GstMessage * message, GError ** gerror, gchar ** debug)
* Extract the requested state from the request_state message.
*
* MT safe.
- *
- * Since: 0.10.23
*/
void
gst_message_parse_request_state (GstMessage * message, GstState * state)
* Returns: (transfer full): the new stream status message.
*
* MT safe.
- *
- * Since: 0.10.24.
*/
GstMessage *
gst_message_new_stream_status (GstObject * src, GstStreamStatusType type,
* should thus not be unreffed.
*
* MT safe.
- *
- * Since: 0.10.24.
*/
void
gst_message_parse_stream_status (GstMessage * message,
*
* Configures the object handling the streaming thread. This is usually a
* GstTask object but other objects might be added in the future.
- *
- * Since: 0.10.24
*/
void
gst_message_set_stream_status_object (GstMessage * message,
* Returns: 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 @message is valid.
- *
- * Since: 0.10.24
*/
const GValue *
gst_message_get_stream_status_object (GstMessage * message)
* Returns: (transfer full): the new step_done message.
*
* MT safe.
- *
- * Since: 0.10.24
*/
GstMessage *
gst_message_new_step_done (GstObject * src, GstFormat format, guint64 amount,
* Extract the values the step_done message.
*
* MT safe.
- *
- * Since: 0.10.24
*/
void
gst_message_parse_step_done (GstMessage * message, GstFormat * format,
* Returns: (transfer full): The new step_start message.
*
* MT safe.
- *
- * Since: 0.10.24
*/
GstMessage *
gst_message_new_step_start (GstObject * src, gboolean active, GstFormat format,
* Extract the values from step_start message.
*
* MT safe.
- *
- * Since: 0.10.24
*/
void
gst_message_parse_step_start (GstMessage * message, gboolean * active,
* Returns: (transfer full): The new qos message.
*
* MT safe.
- *
- * Since: 0.10.29
*/
GstMessage *
gst_message_new_qos (GstObject * src, gboolean live, guint64 running_time,
* Set the QoS values that have been calculated/analysed from the QoS data
*
* MT safe.
- *
- * Since: 0.10.29
*/
void
gst_message_set_qos_values (GstMessage * message, gint64 jitter,
* invalid. Values of -1 for either @processed or @dropped mean unknown values.
*
* MT safe.
- *
- * Since: 0.10.29
*/
void
gst_message_set_qos_stats (GstMessage * message, GstFormat format,
* values.
*
* MT safe.
- *
- * Since: 0.10.29
*/
void
gst_message_parse_qos (GstMessage * message, gboolean * live,
* Extract the QoS values that have been calculated/analysed from the QoS data
*
* MT safe.
- *
- * Since: 0.10.29
*/
void
gst_message_parse_qos_values (GstMessage * message, gint64 * jitter,
* invalid. Values of -1 for either @processed or @dropped mean unknown values.
*
* MT safe.
- *
- * Since: 0.10.29
*/
void
gst_message_parse_qos_stats (GstMessage * message, GstFormat * format,
* @test should contain a user visible string detailing the current action.
*
* Returns: (transfer full): The new qos message.
- *
- * Since: 0.10.33
*/
GstMessage *
gst_message_new_progress (GstObject * src, GstProgressType type,
* @text: (out) (allow-none) (transfer full): location for the text
*
* Parses the progress @type, @code and @text.
- *
- * Since: 0.10.33
*/
void
gst_message_parse_progress (GstMessage * message, GstProgressType * type,
* Returns: (transfer full): a new TOC message.
*
* MT safe.
- *
- * Since: 0.10.37
*/
GstMessage *
gst_message_new_toc (GstObject * src, GstToc * toc, gboolean updated)
* gst_toc_unref() when done.
*
* MT safe.
- *
- * Since: 0.10.37
*/
void
gst_message_parse_toc (GstMessage * message, GstToc ** toc, gboolean * updated)
* can get the new duration with a duration query.
* @GST_MESSAGE_ASYNC_START: Posted by elements when they start an ASYNC
* #GstStateChange. This message is not forwarded to the application but is used
- * internally. Since: 0.10.13.
+ * internally.
* @GST_MESSAGE_ASYNC_DONE: Posted by elements when they complete an ASYNC
* #GstStateChange. The application will only receive this message from the toplevel
- * pipeline. Since: 0.10.13
+ * pipeline.
* @GST_MESSAGE_LATENCY: Posted by elements when their latency changes. The
- * application should recalculate and distribute a new latency. Since: 0.10.12
+ * application should recalculate and distribute a new latency.
* @GST_MESSAGE_REQUEST_STATE: Posted by elements when they want the pipeline to
* change state. This message is a suggestion to the application which can
- * decide to perform the state change on (part of) the pipeline. Since: 0.10.23.
- * @GST_MESSAGE_STEP_START: A stepping operation was started. Since: 0.10.24
+ * decide to perform the state change on (part of) the pipeline.
+ * @GST_MESSAGE_STEP_START: A stepping operation was started.
* @GST_MESSAGE_QOS: A buffer was dropped or an element changed its processing
- * strategy for Quality of Service reasons. Since: 0.10.29
- * @GST_MESSAGE_PROGRESS: A progress message. Since: 0.10.33
+ * strategy for Quality of Service reasons.
+ * @GST_MESSAGE_PROGRESS: A progress message.
* @GST_MESSAGE_TOC: A new table of contents (TOC) was found or previously found TOC
- * was updated. Since: 0.10.37
+ * was updated. Since:
* @GST_MESSAGE_ANY: mask for all of the above messages.
*
* The different message types that are available.
* @message: a #GstMessage
*
* Get a constant string representation of the #GstMessageType of @message.
- *
- * Since: 0.10.4
*/
#define GST_MESSAGE_TYPE_NAME(message) gst_message_type_get_name(GST_MESSAGE_TYPE(message))
/**
*
* Get the name of the object that posted @message. Returns "(NULL)" if
* the message has no source object set.
- *
- * Since: 0.10.24
*/
#define GST_MESSAGE_SRC_NAME(message) (GST_MESSAGE_SRC(message) ? \
GST_OBJECT_NAME (GST_MESSAGE_SRC(message)) : "(NULL)")
* @GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK: Pad unlinking is starting or done.
*
* The type of a %GST_MESSAGE_STRUCTURE_CHANGE.
- *
- * Since: 0.10.22
*/
typedef enum {
GST_STRUCTURE_CHANGE_TYPE_PAD_LINK = 0,
*
* The type of a %GST_MESSAGE_STREAM_STATUS. The stream status messages inform the
* application of new streaming threads and their status.
- *
- * Since: 0.10.24
*/
typedef enum {
GST_STREAM_STATUS_TYPE_CREATE = 0,
*
* The type of a %GST_MESSAGE_PROGRESS. The progress messages inform the
* application of the status of assynchronous tasks.
- *
- * Since: 0.10.33
*/
typedef enum {
GST_PROGRESS_TYPE_START = 0,
* to the mini object without calling gst_mini_object_ref()
* (gst_mini_object_ref() adds a strong reference, that is, forces the object
* to stay alive).
- *
- * Since: 0.10.35
*/
void
gst_mini_object_weak_ref (GstMiniObject * object,
* @data: data to search for
*
* Removes a weak reference callback from a mini object.
- *
- * Since: 0.10.35
*/
void
gst_mini_object_weak_unref (GstMiniObject * object,
* Returns: TRUE if the pad is blocking.
*
* MT safe.
- *
- * Since: 0.10.11
*/
gboolean
gst_pad_is_blocking (GstPad * pad)
* Sets the given chain list function for the pad. The chainlist function is
* called to process a #GstBufferList input buffer list. See
* #GstPadChainListFunction for more details.
- *
- * Since: 0.10.24
*/
void
gst_pad_set_chain_list_function_full (GstPad * pad,
* @notify: notify called when @iterintlink will not be used anymore.
*
* Sets the given internal link iterator function for the pad.
- *
- * Since: 0.10.21
*/
void
gst_pad_set_iterate_internal_links_function_full (GstPad * pad,
*
* Returns: A result code indicating if the connection worked or
* what went wrong.
- *
- * Since: 0.10.30
*/
GstPadLinkReturn
gst_pad_link_full (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
*
* Returns: a #GstIterator of #GstPad, or NULL if @pad has no parent. Unref each
* returned pad with gst_object_unref().
- *
- * Since: 0.10.21
*/
GstIterator *
gst_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent)
* Returns: (transfer full): a new #GstIterator of #GstPad or %NULL when the
* pad does not have an iterator function configured. Use
* gst_iterator_free() after usage.
- *
- * Since: 0.10.21
*/
GstIterator *
gst_pad_iterate_internal_links (GstPad * pad)
*
* Returns: TRUE if the query could be performed. This function returns %FALSE
* if @pad has no peer.
- *
- * Since: 0.10.15
*/
gboolean
gst_pad_peer_query (GstPad * pad, GstQuery * query)
* MT safe.
*
* Returns: a #GstFlowReturn from the pad.
- *
- * Since: 0.10.24
*/
GstFlowReturn
gst_pad_chain_list (GstPad * pad, GstBufferList * list)
* Returns: a #GstFlowReturn from the peer pad.
*
* MT safe.
- *
- * Since: 0.10.24
*/
GstFlowReturn
gst_pad_push_list (GstPad * pad, GstBufferList * list)
* @GST_FLOW_NOT_SUPPORTED: This operation is not supported.
* @GST_FLOW_CUSTOM_SUCCESS: Elements can use values starting from
* this (and higher) to define custom success
- * codes. Since 0.10.7.
+ * codes.
* @GST_FLOW_CUSTOM_SUCCESS_1: Pre-defined custom success code (define your
* custom success code to this to avoid compiler
- * warnings). Since 0.10.29.
- * @GST_FLOW_CUSTOM_SUCCESS_2: Pre-defined custom success code. Since 0.10.29.
+ * warnings).
+ * @GST_FLOW_CUSTOM_SUCCESS_2: Pre-defined custom success code.
* @GST_FLOW_CUSTOM_ERROR: Elements can use values starting from
* this (and lower) to define custom error codes.
- * Since 0.10.7.
* @GST_FLOW_CUSTOM_ERROR_1: Pre-defined custom error code (define your
* custom error code to this to avoid compiler
- * warnings). Since 0.10.29.
- * @GST_FLOW_CUSTOM_ERROR_2: Pre-defined custom error code. Since 0.10.29.
+ * warnings).
+ * @GST_FLOW_CUSTOM_ERROR_2: Pre-defined custom error code.
*
* The result of passing data to a pad.
*
* Note that the custom return values should not be exposed outside of the
- * element scope and are available since 0.10.7.
+ * element scope.
*/
/* FIXME 0.11: remove custom flow returns */
typedef enum {
* use the default checks (%GST_PAD_LINK_CHECK_DEFAULT) or the regular methods
* for linking the pads.
* </para></warning>
- *
- * Since: 0.10.30
*/
typedef enum {
*
* The default checks done when linking pads (i.e. the ones used by
* gst_pad_link()).
- *
- * Since: 0.10.30
*/
#define GST_PAD_LINK_CHECK_DEFAULT ((GstPadLinkCheck) (GST_PAD_LINK_CHECK_HIERARCHY | GST_PAD_LINK_CHECK_CAPS))
* linked to the given pad on the inside of the parent element.
*
* the caller must call gst_iterator_free() after usage.
- *
- * Since 0.10.21
*/
typedef GstIterator* (*GstPadIterIntLinkFunction) (GstPad *pad, GstObject *parent);
* GstPadTemplate:name-template:
*
* The name template of the pad template.
- *
- * Since: 0.10.21
*/
g_object_class_install_property (gobject_class, PROP_NAME_TEMPLATE,
g_param_spec_string ("name-template", "Name template",
* GstPadTemplate:direction:
*
* The direction of the pad described by the pad template.
- *
- * Since: 0.10.21
*/
g_object_class_install_property (gobject_class, PROP_DIRECTION,
g_param_spec_enum ("direction", "Direction",
* GstPadTemplate:presence:
*
* When the pad described by the pad template will become available.
- *
- * Since: 0.10.21
*/
g_object_class_install_property (gobject_class, PROP_PRESENCE,
g_param_spec_enum ("presence", "Presence",
* GstPadTemplate:caps:
*
* The capabilities of the pad described by the pad template.
- *
- * Since: 0.10.21
*/
g_object_class_install_property (gobject_class, PROP_CAPS,
g_param_spec_boxed ("caps", "Caps",
* instance_init function.
*
* Returns: (transfer full): a newly created parameter specification
- *
- * Since: 0.10.14
*/
GParamSpec *
gst_param_spec_fraction (const gchar * name, const gchar * nick,
*
* Use this flag on GObject properties of GstElements to indicate that
* they can be changed when the element is in the READY or lower state.
- *
- * Since: 0.10.23
*/
#define GST_PARAM_MUTABLE_READY (1 << (G_PARAM_USER_SHIFT + 2))
* Use this flag on GObject properties of GstElements to indicate that
* they can be changed when the element is in the PAUSED or lower state.
* This flag implies GST_PARAM_MUTABLE_READY.
- *
- * Since: 0.10.23
*/
#define GST_PARAM_MUTABLE_PAUSED (1 << (G_PARAM_USER_SHIFT + 3))
* Use this flag on GObject properties of GstElements to indicate that
* they can be changed when the element is in the PLAYING or lower state.
* This flag implies GST_PARAM_MUTABLE_PAUSED.
- *
- * Since: 0.10.23
*/
#define GST_PARAM_MUTABLE_PLAYING (1 << (G_PARAM_USER_SHIFT + 4))
*
* Returns: (transfer full): a newly-allocated parse context. Free with
* gst_parse_context_free() when no longer needed.
- *
- * Since: 0.10.20
*/
GstParseContext *
gst_parse_context_new (void)
* @context: (transfer full): a #GstParseContext
*
* Frees a parse context previously allocated with gst_parse_context_new().
- *
- * Since: 0.10.20
*/
void
gst_parse_context_free (GstParseContext * context)
* Returns: (transfer full) (array zero-terminated=1) (element-type gchar*): a
* NULL-terminated array of element factory name strings of missing
* elements. Free with g_strfreev() when no longer needed.
- *
- * Since: 0.10.20
*/
gchar **
gst_parse_context_get_missing_elements (GstParseContext * context)
* or a partially-constructed bin or element will be returned and @error will
* be set (unless you passed #GST_PARSE_FLAG_FATAL_ERRORS in @flags, then
* %NULL will always be returned on failure)
- *
- * Since: 0.10.20
*/
GstElement *
gst_parse_launchv_full (const gchar ** argv, GstParseContext * context,
* Returns: (transfer full): a new element on success, %NULL on failure. If
* more than one toplevel element is specified by the @pipeline_description,
* all elements are put into a #GstPipeline, which then is returned.
- *
- * Since: 0.10.20
*/
GstElement *
gst_parse_launch_full (const gchar * pipeline_description,
* in some cases)
*
* Parsing options.
- *
- * Since: 0.10.20
*/
typedef enum
{
* GstParseContext:
*
* Opaque structure.
- *
- * Since: 0.10.20
*/
typedef struct _GstParseContext GstParseContext;
* The expected delay needed for elements to spin up to the
* PLAYING state expressed in nanoseconds.
* see gst_pipeline_set_delay() for more information on this option.
- *
- * Since: 0.10.5
**/
g_object_class_install_property (gobject_class, PROP_DELAY,
g_param_spec_uint64 ("delay", "Delay",
* Whether or not to automatically flush all messages on the
* pipeline's bus when going from READY to NULL state. Please see
* gst_pipeline_set_auto_flush_bus() for more information on this option.
- *
- * Since: 0.10.4
**/
g_object_class_install_property (gobject_class, PROP_AUTO_FLUSH_BUS,
g_param_spec_boolean ("auto-flush-bus", "Auto Flush Bus",
* used.
*
* MT safe.
- *
- * Since: 0.10.5
*/
void
gst_pipeline_set_delay (GstPipeline * pipeline, GstClockTime delay)
* Returns: The configured delay.
*
* MT safe.
- *
- * Since: 0.10.5
*/
GstClockTime
gst_pipeline_get_delay (GstPipeline * pipeline)
* automatic flushing is disabled else memory leaks will be introduced.
*
* MT safe.
- *
- * Since: 0.10.4
*/
void
gst_pipeline_set_auto_flush_bus (GstPipeline * pipeline, gboolean auto_flush)
* going from READY to NULL state or not.
*
* MT safe.
- *
- * Since: 0.10.4
*/
gboolean
gst_pipeline_get_auto_flush_bus (GstPipeline * pipeline)
* via gst_init_get_option_group()) before calling this function.
*
* Returns: TRUE if the plugin was registered correctly, otherwise FALSE.
- *
- * Since: 0.10.16
*/
gboolean
gst_plugin_register_static (gint major_version, gint minor_version,
* via gst_init_get_option_group()) before calling this function.
*
* Returns: TRUE if the plugin was registered correctly, otherwise FALSE.
- *
- * Since: 0.10.24
- *
*/
gboolean
gst_plugin_register_static_full (gint major_version, gint minor_version,
* stored. This is the case when the registry is getting rebuilt.
*
* Returns: (transfer none): The cached data as a #GstStructure or %NULL.
- *
- * Since: 0.10.24
*/
const GstStructure *
gst_plugin_get_cache_data (GstPlugin * plugin)
* the @plugin.
*
* The cache is flushed every time the registry is rebuilt.
- *
- * Since: 0.10.24
*/
void
gst_plugin_set_cache_data (GstPlugin * plugin, GstStructure * cache_data)
* library and makes visualisations available as GStreamer elements, or a
* codec loader which exposes elements and/or caps dependent on what external
* codec libraries are currently installed.
- *
- * Since: 0.10.22
*/
void
gst_plugin_add_dependency (GstPlugin * plugin, const gchar ** env_vars,
* Convenience wrapper function for gst_plugin_add_dependency() which
* takes simple strings as arguments instead of string arrays, with multiple
* arguments separated by predefined delimiters (see above).
- *
- * Since: 0.10.22
*/
void
gst_plugin_add_dependency_simple (GstPlugin * plugin,
* the directory
*
* Flags used in connection with gst_plugin_add_dependency().
- *
- * Since: 0.10.22
*/
typedef enum {
GST_PLUGIN_DEPENDENCY_FLAG_NONE = 0,
* user data to be passed to init function (useful for bindings).
*
* Returns: %TRUE if plugin initialised successfully
- *
- * Since: 0.10.24
- *
*/
/* FIXME 0.11: Merge with GstPluginInitFunc */
typedef gboolean (*GstPluginInitFullFunc) (GstPlugin *plugin, gpointer user_data);
* subset thereof), or NULL. Allowed are the following formats:
* "YYYY-MM-DD" and "YYY-MM-DDTHH:MMZ" (with 'T' a separator and 'Z'
* indicating UTC/Zulu time). This field should be set via the
- * GST_PACKAGE_RELEASE_DATETIME preprocessor macro (Since: 0.10.31)
+ * GST_PACKAGE_RELEASE_DATETIME preprocessor macro.
*
* A plugin should export a variable of this type called plugin_desc. The plugin
* loader will use the data provided there to initialize the plugin.
*
* Returns: (transfer full) (element-type Gst.PluginFeature): a copy of @list,
* with each feature's reference count incremented.
- *
- * Since: 0.10.26
*/
GList *
gst_plugin_feature_list_copy (GList * list)
* plugin features
*
* Debug the plugin feature names in @list.
- *
- * Since: 0.10.31
*/
void
gst_plugin_feature_list_debug (GList * list)
* equal but the name of p1 comes before the name of p2; zero if the rank
* and names are equal; positive value if the rank of p1 < the rank of p2 or the
* ranks are equal but the name of p2 comes after the name of p1
- *
- * Since: 0.10.31
*/
gint
gst_plugin_feature_rank_compare_func (gconstpointer p1, gconstpointer p2)
* plugin features
*
* Debug the plugin feature names in @list.
- *
- * Since: 0.10.31
*/
#ifndef GST_DISABLE_GST_DEBUG
#define GST_PLUGIN_FEATURE_LIST_DEBUG(list) gst_plugin_feature_list_debug(list)
*
* Returns: (transfer full): a new #GstPoll, or %NULL in case of an error.
* Free with gst_poll_free().
- *
- * Since: 0.10.18
*/
GstPoll *
gst_poll_new (gboolean controllable)
*
* Returns: (transfer full): a new #GstPoll, or %NULL in case of an error.
* Free with gst_poll_free().
- *
- * Since: 0.10.23
*/
GstPoll *
gst_poll_new_timer (void)
* @set: (transfer full): a file descriptor set.
*
* Free a file descriptor set.
- *
- * Since: 0.10.18
*/
void
gst_poll_free (GstPoll * set)
*
* Get a GPollFD for the reading part of the control socket. This is useful when
* integrating with a GSource and GMainLoop.
- *
- * Since: 0.10.32
*/
void
gst_poll_get_read_gpollfd (GstPoll * set, GPollFD * fd)
*
* Initializes @fd. Alternatively you can initialize it with
* #GST_POLL_FD_INIT.
- *
- * Since: 0.10.18
*/
void
gst_poll_fd_init (GstPollFD * fd)
* Add a file descriptor to the file descriptor set.
*
* Returns: %TRUE if the file descriptor was successfully added to the set.
- *
- * Since: 0.10.18
*/
gboolean
gst_poll_add_fd (GstPoll * set, GstPollFD * fd)
* Remove a file descriptor from the file descriptor set.
*
* Returns: %TRUE if the file descriptor was successfully removed from the set.
- *
- * Since: 0.10.18
*/
gboolean
gst_poll_remove_fd (GstPoll * set, GstPollFD * fd)
* writability.
*
* Returns: %TRUE if the descriptor was successfully updated.
- *
- * Since: 0.10.18
*/
gboolean
gst_poll_fd_ctl_write (GstPoll * set, GstPollFD * fd, gboolean active)
* readability.
*
* Returns: %TRUE if the descriptor was successfully updated.
- *
- * Since: 0.10.18
*/
gboolean
gst_poll_fd_ctl_read (GstPoll * set, GstPollFD * fd, gboolean active)
* The reason why this is needed is because the underlying implementation
* might not allow querying the fd more than once between calls to one of
* the re-enabling operations.
- *
- * Since: 0.10.18
*/
void
gst_poll_fd_ignored (GstPoll * set, GstPollFD * fd)
* Check if @fd in @set has closed the connection.
*
* Returns: %TRUE if the connection was closed.
- *
- * Since: 0.10.18
*/
gboolean
gst_poll_fd_has_closed (const GstPoll * set, GstPollFD * fd)
* Check if @fd in @set has an error.
*
* Returns: %TRUE if the descriptor has an error.
- *
- * Since: 0.10.18
*/
gboolean
gst_poll_fd_has_error (const GstPoll * set, GstPollFD * fd)
* Check if @fd in @set has data to be read.
*
* Returns: %TRUE if the descriptor has data to be read.
- *
- * Since: 0.10.18
*/
gboolean
gst_poll_fd_can_read (const GstPoll * set, GstPollFD * fd)
* Check if @fd in @set can be used for writing.
*
* Returns: %TRUE if the descriptor can be used for writing.
- *
- * Since: 0.10.18
*/
gboolean
gst_poll_fd_can_write (const GstPoll * set, GstPollFD * fd)
* Returns: The number of #GstPollFD in @set that have activity or 0 when no
* activity was detected after @timeout. If an error occurs, -1 is returned
* and errno is set.
- *
- * Since: 0.10.18
*/
gint
gst_poll_wait (GstPoll * set, GstClockTime timeout)
* gst_poll_set_flushing().
*
* Returns: %TRUE if the controllability of @set could be updated.
- *
- * Since: 0.10.18
*/
gboolean
gst_poll_set_controllable (GstPoll * set, gboolean controllable)
* used after adding or removing descriptors to @set.
*
* If @set is not controllable, then this call will have no effect.
- *
- * Since: 0.10.18
*/
void
gst_poll_restart (GstPoll * set)
* to gst_poll_wait() will return -1, with errno set to EBUSY.
*
* Unsetting the flushing state will restore normal operation of @set.
- *
- * Since: 0.10.18
*/
void
gst_poll_set_flushing (GstPoll * set, gboolean flushing)
*
* Returns: %TRUE on success. %FALSE when @set is not controllable or when the
* byte could not be written.
- *
- * Since: 0.10.23
*/
gboolean
gst_poll_write_control (GstPoll * set)
*
* Returns: %TRUE on success. %FALSE when @set is not controllable or when there
* was no byte to read.
- *
- * Since: 0.10.23
*/
gboolean
gst_poll_read_control (GstPoll * set)
* used. This macro can used be to initialize a variable, but it cannot
* be assigned to a variable. In that case you have to use
* gst_poll_fd_init().
- *
- * Since: 0.10.18
*/
#define GST_POLL_FD_INIT { -1, -1 }
*
* Returns: (transfer full) (array zero-terminated=1) (element-type gchar*):
* list with names, ue g_strfreev() after usage.
- *
- * Since: 0.10.20
*/
gchar **
gst_preset_get_preset_names (GstPreset * preset)
*
* Returns: (transfer full) (array zero-terminated=1) (element-type gchar*): an
* array of property names which should be freed with g_strfreev() after use.
- *
- * Since: 0.10.20
*/
gchar **
gst_preset_get_property_names (GstPreset * preset)
* Load the given preset.
*
* Returns: %TRUE for success, %FALSE if e.g. there is no preset with that @name
- *
- * Since: 0.10.20
*/
gboolean
gst_preset_load_preset (GstPreset * preset, const gchar * name)
* is already a preset by this @name it will be overwritten.
*
* Returns: %TRUE for success, %FALSE
- *
- * Since: 0.10.20
*/
gboolean
gst_preset_save_preset (GstPreset * preset, const gchar * name)
* overwritten.
*
* Returns: %TRUE for success, %FALSE if e.g. there is no preset with @old_name
- *
- * Since: 0.10.20
*/
gboolean
gst_preset_rename_preset (GstPreset * preset, const gchar * old_name,
* Delete the given preset.
*
* Returns: %TRUE for success, %FALSE if e.g. there is no preset with that @name
- *
- * Since: 0.10.20
*/
gboolean
gst_preset_delete_preset (GstPreset * preset, const gchar * name)
* @value will unset an existing value.
*
* Returns: %TRUE for success, %FALSE if e.g. there is no preset with that @name
- *
- * Since: 0.10.20
*/
gboolean
gst_preset_set_meta (GstPreset * preset, const gchar * name, const gchar * tag,
*
* Returns: %TRUE for success, %FALSE if e.g. there is no preset with that @name
* or no value for the given @tag
- *
- * Since: 0.10.20
*/
gboolean
gst_preset_get_meta (GstPreset * preset, const gchar * name, const gchar * tag,
* system presets.
*
* Returns: %TRUE for success, %FALSE if the dir already has been set
- *
- * Since: 0.10.36
*/
gboolean
gst_preset_set_app_dir (const gchar * app_dir)
* application.
*
* Returns: the directory or %NULL, don't free or modify the string
- *
- * Since: 0.10.36
*/
const gchar *
gst_preset_get_app_dir (void)
* Free-function: gst_query_unref
*
* Returns: (transfer full): a #GstQuery
- *
- * Since: 0.10.12
*/
GstQuery *
gst_query_new_latency (void)
* @max_latency: the maximal latency of the upstream elements
*
* Answer a latency query by setting the requested values in the given format.
- *
- * Since: 0.10.12
*/
void
gst_query_set_latency (GstQuery * query, gboolean live,
* @max_latency: (out) (allow-none): the storage for the max latency or NULL
*
* Parse a latency query answer.
- *
- * Since: 0.10.12
*/
void
gst_query_parse_latency (GstQuery * query, gboolean * live,
* Free-function: gst_query_unref
*
* Returns: (transfer full): a new #GstQuery
- *
- * Since: 0.10.4
*/
GstQuery *
gst_query_new_formats (void)
*
* Set the formats query result fields in @query. The number of formats passed
* in the @formats array must be equal to @n_formats.
- *
- * Since: 0.10.4
*/
void
gst_query_set_formatsv (GstQuery * query, gint n_formats,
* @n_formats: (out) (allow-none): the number of formats in this query.
*
* Parse the number of formats in the formats @query.
- *
- * Since: 0.10.4
*/
void
gst_query_parse_n_formats (GstQuery * query, guint * n_formats)
* Free-function: gst_query_unref
*
* Returns: (transfer full): a new #GstQuery
- *
- * Since: 0.10.20
*/
GstQuery *
gst_query_new_buffering (GstFormat format)
*
* 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.
- *
- * Since: 0.10.20
*/
void
gst_query_set_buffering_percent (GstQuery * query, gboolean busy, gint percent)
*
* 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.
- *
- * Since: 0.10.20
*/
void
gst_query_parse_buffering_percent (GstQuery * query, gboolean * busy,
* @buffering_left: amount of buffering time left
*
* Configures the buffering stats values in @query.
- *
- * Since: 0.10.20
*/
void
gst_query_set_buffering_stats (GstQuery * query, GstBufferingMode mode,
* @buffering_left: (out) (allow-none): amount of buffering time left, or NULL
*
* Extracts the buffering stats values from @query.
- *
- * Since: 0.10.20
*/
void
gst_query_parse_buffering_stats (GstQuery * query,
* @estimated_total: estimated total amount of download time
*
* Set the available query result fields in @query.
- *
- * Since: 0.10.20
*/
void
gst_query_set_buffering_range (GstQuery * query, GstFormat format,
* Parse an available query, writing the format into @format, and
* other results into the passed parameters, if the respective parameters
* are non-NULL
- *
- * Since: 0.10.20
*/
void
gst_query_parse_buffering_range (GstQuery * query, GstFormat * format,
* start position of the array should be inferior to @start.
*
* Returns: a #gboolean indicating if the range was added or not.
- *
- * Since: 0.10.31
*/
gboolean
gst_query_add_buffering_range (GstQuery * query, gint64 start, gint64 stop)
* buffered-ranges array of the query's structure.
*
* Returns: the range array size as a #guint.
- *
- * Since: 0.10.31
*/
guint
gst_query_get_n_buffering_ranges (GstQuery * query)
* at the @index of the buffered ranges array.
*
* Returns: a #gboolean indicating if the parsing succeeded.
- *
- * Since: 0.10.31
*/
gboolean
gst_query_parse_nth_buffering_range (GstQuery * query, guint index,
* Free-function: gst_query_unref
*
* Returns: (transfer full): a new #GstQuery
- *
- * Since: 0.10.22
*/
GstQuery *
gst_query_new_uri (void)
* @uri: the URI to set
*
* Answer a URI query by setting the requested URI.
- *
- * Since: 0.10.22
*/
void
gst_query_set_uri (GstQuery * query, const gchar * uri)
* Parse an URI query, writing the URI into @uri as a newly
* allocated string, if the respective parameters are non-NULL.
* Free the string with g_free() after usage.
- *
- * Since: 0.10.22
*/
void
gst_query_parse_uri (GstQuery * query, gchar ** uri)
* @GST_QUERY_SEGMENT: segment start/stop positions
* @GST_QUERY_CONVERT: convert values between formats
* @GST_QUERY_FORMATS: query supported formats for convert
- * @GST_QUERY_BUFFERING: query available media for efficient seeking. Since
- * 0.10.20.
- * @GST_QUERY_CUSTOM: a custom application or element defined query. Since
- * 0.10.22.
- * @GST_QUERY_URI: query the URI of the source or sink. Since 0.10.22.
+ * @GST_QUERY_BUFFERING: query available media for efficient seeking.
+ * @GST_QUERY_CUSTOM: a custom application or element defined query.
+ * @GST_QUERY_URI: query the URI of the source or sink.
* @GST_QUERY_ALLOCATION: the buffer allocation properties
* @GST_QUERY_SCHEDULING: the scheduling properties
* @GST_QUERY_ACCEPT_CAPS: the accept caps query
* @query: the query to query
*
* Get a constant string representation of the #GstQueryType of the query.
- *
- * Since: 0.10.4
*/
#define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
*
* Returns: %TRUE if GStreamer will use the child helper process when
* rebuilding the registry.
- *
- * Since: 0.10.10
*/
gboolean
gst_registry_fork_is_enabled (void)
* Applications might want to disable/enable spawning of a child helper process
* when rebuilding the registry. See gst_registry_fork_is_enabled() for more
* information.
- *
- * Since: 0.10.10
*/
void
gst_registry_fork_set_enabled (gboolean enabled)
*
* Returns: %TRUE if the registry has been updated successfully (does not
* imply that there were changes), otherwise %FALSE.
- *
- * Since: 0.10.12
*/
gboolean
gst_update_registry (void)
* every time a feature is added or removed from the registry.
*
* Returns: the feature list cookie.
- *
- * Since: 0.10.26
*/
guint32
gst_registry_get_feature_list_cookie (GstRegistry * registry)
*
* Returns: (transfer full): the new #GstSample. gst_sample_unref()
* after usage.
- *
- * Since: 0.10.24
*/
GstSample *
gst_sample_new (GstBuffer * buffer, GstCaps * caps, const GstSegment * segment,
* Free-function: gst_segment_free
*
* Returns: (transfer full): a new #GstSegment, free with gst_segment_free().
- *
- * Since: 0.10.20
*/
GstSegment *
gst_segment_copy (const GstSegment * segment)
*
* Returns: the position in the segment for @running_time. This function returns
* -1 when @running_time is -1 or when it is not inside @segment.
- *
- * Since: 0.10.24
*/
guint64
gst_segment_to_position (const GstSegment * segment, GstFormat format,
*
* Returns: %TRUE if the segment could be updated successfully. If %FALSE is
* returned, @running_time is -1 or not in @segment.
- *
- * Since: 0.10.24
*/
gboolean
gst_segment_set_running_time (GstSegment * segment, GstFormat format,
* @GST_SEEK_FLAG_SEGMENT: perform a segment seek.
* @GST_SEEK_FLAG_SKIP: when doing fast foward or fast reverse playback, allow
* elements to skip frames instead of generating all
- * frames. Since 0.10.22.
+ * frames.
* @GST_SEEK_FLAG_SNAP_BEFORE: go to a location before the requested position,
* if KEY_UNIT this means the keyframe at or before the
* requested position the one at or before the seek target.
- * Since 0.10.37.
* @GST_SEEK_FLAG_SNAP_AFTER: go to a location after the requested position,
* if KEY_UNIT this means the keyframe at of after the
- * requested position. Since 0.10.37.
+ * requested position.
* @GST_SEEK_FLAG_SNAP_NEAREST: go to a position near the requested position,
* if KEY_UNIT this means the keyframe closest to the
* requested position, if both keyframes are at an equal
- * distance, behaves like SNAP_BEFORE. Since 0.10.37.
+ * distance, behaves like SNAP_BEFORE.
*
* Flags to be used with gst_element_seek() or gst_event_new_seek(). All flags
* can be used together.
* Sets the field with the given GQuark @field to @value. If the field
* does not exist, it is created. If the field exists, the previous
* value is replaced and freed.
- *
- * Since: 0.10.31
*/
void
gst_structure_id_take_value (GstStructure * structure, GQuark field,
* Sets the field with the given name @field to @value. If the field
* does not exist, it is created. If the field exists, the previous
* value is replaced and freed. The function will take ownership of @value.
- *
- * Since: 0.10.31
*/
void
gst_structure_take_value (GstStructure * structure, const gchar * fieldname,
* setting of the structure if the caller already knows the associated
* quark values.
* The last variable argument must be NULL.
- *
- * Since: 0.10.10
*/
void
gst_structure_id_set (GstStructure * structure, GQuark field, ...)
* @varargs: variable arguments
*
* va_list form of gst_structure_id_set().
- *
- * Since: 0.10.10
*/
void
gst_structure_id_set_valist (GstStructure * structure,
* Free-function: gst_structure_free
*
* Returns: (transfer full): a new #GstStructure
- *
- * Since: 0.10.24
*/
GstStructure *
gst_structure_new_id (GQuark name_quark, GQuark field_quark, ...)
* Check if @structure contains a field named @field.
*
* Returns: TRUE if the structure contains a field with the given name
- *
- * Since: 0.10.26
*/
gboolean
gst_structure_id_has_field (const GstStructure * structure, GQuark field)
* Check if @structure contains a field named @field and with GType @type.
*
* Returns: TRUE if the structure contains a field with the given name and type
- *
- * Since: 0.10.26
*/
gboolean
gst_structure_id_has_field_typed (const GstStructure * structure,
* Returns: %TRUE if the value could be set correctly. If there was no field
* with @fieldname or the existing field did not contain a uint, this function
* returns %FALSE.
- *
- * Since: 0.10.15
*/
gboolean
gst_structure_get_uint (const GstStructure * structure,
* Returns: TRUE if the value could be set correctly. If there was no field
* with @fieldname or the existing field did not contain a data, this function
* returns FALSE.
- *
- * Since: 0.10.31
*/
gboolean
gst_structure_get_date_time (const GstStructure * structure,
* @target string if that field is not fixed yet.
*
* Returns: TRUE if the structure could be fixated
- *
- * Since: 0.10.30
*/
gboolean
gst_structure_fixate_field_string (GstStructure * structure,
* gst_structure_get() for more details.
*
* Returns: TRUE, or FALSE if there was a problem reading any of the fields
- *
- * Since: 0.10.24
*/
gboolean
gst_structure_get_valist (const GstStructure * structure,
* gst_structure_id_get() for more details.
*
* Returns: TRUE, or FALSE if there was a problem reading any of the fields
- *
- * Since: 0.10.24
*/
gboolean
gst_structure_id_get_valist (const GstStructure * structure,
* Returns: FALSE if there was a problem reading any of the fields (e.g.
* because the field requested did not exist, or was of a type other
* than the type specified), otherwise TRUE.
- *
- * Since: 0.10.24
*/
gboolean
gst_structure_get (const GstStructure * structure, const char *first_fieldname,
* Returns: FALSE if there was a problem reading any of the fields (e.g.
* because the field requested did not exist, or was of a type other
* than the type specified), otherwise TRUE.
- *
- * Since: 0.10.24
*/
gboolean
gst_structure_id_get (const GstStructure * structure, GQuark first_field_id,
* Tests if the two #GstStructure are equal.
*
* Returns: TRUE if the two structures have the same name and field.
- *
- * Since: 0.10.36
**/
gboolean
gst_structure_is_equal (const GstStructure * structure1,
* Interesects @struct1 and @struct2 and returns the intersection.
*
* Returns: Intersection of @struct1 and @struct2
- *
- * Since: 0.10.36
*/
GstStructure *
gst_structure_intersect (const GstStructure * struct1,
* would not be empty.
*
* Returns: %TRUE if intersection would not be empty
- *
- * Since: 0.10.36
*/
gboolean
gst_structure_can_intersect (const GstStructure * struct1,
* @subset has a value that is a subset of the value in @superset.
*
* Returns: %TRUE if @subset is a subset of @superset
- *
- * Since: 0.10.36
*/
gboolean
gst_structure_is_subset (const GstStructure * subset,
*
* Returns: (transfer full): a new #GstTagList. Free with gst_tag_list_unref()
* when no longer needed.
- *
- * Since: 0.10.24
*/
GstTagList *
gst_tag_list_new (const gchar * tag, ...)
*
* Returns: (transfer full): a new #GstTagList. Free with gst_tag_list_unref()
* when no longer needed.
- *
- * Since: 0.10.24
*/
GstTagList *
gst_tag_list_new_valist (va_list var_args)
*
* Returns: a newly-allocated string, or NULL in case of an error. The
* string must be freed with g_free() when no longer needed.
- *
- * Since: 0.10.36
*/
gchar *
gst_tag_list_to_string (const GstTagList * list)
* Deserializes a tag list.
*
* Returns: a new #GstTagList, or NULL in case of an error.
- *
- * Since: 0.10.36
*/
GstTagList *
gst_tag_list_new_from_string (const gchar * str)
* Checks if the given taglist is empty.
*
* Returns: TRUE if the taglist is empty, otherwise FALSE.
- *
- * Since: 0.10.11
*/
gboolean
gst_tag_list_is_empty (const GstTagList * list)
* Checks if the two given taglists are equal.
*
* Returns: TRUE if the taglists are equal, otherwise FALSE
- *
- * Since: 0.10.36
*/
gboolean
gst_tag_list_is_equal (const GstTagList * list1, const GstTagList * list2)
* @value: GValue for this tag
*
* Sets the GValue for a given tag using the specified mode.
- *
- * Since: 0.10.24
*/
void
gst_tag_list_add_value (GstTagList * list, GstTagMergeMode mode,
* to retrieve the first string associated with this tag unmodified.
*
* The resulting string in @value will be in UTF-8 encoding and should be
- * freed by the caller using g_free when no longer needed. Since 0.10.24 the
+ * freed by the caller using g_free when no longer needed. The
* returned string is also guaranteed to be non-NULL and non-empty.
*
* Free-function: g_free
* list.
*
* The resulting string in @value will be in UTF-8 encoding and should be
- * freed by the caller using g_free when no longer needed. Since 0.10.24 the
+ * freed by the caller using g_free when no longer needed. The
* returned string is also guaranteed to be non-NULL and non-empty.
*
* Free-function: g_free
*
* Returns: TRUE, if a datetime was copied, FALSE if the tag didn't exist in
* thegiven list or if it was #NULL.
- *
- * Since: 0.10.31
*/
gboolean
gst_tag_list_get_date_time (const GstTagList * list, const gchar * tag,
*
* Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
* given list or if it was #NULL.
- *
- * Since: 0.10.31
*/
gboolean
gst_tag_list_get_date_time_index (const GstTagList * list,
*
* Returns: TRUE, if a buffer was copied, FALSE if the tag didn't exist in the
* given list or if it was #NULL.
- *
- * Since: 0.10.23
*/
gboolean
gst_tag_list_get_buffer (const GstTagList * list, const gchar * tag,
*
* Returns: TRUE, if a buffer was copied, FALSE if the tag didn't exist in the
* given list or if it was #NULL.
- *
- * Since: 0.10.23
*/
gboolean
gst_tag_list_get_buffer_index (const GstTagList * list,
* commonly used title, as used for sorting (string)
*
* The title as it should be sorted, e.g. 'Doll House, The'
- *
- * Since: 0.10.15
*/
#define GST_TAG_TITLE_SORTNAME "title-sortname"
/**
*
* The artist name as it should be sorted, e.g. 'Hendrix, Jimi' or
* 'Guitar Heroes, The'
- *
- * Since: 0.10.15
*/
#define GST_TAG_ARTIST_SORTNAME "artist-sortname"
/**
* album containing this data, as used for sorting (string)
*
* The album name as it should be sorted, e.g. 'Jazz Guitar, The'
- *
- * Since: 0.10.15
*/
#define GST_TAG_ALBUM_SORTNAME "album-sortname"
/**
* GST_TAG_ALBUM_ARTIST:
*
* The artist of the entire album, as it should be displayed.
- *
- * Since: 0.10.25
*/
#define GST_TAG_ALBUM_ARTIST "album-artist"
/**
* GST_TAG_ALBUM_ARTIST_SORTNAME:
*
* The artist of the entire album, as it should be sorted.
- *
- * Since: 0.10.25
*/
#define GST_TAG_ALBUM_ARTIST_SORTNAME "album-artist-sortname"
/**
* GST_TAG_COMPOSER:
*
* person(s) who composed the recording (string)
- *
- * Since: 0.10.15
*/
#define GST_TAG_COMPOSER "composer"
/**
* GST_TAG_DATE_TIME:
*
* date and time the data was created (#GstDateTime structure)
- *
- * Since: 0.10.31
*/
#define GST_TAG_DATE_TIME "datetime"
/**
*
* This tag is used for unknown Vorbis comment tags,
* unknown APE tags and certain ID3v2 comment fields.
- *
- * Since: 0.10.10
*/
#define GST_TAG_EXTENDED_COMMENT "extended-comment"
/**
* GST_TAG_HOMEPAGE:
*
* Homepage for this media (i.e. artist or movie homepage) (string)
- *
- * Since: 0.10.23
*/
#define GST_TAG_HOMEPAGE "homepage"
/**
* GST_TAG_COPYRIGHT_URI:
*
* URI to location where copyright details can be found (string)
- *
- * Since: 0.10.14
*/
#define GST_TAG_COPYRIGHT_URI "copyright-uri"
/**
*
* Note: do not use this field to describe the encoding application. Use
* #GST_TAG_APPLICATION_NAME or #GST_TAG_COMMENT for that.
- *
- * Since: 0.10.33
*/
#define GST_TAG_ENCODED_BY "encoded-by"
/**
* GST_TAG_LICENSE_URI:
*
* URI to location where license details can be found (string)
- *
- * Since: 0.10.14
*/
#define GST_TAG_LICENSE_URI "license-uri"
/**
* GST_TAG_SUBTITLE_CODEC:
*
* codec/format the subtitle data is stored in (string)
- *
- * Since: 0.10.23
*/
#define GST_TAG_SUBTITLE_CODEC "subtitle-codec"
/**
* GST_TAG_CONTAINER_FORMAT:
*
* container format the data is stored in (string)
- *
- * Since: 0.10.24
*/
#define GST_TAG_CONTAINER_FORMAT "container-format"
/**
* GST_TAG_REFERENCE_LEVEL:
*
* reference level of track and album gain values (double)
- *
- * Since: 0.10.12
*/
#define GST_TAG_REFERENCE_LEVEL "replaygain-reference-level"
/**
* Free-form name of the language the content is in, if a language code
* is not available. This tag should not be set in addition to a language
* code. It is undefined what language or locale the language name is in.
- *
- * Since: 0.10.37
*/
#define GST_TAG_LANGUAGE_NAME "language-name"
/**
*
* image (sample) (sample taglist should specify the content type and preferably
* also set "image-type" field as #GstTagImageType)
- *
- * Since: 0.10.6
*/
#define GST_TAG_IMAGE "image"
/**
*
* image that is meant for preview purposes, e.g. small icon-sized version
* (sample) (sample taglist should specify the content type)
- *
- * Since: 0.10.7
*/
#define GST_TAG_PREVIEW_IMAGE "preview-image"
* generic file attachment (sample) (sample taglist should specify the content
* type and if possible set "filename" to the file name of the
* attachment)
- *
- * Since: 0.10.21
*/
#define GST_TAG_ATTACHMENT "attachment"
* GST_TAG_BEATS_PER_MINUTE:
*
* number of beats per minute in audio (double)
- *
- * Since: 0.10.12
*/
#define GST_TAG_BEATS_PER_MINUTE "beats-per-minute"
* GST_TAG_KEYWORDS:
*
* comma separated keywords describing the content (string).
- *
- * Since: 0.10.21
*/
#define GST_TAG_KEYWORDS "keywords"
*
* human readable descriptive location of where the media has been recorded or
* produced. (string).
- *
- * Since: 0.10.21
*/
#define GST_TAG_GEO_LOCATION_NAME "geo-location-name"
* geo latitude location of where the media has been recorded or produced in
* degrees according to WGS84 (zero at the equator, negative values for southern
* latitudes) (double).
- *
- * Since: 0.10.21
*/
#define GST_TAG_GEO_LOCATION_LATITUDE "geo-location-latitude"
* geo longitude location of where the media has been recorded or produced in
* degrees according to WGS84 (zero at the prime meridian in Greenwich/UK,
* negative values for western longitudes). (double).
- *
- * Since: 0.10.21
*/
#define GST_TAG_GEO_LOCATION_LONGITUDE "geo-location-longitude"
*
* geo elevation of where the media has been recorded or produced in meters
* according to WGS84 (zero is average sea level) (double).
- *
- * Since: 0.10.21
*/
#define GST_TAG_GEO_LOCATION_ELEVATION "geo-location-elevation"
/**
* GST_TAG_GEO_LOCATION_COUNTRY:
*
* The country (english name) where the media has been produced (string).
- *
- * Since: 0.10.29
*/
#define GST_TAG_GEO_LOCATION_COUNTRY "geo-location-country"
/**
* GST_TAG_GEO_LOCATION_CITY:
*
* The city (english name) where the media has been produced (string).
- *
- * Since: 0.10.29
*/
#define GST_TAG_GEO_LOCATION_CITY "geo-location-city"
/**
*
* This tag has been added as this is how it is handled/named in XMP's
* Iptc4xmpcore schema.
- *
- * Since: 0.10.29
*/
#define GST_TAG_GEO_LOCATION_SUBLOCATION "geo-location-sublocation"
/**
*
* Represents the expected error on the horizontal positioning in
* meters (double).
- *
- * Since: 0.10.31
*/
#define GST_TAG_GEO_LOCATION_HORIZONTAL_ERROR "geo-location-horizontal-error"
/**
* Represented in m/s. (double)
*
* See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION
- *
- * Since 0.10.30
*/
#define GST_TAG_GEO_LOCATION_MOVEMENT_SPEED "geo-location-movement-speed"
/**
* 0 means the geographic north, and increases clockwise (double from 0 to 360)
*
* See also #GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION
- *
- * Since: 0.10.30
*/
#define GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION "geo-location-movement-direction"
/**
* 0 means the geographic north, and increases clockwise (double from 0 to 360)
*
* See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION
- *
- * Since: 0.10.30
*/
#define GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION "geo-location-capture-direction"
/**
* GST_TAG_SHOW_NAME:
*
* Name of the show, used for displaying (string)
- *
- * Since: 0.10.26
*/
#define GST_TAG_SHOW_NAME "show-name"
/**
* GST_TAG_SHOW_SORTNAME:
*
* Name of the show, used for sorting (string)
- *
- * Since: 0.10.26
*/
#define GST_TAG_SHOW_SORTNAME "show-sortname"
/**
* GST_TAG_SHOW_EPISODE_NUMBER:
*
* Number of the episode within a season/show (unsigned integer)
- *
- * Since: 0.10.26
*/
#define GST_TAG_SHOW_EPISODE_NUMBER "show-episode-number"
/**
* GST_TAG_SHOW_SEASON_NUMBER:
*
* Number of the season of a show/series (unsigned integer)
- *
- * Since: 0.10.26
*/
#define GST_TAG_SHOW_SEASON_NUMBER "show-season-number"
/**
* GST_TAG_LYRICS:
*
* The lyrics of the media (string)
- *
- * Since: 0.10.26
*/
#define GST_TAG_LYRICS "lyrics"
/**
* GST_TAG_COMPOSER_SORTNAME:
*
* The composer's name, used for sorting (string)
- *
- * Since: 0.10.26
*/
#define GST_TAG_COMPOSER_SORTNAME "composer-sortname"
/**
*
* Groups together media that are related and spans multiple tracks. An
* example are multiple pieces of a concerto. (string)
- *
- * Since: 0.10.26
*/
#define GST_TAG_GROUPING "grouping"
/**
* Rating attributed by a person (likely the application user).
* The higher the value, the more the user likes this media
* (unsigned int from 0 to 100)
- *
- * Since: 0.10.29
*/
#define GST_TAG_USER_RATING "user-rating"
/**
* GST_TAG_DEVICE_MANUFACTURER:
*
* Manufacturer of the device used to create the media (string)
- *
- * Since: 0.10.30
*/
#define GST_TAG_DEVICE_MANUFACTURER "device-manufacturer"
/**
* GST_TAG_DEVICE_MODEL:
*
* Model of the device used to create the media (string)
- *
- * Since: 0.10.30
*/
#define GST_TAG_DEVICE_MODEL "device-model"
/**
* GST_TAG_APPLICATION_NAME:
*
* Name of the application used to create the media (string)
- *
- * Since: 0.10.31
*/
#define GST_TAG_APPLICATION_NAME "application-name"
/**
*
* Some formats allow application's to add their own arbitrary data
* into files. This data is application's dependent.
- *
- * Since: 0.10.31
*/
#define GST_TAG_APPLICATION_DATA "application-data"
/**
*
* Rotations indicated by the values are in clockwise direction and
* 'flip' means an horizontal mirroring.
- *
- * Since: 0.10.30
*/
#define GST_TAG_IMAGE_ORIENTATION "image-orientation"
*
* Reset the internal taglist. Elements should call this from within the
* state-change handler.
- *
- * Since: 0.10.22
*/
void
gst_tag_setter_reset_tags (GstTagSetter * setter)
* @value: GValue to set for the tag
*
* Adds the given tag / GValue pair on the setter using the given merge mode.
- *
- * Since: 0.10.24
*/
void
gst_tag_setter_add_tag_value (GstTagSetter * setter,
*
* Returns: (transfer full): the #GstTaskPool used by @task. gst_object_unref()
* after usage.
- *
- * Since: 0.10.24
*/
GstTaskPool *
gst_task_get_pool (GstTask * task)
* will be created by @task will now use @pool.
*
* MT safe.
- *
- * Since: 0.10.24
*/
void
gst_task_set_pool (GstTask * task, GstTaskPool * pool)
* MT safe.
*
* Returns: %TRUE if the state could be changed.
- *
- * Since: 0.10.24
*/
gboolean
gst_task_set_state (GstTask * task, GstTaskState state)
* GThreadPool for threads.
*
* Returns: (transfer full): a new #GstTaskPool. gst_object_unref() after usage.
- *
- * Since: 0.10.24
*/
GstTaskPool *
gst_task_pool_new (void)
* Prepare the taskpool for accepting gst_task_pool_push() operations.
*
* MT safe.
- *
- * Since: 0.10.24
*/
void
gst_task_pool_prepare (GstTaskPool * pool, GError ** error)
* to ensure proper cleanup of internal data structures in test suites.
*
* MT safe.
- *
- * Since: 0.10.24
*/
void
gst_task_pool_cleanup (GstTaskPool * pool)
* Returns: (transfer none): a pointer that should be used for the
* gst_task_pool_join function. This pointer can be NULL, you must
* check @error to detect errors.
- *
- * Since: 0.10.24
*/
gpointer
gst_task_pool_push (GstTaskPool * pool, GstTaskPoolFunction func,
*
* Join a task and/or return it to the pool. @id is the id obtained from
* gst_task_pool_push().
- *
- * Since: 0.10.24
*/
void
gst_task_pool_join (GstTaskPool * pool, gpointer id)
* @user_data: user data for the task function
*
* Task function, see gst_task_pool_push().
- *
- * Since: 0.10.24
*/
typedef void (*GstTaskPoolFunction) (void *user_data);
*
* Returns: (transfer full): newly allocated #GstToc structure, free it
* with gst_toc_unref().
- *
- * Since: 0.10.37
*/
GstToc *
gst_toc_new (void)
* @tags: (allow-none) (transfer full): A #GstTagList or %NULL
*
* Set a #GstTagList with tags for the complete @toc.
- *
- * Since: 0.10.37
*/
void
gst_toc_set_tags (GstToc * toc, GstTagList * tags)
* @mode: A #GstTagMergeMode
*
* Merge @tags into the existing tags of @toc using @mode.
- *
- * Since: 0.10.37
*/
void
gst_toc_merge_tags (GstToc * toc, GstTagList * tags, GstTagMergeMode mode)
* Gets the tags for @toc.
*
* Returns: (transfer none): A #GstTagList for @entry
- *
- * Since: 0.10.37
*/
GstTagList *
gst_toc_get_tags (const GstToc * toc)
* @entry: (transfer full): A #GstTocEntry
*
* Appends the #GstTocEntry @entry to @toc.
- *
- * Since: 0.10.37
*/
void
gst_toc_append_entry (GstToc * toc, GstTocEntry * entry)
* Gets the list of #GstTocEntry of @toc.
*
* Returns: (transfer none) (element-type Gst.TocEntry): A #GList of #GstTocEntry for @entry
- *
- * Since: 0.10.37
*/
GList *
gst_toc_get_entries (const GstToc * toc)
* Create new #GstTocEntry structure.
*
* Returns: newly allocated #GstTocEntry structure, free it with gst_toc_entry_unref().
- *
- * Since: 0.10.37
*/
GstTocEntry *
gst_toc_entry_new (GstTocEntryType type, const gchar * uid)
* Find #GstTocEntry with given @uid in the @toc.
*
* Returns: #GstTocEntry with specified @uid from the @toc, or NULL if not found.
- *
- * Since: 0.10.37
*/
GstTocEntry *
gst_toc_find_entry (const GstToc * toc, const gchar * uid)
*
* Returns: newly allocated #GstTocEntry in case of success, NULL otherwise;
* free it when done with gst_toc_entry_unref().
- *
- * Since: 0.10.37
*/
static GstTocEntry *
gst_toc_entry_copy (const GstTocEntry * entry)
*
* Returns: newly allocated #GstToc in case of success, NULL otherwise;
* free it when done with gst_toc_free().
- *
- * Since: 0.10.37
*/
static GstToc *
gst_toc_copy (const GstToc * toc)
* @stop: stop value to set.
*
* Set @start and @stop values for the @entry.
- *
- * Since: 0.10.37
*/
void
gst_toc_entry_set_start_stop_times (GstTocEntry * entry, gint64 start,
*
* Returns: TRUE if all non-NULL storage pointers were filled with appropriate values,
* FALSE otherwise.
- *
- * Since: 0.10.37
*/
gboolean
gst_toc_entry_get_start_stop_times (const GstTocEntry * entry, gint64 * start,
* Gets the UID of @entry.
*
* Returns: (transfer none): The UID of @entry
- *
- * Since: 0.10.37
*/
const gchar *
gst_toc_entry_get_uid (const GstTocEntry * entry)
* @subentry: (transfer full): A #GstTocEntry
*
* Appends the #GstTocEntry @subentry to @entry.
- *
- * Since: 0.10.37
*/
void
gst_toc_entry_append_sub_entry (GstTocEntry * entry, GstTocEntry * subentry)
* Gets the sub-entries of @entry.
*
* Returns: (transfer none) (element-type Gst.TocEntry): A #GList of #GstTocEntry of @entry
- *
- * Since: 0.10.37
*/
GList *
gst_toc_entry_get_sub_entries (const GstTocEntry * entry)
* @tags: (allow-none) (transfer full): A #GstTagList or %NULL
*
* Set a #GstTagList with tags for the complete @entry.
- *
- * Since: 0.10.37
*/
void
gst_toc_entry_set_tags (GstTocEntry * entry, GstTagList * tags)
* @mode: A #GstTagMergeMode
*
* Merge @tags into the existing tags of @entry using @mode.
- *
- * Since: 0.10.37
*/
void
gst_toc_entry_merge_tags (GstTocEntry * entry, GstTagList * tags,
* Gets the tags for @entry.
*
* Returns: (transfer none): A #GstTagList for @entry
- *
- * Since: 0.10.37
*/
GstTagList *
gst_toc_entry_get_tags (const GstTocEntry * entry)
*
* Reset the internal TOC. Elements should call this from within the
* state-change handler.
- *
- * Since: 0.10.37
*/
void
gst_toc_setter_reset (GstTocSetter * setter)
*
* Returns: (transfer full): TOC set, or NULL. Unref with gst_toc_unref()
* when no longer needed
- *
- * Since: 0.10.37
*/
GstToc *
gst_toc_setter_get_toc (GstTocSetter * setter)
*
* Set the given TOC on the setter. Previously setted TOC will be
* unrefed before setting a new one.
- *
- * Since: 0.10.37
*/
void
gst_toc_setter_set_toc (GstTocSetter * setter, GstToc * toc)
/**
* GstAllocTraceFlags:
- * @GST_ALLOC_TRACE_NONE: No tracing specified or desired. Since 0.10.36.
+ * @GST_ALLOC_TRACE_NONE: No tracing specified or desired.
* @GST_ALLOC_TRACE_LIVE: Trace number of non-freed memory.
* @GST_ALLOC_TRACE_MEM_LIVE: Trace pointers of unfreed memory.
*
/**
* gst_type_find_register:
- * @plugin: A #GstPlugin, or NULL for a static typefind function (note that
- * passing NULL only works in GStreamer 0.10.16 and later)
+ * @plugin: A #GstPlugin, or NULL for a static typefind function
* @name: The name for registering
* @rank: The rank (or importance) of this typefind function
* @func: The #GstTypeFindFunction to use
* the values passed have the correct type (in terms of width in bytes when
* passed to the vararg function - this applies particularly to gdouble and
* guint64 arguments).
- *
- * Since: 0.10.20
*/
void
gst_type_find_suggest_simple (GstTypeFind * find, guint probability,
/**
* GstTypeFindProbability:
- * @GST_TYPE_FIND_NONE: type undetected. Since 0.10.36.
+ * @GST_TYPE_FIND_NONE: type undetected.
* @GST_TYPE_FIND_MINIMUM: unlikely typefind.
* @GST_TYPE_FIND_POSSIBLE: possible type detected.
* @GST_TYPE_FIND_LIKELY: likely a type was detected.
* list using gst_plugin_feature_list_free().
*
* The returned factories are sorted by highest rank first, and then by
- * factory name. (behaviour change since 0.10.26)
+ * factory name.
*
* Free-function: gst_plugin_feature_list_free
*
* Checks if the protocol of a given valid URI matches @protocol.
*
* Returns: %TRUE if the protocol matches.
- *
- * Since: 0.10.4
*/
gboolean
gst_uri_has_protocol (const gchar * uri, const gchar * protocol)
* gst_element_make_from_uri() is guaranteed to work.
*
* Returns: TRUE
- *
- * Since: 0.10.13
*/
gboolean
gst_uri_protocol_is_supported (const GstURIType type, const gchar * protocol)
* will be canonicalised so that it doesn't contain any './' or '../' segments.
*
* On Windows #filename should be in UTF-8 encoding.
- *
- * Since: 0.10.33
*/
gchar *
gst_filename_to_uri (const gchar * filename, GError ** error)
* Returns: A constantly incrementing 32-bit unsigned integer, which might
* overflow back to 0 at some point. Use gst_util_seqnum_compare() to make sure
* you handle wraparound correctly.
- *
- * Since: 0.10.22
*/
guint32
gst_util_seqnum_next (void)
*
* Returns: A negative number if @s1 is before @s2, 0 if they are equal, or a
* positive number if @s1 is after @s2.
- *
- * Since: 0.10.22
*/
gint32
gst_util_seqnum_compare (guint32 s1, guint32 s2)
*
* Returns: (transfer none): a string with the name of the state
* result.
- *
- * Since: 0.10.11
*/
const gchar *
gst_element_state_change_return_get_name (GstStateChangeReturn state_ret)
* Checks if the factory can sink all possible capabilities.
*
* Returns: %TRUE if the caps are fully compatible.
- *
- * Since: 0.10.33
*/
gboolean
gst_element_factory_can_sink_all_caps (GstElementFactory * factory,
* Checks if the factory can src all possible capabilities.
*
* Returns: %TRUE if the caps are fully compatible.
- *
- * Since: 0.10.33
*/
gboolean
gst_element_factory_can_src_all_caps (GstElementFactory * factory,
* Checks if the factory can sink any possible capability.
*
* Returns: %TRUE if the caps have a common subset.
- *
- * Since: 0.10.33
*/
gboolean
gst_element_factory_can_sink_any_caps (GstElementFactory * factory,
* Checks if the factory can src any possible capability.
*
* Returns: %TRUE if the caps have a common subset.
- *
- * Since: 0.10.33
*/
gboolean
gst_element_factory_can_src_any_caps (GstElementFactory * factory,
* This is a convenience function for gst_pad_link_full().
*
* Returns: TRUE if the pads could be linked, FALSE otherwise.
- *
- * Since: 0.10.30
*/
gboolean
gst_element_link_pads_full (GstElement * src, const gchar * srcpadname,
*
* Returns: %TRUE if the seek operation succeeded. Flushing seeks will trigger a
* preroll, which will emit %GST_MESSAGE_ASYNC_DONE.
- *
- * Since: 0.10.7
*/
gboolean
gst_element_seek_simple (GstElement * element, GstFormat format,
* pad when it is not needed any longer.
*
* Returns: (transfer full): unlinked pad of the given direction, or NULL.
- *
- * Since: 0.10.20
*/
GstPad *
gst_bin_find_unlinked_pad (GstBin * bin, GstPadDirection direction)
* yourself).
*
* Returns: (transfer floating): a newly-created bin, or NULL if an error occurred.
- *
- * Since: 0.10.3
*/
GstElement *
gst_parse_bin_from_description (const gchar * bin_description,
* yourself).
*
* Returns: (transfer full): a newly-created bin, or NULL if an error occurred.
- *
- * Since: 0.10.20
*/
GstElement *
gst_parse_bin_from_description_full (const gchar * bin_description,
* The timestamp should not be interpreted in any other way.
*
* Returns: the timestamp
- *
- * Since: 0.10.16
*/
GstClockTime
gst_util_get_timestamp (void)
* The complexity of this search function is O(log (num_elements)).
*
* Returns: (transfer none): The address of the found element or %NULL if nothing was found
- *
- * Since: 0.10.23
*/
gpointer
gst_util_array_binary_search (gpointer array, guint num_elements,
* and @b.
*
* Returns: Greatest common divisor of @a and @b
- *
- * Since: 0.10.26
*/
gint
gst_util_greatest_common_divisor (gint a, gint b)
* and @b.
*
* Returns: Greatest common divisor of @a and @b
- *
- * Since: 0.11.0
*/
gint64
gst_util_greatest_common_divisor_int64 (gint64 a, gint64 b)
* @dest: (out): pointer to a #gdouble for the result
*
* Transforms a fraction to a #gdouble.
- *
- * Since: 0.10.26
*/
void
gst_util_fraction_to_double (gint src_n, gint src_d, gdouble * dest)
*
* Transforms a #gdouble to a fraction and simplifies
* the result.
- *
- * Since: 0.10.26
*/
void
gst_util_double_to_fraction (gdouble src, gint * dest_n, gint * dest_d)
* the result in @res_n and @res_d.
*
* Returns: %FALSE on overflow, %TRUE otherwise.
- *
- * Since: 0.10.26
*/
gboolean
gst_util_fraction_multiply (gint a_n, gint a_d, gint b_n, gint b_d,
* the result in @res_n and @res_d.
*
* Returns: %FALSE on overflow, %TRUE otherwise.
- *
- * Since: 0.10.26
*/
gboolean
gst_util_fraction_add (gint a_n, gint a_d, gint b_n, gint b_d, gint * res_n,
* -1 if a < b, 0 if a = b and 1 if a > b.
*
* Returns: -1 if a < b; 0 if a = b; 1 if a > b.
- *
- * Since: 0.10.31
*/
gint
gst_util_fraction_compare (gint a_n, gint a_d, gint b_n, gint b_d)
* @data: memory location
*
* Read a 24 bit unsigned integer value in big endian format from the memory buffer.
- *
- * Since: 0.10.22
*/
#define GST_READ_UINT24_BE(data) (_GST_GET (data, 0, 32, 16) | \
_GST_GET (data, 1, 32, 8) | \
* @data: memory location
*
* Read a 24 bit unsigned integer value in little endian format from the memory buffer.
- *
- * Since: 0.10.22
*/
#define GST_READ_UINT24_LE(data) (_GST_GET (data, 2, 32, 16) | \
_GST_GET (data, 1, 32, 8) | \
* @num: value to store
*
* Store a 24 bit unsigned integer value in big endian format into the memory buffer.
- *
- * Since: 0.10.22
*/
#define GST_WRITE_UINT24_BE(data, num) do { \
_GST_PUT (data, 0, 32, 16, num); \
* @num: value to store
*
* Store a 24 bit unsigned integer value in little endian format into the memory buffer.
- *
- * Since: 0.10.22
*/
#define GST_WRITE_UINT24_LE(data, num) do { \
_GST_PUT (data, 0, 32, 0, num); \
* Swap byte order of a 32-bit floating point value (float).
*
* Returns: @in byte-swapped.
- *
- * Since: 0.10.22
- *
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC gfloat GFLOAT_SWAP_LE_BE (gfloat in);
* Swap byte order of a 64-bit floating point value (double).
*
* Returns: @in byte-swapped.
- *
- * Since: 0.10.22
- *
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC gdouble GDOUBLE_SWAP_LE_BE (gdouble in);
*
* Convert 64-bit floating point value (double) from native byte order into
* little endian byte order.
- *
- * Since: 0.10.22
- *
*/
/**
* GDOUBLE_TO_BE:
*
* Convert 64-bit floating point value (double) from native byte order into
* big endian byte order.
- *
- * Since: 0.10.22
- *
*/
/**
* GDOUBLE_FROM_LE:
*
* Convert 64-bit floating point value (double) from little endian byte order
* into native byte order.
- *
- * Since: 0.10.22
- *
*/
/**
* GDOUBLE_FROM_BE:
*
* Convert 64-bit floating point value (double) from big endian byte order
* into native byte order.
- *
- * Since: 0.10.22
- *
*/
/**
*
* Convert 32-bit floating point value (float) from native byte order into
* little endian byte order.
- *
- * Since: 0.10.22
- *
*/
/**
* GFLOAT_TO_BE:
*
* Convert 32-bit floating point value (float) from native byte order into
* big endian byte order.
- *
- * Since: 0.10.22
- *
*/
/**
* GFLOAT_FROM_LE:
*
* Convert 32-bit floating point value (float) from little endian byte order
* into native byte order.
- *
- * Since: 0.10.22
- *
*/
/**
* GFLOAT_FROM_BE:
*
* Convert 32-bit floating point value (float) from big endian byte order
* into native byte order.
- *
- * Since: 0.10.22
- *
*/
#if G_BYTE_ORDER == G_LITTLE_ENDIAN
* Read a 32 bit float value in little endian format from the memory buffer.
*
* Returns: The floating point value read from @data
- *
- * Since: 0.10.22
- *
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC gfloat GST_READ_FLOAT_LE (const guint8 *data);
* Read a 32 bit float value in big endian format from the memory buffer.
*
* Returns: The floating point value read from @data
- *
- * Since: 0.10.22
- *
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC gfloat GST_READ_FLOAT_BE (const guint8 *data);
* Read a 64 bit double value in little endian format from the memory buffer.
*
* Returns: The double-precision floating point value read from @data
- *
- * Since: 0.10.22
- *
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC gdouble GST_READ_DOUBLE_LE (const guint8 *data);
* Read a 64 bit double value in big endian format from the memory buffer.
*
* Returns: The double-precision floating point value read from @data
- *
- * Since: 0.10.22
- *
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC gdouble GST_READ_DOUBLE_BE (const guint8 *data);
* @num: value to store
*
* Store a 32 bit float value in little endian format into the memory buffer.
- *
- * Since: 0.10.22
- *
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC void GST_WRITE_FLOAT_LE (guint8 *data, gfloat num);
* @num: value to store
*
* Store a 32 bit float value in big endian format into the memory buffer.
- *
- * Since: 0.10.22
- *
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC void GST_WRITE_FLOAT_BE (guint8 *data, gfloat num);
* @num: value to store
*
* Store a 64 bit double value in little endian format into the memory buffer.
- *
- * Since: 0.10.22
- *
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC void GST_WRITE_DOUBLE_LE (guint8 *data, gdouble num);
* @num: value to store
*
* Store a 64 bit double value in big endian format into the memory buffer.
- *
- * Since: 0.10.22
- *
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC void GST_WRITE_DOUBLE_BE (guint8 *data, gdouble num);
* @num: integer value to round down
*
* Rounds an integer value down to the next multiple of 2.
- *
- * Since: 0.10.12
*/
#define GST_ROUND_DOWN_2(num) ((num)&(~1))
/**
* @num: integer value to round down
*
* Rounds an integer value down to the next multiple of 4.
- *
- * Since: 0.10.12
*/
#define GST_ROUND_DOWN_4(num) ((num)&(~3))
/**
* @num: integer value to round down
*
* Rounds an integer value down to the next multiple of 8.
- *
- * Since: 0.10.12
*/
#define GST_ROUND_DOWN_8(num) ((num)&(~7))
/**
* @num: integer value to round down
*
* Rounds an integer value down to the next multiple of 16.
- *
- * Since: 0.10.12
*/
#define GST_ROUND_DOWN_16(num) ((num)&(~15))
/**
* @num: integer value to round down
*
* Rounds an integer value down to the next multiple of 32.
- *
- * Since: 0.10.12
*/
#define GST_ROUND_DOWN_32(num) ((num)&(~31))
/**
* @num: integer value to round down
*
* Rounds an integer value down to the next multiple of 64.
- *
- * Since: 0.10.12
*/
#define GST_ROUND_DOWN_64(num) ((num)&(~63))
* @GST_SEARCH_MODE_AFTER : Search for an exact match or the element just after.
*
* The different search modes.
- *
- * Since: 0.10.23
*/
typedef enum {
GST_SEARCH_MODE_EXACT = 0,
* The result will be put into @dest and will either be a list that will not
* contain any duplicates, or a non-list type (if @value1 and @value2
* were equal).
- *
- * Since: 0.10.32
*/
void
gst_value_list_merge (GValue * dest, const GValue * value1,
* @step: the step of the range
*
* Sets @value to the range specified by @start, @end and @step.
- *
- * Since: 0.11.0
*/
void
gst_value_set_int64_range_step (GValue * value, gint64 start, gint64 end,
* @end: the end of the range
*
* Sets @value to the range specified by @start and @end.
- *
- * Since: 0.10.31
*/
void
gst_value_set_int64_range (GValue * value, gint64 start, gint64 end)
* Gets the minimum of the range specified by @value.
*
* Returns: the minimum of the range
- *
- * Since: 0.10.31
*/
gint64
gst_value_get_int64_range_min (const GValue * value)
* Gets the maximum of the range specified by @value.
*
* Returns: the maxumum of the range
- *
- * Since: 0.10.31
*/
gint64
gst_value_get_int64_range_max (const GValue * value)
* Gets the step of the range specified by @value.
*
* Returns: the step of the range
- *
- * Since: 0.11.0
*/
gint64
gst_value_get_int64_range_step (const GValue * value)
* @structure: the structure to set the value to
*
* Sets the contents of @value to @structure. The actual
- *
- * Since: 0.10.15
*/
void
gst_value_set_structure (GValue * value, const GstStructure * structure)
* Gets the contents of @value.
*
* Returns: (transfer none): the contents of @value
- *
- * Since: 0.10.15
*/
const GstStructure *
gst_value_get_structure (const GValue * value)
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_INT64_RANGE value.
- *
- * Since: 0.10.31
*/
#define GST_VALUE_HOLDS_INT64_RANGE(x) (G_VALUE_HOLDS((x), gst_int64_range_get_type ()))
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_STRUCTURE value.
- *
- * Since: 0.10.15
*/
#define GST_VALUE_HOLDS_STRUCTURE(x) (G_VALUE_HOLDS((x), GST_TYPE_STRUCTURE))
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_DATE_TIME value.
- *
- * Since: 0.10.31
*/
#define GST_VALUE_HOLDS_DATE_TIME(x) (G_VALUE_HOLDS((x), gst_date_time_get_type ()))
* a #GValue type that represents an #gint64 range
*
* Returns: the #GType of GstInt64Range
- *
- * Since: 0.10.31
*/
#define GST_TYPE_INT64_RANGE gst_int64_range_get_type ()
* a boxed #GValue type for #GstDateTime that represents a date and time.
*
* Returns: the #GType of GstDateTime
- * Since: 0.10.31
*/
#define GST_TYPE_DATE_TIME gst_date_time_get_type ()
*
* Check whether a GStreamer version equal to or greater than
* major.minor.micro is present.
- *
- * Since: 0.10.18
*/
#define GST_CHECK_VERSION(major,minor,micro) \
(GST_VERSION_MAJOR > (major) || \
* Also check the GST_BUFFER_FLAG_DISCONT flag on the buffer. Some elements might
* need to clear the adapter after a discontinuity.
*
- * Since 0.10.24, the adapter will keep track of the timestamps of the buffers
+ * The adapter will keep track of the timestamps of the buffers
* that were pushed. The last seen timestamp before the current position
* can be queried with gst_adapter_prev_timestamp(). This function can
* optionally return the amount of bytes between the start of the buffer that
* The array @dest should be large enough to contain @size bytes.
* The user should check that the adapter has (@offset + @size) bytes
* available before calling this function.
- *
- * Since: 0.10.12
*/
void
gst_adapter_copy (GstAdapter * adapter, gpointer dest, gsize offset, gsize size)
*
* Returns: (transfer full): a #GstBuffer containing the first @nbytes of
* the adapter, or #NULL if @nbytes bytes are not available
- *
- * Since: 0.10.6
*/
GstBuffer *
gst_adapter_take_buffer (GstAdapter * adapter, gsize nbytes)
* Returns: (element-type Gst.Buffer) (transfer full): a #GList of buffers
* containing the first @nbytes of the adapter, or #NULL if @nbytes bytes
* are not available
- *
- * Since: 0.10.31
*/
GList *
gst_adapter_take_list (GstAdapter * adapter, gsize nbytes)
* enough data (offset+size bytes) in the adapter.
*
* Returns: offset of the first match, or -1 if no match was found.
- *
- * Since: 0.10.30
*/
gsize
gst_adapter_masked_scan_uint32_peek (GstAdapter * adapter, guint32 mask,
* gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 4);
* // -> returns -1
* </programlisting>
- *
- * Since: 0.10.24
*/
gsize
gst_adapter_masked_scan_uint32 (GstAdapter * adapter, guint32 mask,
* sure gst_base_parse_frame_free() only frees the contents but not
* the actual frame. Use this function to initialise a #GstBaseParseFrame
* allocated on the stack.
- *
- * Since: 0.10.33
*/
void
gst_base_parse_frame_init (GstBaseParseFrame * frame)
*
* Returns: a newly-allocated #GstBaseParseFrame. Free with
* gst_base_parse_frame_free() when no longer needed.
- *
- * Since: 0.10.33
*/
GstBaseParseFrame *
gst_base_parse_frame_new (GstBuffer * buffer, GstBaseParseFrameFlags flags,
* Default implementation of "convert" vmethod in #GstBaseParse class.
*
* Returns: TRUE if conversion was successful.
- *
- * Since: 0.10.33
*/
gboolean
gst_base_parse_convert_default (GstBaseParse * parse,
* to the new entry, etc.
*
* Returns: #gboolean indicating whether entry was added
- *
- * Since: 0.10.33
*/
gboolean
gst_base_parse_add_index_entry (GstBaseParse * parse, guint64 offset,
* This must be called with sinkpad STREAM_LOCK held.
*
* Returns: #GstFlowReturn
- *
- * Since: 0.10.33
*/
GstFlowReturn
gst_base_parse_push_frame (GstBaseParse * parse, GstBaseParseFrame * frame)
* caller retains ownership of @frame.
*
* Returns: a #GstFlowReturn that should be escalated to caller (of caller)
- *
- * Since: 0.11.1
*/
GstFlowReturn
gst_base_parse_finish_frame (GstBaseParse * parse, GstBaseParseFrame * frame,
* duration. Alternatively, if @interval is non-zero (default), then stream
* duration is determined based on estimated bitrate, and updated every @interval
* frames.
- *
- * Since: 0.10.33
*/
void
gst_base_parse_set_duration (GstBaseParse * parse,
* is used to estimate the total duration of the stream and to estimate
* a seek position, if there's no index and the format is syncable
* (see gst_base_parse_set_syncable()).
- *
- * Since: 0.10.33
*/
void
gst_base_parse_set_average_bitrate (GstBaseParse * parse, guint bitrate)
*
* Subclass can use this function to tell the base class that it needs to
* give at least #min_size buffers.
- *
- * Since: 0.10.33
*/
void
gst_base_parse_set_min_frame_size (GstBaseParse * parse, guint min_size)
* location, a corresponding decoder might need an initial @lead_in and a
* following @lead_out number of frames to ensure the desired segment is
* entirely filled upon decoding.
- *
- * Since: 0.10.33
*/
void
gst_base_parse_set_frame_rate (GstBaseParse * parse, guint fps_num,
* Set if frames carry timing information which the subclass can (generally)
* parse and provide. In particular, intrinsic (rather than estimated) time
* can be obtained following a seek.
- *
- * Since: 0.10.33
*/
void
gst_base_parse_set_has_timing_info (GstBaseParse * parse, gboolean has_timing)
* Set if frame starts can be identified. This is set by default and
* determines whether seeking based on bitrate averages
* is possible for a format/stream.
- *
- * Since: 0.10.33
*/
void
gst_base_parse_set_syncable (GstBaseParse * parse, gboolean syncable)
* callbacks will be invoked, but @pre_push_frame will still be invoked,
* so subclass can perform as much or as little is appropriate for
* passthrough semantics in @pre_push_frame.
- *
- * Since: 0.10.33
*/
void
gst_base_parse_set_passthrough (GstBaseParse * parse, gboolean passthrough)
* Sets the minimum and maximum (which may likely be equal) latency introduced
* by the parsing process. If there is such a latency, which depends on the
* particular parsing of the format, it typically corresponds to 1 frame duration.
- *
- * Since: 0.10.36
*/
void
gst_base_parse_set_latency (GstBaseParse * parse, GstClockTime min_latency,
* @obj: base parse instance
*
* Gives the pointer to the source #GstPad object of the element.
- *
- * Since: 0.10.33
*/
#define GST_BASE_PARSE_SRC_PAD(obj) (GST_BASE_PARSE_CAST (obj)->srcpad)
* @obj: base parse instance
*
* Gives the pointer to the sink #GstPad object of the element.
- *
- * Since: 0.10.33
*/
#define GST_BASE_PARSE_SINK_PAD(obj) (GST_BASE_PARSE_CAST (obj)->sinkpad)
* A #GstFlowReturn that can be returned from parse_frame to
* indicate that no output buffer was generated, or from pre_push_frame to
* to forego pushing buffer.
- *
- * Since: 0.10.33
*/
#define GST_BASE_PARSE_FLOW_DROPPED GST_FLOW_CUSTOM_SUCCESS
* @parse: base parse instance
*
* Obtains current sync status.
- *
- * Since: 0.10.33
*/
#define GST_BASE_PARSE_LOST_SYNC(parse) (!!(GST_BASE_PARSE_CAST(parse)->flags & GST_BASE_PARSE_FLAG_LOST_SYNC))
*
* Obtains current drain status (ie. whether EOS has been received and
* the parser is now processing the frames at the end of the stream)
- *
- * Since: 0.10.33
*/
#define GST_BASE_PARSE_DRAINING(parse) (!!(GST_BASE_PARSE_CAST(parse)->flags & GST_BASE_PARSE_FLAG_DRAINING))
* when the first non-queued frame is finished
*
* Flags to be used in a #GstBaseParseFrame.
- *
- * Since: 0.10.33
*/
typedef enum {
GST_BASE_PARSE_FRAME_FLAG_NONE = 0,
* than global parameters). Some of these may apply to each parsing stage, others
* only to some a particular one. These parameters are effectively zeroed at start
* of each frame's processing, i.e. parsing virtual method invocation sequence.
- *
- * Since: 0.10.33
*/
typedef struct {
GstBuffer * buffer;
* @detect: Optional.
* Called until it doesn't return GST_FLOW_OK anymore for
* the first buffers. Can be used by the subclass to detect
- * the stream format. Since: 0.10.36
+ * the stream format.
*
* Subclasses can override any of the available virtual methods or not, as
* needed. At minimum @check_valid_frame and @parse_frame needs to be
* After synchronisation the virtual method #GstBaseSinkClass.render() will be
* called. Subclasses should minimally implement this method.
*
- * Since 0.10.3 subclasses that synchronise on the clock in the
- * #GstBaseSinkClass.render() method are supported as well. These classes
- * typically receive a buffer in the render method and can then potentially
- * block on the clock while rendering. A typical example is an audiosink.
- * Since 0.10.11 these subclasses can use gst_base_sink_wait_preroll() to
- * perform the blocking wait.
+ * Subclasses that synchronise on the clock in the #GstBaseSinkClass.render()
+ * method are supported as well. These classes typically receive a buffer in
+ * the render method and can then potentially block on the clock while
+ * rendering. A typical example is an audiosink.
+ * These subclasses can use gst_base_sink_wait_preroll() to perform the
+ * blocking wait.
*
* Upon receiving the EOS event in the PLAYING state, #GstBaseSink will wait
* for the clock to reach the time indicated by the stop time of the last
* information can then be used by upstream elements to reduce their processing
* rate, for example.
*
- * Since 0.10.15 the #GstBaseSink:async property can be used to instruct the
- * sink to never perform an ASYNC state change. This feature is mostly usable
- * when dealing with non-synchronized streams or sparse streams.
+ * The #GstBaseSink:async property can be used to instruct the sink to never
+ * perform an ASYNC state change. This feature is mostly usable when dealing
+ * with non-synchronized streams or sparse streams.
*
* Last reviewed on 2007-08-29 (0.10.15)
*/
* When set to #FALSE, the sink will not signal the parent when it prerolls.
* Use this option when dealing with sparse streams or when synchronisation is
* not required.
- *
- * Since: 0.10.15
*/
g_object_class_install_property (gobject_class, PROP_ASYNC,
g_param_spec_boolean ("async", "Async",
* Controls the final synchronisation, a negative value will render the buffer
* earlier while a positive value delays playback. This property can be
* used to fix synchronisation in bad files.
- *
- * Since: 0.10.15
*/
g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
g_param_spec_int64 ("ts-offset", "TS Offset",
* reference to the last buffer arrived and the last-sample property is always
* set to NULL. This can be useful if you need buffers to be released as soon
* as possible, eg. if you're using a buffer pool.
- *
- * Since: 0.10.30
*/
g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_SAMPLE,
g_param_spec_boolean ("enable-last-sample", "Enable Last Buffer",
* The last buffer that arrived in the sink and was used for preroll or for
* rendering. This property can be used to generate thumbnails. This property
* can be NULL when the sink has not yet received a bufer.
- *
- * Since: 0.10.15
*/
g_object_class_install_property (gobject_class, PROP_LAST_SAMPLE,
g_param_spec_boxed ("last-sample", "Last Sample",
* GstBaseSink:blocksize:
*
* The amount of bytes to pull when operating in pull mode.
- *
- * Since: 0.10.22
*/
/* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
* The additional delay between synchronisation and actual rendering of the
* media. This property will add additional latency to the device in order to
* make other sinks compensate for the delay.
- *
- * Since: 0.10.22
*/
g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
g_param_spec_uint64 ("render-delay", "Render Delay",
* The time to insert between buffers. This property can be used to control
* the maximum amount of buffers per second to render. Setting this property
* to a value bigger than 0 will make the sink create THROTTLE QoS events.
- *
- * Since: 0.10.33
*/
g_object_class_install_property (gobject_class, PROP_THROTTLE_TIME,
g_param_spec_uint64 ("throttle-time", "Throttle time",
* possible. If @sync is TRUE, the timestamps of the incomming
* buffers will be used to schedule the exact render time of its
* contents.
- *
- * Since: 0.10.4
*/
void
gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
* clock.
*
* Returns: TRUE if the sink is configured to synchronize against the clock.
- *
- * Since: 0.10.4
*/
gboolean
gst_base_sink_get_sync (GstBaseSink * sink)
* used to decide if a buffer should be dropped or not based on the
* buffer timestamp and the current clock time. A value of -1 means
* an unlimited time.
- *
- * Since: 0.10.4
*/
void
gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
* Returns: The maximum time in nanoseconds that a buffer can be late
* before it is dropped and not rendered. A value of -1 means an
* unlimited time.
- *
- * Since: 0.10.4
*/
gint64
gst_base_sink_get_max_lateness (GstBaseSink * sink)
* @enabled: the new qos value.
*
* Configures @sink to send Quality-of-Service events upstream.
- *
- * Since: 0.10.5
*/
void
gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
* upstream.
*
* Returns: TRUE if the sink is configured to perform Quality-of-Service.
- *
- * Since: 0.10.5
*/
gboolean
gst_base_sink_is_qos_enabled (GstBaseSink * sink)
* disabled, the sink will immediately go to PAUSED instead of waiting for a
* preroll buffer. This feature is useful if the sink does not synchronize
* against the clock or when it is dealing with sparse streams.
- *
- * Since: 0.10.15
*/
void
gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
*
* Returns: TRUE if the sink is configured to perform asynchronous state
* changes.
- *
- * Since: 0.10.15
*/
gboolean
gst_base_sink_is_async_enabled (GstBaseSink * sink)
* render buffers earlier than their timestamp. A positive value will delay
* rendering. This function can be used to fix playback of badly timestamped
* buffers.
- *
- * Since: 0.10.15
*/
void
gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
* Get the synchronisation offset of @sink.
*
* Returns: The synchronisation offset.
- *
- * Since: 0.10.15
*/
GstClockTimeDiff
gst_base_sink_get_ts_offset (GstBaseSink * sink)
* Returns: (transfer full): a #GstSample. gst_sample_unref() after usage.
* This function returns NULL when no buffer has arrived in the sink yet
* or when the sink is not in PAUSED or PLAYING.
- *
- * Since: 0.10.15
*/
GstSample *
gst_base_sink_get_last_sample (GstBaseSink * sink)
*
* Configures @sink to store the last received sample in the last-sample
* property.
- *
- * Since: 0.10.30
*/
void
gst_base_sink_set_last_sample_enabled (GstBaseSink * sink, gboolean enabled)
* the last-sample property.
*
* Returns: TRUE if the sink is configured to store the last received sample.
- *
- * Since: 0.10.30
*/
gboolean
gst_base_sink_is_last_sample_enabled (GstBaseSink * sink)
* Get the currently configured latency.
*
* Returns: The configured latency.
- *
- * Since: 0.10.12
*/
GstClockTime
gst_base_sink_get_latency (GstBaseSink * sink)
* This function is mostly used by subclasses.
*
* Returns: TRUE if the query succeeded.
- *
- * Since: 0.10.12
*/
gboolean
gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
* other sinks will adjust their latency to delay the rendering of their media.
*
* This function is usually called by subclasses.
- *
- * Since: 0.10.21
*/
void
gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
* information about the render delay.
*
* Returns: the render delay of @sink.
- *
- * Since: 0.10.21
*/
GstClockTime
gst_base_sink_get_render_delay (GstBaseSink * sink)
*
* Set the number of bytes that the sink will pull when it is operating in pull
* mode.
- *
- * Since: 0.10.22
*/
/* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
void
* mode.
*
* Returns: the number of bytes @sink will pull in pull mode.
- *
- * Since: 0.10.22
*/
/* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
guint
* Set the time that will be inserted between rendered buffers. This
* can be used to control the maximum buffers per second that the sink
* will render.
- *
- * Since: 0.10.33
*/
void
gst_base_sink_set_throttle_time (GstBaseSink * sink, guint64 throttle)
* maximum buffers per second.
*
* Returns: the number of nanoseconds @sink will put between frames.
- *
- * Since: 0.10.33
*/
guint64
gst_base_sink_get_throttle_time (GstBaseSink * sink)
* return and is not adjusted with any latency or offset configured in the
* sink.
*
- * Since: 0.10.20
- *
* Returns: #GstClockReturn
*/
GstClockReturn
*
* Returns: #GST_FLOW_OK if the preroll completed and processing can
* continue. Any other return value should be returned from the render vmethod.
- *
- * Since: 0.10.11
*/
GstFlowReturn
gst_base_sink_wait_preroll (GstBaseSink * sink)
*
* Returns: #GST_FLOW_OK if the preroll completed and processing can
* continue. Any other return value should be returned from the render vmethod.
- *
- * Since: 0.10.22
*/
GstFlowReturn
gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
* and will be adjusted with any latency and offset configured in the sink.
*
* Returns: #GstFlowReturn
- *
- * Since: 0.10.15
*/
GstFlowReturn
gst_base_sink_wait (GstBaseSink * sink, GstClockTime time,
* unblock any blocked function ASAP
* @unlock_stop: Clear the previous unlock request. Subclasses should clear
* any state they set during unlock(), such as clearing command queues.
- * @query: perform a #GstQuery on the element. Since: 0.10.36
+ * @query: perform a #GstQuery on the element.
* @event: Override this to handle events arriving on the sink pad
* @wait_eos: Override this to implement custom logic to wait for the EOS time.
* subclasses should always first chain up to the default implementation.
* @render: Called when a buffer should be presented or output, at the
* correct moment if the #GstBaseSink has been set to sync to the clock.
* @render_list: Same as @render but used whith buffer lists instead of
- * buffers. Since: 0.10.24
+ * buffers.
*
* Subclasses can override any of the available virtual methods or not, as
* needed. At the minimum, the @render method should be overridden to
* distributed and running.
*
* Live sources that synchronize and block on the clock (an audio source, for
- * example) can since 0.10.12 use gst_base_src_wait_playing() when the
+ * example) can use gst_base_src_wait_playing() when the
* #GstBaseSrcClass.create() function was interrupted by a state change to
* PAUSED.
*
* EOS message posted on the pipeline's bus to know when all data has
* been processed and the pipeline can safely be stopped.
*
- * Since GStreamer 0.10.16 an application may send an EOS event to a source
- * element to make it perform the EOS logic (send EOS event downstream or post a
+ * An application may send an EOS event to a source element to make it
+ * perform the EOS logic (send EOS event downstream or post a
* #GST_MESSAGE_SEGMENT_DONE on the bus). This can typically be done
* with the gst_element_send_event() function on the element or its parent bin.
*
* to a state change to READY or a FLUSH event (in which case this function
* returns #GST_FLOW_FLUSHING).
*
- * Since: 0.10.12
- *
* Returns: #GST_FLOW_OK if @src is PLAYING and processing can
* continue. Any other return value should be returned from the create vmethod.
*/
* operate in pull mode if the #GstBaseSrcClass.is_seekable() returns TRUE.
*
* This function must only be called in states < %GST_STATE_PAUSED.
- *
- * Since: 0.10.1
*/
void
gst_base_src_set_format (GstBaseSrc * src, GstFormat format)
* If not @dynamic, size is only updated when needed, such as when trying to
* read past current tracked size. Otherwise, size is checked for upon each
* read.
- *
- * Since: 0.10.36
*/
void
gst_base_src_set_dynamic_size (GstBaseSrc * src, gboolean dynamic)
* This function is mostly used by subclasses.
*
* Returns: TRUE if the query succeeded.
- *
- * Since: 0.10.13
*/
gboolean
gst_base_src_query_latency (GstBaseSrc * src, gboolean * live,
*
* Set the number of bytes that @src will push out with each buffer. When
* @blocksize is set to -1, a default length will be used.
- *
- * Since: 0.10.22
*/
void
gst_base_src_set_blocksize (GstBaseSrc * src, guint blocksize)
* Get the number of bytes that @src will push out with each buffer.
*
* Returns: the number of bytes pushed with each buffer.
- *
- * Since: 0.10.22
*/
guint
gst_base_src_get_blocksize (GstBaseSrc * src)
* Configure @src to automatically timestamp outgoing buffers based on the
* current running_time of the pipeline. This property is mostly useful for live
* sources.
- *
- * Since: 0.10.15
*/
void
gst_base_src_set_do_timestamp (GstBaseSrc * src, gboolean timestamp)
* Query if @src timestamps outgoing buffers based on the current running_time.
*
* Returns: %TRUE if the base class will automatically timestamp outgoing buffers.
- *
- * Since: 0.10.15
*/
gboolean
gst_base_src_get_do_timestamp (GstBaseSrc * src)
* configured with gst_base_src_set_format()
*
* Returns: %TRUE if preparation of the seamless segment succeeded.
- *
- * Since: 0.10.26
*/
gboolean
gst_base_src_new_seamless_segment (GstBaseSrc * src, gint64 start, gint64 stop,
* this if they support seeking in formats other than the configured native
* format. By default, it tries to convert the seek arguments to the
* configured native format and prepare a segment in that format.
- * Since: 0.10.13
* @do_seek: Perform seeking on the resource to the indicated segment.
* @unlock: Unlock any pending access to the resource. Subclasses should
* unblock any blocked function ASAP. In particular, any create() function in
* when needed.
*
* MT safe.
- *
- * Since: 0.10.5
*/
void
gst_base_transform_update_qos (GstBaseTransform * trans,
* Enable or disable QoS handling in the transform.
*
* MT safe.
- *
- * Since: 0.10.5
*/
void
gst_base_transform_set_qos_enabled (GstBaseTransform * trans, gboolean enabled)
* Returns: TRUE if QoS is enabled.
*
* MT safe.
- *
- * Since: 0.10.5
*/
gboolean
gst_base_transform_is_qos_enabled (GstBaseTransform * trans)
* unset the flag if the output is no neutral data.
*
* MT safe.
- *
- * Since: 0.10.16
*/
void
gst_base_transform_set_gap_aware (GstBaseTransform * trans, gboolean gap_aware)
* Instructs @trans to renegotiate a new downstream transform on the next
* buffer. This function is typically called after properties on the transform
* were set that influence the output format.
- *
- * Since: 0.10.21
*/
void
gst_base_transform_reconfigure_src (GstBaseTransform * trans)
#define GST_BASE_TRANSFORM_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_BASE_TRANSFORM,GstBaseTransformClass))
#define GST_IS_BASE_TRANSFORM(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_TRANSFORM))
#define GST_IS_BASE_TRANSFORM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_TRANSFORM))
-/* since 0.10.4 */
#define GST_BASE_TRANSFORM_CAST(obj) ((GstBaseTransform *)(obj))
/**
* @obj: base transform instance
*
* Gives the pointer to the source #GstPad object of the element.
- *
- * Since: 0.10.4
*/
#define GST_BASE_TRANSFORM_SRC_PAD(obj) (GST_BASE_TRANSFORM_CAST (obj)->srcpad)
* @obj: base transform instance
*
* Gives the pointer to the sink #GstPad object of the element.
- *
- * Since: 0.10.4
*/
#define GST_BASE_TRANSFORM_SINK_PAD(obj) (GST_BASE_TRANSFORM_CAST (obj)->sinkpad)
*
* A #GstFlowReturn that can be returned from transform and transform_ip to
* indicate that no output buffer was generated.
- *
- * Since: 0.10.13
*/
#define GST_BASE_TRANSFORM_FLOW_DROPPED GST_FLOW_CUSTOM_SUCCESS
* caps, fixate the caps on the other pad. The function takes
* ownership of @othercaps and returns a fixated version of
* @othercaps. @othercaps is not guaranteed to be writable.
- * @accept_caps: Optional. Since 0.10.30
+ * @accept_caps: Optional.
* Subclasses can override this method to check if @caps can be
* handled by the element. The default implementation might not be
* the most optimal way to check this in all cases.
* @set_caps: allows the subclass to be notified of the actual caps set.
- * @query: Optional Since 0.10.36
+ * @query: Optional.
* Handle a requested query. Subclasses that implement this
* should must chain up to the parent if they didn't handle the
* query
* output buffer. By default this method is NULL and no
* metadata is copied. subclasses can implement this method and
* return TRUE if the metadata is to be copied.
- * @before_transform: Optional. Since 0.10.22
+ * @before_transform: Optional.
* This method is called right before the base class will
* start processing. Dynamic properties or other delayed
* configuration could be performed in this method.
*
* Skips @nbits bits of the #GstBitReader instance without checking if there
* are enough bits available in the bit reader.
- *
- * Since: 0.10.31
*/
void gst_bit_reader_skip_unchecked (GstBitReader * reader, guint nbits);
*
* Skips until the next byte without checking if there are enough bits
* available in the bit reader.
- *
- * Since: 0.10.31
*/
void gst_bit_reader_skip_to_byte_unchecked (GstBitReader * reader);
* checking if there are enough bits available in the bit reader.
*
* Returns: unsigned 8 bit integer with the bits.
- *
- * Since: 0.10.31
*/
guint8 gst_bit_reader_peek_bits_uint8_unchecked (const GstBitReader *reader, guint nbits);
* checking if there are enough bits available in the bit reader
*
* Returns: unsigned 8 bit integer with the bits.
- *
- * Since: 0.10.31
*/
guint8 gst_bit_reader_get_bits_uint8_unchecked (GstBitReader *reader, guint nbits);
* checking if there are enough bits available in the bit reader.
*
* Returns: unsigned 16 bit integer with the bits.
- *
- * Since: 0.10.31
*/
guint16 gst_bit_reader_peek_bits_uint16_unchecked (const GstBitReader *reader, guint nbits);
* checking if there are enough bits available in the bit reader
*
* Returns: unsigned 16 bit integer with the bits.
- *
- * Since: 0.10.31
*/
guint16 gst_bit_reader_get_bits_uint16_unchecked (GstBitReader *reader, guint nbits);
* checking if there are enough bits available in the bit reader.
*
* Returns: unsigned 32 bit integer with the bits.
- *
- * Since: 0.10.31
*/
guint32 gst_bit_reader_peek_bits_uint32_unchecked (const GstBitReader *reader, guint nbits);
* checking if there are enough bits available in the bit reader
*
* Returns: unsigned 32 bit integer with the bits.
- *
- * Since: 0.10.31
*/
guint32 gst_bit_reader_get_bits_uint32_unchecked (GstBitReader *reader, guint nbits);
* checking if there are enough bits available in the bit reader.
*
* Returns: unsigned 64 bit integer with the bits.
- *
- * Since: 0.10.31
*/
guint64 gst_bit_reader_peek_bits_uint64_unchecked (const GstBitReader *reader, guint nbits);
* checking if there are enough bits available in the bit reader
*
* Returns: unsigned 64 bit integer with the bits.
- *
- * Since: 0.10.31
*/
guint64 gst_bit_reader_get_bits_uint64_unchecked (GstBitReader *reader, guint nbits);
* Free-function: gst_bit_reader_free
*
* Returns: (transfer full): a new #GstBitReader instance
- *
- * Since: 0.10.22
*/
GstBitReader *
gst_bit_reader_new (const guint8 * data, guint size)
*
* Frees a #GstBitReader instance, which was previously allocated by
* gst_bit_reader_new().
- *
- * Since: 0.10.22
*/
void
gst_bit_reader_free (GstBitReader * reader)
*
* Initializes a #GstBitReader instance to read from @data. This function
* can be called on already initialized instances.
- *
- * Since: 0.10.22
*/
void
gst_bit_reader_init (GstBitReader * reader, const guint8 * data, guint size)
*
* Returns: %TRUE if the position could be set successfully, %FALSE
* otherwise.
- *
- * Since: 0.10.22
*/
gboolean
gst_bit_reader_set_pos (GstBitReader * reader, guint pos)
* Returns the current position of a #GstBitReader instance in bits.
*
* Returns: The current position of @reader in bits.
- *
- * Since: 0.10.22
*/
guint
gst_bit_reader_get_pos (const GstBitReader * reader)
* Returns the remaining number of bits of a #GstBitReader instance.
*
* Returns: The remaining number of bits of @reader instance.
- *
- * Since: 0.10.22
*/
guint
gst_bit_reader_get_remaining (const GstBitReader * reader)
* Returns the total number of bits of a #GstBitReader instance.
*
* Returns: The total number of bits of @reader instance.
- *
- * Since: 0.10.26
*/
guint
gst_bit_reader_get_size (const GstBitReader * reader)
* Skips @nbits bits of the #GstBitReader instance.
*
* Returns: %TRUE if @nbits bits could be skipped, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
gboolean
gst_bit_reader_skip (GstBitReader * reader, guint nbits)
* Skips until the next byte.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
gboolean
gst_bit_reader_skip_to_byte (GstBitReader * reader)
* Read @nbits bits into @val and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* Read @nbits bits into @val and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* Read @nbits bits into @val and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* Read @nbits bits into @val and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* Read @nbits bits into @val but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* Read @nbits bits into @val but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* Read @nbits bits into @val but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* Read @nbits bits into @val but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
#define GST_BIT_READER_READ_BITS(bits) \
* used. This macro can used be to initialize a variable, but it cannot
* be assigned to a variable. In that case you have to use
* gst_bit_reader_init().
- *
- * Since: 0.10.22
*/
#define GST_BIT_READER_INIT(data, size) {data, size, 0, 0}
*
* Skips @nbytes bytes of the #GstByteReader instance without checking if
* there are enough bytes available in the byte reader.
- *
- * Since: 0.10.25
*/
void gst_byte_reader_skip_unchecked (GstByteReader * reader, guint nbytes);
* available in the byte reader and update the current position.
*
* Returns: unsigned 8 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_uint8_unchecked:
* available in the byte reader, but do not advance the current read position.
*
* Returns: unsigned 8 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_int8_unchecked:
* available in the byte reader and update the current position.
*
* Returns: signed 8 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_int8_unchecked:
* available in the byte reader, but do not advance the current read position.
*
* Returns: signed 8 bit integer.
- *
- * Since: 0.10.25
*/
guint8 gst_byte_reader_get_uint8_unchecked (GstByteReader * reader);
guint8 gst_byte_reader_peek_uint8_unchecked (GstByteReader * reader);
* current position.
*
* Returns: unsigned 16 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_uint16_le_unchecked:
* the current position.
*
* Returns: unsigned 16 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_uint16_be_unchecked:
* current position.
*
* Returns: unsigned 16 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_uint16_be_unchecked:
* the current position.
*
* Returns: unsigned 16 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_int16_le_unchecked:
* current position.
*
* Returns: signed 16 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_int16_le_unchecked:
* the current position.
*
* Returns: signed 16 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_int16_be_unchecked:
* current position.
*
* Returns: signed 16 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_int16_be_unchecked:
* the current position.
*
* Returns: signed 16 bit integer.
- *
- * Since: 0.10.25
*/
guint16 gst_byte_reader_get_uint16_le_unchecked (GstByteReader * reader);
guint16 gst_byte_reader_get_uint16_be_unchecked (GstByteReader * reader);
* current position.
*
* Returns: unsigned 24 bit integer (as guint32)
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_uint24_le_unchecked:
* the current position.
*
* Returns: unsigned 24 bit integer (as guint32)
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_uint24_be_unchecked:
* current position.
*
* Returns: unsigned 24 bit integer (as guint32)
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_uint24_be_unchecked:
* the current position.
*
* Returns: unsigned 24 bit integer (as guint32)
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_int24_le_unchecked:
* current position.
*
* Returns: signed 24 bit integer (as gint32)
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_int24_le_unchecked:
* the current position.
*
* Returns: signed 24 bit integer (as gint32)
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_int24_be_unchecked:
* current position.
*
* Returns: signed 24 bit integer (as gint32)
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_int24_be_unchecked:
* the current position.
*
* Returns: signed 24 bit integer (as gint32)
- *
- * Since: 0.10.25
*/
guint32 gst_byte_reader_get_uint24_le_unchecked (GstByteReader * reader);
guint32 gst_byte_reader_get_uint24_be_unchecked (GstByteReader * reader);
* current position.
*
* Returns: unsigned 32 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_uint32_le_unchecked:
* the current position.
*
* Returns: unsigned 32 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_uint32_be_unchecked:
* current position.
*
* Returns: unsigned 32 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_uint32_be_unchecked:
* the current position.
*
* Returns: unsigned 32 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_int32_le_unchecked:
* current position.
*
* Returns: signed 32 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_int32_le_unchecked:
* the current position.
*
* Returns: signed 32 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_int32_be_unchecked:
* current position.
*
* Returns: signed 32 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_int32_be_unchecked:
* the current position.
*
* Returns: signed 32 bit integer.
- *
- * Since: 0.10.25
*/
guint32 gst_byte_reader_get_uint32_le_unchecked (GstByteReader * reader);
guint32 gst_byte_reader_get_uint32_be_unchecked (GstByteReader * reader);
* current position.
*
* Returns: unsigned 64 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_uint64_le_unchecked:
* the current position.
*
* Returns: unsigned 64 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_uint64_be_unchecked:
* current position.
*
* Returns: unsigned 64 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_uint64_be_unchecked:
* the current position.
*
* Returns: unsigned 64 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_int64_le_unchecked:
* current position.
*
* Returns: signed 64 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_int64_le_unchecked:
* the current position.
*
* Returns: signed 64 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_int64_be_unchecked:
* current position.
*
* Returns: signed 64 bit integer.
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_int64_be_unchecked:
* the current position.
*
* Returns: signed 64 bit integer.
- *
- * Since: 0.10.25
*/
guint64 gst_byte_reader_get_uint64_le_unchecked (GstByteReader * reader);
guint64 gst_byte_reader_get_uint64_be_unchecked (GstByteReader * reader);
* data available and update the current position.
*
* Returns: floating point value read
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_float32_le_unchecked:
* data available, but keep the current position.
*
* Returns: floating point value read
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_float32_be_unchecked:
* data available and update the current position.
*
* Returns: floating point value read
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_float32_be_unchecked:
* data available, but keep the current position.
*
* Returns: floating point value read
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_float64_le_unchecked:
* data available and update the current position.
*
* Returns: double precision floating point value read
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_float64_le_unchecked:
* data available, but keep the current position.
*
* Returns: double precision floating point value read
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_get_float64_be_unchecked:
* data available and update the current position.
*
* Returns: double precision floating point value read
- *
- * Since: 0.10.25
*/
/**
* gst_byte_reader_peek_float64_be_unchecked:
* data available, but keep the current position.
*
* Returns: double precision floating point value read
- *
- * Since: 0.10.25
*/
gfloat gst_byte_reader_get_float32_le_unchecked (GstByteReader * reader);
* @reader: a #GstByteReader instance
*
* Returns: (transfer none): a constant pointer to the current data position
- *
- * Since: 0.10.25
*/
const guint8 * gst_byte_reader_peek_data_unchecked (GstByteReader * reader);
/**
*
* Returns: (transfer none) (array length=size): a constant pointer to the
* current data position.
- *
- * Since: 0.10.25
*/
const guint8 * gst_byte_reader_get_data_unchecked (GstByteReader * reader, guint size);
/**
*
* Returns: (transfer full) (array length=size): a newly-allocated copy of the
* data @size bytes in size. Free with g_free() when no longer needed.
- *
- * Since: 0.10.25
*/
guint8 * gst_byte_reader_dup_data_unchecked (GstByteReader * reader, guint size);
* Free-function: gst_byte_reader_free
*
* Returns: (transfer full): a new #GstByteReader instance
- *
- * Since: 0.10.22
*/
GstByteReader *
gst_byte_reader_new (const guint8 * data, guint size)
*
* Frees a #GstByteReader instance, which was previously allocated by
* gst_byte_reader_new().
- *
- * Since: 0.10.22
*/
void
gst_byte_reader_free (GstByteReader * reader)
*
* Initializes a #GstByteReader instance to read from @data. This function
* can be called on already initialized instances.
- *
- * Since: 0.10.22
*/
void
gst_byte_reader_init (GstByteReader * reader, const guint8 * data, guint size)
*
* Returns: %TRUE if the position could be set successfully, %FALSE
* otherwise.
- *
- * Since: 0.10.22
*/
gboolean
gst_byte_reader_set_pos (GstByteReader * reader, guint pos)
* Returns the current position of a #GstByteReader instance in bytes.
*
* Returns: The current position of @reader in bytes.
- *
- * Since: 0.10.22
*/
guint
gst_byte_reader_get_pos (const GstByteReader * reader)
* Returns the remaining number of bytes of a #GstByteReader instance.
*
* Returns: The remaining number of bytes of @reader instance.
- *
- * Since: 0.10.22
*/
guint
gst_byte_reader_get_remaining (const GstByteReader * reader)
* Returns the total number of bytes of a #GstByteReader instance.
*
* Returns: The total number of bytes of @reader instance.
- *
- * Since: 0.10.26
*/
guint
gst_byte_reader_get_size (const GstByteReader * reader)
* Skips @nbytes bytes of the #GstByteReader instance.
*
* Returns: %TRUE if @nbytes bytes could be skipped, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
gboolean
gst_byte_reader_skip (GstByteReader * reader, guint nbytes)
* Read an unsigned 8 bit integer into @val and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* Read a signed 8 bit integer into @val and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* Read an unsigned 8 bit integer into @val but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* Read a signed 8 bit integer into @val but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
#define GST_BYTE_READER_PEEK_GET(bits,type,name) \
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* and update the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
/**
* but keep the current position.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
GST_BYTE_READER_PEEK_GET(32,gfloat,float32_le)
*
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
gboolean
gst_byte_reader_get_data (GstByteReader * reader, guint size,
*
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.22
*/
gboolean
gst_byte_reader_peek_data (const GstByteReader * reader, guint size,
* updates the current position. Free with g_free() when no longer needed.
*
* Returns: %TRUE if successful, %FALSE otherwise.
- *
- * Since: 0.10.24
*/
gboolean
gst_byte_reader_dup_data (GstByteReader * reader, guint size, guint8 ** val)
* gst_byte_reader_masked_scan_uint32 (reader, 0xffff0000, 0x02030000, 0, 4);
* // -> returns -1
* </programlisting>
- *
- * Since: 0.10.24
*/
guint
gst_byte_reader_masked_scan_uint32 (const GstByteReader * reader, guint32 mask,
* This function will fail if no NUL-terminator was found in in the data.
*
* Returns: %TRUE if a string could be skipped, %FALSE otherwise.
- *
- * Since: 0.10.24
*/
/**
* gst_byte_reader_skip_string_utf8:
* This function will fail if no NUL-terminator was found in in the data.
*
* Returns: %TRUE if a string could be skipped, %FALSE otherwise.
- *
- * Since: 0.10.24
*/
GST_BYTE_READER_SKIP_STRING (8);
* This function will fail if no NUL-terminator was found in in the data.
*
* Returns: %TRUE if a string could be skipped, %FALSE otherwise.
- *
- * Since: 0.10.24
*/
GST_BYTE_READER_SKIP_STRING (16);
* This function will fail if no NUL-terminator was found in in the data.
*
* Returns: %TRUE if a string could be skipped, %FALSE otherwise.
- *
- * Since: 0.10.24
*/
GST_BYTE_READER_SKIP_STRING (32);
* This function will fail if no NUL-terminator was found in in the data.
*
* Returns: %TRUE if a string could be skipped, %FALSE otherwise.
- *
- * Since: 0.10.24
*/
/**
* gst_byte_reader_peek_string_utf8:
* This function will fail if no NUL-terminator was found in in the data.
*
* Returns: %TRUE if a string could be skipped, %FALSE otherwise.
- *
- * Since: 0.10.24
*/
gboolean
gst_byte_reader_peek_string_utf8 (const GstByteReader * reader,
* This function will fail if no NUL-terminator was found in in the data.
*
* Returns: %TRUE if a string could be found, %FALSE otherwise.
- *
- * Since: 0.10.24
*/
gboolean
gst_byte_reader_get_string_utf8 (GstByteReader * reader, const gchar ** str)
*
* Returns: %TRUE if a string could be read into @str, %FALSE otherwise. The
* string put into @str must be freed with g_free() when no longer needed.
- *
- * Since: 0.10.24
*/
GST_BYTE_READER_DUP_STRING (8, gchar);
*
* Returns: %TRUE if a string could be read, %FALSE otherwise. The
* string put into @str must be freed with g_free() when no longer needed.
- *
- * Since: 0.10.24
*/
GST_BYTE_READER_DUP_STRING (16, guint16);
*
* Returns: %TRUE if a string could be read, %FALSE otherwise. The
* string put into @str must be freed with g_free() when no longer needed.
- *
- * Since: 0.10.24
*/
GST_BYTE_READER_DUP_STRING (32, guint32);
* used. This macro can used be to initialize a variable, but it cannot
* be assigned to a variable. In that case you have to use
* gst_byte_reader_init().
- *
- * Since: 0.10.22
*/
#define GST_BYTE_READER_INIT(data, size) {data, size, 0}
*
* Writes a unsigned 8 bit integer to @writer without checking if there
* is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_uint8_unchecked (GstByteWriter *writer, guint8 val);
*
* Writes a unsigned big endian 16 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_uint16_be_unchecked (GstByteWriter *writer, guint16 val);
*
* Writes a unsigned big endian 24 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_uint24_be_unchecked (GstByteWriter *writer, guint32 val);
*
* Writes a unsigned big endian 32 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_uint32_be_unchecked (GstByteWriter *writer, guint32 val);
*
* Writes a unsigned big endian 64 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_uint64_be_unchecked (GstByteWriter *writer, guint64 val);
*
* Writes a unsigned little endian 16 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_uint16_le_unchecked (GstByteWriter *writer, guint16 val);
*
* Writes a unsigned little endian 24 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_uint24_le_unchecked (GstByteWriter *writer, guint32 val);
*
* Writes a unsigned little endian 32 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_uint32_le_unchecked (GstByteWriter *writer, guint32 val);
*
* Writes a unsigned little endian 64 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_uint64_le_unchecked (GstByteWriter *writer, guint64 val);
*
* Writes a signed 8 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_int8_unchecked (GstByteWriter *writer, gint8 val);
*
* Writes a signed big endian 16 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_int16_be_unchecked (GstByteWriter *writer, gint16 val);
*
* Writes a signed big endian 24 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_int24_be_unchecked (GstByteWriter *writer, gint32 val);
*
* Writes a signed big endian 32 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_int32_be_unchecked (GstByteWriter *writer, gint32 val);
*
* Writes a signed big endian 64 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_int64_be_unchecked (GstByteWriter *writer, gint64 val);
*
* Writes a signed little endian 16 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_int16_le_unchecked (GstByteWriter *writer, gint16 val);
*
* Writes a signed little endian 24 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_int24_le_unchecked (GstByteWriter *writer, gint32 val);
*
* Writes a signed little endian 32 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_int32_le_unchecked (GstByteWriter *writer, gint32 val);
*
* Writes a signed little endian 64 bit integer to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_int64_le_unchecked (GstByteWriter *writer, gint64 val);
*
* Writes a big endian 32 bit float to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_float32_be_unchecked (GstByteWriter *writer, gfloat val);
*
* Writes a big endian 64 bit float to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_float64_be_unchecked (GstByteWriter *writer, gdouble val);
*
* Writes a little endian 32 bit float to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_float32_le_unchecked (GstByteWriter *writer, gfloat val);
*
* Writes a little endian 64 bit float to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_float64_le_unchecked (GstByteWriter *writer, gdouble val);
*
* Writes @size bytes of @data to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_put_data_unchecked (GstByteWriter *writer, const guint8 *data, guint size);
*
* Writes @size bytes containing @value to @writer without
* checking if there is enough free space available in the byte writer.
- *
- * Since: 0.10.31
*/
void gst_byte_writer_fill_unchecked (GstByteWriter *writer, guint8 value, guint size);
* Free-function: gst_byte_writer_free
*
* Returns: (transfer full): a new, empty #GstByteWriter instance
- *
- * Since: 0.10.26
*/
GstByteWriter *
gst_byte_writer_new (void)
* Free-function: gst_byte_writer_free
*
* Returns: (transfer full): a new #GstByteWriter instance
- *
- * Since: 0.10.26
*/
GstByteWriter *
gst_byte_writer_new_with_size (guint size, gboolean fixed)
* Free-function: gst_byte_writer_free
*
* Returns: (transfer full): a new #GstByteWriter instance
- *
- * Since: 0.10.26
*/
GstByteWriter *
gst_byte_writer_new_with_data (guint8 * data, guint size, gboolean initialized)
* @writer: #GstByteWriter instance
*
* Initializes @writer to an empty instance
- *
- * Since: 0.10.26
*/
void
gst_byte_writer_init (GstByteWriter * writer)
* @fixed: If %TRUE the data can't be reallocated
*
* Initializes @writer with the given initial data size.
- *
- * Since: 0.10.26
*/
void
gst_byte_writer_init_with_size (GstByteWriter * writer, guint size,
* Initializes @writer with the given
* memory area. If @initialized is %TRUE it is possible to
* read @size bytes from the #GstByteWriter from the beginning.
- *
- * Since: 0.10.26
*/
void
gst_byte_writer_init_with_data (GstByteWriter * writer, guint8 * data,
*
* Resets @writer and frees the data if it's
* owned by @writer.
- *
- * Since: 0.10.26
*/
void
gst_byte_writer_reset (GstByteWriter * writer)
*
* Returns: (array) (transfer full): the current data. g_free() after
* usage.
- *
- * Since: 0.10.26
*/
guint8 *
gst_byte_writer_reset_and_get_data (GstByteWriter * writer)
*
* Returns: (transfer full): the current data as buffer. gst_buffer_unref()
* after usage.
- *
- * Since: 0.10.26
*/
GstBuffer *
gst_byte_writer_reset_and_get_buffer (GstByteWriter * writer)
* @writer: (in) (transfer full): #GstByteWriter instance
*
* Frees @writer and all memory allocated by it.
- *
- * Since: 0.10.26
*/
void
gst_byte_writer_free (GstByteWriter * writer)
* Free-function: g_free
*
* Returns: (transfer full): the current data. g_free() after usage.
- *
- * Since: 0.10.26
*/
guint8 *
gst_byte_writer_free_and_get_data (GstByteWriter * writer)
*
* Returns: (transfer full): the current data as buffer. gst_buffer_unref()
* after usage.
- *
- * Since: 0.10.26
*/
GstBuffer *
gst_byte_writer_free_and_get_buffer (GstByteWriter * writer)
* -1 is returned the remaining size is only limited by system resources.
*
* Returns: the remaining size of data that can still be written
- *
- * Since: 0.10.26
*/
guint
gst_byte_writer_get_remaining (const GstByteWriter * writer)
* available and reallocates if necessary.
*
* Returns: %TRUE if at least @size bytes are still available
- *
- * Since: 0.10.26
*/
gboolean
gst_byte_writer_ensure_free_space (GstByteWriter * writer, guint size)
* Writes a unsigned 8 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_uint16_be:
* Writes a unsigned big endian 16 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_uint24_be:
* Writes a unsigned big endian 24 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_uint32_be:
* Writes a unsigned big endian 32 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_uint64_be:
* Writes a unsigned big endian 64 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_uint16_le:
* Writes a unsigned little endian 16 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_uint24_le:
* Writes a unsigned little endian 24 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_uint32_le:
* Writes a unsigned little endian 32 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_uint64_le:
* Writes a unsigned little endian 64 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_int8:
* Writes a signed 8 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_int16_be:
* Writes a signed big endian 16 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_int24_be:
* Writes a signed big endian 24 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_int32_be:
* Writes a signed big endian 32 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_int64_be:
* Writes a signed big endian 64 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_int16_le:
* Writes a signed little endian 16 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_int24_le:
* Writes a signed little endian 24 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_int32_le:
* Writes a signed little endian 32 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_int64_le:
* Writes a signed little endian 64 bit integer to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_float32_be:
* Writes a big endian 32 bit float to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.27
*/
/**
* gst_byte_writer_put_float64_be:
* Writes a big endian 64 bit float to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.27
*/
/**
* gst_byte_writer_put_float32_le:
* Writes a little endian 32 bit float to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.27
*/
/**
* gst_byte_writer_put_float64_le:
* Writes a little endian 64 bit float to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.27
*/
/**
* gst_byte_writer_put_string_utf8:
* Writes a NUL-terminated UTF8 string to @writer (including the terminator).
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_string_utf16:
* Writes a NUL-terminated UTF16 string to @writer (including the terminator).
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_string_utf32:
* Writes a NUL-terminated UTF32 string to @writer (including the terminator).
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_put_data:
* Writes @size bytes of @data to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_fill:
* Writes @size bytes containing @value to @writer.
*
* Returns: %TRUE if the value could be written
- *
- * Since: 0.10.27
*/
/**
* @writer: #GstByteWriter instance
*
* Returns: The current position of the read/write cursor
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_set_pos:
* can only be between 0 and the current size.
*
* Returns: %TRUE if the new position could be set
- *
- * Since: 0.10.26
*/
/**
* gst_byte_writer_get_size:
* @writer: #GstByteWriter instance
*
* Returns: The current, initialized size of the data
- *
- * Since: 0.10.26
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC guint gst_byte_writer_get_pos (const GstByteWriter *writer);
* ISO-8859-1).
*
* Returns: %TRUE if the string could be written
- *
- * Since: 0.10.26
*/
#define gst_byte_writer_put_string(writer, data) \
gst_byte_writer_put_string_utf8(writer, data)
* </itemizedlist>
*
* Last reviewed on 2011-10-28 (0.10.36)
- *
- * Since: 0.10.36
*/
#ifdef HAVE_CONFIG_H
* MT safe.
*
* Returns: (transfer full): a new #GstCollectPads, or NULL in case of an error.
- *
- * Since: 0.10.36
*/
GstCollectPads *
gst_collect_pads_new (void)
* the oldest buffer when all pads have been collected.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_collect_pads_set_buffer_function (GstCollectPads * pads,
* Set the timestamp comparison function.
*
* MT safe.
- *
- * Since: 0.10.36
*/
/* NOTE allowing to change comparison seems not advisable;
no known use-case, and collaboration with default algorithm is unpredictable.
* If this callback is set, the former will be unset.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_collect_pads_set_function (GstCollectPads * pads,
* if so (unusually) needed.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_collect_pads_set_event_function (GstCollectPads * pads,
* if so (unusually) needed.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_collect_pads_set_query_function (GstCollectPads * pads,
*
* Convenience clipping function that converts incoming buffer's timestamp
* to running time, or clips the buffer if outside configured segment.
-*
-* Since: 0.10.37
*/
GstFlowReturn
gst_collect_pads_clip_running_time (GstCollectPads * pads,
*
* Install a clipping function that is called right after a buffer is received
* on a pad managed by @pads. See #GstCollectPad2ClipFunction for more info.
- *
- * Since: 0.10.36
*/
void
gst_collect_pads_set_clip_function (GstCollectPads * pads,
*
* Returns: a new #GstCollectData to identify the new pad. Or NULL
* if wrong parameters are supplied.
- *
- * Since: 0.10.36
*/
GstCollectData *
gst_collect_pads_add_pad (GstCollectPads * pads, GstPad * pad, guint size)
*
* MT safe.
*
- * Since: 0.10.36
- *
* Returns: a new #GstCollectData to identify the new pad. Or NULL
* if wrong parameters are supplied.
*/
* MT safe.
*
* Returns: %TRUE if the pad could be removed.
- *
- * Since: 0.10.36
*/
gboolean
gst_collect_pads_remove_pad (GstCollectPads * pads, GstPad * pad)
* MT safe.
*
* Returns: %TRUE if the pad is active.
- *
- * Since: 0.10.36
*/
gboolean
gst_collect_pads_is_active (GstCollectPads * pads, GstPad * pad)
* MT safe.
*
* Returns: #GstFlowReturn of the operation.
- *
- * Since: 0.10.36
*/
GstFlowReturn
gst_collect_pads_collect (GstCollectPads * pads)
* MT safe.
*
* Returns: #GstFlowReturn of the operation.
- *
- * Since: 0.10.36
*/
GstFlowReturn
gst_collect_pads_collect_range (GstCollectPads * pads, guint64 offset,
* e.g. by sending a FLUSH_START downstream.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_collect_pads_set_flushing (GstCollectPads * pads, gboolean flushing)
* Starts the processing of data in the collect_pads.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_collect_pads_start (GstCollectPads * pads)
* will also unblock any blocking operations.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_collect_pads_stop (GstCollectPads * pads)
*
* Returns: The buffer in @data or NULL if no buffer is queued.
* should unref the buffer after usage.
- *
- * Since: 0.10.36
*/
GstBuffer *
gst_collect_pads_peek (GstCollectPads * pads, GstCollectData * data)
*
* Returns: (transfer full): The buffer in @data or NULL if no buffer was
* queued. You should unref the buffer after usage.
- *
- * Since: 0.10.36
*/
GstBuffer *
gst_collect_pads_pop (GstCollectPads * pads, GstCollectData * data)
*
* Returns: The maximum number of bytes queued on all pads. This function
* returns 0 if a pad has no queued buffer.
- *
- * Since: 0.10.36
*/
/* we might pre-calculate this in some struct field,
* but would then have to maintain this in _chain and particularly _pop, etc,
*
* Returns: The number of bytes flushed This can be less than @size and
* is 0 if the pad was end-of-stream.
- *
- * Since: 0.10.36
*/
guint
gst_collect_pads_flush (GstCollectPads * pads, GstCollectData * data,
*
* MT safe.
*
- * Since: 0.10.36
- *
* Returns: (transfer full): A sub buffer. The size of the buffer can be less that requested.
* A return of NULL signals that the pad is end-of-stream.
* Unref the buffer after use.
*
* MT safe.
*
- * Since: 0.10.36
- *
* Returns: A sub buffer. The size of the buffer can be less that requested.
* A return of NULL signals that the pad is end-of-stream.
* Unref the buffer after use.
* in the callback.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_collect_pads_set_waiting (GstCollectPads * pads, GstCollectData * data,
*
* This function should be called with STREAM_LOCK held,
* such as in the callback.
- *
- * Since: 0.10.36
*/
static void
gst_collect_pads_find_best_pad (GstCollectPads * pads,
* Default GstCollectPads event handling that elements should always
* chain up to to ensure proper operation. Element might however indicate
* event should not be forwarded downstream.
- *
- * Since: 0.11.x
*/
gboolean
gst_collect_pads_event_default (GstCollectPads * pads, GstCollectData * data,
* Default GstCollectPads query handling that elements should always
* chain up to to ensure proper operation. Element might however indicate
* query should not be forwarded downstream.
- *
- * Since: 0.11.x
*/
gboolean
gst_collect_pads_query_default (GstCollectPads * pads, GstCollectData * data,
* A function that will be called when the #GstCollectData will be freed.
* It is passed the pointer to the structure and should free any custom
* memory and resources allocated for it.
- *
- * Since: 0.10.36
*/
typedef void (*GstCollectDataDestroyNotify) (GstCollectData *data);
* @GST_COLLECT_PADS_STATE_LOCKED: Set collectdata's pad WAITING state must
* not be changed.
* #GstCollectPadsStateFlags indicate private state of a collectdata('s pad).
- *
- * Since: 0.10.36
*/
typedef enum {
GST_COLLECT_PADS_STATE_EOS = 1 << 0,
*
* A flags word containing #GstCollectPadsStateFlags flags set
* on this collected pad.
- *
- * Since: 0.10.36
*/
#define GST_COLLECT_PADS_STATE(data) (((GstCollectData *) data)->state)
/**
* @flag: the #GstCollectPadsStateFlags to check.
*
* Gives the status of a specific flag on a collected pad.
- *
- * Since: 0.10.36
*/
#define GST_COLLECT_PADS_STATE_IS_SET(data,flag) !!(GST_COLLECT_PADS_STATE (data) & flag)
/**
* @flag: the #GstCollectPadsStateFlags to set.
*
* Sets a state flag on a collected pad.
- *
- * Since: 0.10.36
*/
#define GST_COLLECT_PADS_STATE_SET(data,flag) (GST_COLLECT_PADS_STATE (data) |= flag)
/**
* @flag: the #GstCollectPadsStateFlags to clear.
*
* Clears a state flag on a collected pad.
- *
- * Since: 0.10.36
*/
#define GST_COLLECT_PADS_STATE_UNSET(data,flag) (GST_COLLECT_PADS_STATE (data) &= ~(flag))
* @segment: last segment received.
*
* Structure used by the collect_pads.
- *
- * Since: 0.10.36
*/
struct _GstCollectData
{
* A function that will be called when all pads have received data.
*
* Returns: #GST_FLOW_OK for success
- *
- * Since: 0.10.36
*/
typedef GstFlowReturn (*GstCollectPadsFunction) (GstCollectPads *pads, gpointer user_data);
* and NULL @data.
*
* Returns: #GST_FLOW_OK for success
- *
- * Since: 0.10.36
*/
typedef GstFlowReturn (*GstCollectPadsBufferFunction) (GstCollectPads *pads, GstCollectData *data,
GstBuffer *buffer, gpointer user_data);
* Returns: Integer less than zero when first timestamp is deemed older than the second one.
* Zero if the timestamps are deemed equally old.
* Integer greate than zero when second timestamp is deemed older than the first one.
- *
- * Since: 0.10.36
*/
typedef gint (*GstCollectPadsCompareFunction) (GstCollectPads *pads,
GstCollectData * data1, GstClockTime timestamp1,
* being handled by the default handler).
*
* Returns: %TRUE if the pad could handle the event
- *
- * Since: 0.10.36
*/
typedef gboolean (*GstCollectPadsEventFunction) (GstCollectPads *pads, GstCollectData * pad,
GstEvent * event, gpointer user_data);
* events downstream (with gst_pad_event_default()).
*
* Returns: %TRUE if the pad could handle the event
- *
- * Since: 0.11.x
*/
typedef gboolean (*GstCollectPadsQueryFunction) (GstCollectPads *pads, GstCollectData * pad,
GstQuery * query, gpointer user_data);
* @outbuffer or return %NULL in @outbuffer if the buffer should be dropped.
*
* Returns: a #GstFlowReturn that corresponds to the result of clipping.
- *
- * Since: 0.10.36
*/
typedef GstFlowReturn (*GstCollectPadsClipFunction) (GstCollectPads *pads, GstCollectData *data,
GstBuffer *inbuffer, GstBuffer **outbuffer,
* Get the stream lock of @pads. The stream lock is used to coordinate and
* serialize execution among the various streams being collected, and in
* protecting the resources used to accomplish this.
- *
- * Since: 0.10.36
*/
#define GST_COLLECT_PADS_GET_STREAM_LOCK(pads) (&((GstCollectPads *)pads)->stream_lock)
/**
* @pads: a #GstCollectPads
*
* Lock the stream lock of @pads.
- *
- * Since: 0.10.36
*/
#define GST_COLLECT_PADS_STREAM_LOCK(pads) g_rec_mutex_lock(GST_COLLECT_PADS_GET_STREAM_LOCK (pads))
/**
* @pads: a #GstCollectPads
*
* Unlock the stream lock of @pads.
- *
- * Since: 0.10.36
*/
#define GST_COLLECT_PADS_STREAM_UNLOCK(pads) g_rec_mutex_unlock(GST_COLLECT_PADS_GET_STREAM_LOCK (pads))
* @data: #GList of #GstCollectData managed by this #GstCollectPads.
*
* Collectpads object.
- *
- * Since: 0.10.36
*/
struct _GstCollectPads {
GstObject object;
*
* Lets the app register a custom function to map index
* ids to writer descriptions.
- *
- * Since: 0.10.18
*/
void
gst_index_set_resolver_full (GstIndex * index, GstIndexResolver resolver,
*
* Returns: (transfer full): the #GstCaps corresponding to the data stream.
* Returns #NULL if no #GstCaps matches the data stream.
- *
- * Since: 0.10.26
*/
GstCaps *
gst_type_find_helper_get_range (GstObject * obj, GstObject * parent,
* Returns: (transfer full): the #GstCaps corresponding to @extension, or
* #NULL if no type could be found. The caller should free the caps
* returned with gst_caps_unref().
- *
- * Since: 0.10.23
*/
GstCaps *
gst_type_find_helper_for_extension (GstObject * obj, const gchar * extension)
*
* Unref and remove all buffers that are in the global @buffers GList,
* emptying the list.
- *
- * Since: 0.10.18
*/
void
gst_check_drop_buffers (void)
*
* Compare two caps with gst_caps_is_equal and fail unless they are
* equal.
- *
- * Since: 0.10.18
*/
void
gst_check_caps_equal (GstCaps * caps1, GstCaps * caps2)
* pushing the final buffer in the list.
* This can be used to set up a test which pushes some buffers and then an
* invalid buffer, when the final buffer is expected to fail, for example.
- *
- * Since: 0.10.18
*/
/* FIXME 0.11: rename this function now that there's GstBufferList? */
void
* @buffer_in to this element. The element should create one buffer
* and this will be compared with @buffer_out. We only check the caps
* and the data of the buffers. This function unrefs the buffers.
- *
- * Since: 0.10.18
*/
void
gst_check_element_push_buffer (const gchar * element_name,
* This macro checks that @a and @b are (almost) equal and aborts if this
* is not the case, printing both expressions and the values they evaluated
* to. This macro is for use in unit tests.
- *
- * Since: 0.10.14
*/
#define fail_unless_equals_float(a, b) \
G_STMT_START { \
* This macro checks that @a and @b are (almost) equal and aborts if this
* is not the case, printing both expressions and the values they evaluated
* to. This macro is for use in unit tests.
- *
- * Since: 0.10.14
*/
#define assert_equals_float(a, b) fail_unless_equals_float(a, b)
*
* These macros and functions are for internal use of the unit tests found
* inside the 'check' directories of various GStreamer packages.
- *
- * Since: 0.10.24
*/
#include "gstconsistencychecker.h"
* data flow is inconsistent.
*
* Returns: A #GstStreamConsistency structure used to track data flow.
- *
- * Since: 0.10.24
*/
GstStreamConsistency *
gst_consistency_checker_new (GstPad * pad)
* data flow is inconsistent.
*
* Returns: %TRUE if the pad was added
- *
- * Since: 0.10.37
*/
gboolean
gst_consistency_checker_add_pad (GstStreamConsistency * consist, GstPad * pad)
* @consist: The #GstStreamConsistency to reset.
*
* Reset the stream checker's internal variables.
- *
- * Since: 0.10.24
*/
void
* @consist: The #GstStreamConsistency to free.
*
* Frees the allocated data and probes associated with @consist.
- *
- * Since: 0.10.24
*/
void
* GstStreamConsistency:
*
* Opaque consistency checker handle.
- *
- * Since: 0.10.24
*/
typedef struct _GstStreamConsistency GstStreamConsistency;
* #GstDataQueue is an object that handles threadsafe queueing of objects. It
* also provides size-related functionality. This object should be used for
* any #GstElement that wishes to provide some sort of queueing functionality.
- *
- * Since: 0.10.11
*/
#include <gst/gst.h>
* or @emptycallback.
*
* Returns: a new #GstDataQueue.
- *
- * Since: 0.10.26
*/
GstDataQueue *
* Flushes all the contents of the @queue. Any call to #gst_data_queue_push and
* #gst_data_queue_pop will be released.
* MT safe.
- *
- * Since: 0.10.11
*/
void
gst_data_queue_flush (GstDataQueue * queue)
* MT safe.
*
* Returns: #TRUE if @queue is empty.
- *
- * Since: 0.10.11
*/
gboolean
gst_data_queue_is_empty (GstDataQueue * queue)
* MT safe.
*
* Returns: #TRUE if @queue is full.
- *
- * Since: 0.10.11
*/
gboolean
gst_data_queue_is_full (GstDataQueue * queue)
* all calls to those two functions will return #FALSE.
*
* MT Safe.
- *
- * Since: 0.10.11
*/
void
gst_data_queue_set_flushing (GstDataQueue * queue, gboolean flushing)
* is returned, the caller is responsible for freeing @item and its contents.
*
* Returns: #TRUE if the @item was successfully pushed on the @queue.
- *
- * Since: 0.10.11
*/
gboolean
gst_data_queue_push (GstDataQueue * queue, GstDataQueueItem * item)
* MT safe.
*
* Returns: #TRUE if an @item was successfully retrieved from the @queue.
- *
- * Since: 0.10.11
*/
gboolean
gst_data_queue_pop (GstDataQueue * queue, GstDataQueueItem ** item)
* Pop and unref the head-most #GstMiniObject with the given #GType.
*
* Returns: TRUE if an element was removed.
- *
- * Since: 0.10.11
*/
gboolean
gst_data_queue_drop_head (GstDataQueue * queue, GType type)
*
* Inform the queue that the limits for the fullness check have changed and that
* any blocking gst_data_queue_push() should be unblocked to recheck the limts.
- *
- * Since: 0.10.11
*/
void
gst_data_queue_limits_changed (GstDataQueue * queue)
* @level: the location to store the result
*
* Get the current level of the queue.
- *
- * Since: 0.10.11
*/
void
gst_data_queue_get_level (GstDataQueue * queue, GstDataQueueSize * level)
*
* Structure used by #GstDataQueue. You can supply a different structure, as
* long as the top of the structure is identical to this structure.
- *
- * Since: 0.10.11
*/
struct _GstDataQueueItem
* @time: amount of time
*
* Structure describing the size of a queue.
- *
- * Since: 0.10.11
*/
struct _GstDataQueueSize
{
* considered as full.
*
* Returns: #TRUE if the queue should be considered full.
- *
- * Since: 0.10.11
*/
typedef gboolean (*GstDataQueueCheckFullFunction) (GstDataQueue * queue,
guint visible, guint bytes, guint64 time, gpointer checkdata);
* @object: the parent structure
*
* Opaque #GstDataQueue structure.
- *
- * Since: 0.10.11
*/
struct _GstDataQueue
{
* @pad: the pad that received it
*
* This signal gets emitted before unreffing the buffer.
- *
- * Since: 0.10.7
*/
gst_fake_sink_signals[SIGNAL_PREROLL_HANDOFF] =
g_signal_new ("preroll-handoff", G_TYPE_FROM_CLASS (klass),
* GstFakeSrc:format
*
* Set the format of the newsegment events to produce.
- *
- * Since: 0.10.20
*/
g_object_class_install_property (gobject_class, PROP_FORMAT,
g_param_spec_enum ("format", "Format",
* GstFdSrc:timeout
*
* Post a message after timeout microseconds
- *
- * Since: 0.10.21
*/
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TIMEOUT,
g_param_spec_uint64 ("timeout", "Timeout",
* GstFileSink:append
*
* Append to an already existing file.
- *
- * Since: 0.10.25
*/
g_object_class_install_property (gobject_class, PROP_APPEND,
g_param_spec_boolean ("append", "Append",
*
* If set to #TRUE, the identity will emit a handoff signal when handling a buffer.
* When set to #FALSE, no signal will be emited, which might improve performance.
- *
- * Since: 0.10.16
*/
g_object_class_install_property (gobject_class, PROP_SIGNAL_HANDOFFS,
g_param_spec_boolean ("signal-handoffs",
* #GST_FLOW_NOT_LINKED
* </listitem>
* </itemizedlist>
- *
- * Since: 0.10.32
*/
#ifdef HAVE_CONFIG_H
* To make sure no buffers are dropped by input-selector
* that might be needed when switching the active pad,
* sync-mode should be set to "clock" and cache-buffers to TRUE.
- *
- * Since: 0.10.36
*/
g_object_class_install_property (gobject_class, PROP_SYNC_STREAMS,
g_param_spec_boolean ("sync-streams", "Sync Streams",
* be ahead of current clock time when switching the active pad, as the current
* active pad may have pushed more buffers than what was displayed/consumed,
* which may cause delays and some missing buffers.
- *
- * Since: 0.10.36
*/
g_object_class_install_property (gobject_class, PROP_SYNC_MODE,
g_param_spec_enum ("sync-mode", "Sync mode",
*
* Enable the buffering option in multiqueue so that BUFFERING messages are
* emited based on low-/high-percent thresholds.
- *
- * Since: 0.10.26
*/
g_object_class_install_property (gobject_class, PROP_USE_BUFFERING,
g_param_spec_boolean ("use-buffering", "Use buffering",
* GstMultiQueue:low-percent
*
* Low threshold percent for buffering to start.
- *
- * Since: 0.10.26
*/
g_object_class_install_property (gobject_class, PROP_LOW_PERCENT,
g_param_spec_int ("low-percent", "Low percent",
* GstMultiQueue:high-percent
*
* High threshold percent for buffering to finish.
- *
- * Since: 0.10.26
*/
g_object_class_install_property (gobject_class, PROP_HIGH_PERCENT,
g_param_spec_int ("high-percent", "High percent",
* Otherwise multiqueue will synchronize the deactivated or not-linked
* streams by keeping the order in which buffers and events arrived compared
* to active and linked streams.
- *
- * Since: 0.10.36
*/
g_object_class_install_property (gobject_class, PROP_SYNC_BY_RUNNING_TIME,
g_param_spec_boolean ("sync-by-running-time", "Sync By Running Time",
* @see_also: #GstOutputSelector, #GstInputSelector
*
* Direct input stream to one out of N output pads.
- *
- * Since: 0.10.32
*/
#ifdef HAVE_CONFIG_H
*
* Don't emit queue signals. Makes queues more lightweight if no signals are
* needed.
- *
- * Since: 0.10.31
*/
g_object_class_install_property (gobject_class, PROP_SILENT,
g_param_spec_boolean ("silent", "Silent",
* GstQueue2:temp-remove
*
* When temp-template is set, remove the temporary file when going to READY.
- *
- * Since: 0.10.26
*/
g_object_class_install_property (gobject_class, PROP_TEMP_REMOVE,
g_param_spec_boolean ("temp-remove", "Remove the Temporary File",
*
* The maximum size of the ring buffer in bytes. If set to 0, the ring
* buffer is disabled. Default 0.
- *
- * Since: 0.10.31
*/
g_object_class_install_property (gobject_class, PROP_RING_BUFFER_MAX_SIZE,
g_param_spec_uint64 ("ring-buffer-max-size",
* gst-plugins-bad.
*
* Documentation last reviewed on 2010-12-30 (0.10.31)
- *
- * Since: 0.10.32
*/
#ifdef HAVE_CONFIG_H
* GstValve:
*
* The private valve structure
- *
- * Since: 0.10.32
*/
struct _GstValve
{