Class UserPacket

Inheritance

object

UserPacket

Implements

IMessage<UserPacket>

IEquatable<UserPacket>

IDeepCloneable<UserPacket>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: LiveKit.Proto

Assembly: Uniform.LiveKit.Protocol.dll

Syntax

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

Constructors

UserPacket()

Declaration

public UserPacket()

UserPacket(UserPacket)

Declaration

public UserPacket(UserPacket other)

Parameters

Type	Name	Description
UserPacket	other

Fields

DestinationIdentitiesFieldNumber

Field number for the "destination_identities" field.

Declaration

public const int DestinationIdentitiesFieldNumber = 6

Field Value

Type	Description
int

DestinationSidsFieldNumber

Field number for the "destination_sids" field.

Declaration

public const int DestinationSidsFieldNumber = 3

Field Value

Type	Description
int

EndTimeFieldNumber

Field number for the "end_time" field.

Declaration

public const int EndTimeFieldNumber = 10

Field Value

Type	Description
int

IdFieldNumber

Field number for the "id" field.

Declaration

public const int IdFieldNumber = 8

Field Value

Type	Description
int

NonceFieldNumber

Field number for the "nonce" field.

Declaration

public const int NonceFieldNumber = 11

Field Value

Type	Description
int

ParticipantIdentityFieldNumber

Field number for the "participant_identity" field.

Declaration

public const int ParticipantIdentityFieldNumber = 5

Field Value

Type	Description
int

ParticipantSidFieldNumber

Field number for the "participant_sid" field.

Declaration

public const int ParticipantSidFieldNumber = 1

Field Value

Type	Description
int

PayloadFieldNumber

Field number for the "payload" field.

Declaration

public const int PayloadFieldNumber = 2

Field Value

Type	Description
int

StartTimeFieldNumber

Field number for the "start_time" field.

Declaration

public const int StartTimeFieldNumber = 9

Field Value

Type	Description
int

TopicFieldNumber

Field number for the "topic" field.

Declaration

public const int TopicFieldNumber = 4

Field Value

Type	Description
int

Properties

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

DestinationIdentities

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

Declaration

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

Property Value

Type	Description
RepeatedField<string>

DestinationSids

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

Declaration

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

Property Value

Type	Description
RepeatedField<string>

EndTime

Declaration

public ulong EndTime { get; set; }

Property Value

Type	Description
ulong

HasEndTime

Gets whether the "end_time" field is set

Declaration

public bool HasEndTime { get; }

Property Value

Type	Description
bool

HasId

Gets whether the "id" field is set

Declaration

public bool HasId { get; }

Property Value

Type	Description
bool

HasStartTime

Gets whether the "start_time" field is set

Declaration

public bool HasStartTime { get; }

Property Value

Type	Description
bool

HasTopic

Gets whether the "topic" field is set

Declaration

public bool HasTopic { get; }

Property Value

Type	Description
bool

Id

Unique ID to identify the message

Declaration

public string Id { get; set; }

Property Value

Type	Description
string

Nonce

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

Declaration

public ByteString Nonce { get; set; }

Property Value

Type	Description
ByteString

Parser

Declaration

public static MessageParser<UserPacket> Parser { get; }

Property Value

Type	Description
MessageParser<UserPacket>

ParticipantIdentity

Declaration

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

Property Value

Type	Description
string

ParticipantSid

participant ID of user that sent the message

Declaration

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

Property Value

Type	Description
string

Payload

user defined payload

Declaration

public ByteString Payload { get; set; }

Property Value

Type	Description
ByteString

StartTime

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

Declaration

public ulong StartTime { get; set; }

Property Value

Type	Description
ulong

Topic

topic under which the message was published

Declaration

public string Topic { get; set; }

Property Value

Type	Description
string

Methods

CalculateSize()

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

Declaration

public int CalculateSize()

Returns

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

ClearEndTime()

Clears the value of the "end_time" field

Declaration

public void ClearEndTime()

ClearId()

Clears the value of the "id" field

Declaration

public void ClearId()

ClearStartTime()

Clears the value of the "start_time" field

Declaration

public void ClearStartTime()

ClearTopic()

Clears the value of the "topic" field

Declaration

public void ClearTopic()

Clone()

Creates a deep clone of this object.

Declaration

public UserPacket Clone()

Returns

Type	Description
UserPacket	A deep clone of this object.

Equals(UserPacket)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(UserPacket other)

Parameters

Type	Name	Description
UserPacket	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
object	other

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

object.Equals(object)

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

MergeFrom(CodedInputStream)

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

Declaration

public void MergeFrom(CodedInputStream input)

Parameters

Type	Name	Description
CodedInputStream	input

Remarks

See the user guide for precise merge semantics.

MergeFrom(UserPacket)

Merges the given message into this one.

Declaration

public void MergeFrom(UserPacket other)

Parameters

Type	Name	Description
UserPacket	other

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

Declaration

public void WriteTo(CodedOutputStream output)

Parameters

Type	Name	Description
CodedOutputStream	output	Coded output stream to write the data to. Must not be null.

Implements

Google.Protobuf.IMessage<T>

IEquatable<T>

Google.Protobuf.IDeepCloneable<T>

Google.Protobuf.IBufferMessage

Google.Protobuf.IMessage