Documentation

MuteRoomTrackRequest extends Message
in package

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

Table of Contents

Properties

$identity  : mixed
Generated from protobuf field <code>string identity = 2;</code>
$muted  : mixed
set to true to mute, false to unmute
$room  : mixed
name of the room
$track_sid  : mixed
sid of the track to mute

Methods

__construct()  : mixed
Constructor.
getIdentity()  : string
Generated from protobuf field <code>string identity = 2;</code>
getMuted()  : bool
set to true to mute, false to unmute
getRoom()  : string
name of the room
getTrackSid()  : string
sid of the track to mute
setIdentity()  : $this
Generated from protobuf field <code>string identity = 2;</code>
setMuted()  : $this
set to true to mute, false to unmute
setRoom()  : $this
name of the room
setTrackSid()  : $this
sid of the track to mute

Properties

$identity

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

protected mixed $identity = ''

$muted

set to true to mute, false to unmute

protected mixed $muted = false

Generated from protobuf field bool muted = 4;

$room

name of the room

protected mixed $room = ''

Generated from protobuf field string room = 1;

$track_sid

sid of the track to mute

protected mixed $track_sid = ''

Generated from protobuf field string track_sid = 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
      name of the room
@type string $identity
@type string $track_sid
      sid of the track to mute
@type bool $muted
      set to true to mute, false to unmute

}

getIdentity()

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

public getIdentity() : string
Return values
string

getMuted()

set to true to mute, false to unmute

public getMuted() : bool

Generated from protobuf field bool muted = 4;

Return values
bool

getRoom()

name of the room

public getRoom() : string

Generated from protobuf field string room = 1;

Return values
string

getTrackSid()

sid of the track to mute

public getTrackSid() : string

Generated from protobuf field string track_sid = 3;

Return values
string

setIdentity()

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

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

setMuted()

set to true to mute, false to unmute

public setMuted(bool $var) : $this

Generated from protobuf field bool muted = 4;

Parameters
$var : bool
Return values
$this

setRoom()

name of the room

public setRoom(string $var) : $this

Generated from protobuf field string room = 1;

Parameters
$var : string
Return values
$this

setTrackSid()

sid of the track to mute

public setTrackSid(string $var) : $this

Generated from protobuf field string track_sid = 3;

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results