GstBufferPool

Gst.BufferPool

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──Gst.BufferPool

Gst.BufferPool.prototype.new

function Gst.BufferPool.prototype.new(): {
    // javascript wrapper for 'gst_buffer_pool_new'
}

Creates a new Gst.BufferPool instance.

Gst.BufferPool.prototype.acquire_buffer

function Gst.BufferPool.prototype.acquire_buffer(params: Gst.BufferPoolAcquireParams): {
    // javascript wrapper for 'gst_buffer_pool_acquire_buffer'
}

Acquires a buffer from pool. buffer should point to a memory location that can hold a pointer to the new buffer. When the pool is empty, this function will by default block until a buffer is released into the pool again or when the pool is set to flushing or deactivated.

params can contain optional parameters to influence the allocation.

Gst.BufferPool.prototype.get_config

function Gst.BufferPool.prototype.get_config(): {
    // javascript wrapper for 'gst_buffer_pool_get_config'
}

Gets a copy of the current configuration of the pool. This configuration can be modified and used for the Gst.BufferPool.prototype.set_config call.

Gst.BufferPool.prototype.get_options

function Gst.BufferPool.prototype.get_options(): {
    // javascript wrapper for 'gst_buffer_pool_get_options'
}

Gets a null terminated array of string with supported bufferpool options for pool. An option would typically be enabled with Gst.BufferPool.prototype.config_add_option.

Gst.BufferPool.prototype.has_option

function Gst.BufferPool.prototype.has_option(option: String): {
    // javascript wrapper for 'gst_buffer_pool_has_option'
}

Checks if the bufferpool supports option.

Gst.BufferPool.prototype.is_active

function Gst.BufferPool.prototype.is_active(): {
    // javascript wrapper for 'gst_buffer_pool_is_active'
}

Checks if pool is active. A pool can be activated with the Gst.BufferPool.prototype.set_active call.

Gst.BufferPool.prototype.release_buffer

function Gst.BufferPool.prototype.release_buffer(buffer: Gst.Buffer): {
    // javascript wrapper for 'gst_buffer_pool_release_buffer'
}

Releases buffer to pool. buffer should have previously been allocated from pool with Gst.BufferPool.prototype.acquire_buffer.

This function is usually called automatically when the last ref on buffer disappears.

Gst.BufferPool.prototype.set_active

function Gst.BufferPool.prototype.set_active(active: Number): {
    // javascript wrapper for 'gst_buffer_pool_set_active'
}

Controls the active state of pool. When the pool is inactive, new calls to Gst.BufferPool.prototype.acquire_buffer will return with Gst.FlowReturn.FLUSHING.

Activating the bufferpool will preallocate all resources in the pool based on the configuration of the pool.

Deactivating will free the resources again when there are no outstanding buffers. When there are outstanding buffers, they will be freed as soon as they are all returned to the pool.

Gst.BufferPool.prototype.set_config

function Gst.BufferPool.prototype.set_config(config: Gst.Structure): {
    // javascript wrapper for 'gst_buffer_pool_set_config'
}

Sets the configuration of the pool. If the pool is already configured, and the configuration hasn't changed, this function will return true. If the pool is active, this method will return false and active configuration will remain. Buffers allocated from this pool must be returned or else this function will do nothing and return false.

config is a Gst.Structure that contains the configuration parameters for the pool. A default and mandatory set of parameters can be configured with Gst.BufferPool.prototype.config_set_params, Gst.BufferPool.prototype.config_set_allocator and Gst.BufferPool.prototype.config_add_option.

If the parameters in config can not be set exactly, this function returns false and will try to update as much state as possible. The new state can then be retrieved and refined with Gst.BufferPool.prototype.get_config.

This function takes ownership of config.

Gst.BufferPool.prototype.set_flushing

function Gst.BufferPool.prototype.set_flushing(flushing: Number): {
    // javascript wrapper for 'gst_buffer_pool_set_flushing'
}

Enables or disables the flushing state of a pool without freeing or allocating buffers.

Since : 1.4

Gst.BufferPool.prototype.config_add_option

function Gst.BufferPool.prototype.config_add_option(config: Gst.Structure, option: String): {
    // javascript wrapper for 'gst_buffer_pool_config_add_option'
}

Enables the option in config. This will instruct the bufferpool to enable the specified option on the buffers that it allocates.

The options supported by pool can be retrieved with Gst.BufferPool.prototype.get_options.

Gst.BufferPool.prototype.config_get_allocator

function Gst.BufferPool.prototype.config_get_allocator(config: Gst.Structure): {
    // javascript wrapper for 'gst_buffer_pool_config_get_allocator'
}

Gets the allocator and params from config.

Gst.BufferPool.prototype.config_get_option

function Gst.BufferPool.prototype.config_get_option(config: Gst.Structure, index: Number): {
    // javascript wrapper for 'gst_buffer_pool_config_get_option'
}

Parses an available config and gets the option at index of the options API array.

Gst.BufferPool.prototype.config_get_params

function Gst.BufferPool.prototype.config_get_params(config: Gst.Structure): {
    // javascript wrapper for 'gst_buffer_pool_config_get_params'
}

Gets the configuration values from config.

Gst.BufferPool.prototype.config_has_option

function Gst.BufferPool.prototype.config_has_option(config: Gst.Structure, option: String): {
    // javascript wrapper for 'gst_buffer_pool_config_has_option'
}

Checks if config contains option.

Gst.BufferPool.prototype.config_n_options

function Gst.BufferPool.prototype.config_n_options(config: Gst.Structure): {
    // javascript wrapper for 'gst_buffer_pool_config_n_options'
}

Retrieves the number of values currently stored in the options array of the config structure.

Gst.BufferPool.prototype.config_set_allocator

function Gst.BufferPool.prototype.config_set_allocator(config: Gst.Structure, allocator: Gst.Allocator, params: Gst.AllocationParams): {
    // javascript wrapper for 'gst_buffer_pool_config_set_allocator'
}

Sets the allocator and params on config.

One of allocator and params can be null, but not both. When allocator is null, the default allocator of the pool will use the values in param to perform its allocation. When param is null, the pool will use the provided allocator with its default Gst.AllocationParams.

A call to Gst.BufferPool.prototype.set_config can update the allocator and params with the values that it is able to do. Some pools are, for example, not able to operate with different allocators or cannot allocate with the values specified in params. Use Gst.BufferPool.prototype.get_config to get the currently used values.

Gst.BufferPool.prototype.config_set_params

function Gst.BufferPool.prototype.config_set_params(config: Gst.Structure, caps: Gst.Caps, size: Number, min_buffers: Number, max_buffers: Number): {
    // javascript wrapper for 'gst_buffer_pool_config_set_params'
}

Configures config with the given parameters.

Gst.BufferPool.prototype.config_validate_params

function Gst.BufferPool.prototype.config_validate_params(config: Gst.Structure, caps: Gst.Caps, size: Number, min_buffers: Number, max_buffers: Number): {
    // javascript wrapper for 'gst_buffer_pool_config_validate_params'
}

Validates that changes made to config are still valid in the context of the expected parameters. This function is a helper that can be used to validate changes made by a pool to a config when Gst.BufferPool.prototype.set_config returns false. This expects that caps haven't changed and that min_buffers aren't lower then what we initially expected. This does not check if options or allocator parameters are still valid, won't check if size have changed, since changing the size is valid to adapt padding.

Since : 1.4

vfunc_acquire_buffer

function vfunc_acquire_buffer(pool: Gst.BufferPool, params: Gst.BufferPoolAcquireParams): {
    // javascript implementation of the 'acquire_buffer' virtual method
}

Get a new buffer from the pool. The default implementation will take a buffer from the queue and optionally wait for a buffer to be released when there are no buffers available.

vfunc_alloc_buffer

function vfunc_alloc_buffer(pool: Gst.BufferPool, params: Gst.BufferPoolAcquireParams): {
    // javascript implementation of the 'alloc_buffer' virtual method
}

Allocate a buffer. the default implementation allocates buffers from the configured memory allocator and with the configured parameters. All metadata that is present on the allocated buffer will be marked as Gst.MetaFlags.POOLED and Gst.MetaFlags.LOCKED and will not be removed from the buffer in vfunc_reset_buffer. The buffer should have the Gst.BufferFlags.TAG_MEMORY cleared.

vfunc_flush_start

function vfunc_flush_start(pool: Gst.BufferPool): {
    // javascript implementation of the 'flush_start' virtual method
}

Enter the flushing state.

Since : 1.4

vfunc_flush_stop

function vfunc_flush_stop(pool: Gst.BufferPool): {
    // javascript implementation of the 'flush_stop' virtual method
}

Leave the flushing state.

Since : 1.4

vfunc_free_buffer

function vfunc_free_buffer(pool: Gst.BufferPool, buffer: Gst.Buffer): {
    // javascript implementation of the 'free_buffer' virtual method
}

Free a buffer. The default implementation unrefs the buffer.

vfunc_get_options

function vfunc_get_options(pool: Gst.BufferPool): {
    // javascript implementation of the 'get_options' virtual method
}

Get a list of options supported by this pool

vfunc_release_buffer

function vfunc_release_buffer(pool: Gst.BufferPool, buffer: Gst.Buffer): {
    // javascript implementation of the 'release_buffer' virtual method
}

Release a buffer back in the pool. The default implementation will put the buffer back in the queue and notify any blocking vfunc_acquire_buffer calls when the Gst.BufferFlags.TAG_MEMORY is not set on the buffer. If Gst.BufferFlags.TAG_MEMORY is set, the buffer will be freed with vfunc_free_buffer.

vfunc_reset_buffer

function vfunc_reset_buffer(pool: Gst.BufferPool, buffer: Gst.Buffer): {
    // javascript implementation of the 'reset_buffer' virtual method
}

Reset the buffer to its state when it was freshly allocated. The default implementation will clear the flags, timestamps and will remove the metadata without the Gst.MetaFlags.POOLED flag (even the metadata with Gst.MetaFlags.LOCKED). If the Gst.BufferFlags.TAG_MEMORY was set, this function can also try to restore the memory and clear the Gst.BufferFlags.TAG_MEMORY again.

vfunc_set_config

function vfunc_set_config(pool: Gst.BufferPool, config: Gst.Structure): {
    // javascript implementation of the 'set_config' virtual method
}

Apply the bufferpool configuration. The default configuration will parse the default config parameters.

vfunc_start

function vfunc_start(pool: Gst.BufferPool): {
    // javascript implementation of the 'start' virtual method
}

Start the bufferpool. The default implementation will preallocate min-buffers buffers and put them in the queue.

Subclasses do not need to chain up to the parent's default implementation if they don't want min-buffers based preallocation.

vfunc_stop

function vfunc_stop(pool: Gst.BufferPool): {
    // javascript implementation of the 'stop' virtual method
}

Stop the bufferpool. the default implementation will free the preallocated buffers. This function is called when all the buffers are returned to the pool.

Gst.BufferPoolAcquireParams

Gst.BufferPoolAcquireFlags

Additional flags to control the allocation of a buffer