Class AudioCaptureDeviceDescriptor

Namespace

VAST.Capture

Assembly

VAST.Common.dll

Audio capture device descriptor

public class AudioCaptureDeviceDescriptor

Inheritance

object

AudioCaptureDeviceDescriptor

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AudioCaptureDeviceDescriptor()

public AudioCaptureDeviceDescriptor()

Properties

ActualDeviceId

Gets or sets actual audio capture device id without filtering postfixes. Initialized and makes sense only when channel filtering is enabled and supported by capture framework.

public string ActualDeviceId { get; set; }

Property Value

string

CaptureModes

Gets or sets list of supported capture modes

public List<AudioCaptureMode> CaptureModes { get; set; }

Property Value

List<AudioCaptureMode>

ChannelIndices

Gets or sets channel indices represented by current virtual device. Initialized and makes sense only when channel filtering is enabled and supported by capture framework.

public List<int> ChannelIndices { get; set; }

Property Value

List<int>

ChannelIndicesString

Gets or sets channel indices string represented by current virtual device. Initialized and makes sense only when channel filtering is enabled and supported by capture framework.

public string ChannelIndicesString { get; set; }

Property Value

string

DefaultCaptureMode

Gets or sets index of the default capture mode

public int DefaultCaptureMode { get; set; }

Property Value

int

DeviceId

Gets or sets audio capture device id, unique among all available capture devices

public string DeviceId { get; set; }

Property Value

string

Direction

Gets or sets device audio flow direction

public MediaFlowDirection Direction { get; set; }

Property Value

MediaFlowDirection

Framework

Gets or sets device framework

public MediaFramework Framework { get; set; }

Property Value

MediaFramework

Name

Gets or sets audio capture device human readable name

public string Name { get; set; }

Property Value

string

TotalChannelCount

Gets or sets total number of input channels. Initialized and makes sense only when channel filtering is enabled and supported by capture framework.

public int TotalChannelCount { get; set; }

Property Value

int

Methods

Clone()

Creates a deep copy of this device descriptor.

public virtual AudioCaptureDeviceDescriptor Clone()

Returns

AudioCaptureDeviceDescriptor

A new AudioCaptureDeviceDescriptor instance with copied values.

FindClosestMatch(MediaType)

Finds the capture mode that best matches the specified media type.

public AudioCaptureMode FindClosestMatch(MediaType mt)

Parameters

mt MediaType

The target media type to match, or null to use the default capture mode.

Returns

AudioCaptureMode

The closest matching capture mode, or null if no modes are available.