Table of Contents

Class AudioCaptureDeviceInfo

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

Audio capture device information.

public class AudioCaptureDeviceInfo : IComparable

Inheritance

Implements

Inherited Members

Constructors

AudioCaptureDeviceInfo(Device)

Initializes a new instance of the VisioForge.Core.Types.X.Sources.AudioCaptureDeviceInfo class.

public AudioCaptureDeviceInfo(Device device)

Parameters

device Device

The device.

AudioCaptureDeviceInfo(Device, BaseContext)

Initializes a new instance of the VisioForge.Core.Types.X.Sources.AudioCaptureDeviceInfo class with a logging context.

public AudioCaptureDeviceInfo(Device device, BaseContext context)

Parameters

device Device

The device.

context BaseContext

Optional context for structured logging. When null, output falls back to Trace.

Properties

API

Gets the API.

[JsonInclude]
public AudioCaptureDeviceAPI API { get; }

Property Value

AudioCaptureDeviceAPI

Context

Gets or sets the context for structured logging.

public BaseContext Context { get; set; }

Property Value

BaseContext

DevicePath

Gets device path.

[JsonInclude]
public string DevicePath { get; }

Property Value

string

DisplayName

Gets the device name for display. It carries the API tag - "[CoreAudio] Built-in Microphone" - on the desktop platforms, which offer more than one audio capture API, and is the bare device name on Android and iOS, which offer one. It is a display string and its shape is platform dependent, and it is not what the SDK matches a saved device on: persist VisioForge.Core.Types.X.Sources.AudioCaptureDeviceInfo.Name and, on macOS and Mac Catalyst, the stable CoreAudio UniqueID, when a device has to be re-resolved on a later run.

public string DisplayName { get; }

Property Value

string

Formats

Gets video formats.

public List<AudioCaptureDeviceFormatInfo> Formats { get; }

Property Value

List<AudioCaptureDeviceFormatInfo>

InternalName

Gets the internal name.

[JsonInclude]
public string InternalName { get; }

Property Value

string

Name

Gets device name.

[JsonInclude]
public string Name { get; }

Property Value

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.

public int CompareTo(object obj)

Parameters

obj object

An object to compare with this instance.

Returns

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.

public IAudioCaptureDeviceSourceSettings CreateSourceSettings(AudioCaptureDeviceFormat format = null)

Parameters

format AudioCaptureDeviceFormat

The format.

Returns

IAudioCaptureDeviceSourceSettings

IAudioCaptureDeviceSourceSettings.

CreateSourceSettingsVC(AudioCaptureDeviceFormat)

Creates the source settings for VideoCaptureCoreX.

public IVideoCaptureBaseAudioSourceSettings CreateSourceSettingsVC(AudioCaptureDeviceFormat format = null)

Parameters

format AudioCaptureDeviceFormat

The format.

Returns

IVideoCaptureBaseAudioSourceSettings

IVideoCaptureBaseAudioSourceSettings.

GetDefaultFormat()

Gets the default format.

public AudioCaptureDeviceFormat GetDefaultFormat()

Returns

AudioCaptureDeviceFormat

AudioCaptureDeviceFormat.

GetDevice()

Gets the device.

public Device GetDevice()

Returns

Device

Gst.Device.

ToString()

Class as a string.

public override string ToString()

Returns

string

Returns String.