Blame docs/libs/html/gstreamer-libs-GstQueueArray.html

Packit f546b1
Packit f546b1
<html>
Packit f546b1
<head>
Packit f546b1
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit f546b1
<title>GstQueueArray: GStreamer 1.0 Library Reference Manual</title>
Packit f546b1
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit f546b1
<link rel="home" href="index.html" title="GStreamer 1.0 Library Reference Manual">
Packit f546b1
<link rel="up" href="gstreamer-base.html" title="GStreamer Base and Utillity Classes">
Packit f546b1
<link rel="prev" href="gstreamer-libs-GstDataQueue.html" title="GstDataQueue">
Packit f546b1
<link rel="next" href="gstreamer-control.html" title="GStreamer Dynamic Parameter Control">
Packit f546b1
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit f546b1
<link rel="stylesheet" href="style.css" type="text/css">
Packit f546b1
</head>
Packit f546b1
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit f546b1
Packit f546b1
Packit f546b1
Top  | 
Packit f546b1
                  Description
Packit f546b1
Packit f546b1
Home
Packit f546b1
Up
Packit f546b1
Prev
Packit f546b1
Next
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

GstQueueArray

Packit f546b1

GstQueueArray — Array based queue object

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Functions

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstQueueArray *
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_new ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
void
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_free ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
guint
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_get_length ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gpointer
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_pop_head ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gpointer
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_peek_head ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
void
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_push_tail ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gpointer
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_pop_tail ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gpointer
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_peek_tail ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gboolean
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_is_empty ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gpointer
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_drop_element ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
guint
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_find ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstQueueArray *
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_new_for_struct ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
void
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_push_tail_struct ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gpointer
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_peek_head_struct ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gpointer
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_pop_head_struct ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gpointer
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_peek_tail_struct ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gpointer
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_pop_tail_struct ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
gboolean
Packit f546b1
Packit f546b1
Packit f546b1
gst_queue_array_drop_struct ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Types and Values

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
 
Packit f546b1
GstQueueArray
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Includes

Packit f546b1
#include <gst/base/gstqueuearray.h>
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Description

Packit f546b1

GstQueueArray is an object that provides standard queue functionality

Packit f546b1
based on an array instead of linked lists. This reduces the overhead
Packit f546b1
caused by memory management by a large factor.

Packit f546b1
Packit f546b1
Packit f546b1

Functions

Packit f546b1
Packit f546b1

gst_queue_array_new ()

Packit f546b1
GstQueueArray *
Packit f546b1
gst_queue_array_new (guint initial_size);
Packit f546b1

Allocates a new GstQueueArray object with an initial

Packit f546b1
queue size of initial_size
Packit f546b1
.

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

initial_size

Packit f546b1

Initial size of the new queue

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

a new GstQueueArray object

Packit f546b1
Packit f546b1

Since: 1.2

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_free ()

Packit f546b1
void
Packit f546b1
gst_queue_array_free (GstQueueArray *array);
Packit f546b1

Frees queue array

Packit f546b1
 and all memory associated to it.

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

array

Packit f546b1

a GstQueueArray object

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Since: 1.2

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_get_length ()

Packit f546b1
guint
Packit f546b1
gst_queue_array_get_length (GstQueueArray *array);
Packit f546b1

Returns the length of the queue array

Packit f546b1

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

array

Packit f546b1

a GstQueueArray object

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

the length of the queue array

Packit f546b1
.

Packit f546b1
Packit f546b1

Since: 1.2

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_pop_head ()

Packit f546b1
gpointer
Packit f546b1
gst_queue_array_pop_head (GstQueueArray *array);
Packit f546b1

Returns and head of the queue array

Packit f546b1
 and removes
Packit f546b1
it from the queue.

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

array

Packit f546b1

a GstQueueArray object

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

The head of the queue

Packit f546b1
Packit f546b1

Since: 1.2

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_peek_head ()

Packit f546b1
gpointer
Packit f546b1
gst_queue_array_peek_head (GstQueueArray *array);
Packit f546b1

Returns the head of the queue array

Packit f546b1
 and does not
Packit f546b1
remove it from the queue.

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

array

Packit f546b1

a GstQueueArray object

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

The head of the queue

Packit f546b1
Packit f546b1

Since: 1.2

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_push_tail ()

Packit f546b1
void
Packit f546b1
gst_queue_array_push_tail (GstQueueArray *array,
Packit f546b1
                           gpointer data);
Packit f546b1

Pushes data

Packit f546b1
 to the tail of the queue array
Packit f546b1
.

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

array

Packit f546b1

a GstQueueArray object

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

data

Packit f546b1

object to push

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Since: 1.2

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_pop_tail ()

Packit f546b1
gpointer
Packit f546b1
gst_queue_array_pop_tail (GstQueueArray *array);
Packit f546b1

Returns the tail of the queue array

Packit f546b1
 and removes
Packit f546b1
it from the queue.

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

array

Packit f546b1

a GstQueueArray object

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

The tail of the queue

Packit f546b1
Packit f546b1

Since: 1.14

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_peek_tail ()

Packit f546b1
gpointer
Packit f546b1
gst_queue_array_peek_tail (GstQueueArray *array);
Packit f546b1

Returns the tail of the queue array

Packit f546b1
, but does not remove it from the queue.

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

array

Packit f546b1

a GstQueueArray object

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

The tail of the queue

Packit f546b1
Packit f546b1

Since: 1.14

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_is_empty ()

Packit f546b1
gboolean
Packit f546b1
gst_queue_array_is_empty (GstQueueArray *array);
Packit f546b1

Checks if the queue array

Packit f546b1
 is empty.

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

array

Packit f546b1

a GstQueueArray object

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

TRUE if the queue array

Packit f546b1
is empty

Packit f546b1
Packit f546b1

Since: 1.2

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_drop_element ()

Packit f546b1
gpointer
Packit f546b1
gst_queue_array_drop_element (GstQueueArray *array,
Packit f546b1
                              guint idx);
Packit f546b1

Drops the queue element at position idx

Packit f546b1
 from queue array
Packit f546b1
.

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

array

Packit f546b1

a GstQueueArray object

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

idx

Packit f546b1

index to drop

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

the dropped element

Packit f546b1
Packit f546b1

Since: 1.2

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_find ()

Packit f546b1
guint
Packit f546b1
gst_queue_array_find (GstQueueArray *array,
Packit f546b1
                      GCompareFunc func,
Packit f546b1
                      gpointer data);
Packit f546b1

Finds an element in the queue array

Packit f546b1
, either by comparing every element
Packit f546b1
with func
Packit f546b1
 or by looking up data
Packit f546b1
 if no compare function func
Packit f546b1
 is provided,
Packit f546b1
and returning the index of the found element.

Packit f546b1

Note that the index is not 0-based, but an internal index number with a

Packit f546b1
random offset. The index can be used in connection with
Packit f546b1
gst_queue_array_drop_element(). FIXME: return index 0-based and make
Packit f546b1
gst_queue_array_drop_element() take a 0-based index.

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

array

Packit f546b1

a GstQueueArray object

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

func

Packit f546b1

comparison function, or NULL to find data

Packit f546b1
by value. 

Packit f546b1
[allow-none]
Packit f546b1
Packit f546b1
Packit f546b1

data

Packit f546b1

data for comparison function

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

Index of the found element or -1 if nothing was found.

Packit f546b1
Packit f546b1

Since: 1.2

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_new_for_struct ()

Packit f546b1
GstQueueArray *
Packit f546b1
gst_queue_array_new_for_struct (gsize struct_size,
Packit f546b1
                                guint initial_size);
Packit f546b1

Allocates a new GstQueueArray object for elements (e.g. structures)

Packit f546b1
of size struct_size
Packit f546b1
, with an initial queue size of initial_size
Packit f546b1
.

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

struct_size

Packit f546b1

Size of each element (e.g. structure) in the array

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

initial_size

Packit f546b1

Initial size of the new queue

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

a new GstQueueArray object

Packit f546b1
Packit f546b1

Since: 1.6

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_push_tail_struct ()

Packit f546b1
void
Packit f546b1
gst_queue_array_push_tail_struct (GstQueueArray *array,
Packit f546b1
                                  gpointer p_struct);
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_peek_head_struct ()

Packit f546b1
gpointer
Packit f546b1
gst_queue_array_peek_head_struct (GstQueueArray *array);
Packit f546b1

Returns the head of the queue array

Packit f546b1
 without removing it from the queue.

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

array

Packit f546b1

a GstQueueArray object

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

pointer to element or struct, or NULL if array

Packit f546b1
was empty. The
Packit f546b1
data pointed to by the returned pointer stays valid only as long as
Packit f546b1
the queue array is not modified further!

Packit f546b1
Packit f546b1

Since: 1.6

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_pop_head_struct ()

Packit f546b1
gpointer
Packit f546b1
gst_queue_array_pop_head_struct (GstQueueArray *array);
Packit f546b1

Returns the head of the queue array

Packit f546b1
 and removes it from the queue.

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

array

Packit f546b1

a GstQueueArray object

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

pointer to element or struct, or NULL if array

Packit f546b1
was empty. The
Packit f546b1
data pointed to by the returned pointer stays valid only as long as
Packit f546b1
the queue array is not modified further!

Packit f546b1
Packit f546b1

Since: 1.6

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_peek_tail_struct ()

Packit f546b1
gpointer
Packit f546b1
gst_queue_array_peek_tail_struct (GstQueueArray *array);
Packit f546b1

Returns the tail of the queue array

Packit f546b1
, but does not remove it from the queue.

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

array

Packit f546b1

a GstQueueArray object

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

The tail of the queue

Packit f546b1
Packit f546b1

Since: 1.14

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_pop_tail_struct ()

Packit f546b1
gpointer
Packit f546b1
gst_queue_array_pop_tail_struct (GstQueueArray *array);
Packit f546b1

Returns the tail of the queue array

Packit f546b1
 and removes
Packit f546b1
it from the queue.

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

array

Packit f546b1

a GstQueueArray object

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

The tail of the queue

Packit f546b1
Packit f546b1

Since: 1.14

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_queue_array_drop_struct ()

Packit f546b1
gboolean
Packit f546b1
gst_queue_array_drop_struct (GstQueueArray *array,
Packit f546b1
                             guint idx,
Packit f546b1
                             gpointer p_struct);
Packit f546b1

Drops the queue element at position idx

Packit f546b1
 from queue array
Packit f546b1
 and copies the
Packit f546b1
data of the element or structure that was removed into p_struct
Packit f546b1
 if
Packit f546b1
p_struct
Packit f546b1
 is set (not NULL).

Packit f546b1

[skip]

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

array

Packit f546b1

a GstQueueArray object

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

idx

Packit f546b1

index to drop

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

p_struct

Packit f546b1

address into which to store the data of the dropped structure, or NULL

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

TRUE on success, or FALSE on error

Packit f546b1
Packit f546b1

Since: 1.6

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Types and Values

Packit f546b1
Packit f546b1

GstQueueArray

Packit f546b1
typedef struct _GstQueueArray GstQueueArray;
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Generated by GTK-Doc V1.27
Packit f546b1
</body>
Packit f546b1
</html>