Class UserPacket

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

public sealed class UserPacket : IMessage<UserPacket>, IEquatable<UserPacket>, IDeepCloneable<UserPacket>, IBufferMessage, IMessage

Inheritance

object

UserPacket

Implements

IMessage<UserPacket>

IEquatable<UserPacket>

IDeepCloneable<UserPacket>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

UserPacket()

public UserPacket()

UserPacket(UserPacket)

public UserPacket(UserPacket other)

Parameters

other UserPacket

Fields

DestinationIdentitiesFieldNumber

Field number for the "destination_identities" field.

public const int DestinationIdentitiesFieldNumber = 6

Field Value

int

DestinationSidsFieldNumber

Field number for the "destination_sids" field.

public const int DestinationSidsFieldNumber = 3

Field Value

int

EndTimeFieldNumber

Field number for the "end_time" field.

public const int EndTimeFieldNumber = 10

Field Value

int

IdFieldNumber

Field number for the "id" field.

public const int IdFieldNumber = 8

Field Value

int

NonceFieldNumber

Field number for the "nonce" field.

public const int NonceFieldNumber = 11

Field Value

int

ParticipantIdentityFieldNumber

Field number for the "participant_identity" field.

public const int ParticipantIdentityFieldNumber = 5

Field Value

int

ParticipantSidFieldNumber

Field number for the "participant_sid" field.

public const int ParticipantSidFieldNumber = 1

Field Value

int

PayloadFieldNumber

Field number for the "payload" field.

public const int PayloadFieldNumber = 2

Field Value

int

StartTimeFieldNumber

Field number for the "start_time" field.

public const int StartTimeFieldNumber = 9

Field Value

int

TopicFieldNumber

Field number for the "topic" field.

public const int TopicFieldNumber = 4

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

DestinationIdentities

identities of participants who will receive the message (sent to all by default)

[Obsolete]
public RepeatedField<string> DestinationIdentities { get; }

Property Value

RepeatedField<string>

DestinationSids

the ID of the participants who will receive the message (sent to all by default)

[Obsolete]
public RepeatedField<string> DestinationSids { get; }

Property Value

RepeatedField<string>

EndTime

public ulong EndTime { get; set; }

Property Value

ulong

HasEndTime

Gets whether the "end_time" field is set

public bool HasEndTime { get; }

Property Value

bool

HasId

Gets whether the "id" field is set

public bool HasId { get; }

Property Value

bool

HasStartTime

Gets whether the "start_time" field is set

public bool HasStartTime { get; }

Property Value

bool

HasTopic

Gets whether the "topic" field is set

public bool HasTopic { get; }

Property Value

bool

Id

Unique ID to identify the message

public string Id { get; set; }

Property Value

string

Nonce

added by SDK to enable de-duping of messages, for INTERNAL USE ONLY

public ByteString Nonce { get; set; }

Property Value

ByteString

Parser

public static MessageParser<UserPacket> Parser { get; }

Property Value

MessageParser<UserPacket>

ParticipantIdentity

[Obsolete]
public string ParticipantIdentity { get; set; }

Property Value

string

ParticipantSid

participant ID of user that sent the message

[Obsolete]
public string ParticipantSid { get; set; }

Property Value

string

Payload

user defined payload

public ByteString Payload { get; set; }

Property Value

ByteString

StartTime

start and end time allow relating the message to specific media time

public ulong StartTime { get; set; }

Property Value

ulong

Topic

topic under which the message was published

public string Topic { get; set; }

Property Value

string

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.

ClearEndTime()

Clears the value of the "end_time" field

public void ClearEndTime()

ClearId()

Clears the value of the "id" field

public void ClearId()

ClearStartTime()

Clears the value of the "start_time" field

public void ClearStartTime()

ClearTopic()

Clears the value of the "topic" field

public void ClearTopic()

Clone()

Creates a deep clone of this object.

public UserPacket Clone()

Returns

UserPacket

A deep clone of this object.

Equals(UserPacket)

public bool Equals(UserPacket other)

Parameters

other UserPacket

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

Merges the given message into this one.

public void MergeFrom(UserPacket other)

Parameters

other UserPacket

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.