Class LVCAudioInput

Namespace

VisioForge.Core.LiveVideoCompositor

Assembly

VisioForge.Core.dll

Live Video Compositor audio input that feeds audio content into the composition pipeline. Handles audio-only sources with format conversion, mixing, and processing capabilities within the audio composition. Each audio input maintains its own audio format specification and optional processing chain for effects or transformations. Implements the VisioForge.Core.LiveVideoCompositor.LVCInput.

public class LVCAudioInput : LVCInput, IDisposable

Inheritance

object

LVCInput

LVCAudioInput

Implements

IDisposable

Inherited Members

LVCInput._processingBlock

LVCInput._context

LVCInput._mainBlock

LVCInput._bridgeSinkBlock

LVCInput.MediaType

LVCInput.disposedValue

LVCInput.Name

LVCInput.UniqueName

LVCInput.UniqueName2

LVCInput.Pipeline

LVCInput.ID

LVCInput.AutoStart

LVCInput.Build(int, string, int, string)

LVCInput.ResumeAsync()

LVCInput.PauseAsync()

LVCInput.StartAsync()

LVCInput.StopAsync()

LVCInput.Dispose(bool)

LVCInput.Dispose()

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Examples

// Creating an audio input with custom format
var audioInfo = new AudioInfoX(AudioFormatX.S16LE, 48000, 2);
var audioInput = new LVCAudioInput("Microphone", compositor, sourceBlock, audioInfo, autostart: true);
await compositor.Input_AddAsync(audioInput);

Remarks

Audio inputs support:

• Configurable audio format (sample rate, channels, bit depth)
• Optional processing blocks for audio effects, normalization, or filtering
• Dynamic audio info updates during playback via UpdateInfo method
• Independent lifecycle management from the main compositor
• Automatic format conversion to match compositor settings

Constructors

LVCAudioInput(string, LiveVideoCompositor, MediaBlock, AudioInfoX, bool, MediaBlock)

Initializes a new instance of the VisioForge.Core.LiveVideoCompositor.LVCAudioInput class.

public LVCAudioInput(string name, LiveVideoCompositor compositor, MediaBlock mainBlock, AudioInfoX info, bool autostart, MediaBlock processingBlock = null)

Parameters

name string

The unique name identifying this audio input.

compositor LiveVideoCompositor

The compositor instance that will manage this audio input.

mainBlock MediaBlock

The main media block that provides the audio source content.

info AudioInfoX

The audio info (format, channels and sample rate are required).

autostart bool

if set to true, automatically starts the input when added to compositor.

processingBlock MediaBlock

The optional processing block for audio effects or transformations.

Methods

Build(int, string, int, string)

Builds the audio input pipeline by creating bridge connections and linking media blocks.

public override void Build(int id, string uniqueName, int id2 = -1, string uniqueName2 = null)

Parameters

id int

The primary identifier for this input.

uniqueName string

The unique name for the bridge connection.

id2 int

The secondary identifier (optional, default is -1).

uniqueName2 string

The secondary unique name (optional).

Exceptions

ArgumentOutOfRangeException

Thrown when media type is invalid.

UpdateInfo(AudioInfoX)

Updates the audio format information for this input.

public void UpdateInfo(AudioInfoX info)

Parameters

info AudioInfoX

The new audio format information including sample rate, channels, and bit depth.

See Also

LVCInput