Class VoiceCaptureSource

An Dmo-based source.

Inheritance
System.Object
Serializable
Dynamic
MediaSourceBase
MediaSource<IAudioOutput, IAudioInput, IAudioInputCollection, AudioSource, AudioFrame, AudioBuffer, AudioBufferCollection, AudioFormat>
AudioSource
VoiceCaptureSource
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.Dmo
Assembly: FM.LiveSwitch.Dmo.dll
Syntax
public class VoiceCaptureSource : AudioSource, IAudioOutput, IMediaOutput<IAudioOutput, IAudioInput, AudioFrame, AudioBuffer, AudioBufferCollection, AudioFormat>, IOutput<IAudioOutput, IAudioInput, AudioFrame, AudioBuffer, AudioBufferCollection, AudioFormat>, IAudioElement, IMediaElement, IElement

Constructors

VoiceCaptureSource(AudioConfig, Boolean)

Initializes a new instance of the VoiceCaptureSource class.

Declaration
public VoiceCaptureSource(AudioConfig config, bool aec)
Parameters
Type Name Description
AudioConfig config

The configuration.
System.Boolean aec

True to enable AEC; false to disable.

VoiceCaptureSource(Boolean)

Initializes a new instance of the VoiceCaptureSource class.

Declaration
public VoiceCaptureSource(bool aec)
Parameters
Type Name Description
System.Boolean aec

True to enable AEC; false to disable.

Properties

AutomaticGainControl

Gets or sets a boolean to turn automatic gain control off or on.

Declaration
public bool AutomaticGainControl { get; set; }
Property Value
Type Description
System.Boolean

CenterClip

Gets or sets a boolean to turn center clipping off or on.

Declaration
public bool CenterClip { get; set; }
Property Value
Type Description
System.Boolean

DefaultConfig

Gets the default configuration.

Declaration
public static AudioConfig DefaultConfig { get; }
Property Value
Type Description
AudioConfig

DefaultDeviceRole

Gets or sets the default role.

Declaration
public DeviceRole DefaultDeviceRole { get; set; }
Property Value
Type Description
DeviceRole

EchoLength

Gets or sets the echo length.

Declaration
public int EchoLength { get; set; }
Property Value
Type Description
System.Int32

EchoSuppressionRuns

Gets or sets the number of echo suppression runs to do. This runs after regular echo cancellation.

Declaration
public int EchoSuppressionRuns { get; set; }
Property Value
Type Description
System.Int32

GainBounder

Gets or sets whether the Voice Capture DSP applies microphone gain bounding.

Declaration
public bool GainBounder { get; set; }
Property Value
Type Description
System.Boolean

Label

Gets a label that identifies this class.

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

NoiseFill

Gets or sets a boolean to turn noise filling off or on.

Declaration
public bool NoiseFill { get; set; }
Property Value
Type Description
System.Boolean

NoiseSuppression

Gets or sets a boolean to turn noise suppression off or on.

Declaration
public bool NoiseSuppression { get; set; }
Property Value
Type Description
System.Boolean

RenderDevice

Gets or sets the selected render device.

Declaration
public SinkOutput RenderDevice { get; set; }
Property Value
Type Description
SinkOutput

VoiceDetected

Gets if voice is detected.

Declaration
public VoiceActivityMode VoiceDetected { get; }
Property Value
Type Description
VoiceActivityMode

VoiceDetection

Gets or sets a boolean to turn voice detection off or on.

Declaration
public bool VoiceDetection { get; set; }
Property Value
Type Description
System.Boolean

Methods

DoStart()

Starts this instance.

Declaration
protected override Future<object> DoStart()
Returns
Type Description
Future<System.Object>
Overrides
FM.LiveSwitch.MediaSource<FM.LiveSwitch.IAudioOutput, FM.LiveSwitch.IAudioInput, FM.LiveSwitch.IAudioInputCollection, FM.LiveSwitch.AudioSource, FM.LiveSwitch.AudioFrame, FM.LiveSwitch.AudioBuffer, FM.LiveSwitch.AudioBufferCollection, FM.LiveSwitch.AudioFormat>.DoStart()

DoStop()

Stops this instance.

Declaration
protected override Future<object> DoStop()
Returns
Type Description
Future<System.Object>
Overrides
FM.LiveSwitch.MediaSource<FM.LiveSwitch.IAudioOutput, FM.LiveSwitch.IAudioInput, FM.LiveSwitch.IAudioInputCollection, FM.LiveSwitch.AudioSource, FM.LiveSwitch.AudioFrame, FM.LiveSwitch.AudioBuffer, FM.LiveSwitch.AudioBufferCollection, FM.LiveSwitch.AudioFormat>.DoStop()

GetInputs()

Gets the available inputs.

Declaration
public override Future<SourceInput[]> GetInputs()
Returns
Type Description
Future<SourceInput[]>
Overrides
FM.LiveSwitch.MediaSource<FM.LiveSwitch.IAudioOutput, FM.LiveSwitch.IAudioInput, FM.LiveSwitch.IAudioInputCollection, FM.LiveSwitch.AudioSource, FM.LiveSwitch.AudioFrame, FM.LiveSwitch.AudioBuffer, FM.LiveSwitch.AudioBufferCollection, FM.LiveSwitch.AudioFormat>.GetInputs()

GetRenderDevices()

Gets the available render devices.

Declaration
public Future<SinkOutput[]> GetRenderDevices()
Returns
Type Description
Future<SinkOutput[]>

IsSupported()

Gets a value that indicates whether DMO is supported on this system. This is an alias for IsSupported.

Declaration
public static bool IsSupported()
Returns
Type Description
System.Boolean

Implements