Table of Contents

Class AddTrackRequest

Namespace
LiveKit.Proto
Assembly
LiveKit.AspNetCore.ServerSdk.Abstractions.dll
public sealed class AddTrackRequest : IMessage<AddTrackRequest>, IEquatable<AddTrackRequest>, IDeepCloneable<AddTrackRequest>, IBufferMessage, IMessage
Inheritance
AddTrackRequest
Implements
IMessage<AddTrackRequest>
IDeepCloneable<AddTrackRequest>
IBufferMessage
IMessage
Inherited Members

Constructors

AddTrackRequest()

public AddTrackRequest()

AddTrackRequest(AddTrackRequest)

public AddTrackRequest(AddTrackRequest other)

Parameters

other AddTrackRequest

Fields

AudioFeaturesFieldNumber

Field number for the "audio_features" field.

public const int AudioFeaturesFieldNumber = 17

Field Value

int

BackupCodecPolicyFieldNumber

Field number for the "backup_codec_policy" field.

public const int BackupCodecPolicyFieldNumber = 16

Field Value

int

CidFieldNumber

Field number for the "cid" field.

public const int CidFieldNumber = 1

Field Value

int

DisableDtxFieldNumber

Field number for the "disable_dtx" field.

public const int DisableDtxFieldNumber = 7

Field Value

int

DisableRedFieldNumber

Field number for the "disable_red" field.

public const int DisableRedFieldNumber = 13

Field Value

int

EncryptionFieldNumber

Field number for the "encryption" field.

public const int EncryptionFieldNumber = 14

Field Value

int

HeightFieldNumber

Field number for the "height" field.

public const int HeightFieldNumber = 5

Field Value

int

LayersFieldNumber

Field number for the "layers" field.

public const int LayersFieldNumber = 9

Field Value

int

MutedFieldNumber

Field number for the "muted" field.

public const int MutedFieldNumber = 6

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 2

Field Value

int

PacketTrailerFeaturesFieldNumber

Field number for the "packet_trailer_features" field.

public const int PacketTrailerFeaturesFieldNumber = 18

Field Value

int

SidFieldNumber

Field number for the "sid" field.

public const int SidFieldNumber = 11

Field Value

int

SimulcastCodecsFieldNumber

Field number for the "simulcast_codecs" field.

public const int SimulcastCodecsFieldNumber = 10

Field Value

int

SourceFieldNumber

Field number for the "source" field.

public const int SourceFieldNumber = 8

Field Value

int

StereoFieldNumber

Field number for the "stereo" field.

public const int StereoFieldNumber = 12

Field Value

int

StreamFieldNumber

Field number for the "stream" field.

public const int StreamFieldNumber = 15

Field Value

int

TypeFieldNumber

Field number for the "type" field.

public const int TypeFieldNumber = 3

Field Value

int

WidthFieldNumber

Field number for the "width" field.

public const int WidthFieldNumber = 4

Field Value

int

Properties

AudioFeatures

public RepeatedField<AudioTrackFeature> AudioFeatures { get; }

Property Value

RepeatedField<AudioTrackFeature>

BackupCodecPolicy

public BackupCodecPolicy BackupCodecPolicy { get; set; }

Property Value

BackupCodecPolicy

Cid

client ID of track, to match it when RTC track is received

public string Cid { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

DisableDtx

true if DTX (Discontinuous Transmission) is disabled for audio

[Obsolete]
public bool DisableDtx { get; set; }

Property Value

bool

DisableRed

true if RED (Redundant Encoding) is disabled for audio

public bool DisableRed { get; set; }

Property Value

bool

Encryption

public Encryption.Types.Type Encryption { get; set; }

Property Value

Encryption.Types.Type

Height

public uint Height { get; set; }

Property Value

uint

Layers

public RepeatedField<VideoLayer> Layers { get; }

Property Value

RepeatedField<VideoLayer>

Muted

true to add track and initialize to muted

public bool Muted { get; set; }

Property Value

bool

Name

public string Name { get; set; }

Property Value

string

PacketTrailerFeatures

public RepeatedField<PacketTrailerFeature> PacketTrailerFeatures { get; }

Property Value

RepeatedField<PacketTrailerFeature>

Parser

public static MessageParser<AddTrackRequest> Parser { get; }

Property Value

MessageParser<AddTrackRequest>

Sid

server ID of track, publish new codec to exist track

public string Sid { get; set; }

Property Value

string

SimulcastCodecs

public RepeatedField<SimulcastCodec> SimulcastCodecs { get; }

Property Value

RepeatedField<SimulcastCodec>

Source

public TrackSource Source { get; set; }

Property Value

TrackSource

Stereo

deprecated in favor of audio_features

[Obsolete]
public bool Stereo { get; set; }

Property Value

bool

Stream

which stream the track belongs to, used to group tracks together. if not specified, server will infer it from track source to bundle camera/microphone, screenshare/audio together

public string Stream { get; set; }

Property Value

string

Type

public TrackType Type { get; set; }

Property Value

TrackType

Width

public uint Width { get; set; }

Property Value

uint

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public AddTrackRequest Clone()

Returns

AddTrackRequest

A deep clone of this object.

Equals(AddTrackRequest)

public bool Equals(AddTrackRequest other)

Parameters

other AddTrackRequest

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(AddTrackRequest)

Merges the given message into this one.

public void MergeFrom(AddTrackRequest other)

Parameters

other AddTrackRequest

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.