Documentation

TrackPermission extends Message
in package

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

Table of Contents

Properties

$all_tracks  : mixed
Generated from protobuf field <code>bool all_tracks = 2;</code>
$participant_identity  : mixed
Generated from protobuf field <code>string participant_identity = 4;</code>
$participant_sid  : mixed
permission could be granted either by participant sid or identity
$track_sids  : mixed
Generated from protobuf field <code>repeated string track_sids = 3;</code>

Methods

__construct()  : mixed
Constructor.
getAllTracks()  : bool
Generated from protobuf field <code>bool all_tracks = 2;</code>
getParticipantIdentity()  : string
Generated from protobuf field <code>string participant_identity = 4;</code>
getParticipantSid()  : string
permission could be granted either by participant sid or identity
getTrackSids()  : RepeatedField<string|int, string>
Generated from protobuf field <code>repeated string track_sids = 3;</code>
setAllTracks()  : $this
Generated from protobuf field <code>bool all_tracks = 2;</code>
setParticipantIdentity()  : $this
Generated from protobuf field <code>string participant_identity = 4;</code>
setParticipantSid()  : $this
permission could be granted either by participant sid or identity
setTrackSids()  : $this
Generated from protobuf field <code>repeated string track_sids = 3;</code>

Properties

$all_tracks

Generated from protobuf field <code>bool all_tracks = 2;</code>

protected mixed $all_tracks = false

$participant_identity

Generated from protobuf field <code>string participant_identity = 4;</code>

protected mixed $participant_identity = ''

$participant_sid

permission could be granted either by participant sid or identity

protected mixed $participant_sid = ''

Generated from protobuf field string participant_sid = 1;

$track_sids

Generated from protobuf field <code>repeated string track_sids = 3;</code>

private mixed $track_sids

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 $participant_sid
      permission could be granted either by participant sid or identity
@type bool $all_tracks
@type string[] $track_sids
@type string $participant_identity

}

getAllTracks()

Generated from protobuf field <code>bool all_tracks = 2;</code>

public getAllTracks() : bool
Return values
bool

getParticipantIdentity()

Generated from protobuf field <code>string participant_identity = 4;</code>

public getParticipantIdentity() : string
Return values
string

getParticipantSid()

permission could be granted either by participant sid or identity

public getParticipantSid() : string

Generated from protobuf field string participant_sid = 1;

Return values
string

getTrackSids()

Generated from protobuf field <code>repeated string track_sids = 3;</code>

public getTrackSids() : RepeatedField<string|int, string>
Return values
RepeatedField<string|int, string>

setAllTracks()

Generated from protobuf field <code>bool all_tracks = 2;</code>

public setAllTracks(bool $var) : $this
Parameters
$var : bool
Return values
$this

setParticipantIdentity()

Generated from protobuf field <code>string participant_identity = 4;</code>

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

setParticipantSid()

permission could be granted either by participant sid or identity

public setParticipantSid(string $var) : $this

Generated from protobuf field string participant_sid = 1;

Parameters
$var : string
Return values
$this

setTrackSids()

Generated from protobuf field <code>repeated string track_sids = 3;</code>

public setTrackSids(array<string|int, string> $var) : $this
Parameters
$var : array<string|int, string>
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results