Class AudioMixerSettings

Namespace

VisioForge.Core.Types.X.AudioEffects

Assembly

VisioForge.Core.dll

Configuration settings for the audio mixer, which combines multiple audio streams into a single output.

public class AudioMixerSettings

Inheritance

object

AudioMixerSettings

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Properties

Format

Gets or sets the output audio format for the mixer. All input streams will be converted to this format before mixing.

public AudioInfoX Format { get; set; }

Property Value

AudioInfoX

Exceptions

ArgumentNullException

Thrown when value is null. Use the AudioInfoX ctor to assign an explicit format instead of nulling the property.

IgnoreInactivePads

Gets or sets a value indicating whether the underlying GstAggregator (audiomixer) should set ignore-inactive-pads=true.

public bool IgnoreInactivePads { get; set; }

Property Value

bool

Remarks

When true, the mixer skips sink pads that are inactive (have not received a buffer or have sent EOS) and continues mixing from the remaining active inputs. Required by consumers that handle multi-stream playback where one stream may end before the others (e.g. MediaPlayerCoreX additional audio streams, LiveVideoCompositor dynamic input add/remove).

When false (default), the property is not set and GstAggregator's default behaviour applies (wait for all sinks). This is the correct setting for single-input mixer usages where an extended initial preroll without data would otherwise be misinterpreted as the only sink being inactive, causing the aggregator to emit EOS on its output before any buffer flows downstream — and silently drop every subsequent buffer via sticky-EOS rejection.