Struct gstreamer_audio::AudioAggregator

pub struct AudioAggregator { /* private fields */ }

Subclasses must use (a subclass of) AudioAggregatorPad for both their source and sink pads, gst_element_class_add_static_pad_template_with_gtype() is a convenient helper.

AudioAggregator can perform conversion on the data arriving on its sink pads, based on the format expected downstream: in order to enable that behaviour, the GType of the sink pads must either be a (subclass of) AudioAggregatorConvertPad to use the default GstAudioConverter implementation, or a subclass of AudioAggregatorPad implementing GstAudioAggregatorPadClass.convert_buffer.

To allow for the output caps to change, the mechanism is the same as above, with the GType of the source pad.

See GstAudioMixer for an example.

When conversion is enabled, AudioAggregator will accept any type of raw audio caps and perform conversion on the data arriving on its sink pads, with whatever downstream expects as the target format.

In case downstream caps are not fully fixated, it will use the first configured sink pad to finish fixating its source pad caps.

A notable exception for now is the sample rate, sink pads must have the same sample rate as either the downstream requirement, or the first configured pad, or a combination of both (when downstream specifies a range or a set of acceptable rates).

The samples-selected signal is provided with some additional information about the output buffer:

• “offset” G_TYPE_UINT64 Offset in samples since segment start for the position that is next to be filled in the output buffer.
• “frames” G_TYPE_UINT Number of frames per output buffer.

In addition the [AggregatorExtManual::peek_next_sample()][crate::gst_base::prelude::AggregatorExtManual::peek_next_sample()] function returns additional information in the info GstStructure of the returned sample:

• “output-offset” G_TYPE_UINT64 Sample offset in output segment relative to the output segment’s start where the current position of this input buffer would be placed
• “position” G_TYPE_UINT current position in the input buffer in samples
• “size” G_TYPE_UINT size of the input buffer in samples

This is an Abstract Base Class, you cannot instantiate it.

Properties

alignment-threshold

Readable | Writeable

discont-wait

Readable | Writeable

force-live

Causes the element to aggregate on a timeout even when no live source is connected to its sinks. See min-upstream-latency for a companion property: in the vast majority of cases where you plan to plug in live sources with a non-zero latency, you should set it to a non-zero value.

Readable | Writeable | Construct Only

ignore-inactive-pads

Don’t wait for inactive pads when live. An inactive pad is a pad that hasn’t yet received a buffer, but that has been waited on at least once.

The purpose of this property is to avoid aggregating on timeout when new pads are requested in advance of receiving data flow, for example the user may decide to connect it later, but wants to configure it already.

Readable | Writeable

output-buffer-duration

Readable | Writeable

output-buffer-duration-fraction

Output block size in nanoseconds, expressed as a fraction.

Readable | Writeable

Aggregator

emit-signals

Enables the emission of signals such as samples-selected

Readable | Writeable

latency

Readable | Writeable

min-upstream-latency

Force minimum upstream latency (in nanoseconds). When sources with a higher latency are expected to be plugged in dynamically after the aggregator has started playing, this allows overriding the minimum latency reported by the initial source(s). This is only taken into account when larger than the actually reported minimum latency.

Readable | Writeable

start-time

Readable | Writeable

start-time-selection

Readable | Writeable

Object

name

Readable | Writeable | Construct

parent

The parent of the object. Please note, that when changing the ‘parent’ property, we don’t emit notify and deep-notify signals due to locking issues. In some cases one can use GstBin::element-added or GstBin::element-removed signals on the parent to achieve a similar effect.

Readable | Writeable

Implements

AudioAggregatorExt, gst_base::prelude::AggregatorExt, gst::prelude::ElementExt, gst::prelude::GstObjectExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl AudioAggregator

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

Trait Implementations

impl Clone for AudioAggregator

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for AudioAggregator

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

Formats the value using the given formatter.

impl HasParamSpec for AudioAggregator

type ParamSpec = ParamSpecObject

type SetValue = AudioAggregator

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for AudioAggregator

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

where H: Hasher,

Hashes the memory address of this object.

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: AudioAggregatorImpl> IsSubclassable<T> for AudioAggregator

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 AudioAggregator

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for AudioAggregator

type Parent = Aggregator

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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

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

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for AudioAggregator

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for AudioAggregator

impl IsA<Aggregator> for AudioAggregator

impl IsA<Element> for AudioAggregator

impl IsA<Object> for AudioAggregator

impl Send for AudioAggregator

impl Sync for AudioAggregator