Class VideoStreamFromParticipantRequest

Namespace

LiveKit.Proto

Request a video stream from a participant

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

Inheritance

object

VideoStreamFromParticipantRequest

Implements

IBufferMessage

Extension Methods

FfiRequestExtensions.InitializeRequestAsyncId<T>(T)

Constructors

VideoStreamFromParticipantRequest()

public VideoStreamFromParticipantRequest()

VideoStreamFromParticipantRequest(VideoStreamFromParticipantRequest)

public VideoStreamFromParticipantRequest(VideoStreamFromParticipantRequest other)

Parameters

other VideoStreamFromParticipantRequest

Fields

FormatFieldNumber

Field number for the "format" field.

public const int FormatFieldNumber = 4

Field Value

int

NormalizeStrideFieldNumber

Field number for the "normalize_stride" field.

public const int NormalizeStrideFieldNumber = 5

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 = 6

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

Descriptor

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

Property Value

MessageDescriptor

Format

public VideoBufferType Format { get; set; }

Property Value

VideoBufferType

HasFormat

Gets whether the "format" field is set

public bool HasFormat { get; }

Property Value

bool

HasNormalizeStride

Gets whether the "normalize_stride" field is set

public bool HasNormalizeStride { 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

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

NormalizeStride

public bool NormalizeStride { get; set; }

Property Value

bool

Parser

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

Property Value

MessageParser<VideoStreamFromParticipantRequest>

ParticipantHandle

public ulong ParticipantHandle { get; set; }

Property Value

ulong

QueueSizeFrames

Maximum number of queued WebRTC sink frames on the receive path. Omit this field to use the default bounded queue size of 1 frame. 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

TrackSource

public TrackSource TrackSource { get; set; }

Property Value

TrackSource

Type

public VideoStreamType Type { get; set; }

Property Value

VideoStreamType

Methods

CalculateSize()

public int CalculateSize()

Returns

int

ClearFormat()

Clears the value of the "format" field

public void ClearFormat()

ClearNormalizeStride()

Clears the value of the "normalize_stride" field

public void ClearNormalizeStride()

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

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 VideoStreamFromParticipantRequest Clone()

Returns

VideoStreamFromParticipantRequest

Equals(VideoStreamFromParticipantRequest)

public bool Equals(VideoStreamFromParticipantRequest other)

Parameters

other VideoStreamFromParticipantRequest

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

public void MergeFrom(VideoStreamFromParticipantRequest other)

Parameters

other VideoStreamFromParticipantRequest

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

public void WriteTo(Google.Protobuf.CodedOutputStream output)

Parameters

output CodedOutputStream