Documentation

TokenSourceRequest extends Message
in package

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

Table of Contents

Properties

$participant_identity  : mixed
The identity of the participant being requested for this client when generating credentials
$participant_metadata  : mixed
Any participant metadata being included along with the credentials generation operation
$participant_name  : mixed
The name of the participant being requested for this client when generating credentials
$room_config  : mixed
A RoomConfiguration object can be passed to request extra parameters should be included when generating connection credentials - dispatching agents, defining egress settings, etc More info: https://docs.livekit.io/home/get-started/authentication/#room-configuration
$room_name  : mixed
The name of the room being requested when generating credentials
$participant_attributes  : mixed
Any participant attributes being included along with the credentials generation operation

Methods

__construct()  : mixed
Constructor.
clearParticipantIdentity()  : mixed
clearParticipantMetadata()  : mixed
clearParticipantName()  : mixed
clearRoomConfig()  : mixed
clearRoomName()  : mixed
getParticipantAttributes()  : MapField
Any participant attributes being included along with the credentials generation operation
getParticipantIdentity()  : string
The identity of the participant being requested for this client when generating credentials
getParticipantMetadata()  : string
Any participant metadata being included along with the credentials generation operation
getParticipantName()  : string
The name of the participant being requested for this client when generating credentials
getRoomConfig()  : RoomConfiguration|null
A RoomConfiguration object can be passed to request extra parameters should be included when generating connection credentials - dispatching agents, defining egress settings, etc More info: https://docs.livekit.io/home/get-started/authentication/#room-configuration
getRoomName()  : string
The name of the room being requested when generating credentials
hasParticipantIdentity()  : mixed
hasParticipantMetadata()  : mixed
hasParticipantName()  : mixed
hasRoomConfig()  : mixed
hasRoomName()  : mixed
setParticipantAttributes()  : $this
Any participant attributes being included along with the credentials generation operation
setParticipantIdentity()  : $this
The identity of the participant being requested for this client when generating credentials
setParticipantMetadata()  : $this
Any participant metadata being included along with the credentials generation operation
setParticipantName()  : $this
The name of the participant being requested for this client when generating credentials
setRoomConfig()  : $this
A RoomConfiguration object can be passed to request extra parameters should be included when generating connection credentials - dispatching agents, defining egress settings, etc More info: https://docs.livekit.io/home/get-started/authentication/#room-configuration
setRoomName()  : $this
The name of the room being requested when generating credentials

Properties

$participant_identity

The identity of the participant being requested for this client when generating credentials

protected mixed $participant_identity = null

Generated from protobuf field optional string participant_identity = 3;

$participant_metadata

Any participant metadata being included along with the credentials generation operation

protected mixed $participant_metadata = null

Generated from protobuf field optional string participant_metadata = 4;

$participant_name

The name of the participant being requested for this client when generating credentials

protected mixed $participant_name = null

Generated from protobuf field optional string participant_name = 2;

$room_config

A RoomConfiguration object can be passed to request extra parameters should be included when generating connection credentials - dispatching agents, defining egress settings, etc More info: https://docs.livekit.io/home/get-started/authentication/#room-configuration

protected mixed $room_config = null

Generated from protobuf field optional .livekit.RoomConfiguration room_config = 6;

$room_name

The name of the room being requested when generating credentials

protected mixed $room_name = null

Generated from protobuf field optional string room_name = 1;

$participant_attributes

Any participant attributes being included along with the credentials generation operation

private mixed $participant_attributes

Generated from protobuf field map<string, string> participant_attributes = 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 string $room_name
      The name of the room being requested when generating credentials
@type string $participant_name
      The name of the participant being requested for this client when generating credentials
@type string $participant_identity
      The identity of the participant being requested for this client when generating credentials
@type string $participant_metadata
      Any participant metadata being included along with the credentials generation operation
@type array|\Google\Protobuf\Internal\MapField $participant_attributes
      Any participant attributes being included along with the credentials generation operation
@type \Livekit\RoomConfiguration $room_config
      A RoomConfiguration object can be passed to request extra parameters should be included when
      generating connection credentials - dispatching agents, defining egress settings, etc
      More info: https://docs.livekit.io/home/get-started/authentication/#room-configuration

}

getParticipantAttributes()

Any participant attributes being included along with the credentials generation operation

public getParticipantAttributes() : MapField

Generated from protobuf field map<string, string> participant_attributes = 5;

Return values
MapField

getParticipantIdentity()

The identity of the participant being requested for this client when generating credentials

public getParticipantIdentity() : string

Generated from protobuf field optional string participant_identity = 3;

Return values
string

getParticipantMetadata()

Any participant metadata being included along with the credentials generation operation

public getParticipantMetadata() : string

Generated from protobuf field optional string participant_metadata = 4;

Return values
string

getParticipantName()

The name of the participant being requested for this client when generating credentials

public getParticipantName() : string

Generated from protobuf field optional string participant_name = 2;

Return values
string

getRoomConfig()

A RoomConfiguration object can be passed to request extra parameters should be included when generating connection credentials - dispatching agents, defining egress settings, etc More info: https://docs.livekit.io/home/get-started/authentication/#room-configuration

public getRoomConfig() : RoomConfiguration|null

Generated from protobuf field optional .livekit.RoomConfiguration room_config = 6;

Return values
RoomConfiguration|null

getRoomName()

The name of the room being requested when generating credentials

public getRoomName() : string

Generated from protobuf field optional string room_name = 1;

Return values
string

setParticipantAttributes()

Any participant attributes being included along with the credentials generation operation

public setParticipantAttributes(array<string|int, mixed>|MapField $var) : $this

Generated from protobuf field map<string, string> participant_attributes = 5;

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

setParticipantIdentity()

The identity of the participant being requested for this client when generating credentials

public setParticipantIdentity(string $var) : $this

Generated from protobuf field optional string participant_identity = 3;

Parameters
$var : string
Return values
$this

setParticipantMetadata()

Any participant metadata being included along with the credentials generation operation

public setParticipantMetadata(string $var) : $this

Generated from protobuf field optional string participant_metadata = 4;

Parameters
$var : string
Return values
$this

setParticipantName()

The name of the participant being requested for this client when generating credentials

public setParticipantName(string $var) : $this

Generated from protobuf field optional string participant_name = 2;

Parameters
$var : string
Return values
$this

setRoomConfig()

A RoomConfiguration object can be passed to request extra parameters should be included when generating connection credentials - dispatching agents, defining egress settings, etc More info: https://docs.livekit.io/home/get-started/authentication/#room-configuration

public setRoomConfig(RoomConfiguration $var) : $this

Generated from protobuf field optional .livekit.RoomConfiguration room_config = 6;

Parameters
$var : RoomConfiguration
Return values
$this

setRoomName()

The name of the room being requested when generating credentials

public setRoomName(string $var) : $this

Generated from protobuf field optional string room_name = 1;

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results