Class AudioDeviceEnumeratorParameters

Namespace

VAST.Capture

Assembly

VAST.Common.dll

Defines parameters for audio device enumeration.

public class AudioDeviceEnumeratorParameters

Inheritance

object

AudioDeviceEnumeratorParameters

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

AudioDeviceEnumeratorParameters()

public AudioDeviceEnumeratorParameters()

Properties

Direction

Gets or sets the audio flow direction filter for enumeration.

public MediaFlowDirection Direction { get; set; }

Property Value

MediaFlowDirection

EnableChannelFilter

Gets or sets whether to enable channel filtering. The default value is false and it means that each found capture device will be present as a single entry with multiple channels, eg stereo device will be a single entry with 2 channels, 4 channel device will be a single entry with 4 channels etc. If the value is true then each multi-channel device will have multiple entries in the list with enumerated devices. It means that stereo device will have 2 entries and 4 channel device will have 4 entries. The channel grouping can be set by the GroupChannelsBy parameter.

public bool EnableChannelFilter { get; set; }

Property Value

bool

Framework

Gets or sets the media framework to use for device enumeration.

public MediaFramework Framework { get; set; }

Property Value

MediaFramework

GroupChannelsBy

Gets or sets channel grouping when channel filtering is enabled. The default value is 1, i.e. each channel will be present as a separate device. Makes sense only when channel filtering is enabled, otherwise ignored.

public int GroupChannelsBy { get; set; }

Property Value

int

Methods

Equals(object)

Determines whether this instance equals another object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with.

Returns

bool

True if the objects are equal; otherwise, false.

Equals(AudioDeviceEnumeratorParameters)

Determines whether this instance equals another AudioDeviceEnumeratorParameters.

public bool Equals(AudioDeviceEnumeratorParameters other)

Parameters

other AudioDeviceEnumeratorParameters

The instance to compare with.

Returns

bool

True if both instances have identical values; otherwise, false.

GetHashCode()

Returns a hash code for this instance.

public override int GetHashCode()

Returns

int

A hash code based on the property values.

Operators

operator ==(AudioDeviceEnumeratorParameters, AudioDeviceEnumeratorParameters)

Determines whether two parameter instances are equal.

public static bool operator ==(AudioDeviceEnumeratorParameters left, AudioDeviceEnumeratorParameters right)

Parameters

left AudioDeviceEnumeratorParameters

The first instance.

right AudioDeviceEnumeratorParameters

The second instance.

Returns

bool

True if both instances are equal; otherwise, false.

operator !=(AudioDeviceEnumeratorParameters, AudioDeviceEnumeratorParameters)

Determines whether two parameter instances are not equal.

public static bool operator !=(AudioDeviceEnumeratorParameters left, AudioDeviceEnumeratorParameters right)

Parameters

left AudioDeviceEnumeratorParameters

The first instance.

right AudioDeviceEnumeratorParameters

The second instance.

Returns

bool

True if the instances are not equal; otherwise, false.