Documentation

ParticipantPermission extends Message
in package

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

Table of Contents

Properties

$agent  : mixed
indicates that participant is an agent deprecated: use ParticipantInfo.kind instead
$can_publish  : mixed
allow participant to publish new tracks to room
$can_publish_data  : mixed
allow participant to publish data
$can_subscribe  : mixed
allow participant to subscribe to other tracks in the room
$can_subscribe_metrics  : mixed
if a participant can subscribe to metrics
$can_update_metadata  : mixed
indicates that participant can update own metadata and attributes
$hidden  : mixed
indicates that it's hidden to others
$recorder  : mixed
indicates it's a recorder instance deprecated: use ParticipantInfo.kind instead
$can_publish_sources  : mixed
sources that are allowed to be published

Methods

__construct()  : mixed
Constructor.
getAgent()  : bool
indicates that participant is an agent deprecated: use ParticipantInfo.kind instead
getCanPublish()  : bool
allow participant to publish new tracks to room
getCanPublishData()  : bool
allow participant to publish data
getCanPublishSources()  : RepeatedField<string|int, int>
sources that are allowed to be published
getCanSubscribe()  : bool
allow participant to subscribe to other tracks in the room
getCanSubscribeMetrics()  : bool
if a participant can subscribe to metrics
getCanUpdateMetadata()  : bool
indicates that participant can update own metadata and attributes
getHidden()  : bool
indicates that it's hidden to others
getRecorder()  : bool
indicates it's a recorder instance deprecated: use ParticipantInfo.kind instead
setAgent()  : $this
indicates that participant is an agent deprecated: use ParticipantInfo.kind instead
setCanPublish()  : $this
allow participant to publish new tracks to room
setCanPublishData()  : $this
allow participant to publish data
setCanPublishSources()  : $this
sources that are allowed to be published
setCanSubscribe()  : $this
allow participant to subscribe to other tracks in the room
setCanSubscribeMetrics()  : $this
if a participant can subscribe to metrics
setCanUpdateMetadata()  : $this
indicates that participant can update own metadata and attributes
setHidden()  : $this
indicates that it's hidden to others
setRecorder()  : $this
indicates it's a recorder instance deprecated: use ParticipantInfo.kind instead

Properties

$agent

indicates that participant is an agent deprecated: use ParticipantInfo.kind instead

protected mixed $agent = false

Generated from protobuf field bool agent = 11 [deprecated = true];

$can_publish

allow participant to publish new tracks to room

protected mixed $can_publish = false

Generated from protobuf field bool can_publish = 2;

$can_publish_data

allow participant to publish data

protected mixed $can_publish_data = false

Generated from protobuf field bool can_publish_data = 3;

$can_subscribe

allow participant to subscribe to other tracks in the room

protected mixed $can_subscribe = false

Generated from protobuf field bool can_subscribe = 1;

$can_subscribe_metrics

if a participant can subscribe to metrics

protected mixed $can_subscribe_metrics = false

Generated from protobuf field bool can_subscribe_metrics = 12;

$can_update_metadata

indicates that participant can update own metadata and attributes

protected mixed $can_update_metadata = false

Generated from protobuf field bool can_update_metadata = 10;

$hidden

indicates that it's hidden to others

protected mixed $hidden = false

Generated from protobuf field bool hidden = 7;

$recorder

indicates it's a recorder instance deprecated: use ParticipantInfo.kind instead

protected mixed $recorder = false

Generated from protobuf field bool recorder = 8 [deprecated = true];

$can_publish_sources

sources that are allowed to be published

private mixed $can_publish_sources

Generated from protobuf field repeated .livekit.TrackSource can_publish_sources = 9;

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 bool $can_subscribe
      allow participant to subscribe to other tracks in the room
@type bool $can_publish
      allow participant to publish new tracks to room
@type bool $can_publish_data
      allow participant to publish data
@type int[] $can_publish_sources
      sources that are allowed to be published
@type bool $hidden
      indicates that it's hidden to others
@type bool $recorder
      indicates it's a recorder instance
      deprecated: use ParticipantInfo.kind instead
@type bool $can_update_metadata
      indicates that participant can update own metadata and attributes
@type bool $agent
      indicates that participant is an agent
      deprecated: use ParticipantInfo.kind instead
@type bool $can_subscribe_metrics
      if a participant can subscribe to metrics

}

getAgent()

indicates that participant is an agent deprecated: use ParticipantInfo.kind instead

public getAgent() : bool

Generated from protobuf field bool agent = 11 [deprecated = true];

Return values
bool

getCanPublish()

allow participant to publish new tracks to room

public getCanPublish() : bool

Generated from protobuf field bool can_publish = 2;

Return values
bool

getCanPublishData()

allow participant to publish data

public getCanPublishData() : bool

Generated from protobuf field bool can_publish_data = 3;

Return values
bool

getCanPublishSources()

sources that are allowed to be published

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

Generated from protobuf field repeated .livekit.TrackSource can_publish_sources = 9;

Return values
RepeatedField<string|int, int>

getCanSubscribe()

allow participant to subscribe to other tracks in the room

public getCanSubscribe() : bool

Generated from protobuf field bool can_subscribe = 1;

Return values
bool

getCanSubscribeMetrics()

if a participant can subscribe to metrics

public getCanSubscribeMetrics() : bool

Generated from protobuf field bool can_subscribe_metrics = 12;

Return values
bool

getCanUpdateMetadata()

indicates that participant can update own metadata and attributes

public getCanUpdateMetadata() : bool

Generated from protobuf field bool can_update_metadata = 10;

Return values
bool

getHidden()

indicates that it's hidden to others

public getHidden() : bool

Generated from protobuf field bool hidden = 7;

Return values
bool

getRecorder()

indicates it's a recorder instance deprecated: use ParticipantInfo.kind instead

public getRecorder() : bool

Generated from protobuf field bool recorder = 8 [deprecated = true];

Return values
bool

setAgent()

indicates that participant is an agent deprecated: use ParticipantInfo.kind instead

public setAgent(bool $var) : $this

Generated from protobuf field bool agent = 11 [deprecated = true];

Parameters
$var : bool
Return values
$this

setCanPublish()

allow participant to publish new tracks to room

public setCanPublish(bool $var) : $this

Generated from protobuf field bool can_publish = 2;

Parameters
$var : bool
Return values
$this

setCanPublishData()

allow participant to publish data

public setCanPublishData(bool $var) : $this

Generated from protobuf field bool can_publish_data = 3;

Parameters
$var : bool
Return values
$this

setCanPublishSources()

sources that are allowed to be published

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

Generated from protobuf field repeated .livekit.TrackSource can_publish_sources = 9;

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

setCanSubscribe()

allow participant to subscribe to other tracks in the room

public setCanSubscribe(bool $var) : $this

Generated from protobuf field bool can_subscribe = 1;

Parameters
$var : bool
Return values
$this

setCanSubscribeMetrics()

if a participant can subscribe to metrics

public setCanSubscribeMetrics(bool $var) : $this

Generated from protobuf field bool can_subscribe_metrics = 12;

Parameters
$var : bool
Return values
$this

setCanUpdateMetadata()

indicates that participant can update own metadata and attributes

public setCanUpdateMetadata(bool $var) : $this

Generated from protobuf field bool can_update_metadata = 10;

Parameters
$var : bool
Return values
$this

setHidden()

indicates that it's hidden to others

public setHidden(bool $var) : $this

Generated from protobuf field bool hidden = 7;

Parameters
$var : bool
Return values
$this

setRecorder()

indicates it's a recorder instance deprecated: use ParticipantInfo.kind instead

public setRecorder(bool $var) : $this

Generated from protobuf field bool recorder = 8 [deprecated = true];

Parameters
$var : bool
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results