Class WASAPIRendererSettings

Class WASAPIRendererSettings. Implements the IAudioRendererSettings

Inheritance

object

WASAPIRendererSettings

Implements

IAudioRendererSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VisioForge.Core.Types.X.AudioRenderers

Assembly: VisioForge.Core.dll

Syntax

public class WASAPIRendererSettings : IAudioRendererSettings

Constructors

WASAPIRendererSettings(AudioOutputDeviceInfo)

Initializes a new instance of the WASAPIRendererSettings class.

Declaration

public WASAPIRendererSettings(AudioOutputDeviceInfo deviceInfo)

Parameters

Type	Name	Description
AudioOutputDeviceInfo	deviceInfo	The device information.

Exceptions

Type	Condition
ArgumentException	Invalid API. Should be WASAPI.

Properties

API

Gets or sets the API.

Declaration

public AudioOutputDeviceAPI API { get; }

Property Value

Type	Description
AudioOutputDeviceAPI	The API.

DevicePath

Gets or sets the device path.

Declaration

public string DevicePath { get; }

Property Value

Type	Description
string	The device path.

Exclusive

Gets or sets whether the device should be opened in exclusive mode.

Declaration

public bool Exclusive { get; set; }

Property Value

Type	Description
bool	true if exclusive mode; otherwise, false.

Guid

Gets or sets the unique identifier.

Declaration

public Guid Guid { get; }

Property Value

Type	Description
Guid	The unique identifier.

LowLatency

Gets or sets a value indicating whether to optimize all settings for lowest latency. It is always safe to enable this setting.

Declaration

public bool LowLatency { get; set; }

Property Value

Type	Description
bool	true if low-latency is enabled; otherwise, false.

Mute

Gets or sets the mute state of this stream.

Declaration

public bool Mute { get; set; }

Property Value

Type	Description
bool	true if muted; otherwise, false.

Role

Gets or sets the role of the device, such as communications, multimedia, etc.

Declaration

public WASAPIDeviceRole Role { get; set; }

Property Value

Type	Description
WASAPIDeviceRole	The role of the device.

UseAudioClient3

Gets or sets a value indicating whether to use the Windows 10 AudioClient3 API when available, and if the low-latency property is set to TRUE.

Declaration

public bool UseAudioClient3 { get; set; }

Property Value

Type	Description
bool	true if using AudioClient3; otherwise, false.

Implements

IAudioRendererSettings

See Also

IAudioRendererSettings