Class NewAudioSourceRequest

Namespace

LiveKit.Proto

Create a new AudioSource

public sealed class NewAudioSourceRequest : Google.Protobuf.IMessage<NewAudioSourceRequest>, Google.Protobuf.IBufferMessage

Inheritance

object

NewAudioSourceRequest

Implements

IBufferMessage

Extension Methods

FfiRequestExtensions.InitializeRequestAsyncId<T>(T)

Constructors

NewAudioSourceRequest()

public NewAudioSourceRequest()

NewAudioSourceRequest(NewAudioSourceRequest)

public NewAudioSourceRequest(NewAudioSourceRequest other)

Parameters

other NewAudioSourceRequest

Fields

NumChannelsFieldNumber

Field number for the "num_channels" field.

public const int NumChannelsFieldNumber = 4

Field Value

int

OptionsFieldNumber

Field number for the "options" field.

public const int OptionsFieldNumber = 2

Field Value

int

PlatformAudioHandleFieldNumber

Field number for the "platform_audio_handle" field.

public const int PlatformAudioHandleFieldNumber = 6

Field Value

int

QueueSizeMsFieldNumber

Field number for the "queue_size_ms" field.

public const int QueueSizeMsFieldNumber = 5

Field Value

int

SampleRateFieldNumber

Field number for the "sample_rate" field.

public const int SampleRateFieldNumber = 3

Field Value

int

TypeFieldNumber

Field number for the "type" field.

public const int TypeFieldNumber = 1

Field Value

int

Properties

Descriptor

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

Property Value

MessageDescriptor

HasNumChannels

Gets whether the "num_channels" field is set

public bool HasNumChannels { get; }

Property Value

bool

HasPlatformAudioHandle

Gets whether the "platform_audio_handle" field is set

public bool HasPlatformAudioHandle { get; }

Property Value

bool

HasQueueSizeMs

Gets whether the "queue_size_ms" field is set

public bool HasQueueSizeMs { get; }

Property Value

bool

HasSampleRate

Gets whether the "sample_rate" field is set

public bool HasSampleRate { get; }

Property Value

bool

HasType

Gets whether the "type" field is set

public bool HasType { get; }

Property Value

bool

NumChannels

Number of audio channels. Optional - defaults to 1 (mono) if not specified. For AudioSourcePlatform: ignored, ADM uses hardware native channels. For AudioSourceNative with queue_size_ms=0 (fast path): ignored, frame values used directly.

public uint NumChannels { get; set; }

Property Value

uint

Options

public AudioSourceOptions Options { get; set; }

Property Value

AudioSourceOptions

Parser

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

Property Value

MessageParser<NewAudioSourceRequest>

PlatformAudioHandle

For AudioSourcePlatform: the PlatformAudio handle to configure audio processing on. If provided with options, audio processing will be configured on the PlatformAudio.

public ulong PlatformAudioHandle { get; set; }

Property Value

ulong

QueueSizeMs

public uint QueueSizeMs { get; set; }

Property Value

uint

SampleRate

Sample rate in Hz. Optional - defaults to 48000 if not specified. For AudioSourcePlatform: ignored, ADM uses hardware native sample rate. For AudioSourceNative with queue_size_ms=0 (fast path): ignored, frame values used directly.

public uint SampleRate { get; set; }

Property Value

uint

Type

public AudioSourceType Type { get; set; }

Property Value

AudioSourceType

Methods

CalculateSize()

public int CalculateSize()

Returns

int

ClearNumChannels()

Clears the value of the "num_channels" field

public void ClearNumChannels()

ClearPlatformAudioHandle()

Clears the value of the "platform_audio_handle" field

public void ClearPlatformAudioHandle()

ClearQueueSizeMs()

Clears the value of the "queue_size_ms" field

public void ClearQueueSizeMs()

ClearSampleRate()

Clears the value of the "sample_rate" field

public void ClearSampleRate()

ClearType()

Clears the value of the "type" field

public void ClearType()

Clone()

public NewAudioSourceRequest Clone()

Returns

NewAudioSourceRequest

Equals(NewAudioSourceRequest)

public bool Equals(NewAudioSourceRequest other)

Parameters

other NewAudioSourceRequest

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(NewAudioSourceRequest)

public void MergeFrom(NewAudioSourceRequest other)

Parameters

other NewAudioSourceRequest

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

public void WriteTo(Google.Protobuf.CodedOutputStream output)

Parameters

output CodedOutputStream