Table of Contents

Class AudioDeviceInfo

Namespace
LiveKit.Proto

Information about an audio device.

public sealed class AudioDeviceInfo : Google.Protobuf.IMessage<AudioDeviceInfo>, Google.Protobuf.IBufferMessage
Inheritance
AudioDeviceInfo
Implements
IBufferMessage
Extension Methods

Constructors

AudioDeviceInfo() 

public AudioDeviceInfo()

AudioDeviceInfo(AudioDeviceInfo) 

public AudioDeviceInfo(AudioDeviceInfo other)

Parameters

other AudioDeviceInfo

Fields

GuidFieldNumber

Field number for the "guid" field.

public const int GuidFieldNumber = 3

Field Value

int

IndexFieldNumber

Field number for the "index" field.

public const int IndexFieldNumber = 1

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 2

Field Value

int

Properties

Descriptor 

public static Google.Protobuf.Reflection.MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Guid

Platform-specific unique device identifier (GUID). This is stable across device additions/removals and should be preferred over index for device selection. Format varies by platform:

  • Windows: Device interface path
  • macOS: AudioObjectID as string
  • Linux: ALSA/PulseAudio device identifier
public string Guid { get; set; }

Property Value

string

HasGuid

Gets whether the "guid" field is set

public bool HasGuid { get; }

Property Value

bool

HasIndex

Gets whether the "index" field is set

public bool HasIndex { get; }

Property Value

bool

HasName

Gets whether the "name" field is set

public bool HasName { get; }

Property Value

bool

Index

Device index (0-based). Note: indices can change when devices are added/removed.

public uint Index { get; set; }

Property Value

uint

Name

Device name as reported by the operating system.

public string Name { get; set; }

Property Value

string

Parser 

public static Google.Protobuf.MessageParser<AudioDeviceInfo> Parser { get; }

Property Value

MessageParser<AudioDeviceInfo>

Methods

CalculateSize() 

public int CalculateSize()

Returns

int

ClearGuid()

Clears the value of the "guid" field

public void ClearGuid()

ClearIndex()

Clears the value of the "index" field

public void ClearIndex()

ClearName()

Clears the value of the "name" field

public void ClearName()

Clone() 

public AudioDeviceInfo Clone()

Returns

AudioDeviceInfo

Equals(AudioDeviceInfo) 

public bool Equals(AudioDeviceInfo other)

Parameters

other AudioDeviceInfo

Returns

bool

Equals(object) 

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode() 

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream) 

public void MergeFrom(Google.Protobuf.CodedInputStream input)

Parameters

input CodedInputStream

MergeFrom(AudioDeviceInfo) 

public void MergeFrom(AudioDeviceInfo other)

Parameters

other AudioDeviceInfo

ToString() 

public override string ToString()

Returns

string

WriteTo(CodedOutputStream) 

public void WriteTo(Google.Protobuf.CodedOutputStream output)

Parameters

output CodedOutputStream
Edit this page