Table of Contents

Class WASAPIRendererSettings

Namespace
VisioForge.Core.Types.X.AudioRenderers
Assembly
VisioForge.Core.dll

Class WASAPIRendererSettings. Implements the VisioForge.Core.Types.X.AudioRenderers.IAudioRendererSettings

public class WASAPIRendererSettings : IAudioRendererSettings

Inheritance

Implements

Inherited Members

Constructors

WASAPIRendererSettings(AudioOutputDeviceInfo)

Initializes a new instance of the VisioForge.Core.Types.X.AudioRenderers.WASAPIRendererSettings class.

public WASAPIRendererSettings(AudioOutputDeviceInfo deviceInfo)

Parameters

deviceInfo AudioOutputDeviceInfo

The device information.

Exceptions

ArgumentException

Invalid API. Should be WASAPI.

Properties

API

Gets or sets the API.

public AudioOutputDeviceAPI API { get; }

Property Value

AudioOutputDeviceAPI

BufferTime

Gets or sets the size of the audio buffer held by the device, and the minimum latency the sink reports. Larger values make playback tolerant of CPU spikes; smaller values reduce latency at the cost of glitches when the machine stalls. Set to Zero or a negative value to leave the element default untouched. The resolution is one microsecond; a smaller positive value is raised to it, and anything above 10 seconds is capped.

public TimeSpan BufferTime { get; set; }

Property Value

TimeSpan

DevicePath

Gets or sets the device path.

public string DevicePath { get; }

Property Value

string

Exclusive

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

public bool Exclusive { get; set; }

Property Value

bool

Guid

Gets or sets the unique identifier.

public Guid Guid { get; }

Property Value

Guid

LatencyTime

Gets or sets the minimum amount of data written in each iteration. Set to Zero or a negative value to leave the element default untouched. The resolution is one microsecond; a smaller positive value is raised to it, and anything above 10 seconds is capped.

public TimeSpan LatencyTime { get; set; }

Property Value

TimeSpan

LowLatency

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

public bool LowLatency { get; set; }

Property Value

bool

Mute

Gets or sets the mute state of this stream.

public bool Mute { get; set; }

Property Value

bool

Role

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

public WASAPIDeviceRole Role { get; set; }

Property Value

WASAPIDeviceRole

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.

public bool UseAudioClient3 { get; set; }

Property Value

bool

See Also