Struct gstreamer::BufferPool

#[repr(transparent)]
pub struct BufferPool { /* private fields */ }

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 new().

Once a pool is created, it needs to be configured. A call to BufferPoolExtManual::config() returns the current configuration structure from the pool. With gst_buffer_pool_config_set_params() and gst_buffer_pool_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 gst_buffer_pool_config_add_option(). The available options can be retrieved with BufferPoolExt::options(). Some options allow for additional configuration properties to be set.

After the configuration structure has been configured, BufferPoolExtManual::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 BufferPoolExt::set_active(). This will preallocate the configured resources in the pool.

When the pool is active, BufferPoolExtManual::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 BufferPoolExt::release_buffer() when their refcount drops to 0.

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

Implements

BufferPoolExt, GstObjectExt, glib::ObjectExt, BufferPoolExtManual

Implementations

impl BufferPool

pub const NONE: Option<&'static BufferPool> = None

pub fn new() -> BufferPool

Creates a new BufferPool instance.

Returns

a new BufferPool instance

Trait Implementations

impl Clone for BufferPool

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BufferPool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BufferPool

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for BufferPool

type ParamSpec = ParamSpecObject

type SetValue = BufferPool

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, BufferPool>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for BufferPool

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: BufferPoolImpl> IsSubclassable<T> for BufferPool

fn class_init(klass: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for BufferPool

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for BufferPool

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for BufferPool

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for BufferPool

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for BufferPool

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for BufferPool

impl IsA<Object> for BufferPool

impl Send for BufferPool

impl Sync for BufferPool