BufferPool

Object Hierarchy:

Description:

[ CCode ( type_id = "gst_buffer_pool_get_type ()" ) ]
public class BufferPool : Object

A BufferPool is an object that can be used to pre-allocate and recycle buffers of the same size and with the same properties.

A BufferPool is created with BufferPool.

Once a pool is created, it needs to be configured. A call to get_config returns the current configuration structure from the pool. With config_set_params and config_set_allocator the bufferpool parameters and allocator can be configured. Other properties can be configured in the pool depending on the pool implementation.

A bufferpool can have extra options that can be enabled with config_add_option. The available options can be retrieved with get_options. Some options allow for additional configuration properties to be set.

After the configuration structure has been configured, set_config updates the configuration in the pool. This can fail when the configuration structure is not accepted.

After the pool has been configured, it can be activated with set_active . This will preallocate the configured resources in the pool.

When the pool is active, acquire_buffer can be used to retrieve a buffer from the pool.

Buffers allocated from a bufferpool will automatically be returned to the pool with release_buffer when their refcount drops to 0.

The bufferpool can be deactivated again with set_active. All further acquire_buffer calls will return an error. When all buffers are returned to the pool they will be freed.

Namespace: Gst

Package: gstreamer-1.0

Content:

Static methods:

public static void config_add_option (Structure config, string option)
Enables the option in config.
public static bool config_get_allocator (Structure config, out unowned Allocator? allocator, out unowned AllocationParams @params)
Gets the allocator and params from config.
public static unowned string? config_get_option (Structure config, uint index)
Parses an available config and gets the option at index of the options API array.
public static bool config_get_params (Structure config, out unowned Caps? caps, out uint size, out uint min_buffers, out uint max_buffers)
Gets the configuration values from config.
public static bool config_has_option (Structure config, string option)
Checks if config contains option.
public static uint config_n_options (Structure config)
Retrieves the number of values currently stored in the options array of the config structure.
public static void config_set_allocator (Structure config, Allocator? allocator, AllocationParams? @params)
Sets the allocator and params on config.
public static void config_set_params (Structure config, Caps? caps, uint size, uint min_buffers, uint max_buffers)
Configures config with the given parameters.
public static bool config_validate_params (Structure config, Caps? caps, uint size, uint min_buffers, uint max_buffers)
Validates that changes made to config are still valid in the context of the expected parameters.

Creation methods:

public BufferPool ()
Creates a new BufferPool instance.

Methods:

public virtual FlowReturn acquire_buffer (out Buffer? buffer, BufferPoolAcquireParams? @params)
Acquires a buffer from this.
public virtual FlowReturn alloc_buffer (out Buffer? buffer, BufferPoolAcquireParams? @params)
Allocate a buffer.
public virtual void flush_start ()
Enter the flushing state.
public virtual void flush_stop ()
Leave the flushing state.
public virtual void free_buffer (Buffer buffer)
Free a buffer.
public Structure get_config ()
Gets a copy of the current configuration of the pool.
public virtual unowned string[] get_options ()
Gets a null terminated array of string with supported bufferpool options for this.
public bool has_option (string option)
Checks if the bufferpool supports option.
public bool is_active ()
Checks if this is active.
public virtual void release_buffer (owned Buffer buffer)
Releases buffer to this.
public virtual void reset_buffer (Buffer buffer)
Reset the buffer to its state when it was freshly allocated.
public bool set_active (bool active)
Controls the active state of this.
public virtual bool set_config (owned Structure config)
Sets the configuration of the pool.
public void set_flushing (bool flushing)
Enables or disables the flushing state of a this without freeing or allocating buffers.
public virtual bool start ()
Start the bufferpool.
public virtual bool stop ()
Stop the bufferpool.

Fields:

public int flushing

Inherited Members:

All known members inherited from class Gst.Object

All known members inherited from class GLib.Object