Documentation

UserPacket extends Message

in package

• Application

Generated from protobuf message <code>livekit.UserPacket</code>

Table of Contents

Properties

$end_time  : mixed

Generated from protobuf field <code>optional uint64 end_time = 10;</code>

$id  : mixed

Unique ID to identify the message

$nonce  : mixed

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

$participant_identity  : mixed

Generated from protobuf field <code>string participant_identity = 5 [deprecated = true];</code>

$participant_sid  : mixed

participant ID of user that sent the message

$payload  : mixed

user defined payload

$start_time  : mixed

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

$topic  : mixed

topic under which the message was published

$destination_identities  : mixed

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

$destination_sids  : mixed

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

Methods

__construct()  : mixed

Constructor.

clearEndTime()  : mixed

clearId()  : mixed

clearStartTime()  : mixed

clearTopic()  : mixed

getDestinationIdentities()  : RepeatedField<string|int, string>

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

getDestinationSids()  : RepeatedField<string|int, string>

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

getEndTime()  : int|string

Generated from protobuf field <code>optional uint64 end_time = 10;</code>

getId()  : string

Unique ID to identify the message

getNonce()  : string

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

getParticipantIdentity()  : string

Generated from protobuf field <code>string participant_identity = 5 [deprecated = true];</code>

getParticipantSid()  : string

participant ID of user that sent the message

getPayload()  : string

user defined payload

getStartTime()  : int|string

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

getTopic()  : string

topic under which the message was published

hasEndTime()  : mixed

hasId()  : mixed

hasStartTime()  : mixed

hasTopic()  : mixed

setDestinationIdentities()  : $this

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

setDestinationSids()  : $this

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

setEndTime()  : $this

Generated from protobuf field <code>optional uint64 end_time = 10;</code>

setId()  : $this

Unique ID to identify the message

setNonce()  : $this

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

setParticipantIdentity()  : $this

Generated from protobuf field <code>string participant_identity = 5 [deprecated = true];</code>

setParticipantSid()  : $this

participant ID of user that sent the message

setPayload()  : $this

user defined payload

setStartTime()  : $this

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

setTopic()  : $this

topic under which the message was published