Documentation

UpdateSubscriptionsRequest extends Message
in package

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

Table of Contents

Properties

$identity  : mixed
Generated from protobuf field <code>string identity = 2;</code>
$room  : mixed
Generated from protobuf field <code>string room = 1;</code>
$subscribe  : mixed
set to true to subscribe, false to unsubscribe from tracks
$participant_tracks  : mixed
list of participants and their tracks
$track_sids  : mixed
list of sids of tracks

Methods

__construct()  : mixed
Constructor.
getIdentity()  : string
Generated from protobuf field <code>string identity = 2;</code>
getParticipantTracks()  : RepeatedField<string|int, ParticipantTracks>
list of participants and their tracks
getRoom()  : string
Generated from protobuf field <code>string room = 1;</code>
getSubscribe()  : bool
set to true to subscribe, false to unsubscribe from tracks
getTrackSids()  : RepeatedField<string|int, string>
list of sids of tracks
setIdentity()  : $this
Generated from protobuf field <code>string identity = 2;</code>
setParticipantTracks()  : $this
list of participants and their tracks
setRoom()  : $this
Generated from protobuf field <code>string room = 1;</code>
setSubscribe()  : $this
set to true to subscribe, false to unsubscribe from tracks
setTrackSids()  : $this
list of sids of tracks

Properties

$subscribe

set to true to subscribe, false to unsubscribe from tracks

protected mixed $subscribe = false

Generated from protobuf field bool subscribe = 4;

$participant_tracks

list of participants and their tracks

private mixed $participant_tracks

Generated from protobuf field repeated .livekit.ParticipantTracks participant_tracks = 5;

$track_sids

list of sids of tracks

private mixed $track_sids

Generated from protobuf field repeated string track_sids = 3;

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 $identity
@type string[] $track_sids
      list of sids of tracks
@type bool $subscribe
      set to true to subscribe, false to unsubscribe from tracks
@type \Livekit\ParticipantTracks[] $participant_tracks
      list of participants and their tracks

}

getIdentity()

Generated from protobuf field <code>string identity = 2;</code>

public getIdentity() : string
Return values
string

getParticipantTracks()

list of participants and their tracks

public getParticipantTracks() : RepeatedField<string|int, ParticipantTracks>

Generated from protobuf field repeated .livekit.ParticipantTracks participant_tracks = 5;

Return values
RepeatedField<string|int, ParticipantTracks>

getRoom()

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

public getRoom() : string
Return values
string

getSubscribe()

set to true to subscribe, false to unsubscribe from tracks

public getSubscribe() : bool

Generated from protobuf field bool subscribe = 4;

Return values
bool

getTrackSids()

list of sids of tracks

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

Generated from protobuf field repeated string track_sids = 3;

Return values
RepeatedField<string|int, string>

setIdentity()

Generated from protobuf field <code>string identity = 2;</code>

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

setParticipantTracks()

list of participants and their tracks

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

Generated from protobuf field repeated .livekit.ParticipantTracks participant_tracks = 5;

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

setRoom()

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

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

setSubscribe()

set to true to subscribe, false to unsubscribe from tracks

public setSubscribe(bool $var) : $this

Generated from protobuf field bool subscribe = 4;

Parameters
$var : bool
Return values
$this

setTrackSids()

list of sids of tracks

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

Generated from protobuf field repeated string track_sids = 3;

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results