Table of Contents

Class AudioOutputDeviceInfo

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

Audio output device info.

public class AudioOutputDeviceInfo : IComparable

Inheritance

Implements

Inherited Members

Constructors

AudioOutputDeviceInfo(Device)

Initializes a new instance of the VisioForge.Core.Types.X.Output.AudioOutputDeviceInfo class.

public AudioOutputDeviceInfo(Device device)

Parameters

device Device

The device.

Properties

API

Gets the API.

[JsonInclude]
public AudioOutputDeviceAPI API { get; }

Property Value

AudioOutputDeviceAPI

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] Speaker" - on the desktop platforms, which offer more than one audio output 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.Output.AudioOutputDeviceInfo.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

Guid

Gets or sets the unique identifier.

[JsonInclude]
public Guid Guid { get; }

Property Value

Guid

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.

GetDevice()

Gets the device.

public Device GetDevice()

Returns

Device

Gst.Device.

ToString()

Class as a string.

public override string ToString()

Returns

string

Returns String.