Class UserPacket

Namespace

Livekit.Server.Sdk.Dotnet

Assembly

LivekitApi.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.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

UserPacket()

public UserPacket()

UserPacket(UserPacket)

public UserPacket(UserPacket other)

Parameters

other UserPacket

Properties

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

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

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