Documentation

DataPacket extends Message
in package

new DataPacket API

Generated from protobuf message livekit.DataPacket

Table of Contents

Properties

$kind  : mixed
Generated from protobuf field <code>.livekit.DataPacket.Kind kind = 1 [deprecated = true];</code>
$participant_identity  : mixed
participant identity of user that sent the message
$participant_sid  : mixed
sid of the user that sent the message
$sequence  : mixed
sequence number of reliable packet
$value  : mixed
$destination_identities  : mixed
identities of participants who will receive the message (sent to all by default)

Methods

__construct()  : mixed
Constructor.
getChatMessage()  : ChatMessage|null
Generated from protobuf field <code>.livekit.ChatMessage chat_message = 9;</code>
getDestinationIdentities()  : RepeatedField<string|int, string>
identities of participants who will receive the message (sent to all by default)
getEncryptedPacket()  : EncryptedPacket|null
Generated from protobuf field <code>.livekit.EncryptedPacket encrypted_packet = 18;</code>
getKind()  : int
Generated from protobuf field <code>.livekit.DataPacket.Kind kind = 1 [deprecated = true];</code>
getMetrics()  : MetricsBatch|null
Generated from protobuf field <code>.livekit.MetricsBatch metrics = 8;</code>
getParticipantIdentity()  : string
participant identity of user that sent the message
getParticipantSid()  : string
sid of the user that sent the message
getRpcAck()  : RpcAck|null
Generated from protobuf field <code>.livekit.RpcAck rpc_ack = 11;</code>
getRpcRequest()  : RpcRequest|null
Generated from protobuf field <code>.livekit.RpcRequest rpc_request = 10;</code>
getRpcResponse()  : RpcResponse|null
Generated from protobuf field <code>.livekit.RpcResponse rpc_response = 12;</code>
getSequence()  : int
sequence number of reliable packet
getSipDtmf()  : SipDTMF|null
Generated from protobuf field <code>.livekit.SipDTMF sip_dtmf = 6;</code>
getSpeaker()  : ActiveSpeakerUpdate|null
Generated from protobuf field <code>.livekit.ActiveSpeakerUpdate speaker = 3 [deprecated = true];</code>
getStreamChunk()  : Chunk|null
Generated from protobuf field <code>.livekit.DataStream.Chunk stream_chunk = 14;</code>
getStreamHeader()  : Header|null
Generated from protobuf field <code>.livekit.DataStream.Header stream_header = 13;</code>
getStreamTrailer()  : Trailer|null
Generated from protobuf field <code>.livekit.DataStream.Trailer stream_trailer = 15;</code>
getTranscription()  : Transcription|null
Generated from protobuf field <code>.livekit.Transcription transcription = 7;</code>
getUser()  : UserPacket|null
Generated from protobuf field <code>.livekit.UserPacket user = 2;</code>
getValue()  : string
hasChatMessage()  : mixed
hasEncryptedPacket()  : mixed
hasMetrics()  : mixed
hasRpcAck()  : mixed
hasRpcRequest()  : mixed
hasRpcResponse()  : mixed
hasSipDtmf()  : mixed
hasSpeaker()  : mixed
hasStreamChunk()  : mixed
hasStreamHeader()  : mixed
hasStreamTrailer()  : mixed
hasTranscription()  : mixed
hasUser()  : mixed
setChatMessage()  : $this
Generated from protobuf field <code>.livekit.ChatMessage chat_message = 9;</code>
setDestinationIdentities()  : $this
identities of participants who will receive the message (sent to all by default)
setEncryptedPacket()  : $this
Generated from protobuf field <code>.livekit.EncryptedPacket encrypted_packet = 18;</code>
setKind()  : $this
Generated from protobuf field <code>.livekit.DataPacket.Kind kind = 1 [deprecated = true];</code>
setMetrics()  : $this
Generated from protobuf field <code>.livekit.MetricsBatch metrics = 8;</code>
setParticipantIdentity()  : $this
participant identity of user that sent the message
setParticipantSid()  : $this
sid of the user that sent the message
setRpcAck()  : $this
Generated from protobuf field <code>.livekit.RpcAck rpc_ack = 11;</code>
setRpcRequest()  : $this
Generated from protobuf field <code>.livekit.RpcRequest rpc_request = 10;</code>
setRpcResponse()  : $this
Generated from protobuf field <code>.livekit.RpcResponse rpc_response = 12;</code>
setSequence()  : $this
sequence number of reliable packet
setSipDtmf()  : $this
Generated from protobuf field <code>.livekit.SipDTMF sip_dtmf = 6;</code>
setSpeaker()  : $this
Generated from protobuf field <code>.livekit.ActiveSpeakerUpdate speaker = 3 [deprecated = true];</code>
setStreamChunk()  : $this
Generated from protobuf field <code>.livekit.DataStream.Chunk stream_chunk = 14;</code>
setStreamHeader()  : $this
Generated from protobuf field <code>.livekit.DataStream.Header stream_header = 13;</code>
setStreamTrailer()  : $this
Generated from protobuf field <code>.livekit.DataStream.Trailer stream_trailer = 15;</code>
setTranscription()  : $this
Generated from protobuf field <code>.livekit.Transcription transcription = 7;</code>
setUser()  : $this
Generated from protobuf field <code>.livekit.UserPacket user = 2;</code>

Properties

$kind

Generated from protobuf field <code>.livekit.DataPacket.Kind kind = 1 [deprecated = true];</code>

protected mixed $kind = 0

$participant_identity

participant identity of user that sent the message

protected mixed $participant_identity = ''

Generated from protobuf field string participant_identity = 4;

$participant_sid

sid of the user that sent the message

protected mixed $participant_sid = ''

Generated from protobuf field string participant_sid = 17;

$sequence

sequence number of reliable packet

protected mixed $sequence = 0

Generated from protobuf field uint32 sequence = 16;

$destination_identities

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

private mixed $destination_identities

Generated from protobuf field repeated string destination_identities = 5;

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type int $kind
@type string $participant_identity
      participant identity of user that sent the message
@type string[] $destination_identities
      identities of participants who will receive the message (sent to all by default)
@type \Livekit\UserPacket $user
@type \Livekit\ActiveSpeakerUpdate $speaker
@type \Livekit\SipDTMF $sip_dtmf
@type \Livekit\Transcription $transcription
@type \Livekit\MetricsBatch $metrics
@type \Livekit\ChatMessage $chat_message
@type \Livekit\RpcRequest $rpc_request
@type \Livekit\RpcAck $rpc_ack
@type \Livekit\RpcResponse $rpc_response
@type \Livekit\DataStream\Header $stream_header
@type \Livekit\DataStream\Chunk $stream_chunk
@type \Livekit\DataStream\Trailer $stream_trailer
@type \Livekit\EncryptedPacket $encrypted_packet
@type int $sequence
      sequence number of reliable packet
@type string $participant_sid
      sid of the user that sent the message

}

getChatMessage()

Generated from protobuf field <code>.livekit.ChatMessage chat_message = 9;</code>

public getChatMessage() : ChatMessage|null
Return values
ChatMessage|null

getDestinationIdentities()

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

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

Generated from protobuf field repeated string destination_identities = 5;

Return values
RepeatedField<string|int, string>

getEncryptedPacket()

Generated from protobuf field <code>.livekit.EncryptedPacket encrypted_packet = 18;</code>

public getEncryptedPacket() : EncryptedPacket|null
Return values
EncryptedPacket|null

getKind()

Generated from protobuf field <code>.livekit.DataPacket.Kind kind = 1 [deprecated = true];</code>

public getKind() : int
Return values
int

getParticipantIdentity()

participant identity of user that sent the message

public getParticipantIdentity() : string

Generated from protobuf field string participant_identity = 4;

Return values
string

getParticipantSid()

sid of the user that sent the message

public getParticipantSid() : string

Generated from protobuf field string participant_sid = 17;

Return values
string

getRpcAck()

Generated from protobuf field <code>.livekit.RpcAck rpc_ack = 11;</code>

public getRpcAck() : RpcAck|null
Return values
RpcAck|null

getRpcRequest()

Generated from protobuf field <code>.livekit.RpcRequest rpc_request = 10;</code>

public getRpcRequest() : RpcRequest|null
Return values
RpcRequest|null

getRpcResponse()

Generated from protobuf field <code>.livekit.RpcResponse rpc_response = 12;</code>

public getRpcResponse() : RpcResponse|null
Return values
RpcResponse|null

getSequence()

sequence number of reliable packet

public getSequence() : int

Generated from protobuf field uint32 sequence = 16;

Return values
int

getSipDtmf()

Generated from protobuf field <code>.livekit.SipDTMF sip_dtmf = 6;</code>

public getSipDtmf() : SipDTMF|null
Return values
SipDTMF|null

getStreamChunk()

Generated from protobuf field <code>.livekit.DataStream.Chunk stream_chunk = 14;</code>

public getStreamChunk() : Chunk|null
Return values
Chunk|null

getStreamHeader()

Generated from protobuf field <code>.livekit.DataStream.Header stream_header = 13;</code>

public getStreamHeader() : Header|null
Return values
Header|null

getStreamTrailer()

Generated from protobuf field <code>.livekit.DataStream.Trailer stream_trailer = 15;</code>

public getStreamTrailer() : Trailer|null
Return values
Trailer|null

getTranscription()

Generated from protobuf field <code>.livekit.Transcription transcription = 7;</code>

public getTranscription() : Transcription|null
Return values
Transcription|null

getUser()

Generated from protobuf field <code>.livekit.UserPacket user = 2;</code>

public getUser() : UserPacket|null
Return values
UserPacket|null

getValue()

public getValue() : string
Return values
string

hasChatMessage()

public hasChatMessage() : mixed

hasEncryptedPacket()

public hasEncryptedPacket() : mixed

hasRpcResponse()

public hasRpcResponse() : mixed

hasStreamChunk()

public hasStreamChunk() : mixed

hasStreamHeader()

public hasStreamHeader() : mixed

hasStreamTrailer()

public hasStreamTrailer() : mixed

hasTranscription()

public hasTranscription() : mixed

setChatMessage()

Generated from protobuf field <code>.livekit.ChatMessage chat_message = 9;</code>

public setChatMessage(ChatMessage $var) : $this
Parameters
$var : ChatMessage
Return values
$this

setDestinationIdentities()

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

public setDestinationIdentities(array<string|int, string> $var) : $this

Generated from protobuf field repeated string destination_identities = 5;

Parameters
$var : array<string|int, string>
Return values
$this

setEncryptedPacket()

Generated from protobuf field <code>.livekit.EncryptedPacket encrypted_packet = 18;</code>

public setEncryptedPacket(EncryptedPacket $var) : $this
Parameters
$var : EncryptedPacket
Return values
$this

setKind()

Generated from protobuf field <code>.livekit.DataPacket.Kind kind = 1 [deprecated = true];</code>

public setKind(int $var) : $this
Parameters
$var : int
Return values
$this

setMetrics()

Generated from protobuf field <code>.livekit.MetricsBatch metrics = 8;</code>

public setMetrics(MetricsBatch $var) : $this
Parameters
$var : MetricsBatch
Return values
$this

setParticipantIdentity()

participant identity of user that sent the message

public setParticipantIdentity(string $var) : $this

Generated from protobuf field string participant_identity = 4;

Parameters
$var : string
Return values
$this

setParticipantSid()

sid of the user that sent the message

public setParticipantSid(string $var) : $this

Generated from protobuf field string participant_sid = 17;

Parameters
$var : string
Return values
$this

setRpcAck()

Generated from protobuf field <code>.livekit.RpcAck rpc_ack = 11;</code>

public setRpcAck(RpcAck $var) : $this
Parameters
$var : RpcAck
Return values
$this

setRpcRequest()

Generated from protobuf field <code>.livekit.RpcRequest rpc_request = 10;</code>

public setRpcRequest(RpcRequest $var) : $this
Parameters
$var : RpcRequest
Return values
$this

setRpcResponse()

Generated from protobuf field <code>.livekit.RpcResponse rpc_response = 12;</code>

public setRpcResponse(RpcResponse $var) : $this
Parameters
$var : RpcResponse
Return values
$this

setSequence()

sequence number of reliable packet

public setSequence(int $var) : $this

Generated from protobuf field uint32 sequence = 16;

Parameters
$var : int
Return values
$this

setSipDtmf()

Generated from protobuf field <code>.livekit.SipDTMF sip_dtmf = 6;</code>

public setSipDtmf(SipDTMF $var) : $this
Parameters
$var : SipDTMF
Return values
$this

setStreamChunk()

Generated from protobuf field <code>.livekit.DataStream.Chunk stream_chunk = 14;</code>

public setStreamChunk(Chunk $var) : $this
Parameters
$var : Chunk
Return values
$this

setStreamHeader()

Generated from protobuf field <code>.livekit.DataStream.Header stream_header = 13;</code>

public setStreamHeader(Header $var) : $this
Parameters
$var : Header
Return values
$this

setStreamTrailer()

Generated from protobuf field <code>.livekit.DataStream.Trailer stream_trailer = 15;</code>

public setStreamTrailer(Trailer $var) : $this
Parameters
$var : Trailer
Return values
$this

setTranscription()

Generated from protobuf field <code>.livekit.Transcription transcription = 7;</code>

public setTranscription(Transcription $var) : $this
Parameters
$var : Transcription
Return values
$this

setUser()

Generated from protobuf field <code>.livekit.UserPacket user = 2;</code>

public setUser(UserPacket $var) : $this
Parameters
$var : UserPacket
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results