Class AudioStreamFromParticipantRequest

Namespace

LiveKit.Proto

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

Inheritance

object

AudioStreamFromParticipantRequest

Implements

IBufferMessage

Extension Methods

FfiRequestExtensions.InitializeRequestAsyncId<T>(T)

Constructors

AudioStreamFromParticipantRequest()

public AudioStreamFromParticipantRequest()

AudioStreamFromParticipantRequest(AudioStreamFromParticipantRequest)

public AudioStreamFromParticipantRequest(AudioStreamFromParticipantRequest other)

Parameters

other AudioStreamFromParticipantRequest

Fields

AudioFilterModuleIdFieldNumber

Field number for the "audio_filter_module_id" field.

public const int AudioFilterModuleIdFieldNumber = 7

Field Value

int

AudioFilterOptionsFieldNumber

Field number for the "audio_filter_options" field.

public const int AudioFilterOptionsFieldNumber = 8

Field Value

int

FrameSizeMsFieldNumber

Field number for the "frame_size_ms" field.

public const int FrameSizeMsFieldNumber = 9

Field Value

int

NumChannelsFieldNumber

Field number for the "num_channels" field.

public const int NumChannelsFieldNumber = 6

Field Value

int

ParticipantHandleFieldNumber

Field number for the "participant_handle" field.

public const int ParticipantHandleFieldNumber = 1

Field Value

int

QueueSizeFramesFieldNumber

Field number for the "queue_size_frames" field.

public const int QueueSizeFramesFieldNumber = 10

Field Value

int

SampleRateFieldNumber

Field number for the "sample_rate" field.

public const int SampleRateFieldNumber = 5

Field Value

int

TrackSourceFieldNumber

Field number for the "track_source" field.

public const int TrackSourceFieldNumber = 3

Field Value

int

TypeFieldNumber

Field number for the "type" field.

public const int TypeFieldNumber = 2

Field Value

int

Properties

AudioFilterModuleId

public string AudioFilterModuleId { get; set; }

Property Value

string

AudioFilterOptions

public string AudioFilterOptions { get; set; }

Property Value

string

Descriptor

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

Property Value

MessageDescriptor

FrameSizeMs

public uint FrameSizeMs { get; set; }

Property Value

uint

HasAudioFilterModuleId

Gets whether the "audio_filter_module_id" field is set

public bool HasAudioFilterModuleId { get; }

Property Value

bool

HasAudioFilterOptions

Gets whether the "audio_filter_options" field is set

public bool HasAudioFilterOptions { get; }

Property Value

bool

HasFrameSizeMs

Gets whether the "frame_size_ms" field is set

public bool HasFrameSizeMs { get; }

Property Value

bool

HasNumChannels

Gets whether the "num_channels" field is set

public bool HasNumChannels { get; }

Property Value

bool

HasParticipantHandle

Gets whether the "participant_handle" field is set

public bool HasParticipantHandle { get; }

Property Value

bool

HasQueueSizeFrames

Gets whether the "queue_size_frames" field is set

public bool HasQueueSizeFrames { get; }

Property Value

bool

HasSampleRate

Gets whether the "sample_rate" field is set

public bool HasSampleRate { get; }

Property Value

bool

HasTrackSource

Gets whether the "track_source" field is set

public bool HasTrackSource { get; }

Property Value

bool

HasType

Gets whether the "type" field is set

public bool HasType { get; }

Property Value

bool

NumChannels

public uint NumChannels { get; set; }

Property Value

uint

Parser

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

Property Value

MessageParser<AudioStreamFromParticipantRequest>

ParticipantHandle

public ulong ParticipantHandle { get; set; }

Property Value

ulong

QueueSizeFrames

Maximum number of queued WebRTC sink frames. Each frame is typically 10 ms of decoded PCM audio on the receive path. Omit this field to use the default bounded queue size of 10 frames. Set it to 0 to request unbounded buffering.

If your application consumes both audio and video, keep the queue sizing strategy coordinated across both streams. Using a much larger queue, or unbounded buffering, for only one of them can increase end-to-end latency for that stream and cause audio/video drift.

public uint QueueSizeFrames { get; set; }

Property Value

uint

SampleRate

public uint SampleRate { get; set; }

Property Value

uint

TrackSource

public TrackSource TrackSource { get; set; }

Property Value

TrackSource

Type

public AudioStreamType Type { get; set; }

Property Value

AudioStreamType

Methods

CalculateSize()

public int CalculateSize()

Returns

int

ClearAudioFilterModuleId()

Clears the value of the "audio_filter_module_id" field

public void ClearAudioFilterModuleId()

ClearAudioFilterOptions()

Clears the value of the "audio_filter_options" field

public void ClearAudioFilterOptions()

ClearFrameSizeMs()

Clears the value of the "frame_size_ms" field

public void ClearFrameSizeMs()

ClearNumChannels()

Clears the value of the "num_channels" field

public void ClearNumChannels()

ClearParticipantHandle()

Clears the value of the "participant_handle" field

public void ClearParticipantHandle()

ClearQueueSizeFrames()

Clears the value of the "queue_size_frames" field

public void ClearQueueSizeFrames()

ClearSampleRate()

Clears the value of the "sample_rate" field

public void ClearSampleRate()

ClearTrackSource()

Clears the value of the "track_source" field

public void ClearTrackSource()

ClearType()

Clears the value of the "type" field

public void ClearType()

Clone()

public AudioStreamFromParticipantRequest Clone()

Returns

AudioStreamFromParticipantRequest

Equals(AudioStreamFromParticipantRequest)

public bool Equals(AudioStreamFromParticipantRequest other)

Parameters

other AudioStreamFromParticipantRequest

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

public void MergeFrom(AudioStreamFromParticipantRequest other)

Parameters

other AudioStreamFromParticipantRequest

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

public void WriteTo(Google.Protobuf.CodedOutputStream output)

Parameters

output CodedOutputStream