Documentation

SendDataRequest extends Message
in package

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

Table of Contents

Properties

$data  : mixed
Generated from protobuf field <code>bytes data = 2;</code>
$kind  : mixed
Generated from protobuf field <code>.livekit.DataPacket.Kind kind = 3;</code>
$nonce  : mixed
added by SDK to enable de-duping of messages, for INTERNAL USE ONLY
$room  : mixed
Generated from protobuf field <code>string room = 1;</code>
$topic  : mixed
Generated from protobuf field <code>optional string topic = 5;</code>
$destination_identities  : mixed
when set, only forward to these identities
$destination_sids  : mixed
mark deprecated

Methods

__construct()  : mixed
Constructor.
clearTopic()  : mixed
getData()  : string
Generated from protobuf field <code>bytes data = 2;</code>
getDestinationIdentities()  : RepeatedField<string|int, string>
when set, only forward to these identities
getDestinationSids()  : RepeatedField<string|int, string>
mark deprecated
getKind()  : int
Generated from protobuf field <code>.livekit.DataPacket.Kind kind = 3;</code>
getNonce()  : string
added by SDK to enable de-duping of messages, for INTERNAL USE ONLY
getRoom()  : string
Generated from protobuf field <code>string room = 1;</code>
getTopic()  : string
Generated from protobuf field <code>optional string topic = 5;</code>
hasTopic()  : mixed
setData()  : $this
Generated from protobuf field <code>bytes data = 2;</code>
setDestinationIdentities()  : $this
when set, only forward to these identities
setDestinationSids()  : $this
mark deprecated
setKind()  : $this
Generated from protobuf field <code>.livekit.DataPacket.Kind kind = 3;</code>
setNonce()  : $this
added by SDK to enable de-duping of messages, for INTERNAL USE ONLY
setRoom()  : $this
Generated from protobuf field <code>string room = 1;</code>
setTopic()  : $this
Generated from protobuf field <code>optional string topic = 5;</code>

Properties

$data

Generated from protobuf field <code>bytes data = 2;</code>

protected mixed $data = ''

$kind

Generated from protobuf field <code>.livekit.DataPacket.Kind kind = 3;</code>

protected mixed $kind = 0

$nonce

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

protected mixed $nonce = ''

Generated from protobuf field bytes nonce = 7;

$room

Generated from protobuf field <code>string room = 1;</code>

protected mixed $room = ''

$topic

Generated from protobuf field <code>optional string topic = 5;</code>

protected mixed $topic = null

$destination_identities

when set, only forward to these identities

private mixed $destination_identities

Generated from protobuf field repeated string destination_identities = 6;

$destination_sids

mark deprecated

private mixed $destination_sids

Generated from protobuf field repeated string destination_sids = 4 [deprecated = true];

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 string $room
@type string $data
@type int $kind
@type string[] $destination_sids
      mark deprecated
@type string[] $destination_identities
      when set, only forward to these identities
@type string $topic
@type string $nonce
      added by SDK to enable de-duping of messages, for INTERNAL USE ONLY

}

getData()

Generated from protobuf field <code>bytes data = 2;</code>

public getData() : string
Return values
string

getDestinationIdentities()

when set, only forward to these identities

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

Generated from protobuf field repeated string destination_identities = 6;

Return values
RepeatedField<string|int, string>

getDestinationSids()

mark deprecated

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

Generated from protobuf field repeated string destination_sids = 4 [deprecated = true];

Return values
RepeatedField<string|int, string>

getKind()

Generated from protobuf field <code>.livekit.DataPacket.Kind kind = 3;</code>

public getKind() : int
Return values
int

getNonce()

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

public getNonce() : string

Generated from protobuf field bytes nonce = 7;

Return values
string

getRoom()

Generated from protobuf field <code>string room = 1;</code>

public getRoom() : string
Return values
string

getTopic()

Generated from protobuf field <code>optional string topic = 5;</code>

public getTopic() : string
Return values
string

setData()

Generated from protobuf field <code>bytes data = 2;</code>

public setData(string $var) : $this
Parameters
$var : string
Return values
$this

setDestinationIdentities()

when set, only forward to these identities

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

Generated from protobuf field repeated string destination_identities = 6;

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

setDestinationSids()

mark deprecated

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

Generated from protobuf field repeated string destination_sids = 4 [deprecated = true];

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

setKind()

Generated from protobuf field <code>.livekit.DataPacket.Kind kind = 3;</code>

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

setNonce()

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

public setNonce(string $var) : $this

Generated from protobuf field bytes nonce = 7;

Parameters
$var : string
Return values
$this

setRoom()

Generated from protobuf field <code>string room = 1;</code>

public setRoom(string $var) : $this
Parameters
$var : string
Return values
$this

setTopic()

Generated from protobuf field <code>optional string topic = 5;</code>

public setTopic(string $var) : $this
Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results