Class NewVideoStreamRequest

Namespace

LiveKit.Proto

Create a new VideoStream VideoStream is used to receive video frames from a track

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

Inheritance

object

NewVideoStreamRequest

Implements

IBufferMessage

Extension Methods

FfiRequestExtensions.InitializeRequestAsyncId<T>(T)

Constructors

NewVideoStreamRequest()

public NewVideoStreamRequest()

NewVideoStreamRequest(NewVideoStreamRequest)

public NewVideoStreamRequest(NewVideoStreamRequest other)

Parameters

other NewVideoStreamRequest

Fields

FormatFieldNumber

Field number for the "format" field.

public const int FormatFieldNumber = 3

Field Value

int

NormalizeStrideFieldNumber

Field number for the "normalize_stride" field.

public const int NormalizeStrideFieldNumber = 4

Field Value

int

QueueSizeFramesFieldNumber

Field number for the "queue_size_frames" field.

public const int QueueSizeFramesFieldNumber = 5

Field Value

int

TrackHandleFieldNumber

Field number for the "track_handle" field.

public const int TrackHandleFieldNumber = 1

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

Get the frame on a specific 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

HasQueueSizeFrames

Gets whether the "queue_size_frames" field is set

public bool HasQueueSizeFrames { get; }

Property Value

bool

HasTrackHandle

Gets whether the "track_handle" field is set

public bool HasTrackHandle { get; }

Property Value

bool

HasType

Gets whether the "type" field is set

public bool HasType { get; }

Property Value

bool

NormalizeStride

if true, stride will be set to width/chroma_width

public bool NormalizeStride { get; set; }

Property Value

bool

Parser

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

Property Value

MessageParser<NewVideoStreamRequest>

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

TrackHandle

public ulong TrackHandle { get; set; }

Property Value

ulong

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

ClearQueueSizeFrames()

Clears the value of the "queue_size_frames" field

public void ClearQueueSizeFrames()

ClearTrackHandle()

Clears the value of the "track_handle" field

public void ClearTrackHandle()

ClearType()

Clears the value of the "type" field

public void ClearType()

Clone()

public NewVideoStreamRequest Clone()

Returns

NewVideoStreamRequest

Equals(NewVideoStreamRequest)

public bool Equals(NewVideoStreamRequest other)

Parameters

other NewVideoStreamRequest

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

public void MergeFrom(NewVideoStreamRequest other)

Parameters

other NewVideoStreamRequest

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

public void WriteTo(Google.Protobuf.CodedOutputStream output)

Parameters

output CodedOutputStream