Class IdentityAudioPipe

An audio pipe whose output matches its input.

Inheritance
System.Object
Serializable
Dynamic
MediaPipe<IAudioOutput, IAudioOutputCollection, IAudioInput, IAudioInputCollection, AudioPipe, AudioFrame, AudioBuffer, AudioBufferCollection, AudioFormat>
AudioPipe
IdentityAudioPipe
Inherited Members
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public class IdentityAudioPipe : AudioPipe, 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

IdentityAudioPipe(AudioFormat)

Initializes a new IdentityAudioPipe.

Declaration
public IdentityAudioPipe(AudioFormat format)
Parameters
Type Name Description
AudioFormat format

The input/output format.

Properties

CanChangeBitrate

Gets whether this pipe can change the output bitrate.

Declaration
protected override bool CanChangeBitrate { get; }
Property Value
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>.CanChangeBitrate

CanPauseBitrate

Gets whether this pipe can pause the output bitrate.

Declaration
protected override bool CanPauseBitrate { get; }
Property Value
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>.CanPauseBitrate

Label

Gets a label that identifies this class.

Declaration
public override string Label { get; }
Property Value
Type Description
System.String
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>.Label

Methods

DoDestroy()

Destroys this instance.

Declaration
protected override void DoDestroy()
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>.DoDestroy()

DoProcessFrame(AudioFrame, AudioBuffer)

Processes a frame.

Declaration
protected override void DoProcessFrame(AudioFrame frame, AudioBuffer inputBuffer)
Parameters
Type Name Description
AudioFrame frame

The frame.
AudioBuffer inputBuffer

The input buffer.
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>.DoProcessFrame(FM.LiveSwitch.AudioFrame, FM.LiveSwitch.AudioBuffer)

UpdateCanChangeBitrate(Boolean)

Sets whether this pipe can change the output bitrate.

Declaration
public void UpdateCanChangeBitrate(bool canChangeBitrate)
Parameters
Type Name Description
System.Boolean canChangeBitrate

Whether this pipe can change the output bitrate.

UpdateCanPauseBitrate(Boolean)

Sets whether this pipe can pause the output bitrate.

Declaration
public void UpdateCanPauseBitrate(bool canPauseBitrate)
Parameters
Type Name Description
System.Boolean canPauseBitrate

Whether this pipe can pause the output bitrate.

UpdateMaxInputBitrate(Int32)

Sets the maximum allowed input bitrate, in kbps. A value of -1 indicates unset, in which case the maximum input bitrate becomes the minimum of all output maximum input bitrates.

Declaration
public virtual void UpdateMaxInputBitrate(int maxInputBitrate)
Parameters
Type Name Description
System.Int32 maxInputBitrate

The maximum allowed input bitrate, in kbps.

UpdateMaxInputEncoding(EncodingInfo)

Sets the maximum allowed input encoding. A value of null indicates unset (no maximum).

Declaration
public virtual void UpdateMaxInputEncoding(EncodingInfo maxInputEncoding)
Parameters
Type Name Description
EncodingInfo maxInputEncoding

The maximum allowed input encoding.

UpdateMaxOutputBitrate(Int32)

Sets the maximum allowed output bitrate, in kbps. A value of -1 indicates unset (no maximum).

Declaration
public virtual void UpdateMaxOutputBitrate(int maxOutputBitrate)
Parameters
Type Name Description
System.Int32 maxOutputBitrate

The maximum allowed output bitrate, in kbps.

UpdateMaxOutputEncoding(EncodingInfo)

Sets the maximum allowed output encoding. A value of null indicates unset (no maximum).

Declaration
public virtual void UpdateMaxOutputEncoding(EncodingInfo maxOutputEncoding)
Parameters
Type Name Description
EncodingInfo maxOutputEncoding

The maximum allowed output encoding.

UpdateMinInputBitrate(Int32)

Sets the minimum allowed input bitrate, in kbps. A value of -1 indicates unset, in which case the minimum input bitrate becomes the maximum of all output minimum input bitrates.

Declaration
public virtual void UpdateMinInputBitrate(int minInputBitrate)
Parameters
Type Name Description
System.Int32 minInputBitrate

The minimum allowed input bitrate, in kbps.

UpdateMinInputEncoding(EncodingInfo)

Sets the minimum allowed input encoding. A value of null indicates unset (no minimum).

Declaration
public virtual void UpdateMinInputEncoding(EncodingInfo minInputEncoding)
Parameters
Type Name Description
EncodingInfo minInputEncoding

The minimum allowed input encoding.

UpdateMinOutputBitrate(Int32)

Sets the minimum allowed output bitrate, in kbps. A value of -1 indicates unset (no minimum).

Declaration
public virtual void UpdateMinOutputBitrate(int minOutputBitrate)
Parameters
Type Name Description
System.Int32 minOutputBitrate

The minimum allowed output bitrate, in kbps.

UpdateMinOutputEncoding(EncodingInfo)

Sets the minimum allowed output encoding. A value of null indicates unset (no minimum).

Declaration
public virtual void UpdateMinOutputEncoding(EncodingInfo minOutputEncoding)
Parameters
Type Name Description
EncodingInfo minOutputEncoding

The minimum allowed output encoding.

UpdateTargetOutputBitrate(Int32)

Sets the target output bitrate, in kbps. A value of -1 indicates unset (no minimum).

Declaration
public virtual void UpdateTargetOutputBitrate(int targetOutputBitrate)
Parameters
Type Name Description
System.Int32 targetOutputBitrate

The target output bitrate, in kbps.

UpdateTargetOutputEncoding(EncodingInfo)

Sets the target output encoding. A value of null indicates unset (no target).

Declaration
public virtual void UpdateTargetOutputEncoding(EncodingInfo targetOutputEncoding)
Parameters
Type Name Description
EncodingInfo targetOutputEncoding

The target output encoding.

Implements