Class AudioCaptureDeviceInfo

Audio capture device information.

Inheritance

object

AudioCaptureDeviceInfo

Implements

IComparable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: VisioForge.Core.Types.X.Sources

Assembly: VisioForge.Core.dll

Syntax

public class AudioCaptureDeviceInfo : IComparable

Constructors

AudioCaptureDeviceInfo(Device)

Initializes a new instance of the AudioCaptureDeviceInfo class.

Declaration

public AudioCaptureDeviceInfo(Device device)

Parameters

Type	Name	Description
Device	device	The device.

Properties

API

Gets the API.

Declaration

public AudioCaptureDeviceAPI API { get; }

Property Value

Type	Description
AudioCaptureDeviceAPI

DevicePath

Gets device path.

Declaration

public string DevicePath { get; }

Property Value

Type	Description
string

DisplayName

Gets device name including API.

Declaration

public string DisplayName { get; }

Property Value

Type	Description
string

Formats

Gets video formats.

Declaration

public List<AudioCaptureDeviceFormatInfo> Formats { get; }

Property Value

Type	Description
List<AudioCaptureDeviceFormatInfo>

InternalName

Gets the internal name.

Declaration

public string InternalName { get; }

Property Value

Type	Description
string	The internal name.

Name

Gets device name.

Declaration

public string Name { get; }

Property Value

Type	Description
string

Methods

CompareTo(object)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Declaration

public int CompareTo(object obj)

Parameters

Type	Name	Description
object	obj	An object to compare with this instance.

Returns

Type	Description
int	A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes obj in the sort order. Zero This instance occurs in the same position in the sort order as obj. Greater than zero This instance follows obj in the sort order.

CreateSourceSettings(AudioCaptureDeviceFormat)

Converts to audio source settings.

Declaration

public IAudioCaptureDeviceSourceSettings CreateSourceSettings(AudioCaptureDeviceFormat format = null)

Parameters

Type	Name	Description
AudioCaptureDeviceFormat	format	The format.

Returns

Type	Description
IAudioCaptureDeviceSourceSettings	IAudioCaptureDeviceSourceSettings.

CreateSourceSettingsVC(AudioCaptureDeviceFormat)

Creates the source settings for VideoCaptureCoreX.

Declaration

public IVideoCaptureBaseAudioSourceSettings CreateSourceSettingsVC(AudioCaptureDeviceFormat format = null)

Parameters

Type	Name	Description
AudioCaptureDeviceFormat	format	The format.

Returns

Type	Description
IVideoCaptureBaseAudioSourceSettings	IVideoCaptureBaseAudioSourceSettings.

GetDefaultFormat()

Gets the default format.

Declaration

public AudioCaptureDeviceFormat GetDefaultFormat()

Returns

Type	Description
AudioCaptureDeviceFormat	AudioCaptureDeviceFormat.

GetDevice()

Gets the device.

Declaration

public Device GetDevice()

Returns

Type	Description
Device	Gst.Device.

ToString()

Class as a string.

Declaration

public override string ToString()

Returns

Type	Description
string	Returns string.

Overrides

object.ToString()

Implements

IComparable