Class AudioPipe

An audio pipe.

Inheritance
System.Object
Serializable
Dynamic
MediaPipe<IAudioOutput, IAudioOutputCollection, IAudioInput, IAudioInputCollection, AudioPipe, AudioFrame, AudioBuffer, AudioBufferCollection, AudioFormat>
AudioPipe
AecPipe
AudioDecoder
AudioDepacketizer
AudioEncoder
AudioMixer
AudioPacketizer
AudioSynchronizer
Receiver
Sender
IdentityAudioPipe
JitterAudioPipe
ResetAudioPipe
SoundConverter
SoundReframer
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public abstract class AudioPipe : MediaPipe<IAudioOutput, IAudioOutputCollection, IAudioInput, IAudioInputCollection, AudioPipe, AudioFrame, AudioBuffer, AudioBufferCollection, AudioFormat>, IAudioInput, IMediaInput<IAudioOutput, IAudioInput, AudioFrame, AudioBuffer, AudioBufferCollection, AudioFormat>, IInput<IAudioOutput, IAudioInput, AudioFrame, AudioBuffer, AudioBufferCollection, AudioFormat>, IAudioOutput, IMediaOutput<IAudioOutput, IAudioInput, AudioFrame, AudioBuffer, AudioBufferCollection, AudioFormat>, IOutput<IAudioOutput, IAudioInput, AudioFrame, AudioBuffer, AudioBufferCollection, AudioFormat>, IAudioElement, IMediaElement, IElement

Constructors

AudioPipe(AudioFormat)

Initializes a new instance of the AudioPipe class.

Declaration
public AudioPipe(AudioFormat outputFormat)
Parameters
Type Name Description
AudioFormat outputFormat

The output format.

AudioPipe(AudioFormat, AudioFormat)

Initializes a new instance of the AudioPipe class.

Declaration
public AudioPipe(AudioFormat inputFormat, AudioFormat outputFormat)
Parameters
Type Name Description
AudioFormat inputFormat

The input format.
AudioFormat outputFormat

The output format.

Properties

Config

Gets the output configuration. (Alias for OutputConfig.)

Declaration
public AudioConfig Config { get; }
Property Value
Type Description
AudioConfig

Gain

Gets or sets a value indicating the gain (input amplification) of this sink. Any value greater than or equal to 0.0 is acceptable.

Declaration
public double Gain { get; set; }
Property Value
Type Description
System.Double

InputConfig

Gets the input configuration.

Declaration
public AudioConfig InputConfig { get; }
Property Value
Type Description
AudioConfig

OutputConfig

Gets the output configuration.

Declaration
public AudioConfig OutputConfig { get; }
Property Value
Type Description
AudioConfig

Volume

Gets or sets a value indicating the volume (output resistance) of this source. Valid value range is 0.0 to 1.0, inclusive.

Declaration
public double Volume { get; set; }
Property Value
Type Description
System.Double

Methods

CreateFrame(AudioBuffer)

Creates a frame.

Declaration
protected override AudioFrame CreateFrame(AudioBuffer buffer)
Parameters
Type Name Description
AudioBuffer buffer

The buffer.
Returns
Type Description
AudioFrame
Overrides
FM.LiveSwitch.MediaPipe<FM.LiveSwitch.IAudioOutput, FM.LiveSwitch.IAudioOutputCollection, FM.LiveSwitch.IAudioInput, FM.LiveSwitch.IAudioInputCollection, FM.LiveSwitch.AudioPipe, FM.LiveSwitch.AudioFrame, FM.LiveSwitch.AudioBuffer, FM.LiveSwitch.AudioBufferCollection, FM.LiveSwitch.AudioFormat>.CreateFrame(FM.LiveSwitch.AudioBuffer)

CreateInputCollection(IAudioOutput)

Creates an input collection.

Declaration
protected override IAudioInputCollection CreateInputCollection(IAudioOutput output)
Parameters
Type Name Description
IAudioOutput output

The output.
Returns
Type Description
IAudioInputCollection
Overrides
FM.LiveSwitch.MediaPipe<FM.LiveSwitch.IAudioOutput, FM.LiveSwitch.IAudioOutputCollection, FM.LiveSwitch.IAudioInput, FM.LiveSwitch.IAudioInputCollection, FM.LiveSwitch.AudioPipe, FM.LiveSwitch.AudioFrame, FM.LiveSwitch.AudioBuffer, FM.LiveSwitch.AudioBufferCollection, FM.LiveSwitch.AudioFormat>.CreateInputCollection(FM.LiveSwitch.IAudioOutput)

CreateOutputCollection(IAudioInput)

Creates an output collection.

Declaration
protected override IAudioOutputCollection CreateOutputCollection(IAudioInput input)
Parameters
Type Name Description
IAudioInput input

The input.
Returns
Type Description
IAudioOutputCollection
Overrides
FM.LiveSwitch.MediaPipe<FM.LiveSwitch.IAudioOutput, FM.LiveSwitch.IAudioOutputCollection, FM.LiveSwitch.IAudioInput, FM.LiveSwitch.IAudioInputCollection, FM.LiveSwitch.AudioPipe, FM.LiveSwitch.AudioFrame, FM.LiveSwitch.AudioBuffer, FM.LiveSwitch.AudioBufferCollection, FM.LiveSwitch.AudioFormat>.CreateOutputCollection(FM.LiveSwitch.IAudioInput)

ProcessFrame(AudioFrame)

Processes a frame.

Declaration
public override bool ProcessFrame(AudioFrame frame)
Parameters
Type Name Description
AudioFrame frame

The frame.
Returns
Type Description
System.Boolean
Overrides
FM.LiveSwitch.MediaPipe<FM.LiveSwitch.IAudioOutput, FM.LiveSwitch.IAudioOutputCollection, FM.LiveSwitch.IAudioInput, FM.LiveSwitch.IAudioInputCollection, FM.LiveSwitch.AudioPipe, FM.LiveSwitch.AudioFrame, FM.LiveSwitch.AudioBuffer, FM.LiveSwitch.AudioBufferCollection, FM.LiveSwitch.AudioFormat>.ProcessFrame(FM.LiveSwitch.AudioFrame)

RaiseFrame(AudioFrame)

Raises a frame.

Declaration
protected override void RaiseFrame(AudioFrame frame)
Parameters
Type Name Description
AudioFrame frame

The frame.
Overrides
FM.LiveSwitch.MediaPipe<FM.LiveSwitch.IAudioOutput, FM.LiveSwitch.IAudioOutputCollection, FM.LiveSwitch.IAudioInput, FM.LiveSwitch.IAudioInputCollection, FM.LiveSwitch.AudioPipe, FM.LiveSwitch.AudioFrame, FM.LiveSwitch.AudioBuffer, FM.LiveSwitch.AudioBufferCollection, FM.LiveSwitch.AudioFormat>.RaiseFrame(FM.LiveSwitch.AudioFrame)

Implements