Class NullAudioSink

An audio sink that discards frames.

Inheritance
System.Object
Serializable
Dynamic
MediaSinkBase
MediaSink<IAudioOutput, IAudioOutputCollection, IAudioInput, AudioSink, AudioFrame, AudioBuffer, AudioBufferCollection, AudioFormat>
AudioSink
NullAudioSink
Inherited Members
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public class NullAudioSink : AudioSink, IAudioInput, IMediaInput<IAudioOutput, IAudioInput, AudioFrame, AudioBuffer, AudioBufferCollection, AudioFormat>, IInput<IAudioOutput, IAudioInput, AudioFrame, AudioBuffer, AudioBufferCollection, AudioFormat>, IAudioElement, IMediaElement, IElement

Constructors

NullAudioSink()

Initializes a new NullAudioSink.

Declaration
public NullAudioSink()

NullAudioSink(AudioFormat)

Initializes a new NullAudioSink.

Declaration
public NullAudioSink(AudioFormat inputFormat)
Parameters
Type Name Description
AudioFormat inputFormat

The input format.

Properties

FrameCount

Gets the current frame count.

Declaration
public long FrameCount { get; }
Property Value
Type Description
System.Int64

Label

Gets a label that identifies this class.

Declaration
public override string Label { get; }
Property Value
Type Description
System.String
Overrides
FM.LiveSwitch.MediaSink<FM.LiveSwitch.IAudioOutput, FM.LiveSwitch.IAudioOutputCollection, FM.LiveSwitch.IAudioInput, FM.LiveSwitch.AudioSink, FM.LiveSwitch.AudioFrame, FM.LiveSwitch.AudioBuffer, FM.LiveSwitch.AudioBufferCollection, FM.LiveSwitch.AudioFormat>.Label

OutputRtpStreamId

Gets or sets the output RTP stream identifier. If the output RTP stream identifier is null (unset), then getting this property returns the InputRtpStreamId.

Declaration
public string OutputRtpStreamId { get; set; }
Property Value
Type Description
System.String

OutputSynchronizationSource

Gets or sets the output synchronization source. If the output synchronization source is -1 (unset), then getting this property returns the InputSynchronizationSource.

Declaration
public long OutputSynchronizationSource { get; set; }
Property Value
Type Description
System.Int64

Methods

DoDestroy()

Destroys this instance.

Declaration
protected override void DoDestroy()
Overrides
FM.LiveSwitch.MediaSink<FM.LiveSwitch.IAudioOutput, FM.LiveSwitch.IAudioOutputCollection, FM.LiveSwitch.IAudioInput, FM.LiveSwitch.AudioSink, 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.MediaSink<FM.LiveSwitch.IAudioOutput, FM.LiveSwitch.IAudioOutputCollection, FM.LiveSwitch.IAudioInput, FM.LiveSwitch.AudioSink, FM.LiveSwitch.AudioFrame, FM.LiveSwitch.AudioBuffer, FM.LiveSwitch.AudioBufferCollection, FM.LiveSwitch.AudioFormat>.DoProcessFrame(FM.LiveSwitch.AudioFrame, FM.LiveSwitch.AudioBuffer)

ProcessControlFrame(MediaControlFrame)

Processes a control frame by raising it.

Declaration
public virtual void ProcessControlFrame(MediaControlFrame controlFrame)
Parameters
Type Name Description
MediaControlFrame controlFrame

The control frame.

ProcessControlFrames(MediaControlFrame[])

Processes control frames by raising them.

Declaration
public virtual void ProcessControlFrames(MediaControlFrame[] controlFrames)
Parameters
Type Name Description
MediaControlFrame[] controlFrames

The control frames.

ProcessedFrames(Int64)

Creates a future that resolves when the specified number of frames have been processed.

Declaration
public Future<object> ProcessedFrames(long count)
Parameters
Type Name Description
System.Int64 count
Returns
Type Description
Future<System.Object>

UpdateMaxInputBitrate(Int32)

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

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.

UpdateMinInputBitrate(Int32)

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

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.

UpdateSystemDelay(Int64)

Sets the system delay in ticks.

Declaration
public virtual void UpdateSystemDelay(long systemDelay)
Parameters
Type Name Description
System.Int64 systemDelay

The system delay.

Implements