struct GstBin

struct GstBin;

enum GstBinFlags

typedef enum {
  /* this bin is a manager of child elements, i.e. a pipeline or thread */
  GST_BIN_FLAG_MANAGER		= GST_ELEMENT_FLAG_LAST,

  /* this bin iterates itself */
  GST_BIN_SELF_SCHEDULABLE,

  /* we prefer to have cothreads when its an option, over chain-based */
  GST_BIN_FLAG_PREFER_COTHREADS,

  GST_BIN_FLAG_FIXED_CLOCK,

  /* padding */
  GST_BIN_FLAG_LAST		= GST_ELEMENT_FLAG_LAST + 5
} GstBinFlags;

Flags for a bin.

gst_bin_new ()

GstElement* gst_bin_new                     (const gchar *name);

Create a new bin with given name.

gst_bin_add ()

void        gst_bin_add                     (GstBin *bin,
                                             GstElement *element);

Adds the given element to the bin. Sets the element's parent, and thus adds a reference.

gst_bin_add_many ()

void        gst_bin_add_many                (GstBin *bin,
                                             GstElement *element_1,
                                             ...);

Adds a NULL-terminated list of elements to a bin. This function is equivalent to calling #gst_bin_add() for each member of the list.

gst_bin_remove ()

void        gst_bin_remove                  (GstBin *bin,
                                             GstElement *element);

Remove the element from its associated bin, unparenting it as well. Unparenting the element means that the element will be dereferenced, so if the bin holds the only reference to the element, the element will be freed in the process of removing it from the bin. If you want the element to still exist after removing, you need to call gst_object_ref before removing it from the bin.

gst_bin_remove_many ()

void        gst_bin_remove_many             (GstBin *bin,
                                             GstElement *element_1,
                                             ...);

Remove a list of elements from a bin. This function is equivalent to calling gst_bin_remove with each member of the list.

gst_bin_get_by_name ()

GstElement* gst_bin_get_by_name             (GstBin *bin,
                                             const gchar *name);

Get the element with the given name from this bin.

gst_bin_get_by_name_recurse_up ()

GstElement* gst_bin_get_by_name_recurse_up  (GstBin *bin,
                                             const gchar *name);

Get the element with the given name from this bin. If the element is not found, a recursion is performed on the parent bin.

gst_bin_get_list ()

G_CONST_RETURN GList* gst_bin_get_list      (GstBin *bin);

Get the list of elements in this bin.

gst_bin_get_by_interface ()

GstElement* gst_bin_get_by_interface        (GstBin *bin,
                                             GType interface);

Looks for the first element inside the bin that implements the given interface. If such an element is found, it returns the element. You can cast this element to the given interface afterwards. If you want all elements that implement the interface, use gst_bin_get_all_by_interface(). The function recurses bins inside bins.

gst_bin_get_all_by_interface ()

GList*      gst_bin_get_all_by_interface    (GstBin *bin,
                                             GType interface);

Looks for all elements inside the bin that implements the given interface. You can safely cast all returned elements to the given interface. The function recurses bins inside bins. You need to free the list using g_list_free() after use.

gst_bin_iterate ()

gboolean    gst_bin_iterate                 (GstBin *bin);

Iterates over the elements in this bin.

gst_bin_use_clock ()

void        gst_bin_use_clock               (GstBin *bin,
                                             GstClock *clock);

Force the bin to use the given clock. Use NULL to force it to use no clock at all.

gst_bin_get_clock ()

GstClock*   gst_bin_get_clock               (GstBin *bin);

Gets the current clock of the (scheduler of the) bin.

gst_bin_auto_clock ()

void        gst_bin_auto_clock              (GstBin *bin);

Let the bin select a clock automatically.

gst_bin_sync_children_state ()

GstElementStateReturn gst_bin_sync_children_state
                                            (GstBin *bin);

Tries to set the state of the children of this bin to the same state of the bin by calling gst_element_set_state for each child not already having a synchronized state.

Returns: The worst return value of any gst_element_set_state. So if one child

gst_bin_child_state_change ()

void        gst_bin_child_state_change      (GstBin *bin,
                                             GstElementState oldstate,
                                             GstElementState newstate,
                                             GstElement *child);

An internal function to inform the parent bin about a state change of a child.

The "element-added" signal

void        user_function                  (GstBin *gstbin,
                                            GstElement *arg1,
                                            gpointer user_data);

Will be emmited if a new element was removed/added to this bin.

The "element-removed" signal

void        user_function                  (GstBin *gstbin,
                                            GstElement *arg1,
                                            gpointer user_data);

Will be emmited if an element was removed from this bin.

The "iterate" signal

gboolean    user_function                  (GstBin *gstbin,
                                            gpointer user_data);

This signal is emitted when a bin iterates, either automatically or due to a #gst_bin_iterate() call. The return value is used to determine if the object method handler processed any data. In most normal cases, a user-provided signal handler should return FALSE.