Documentation

ListEgressRequest extends Message
in package

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

Table of Contents

Properties

$active  : mixed
(optional, list active egress only)
$egress_id  : mixed
(optional, filter by egress ID)
$room_name  : mixed
(optional, filter by room name)

Methods

__construct()  : mixed
Constructor.
getActive()  : bool
(optional, list active egress only)
getEgressId()  : string
(optional, filter by egress ID)
getRoomName()  : string
(optional, filter by room name)
setActive()  : $this
(optional, list active egress only)
setEgressId()  : $this
(optional, filter by egress ID)
setRoomName()  : $this
(optional, filter by room name)

Properties

$active

(optional, list active egress only)

protected mixed $active = false

Generated from protobuf field bool active = 3;

$egress_id

(optional, filter by egress ID)

protected mixed $egress_id = ''

Generated from protobuf field string egress_id = 2;

$room_name

(optional, filter by room name)

protected mixed $room_name = ''

Generated from protobuf field string room_name = 1;

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
      (optional, filter by room name)
@type string $egress_id
      (optional, filter by egress ID)
@type bool $active
      (optional, list active egress only)

}

getActive()

(optional, list active egress only)

public getActive() : bool

Generated from protobuf field bool active = 3;

Return values
bool

getEgressId()

(optional, filter by egress ID)

public getEgressId() : string

Generated from protobuf field string egress_id = 2;

Return values
string

getRoomName()

(optional, filter by room name)

public getRoomName() : string

Generated from protobuf field string room_name = 1;

Return values
string

setActive()

(optional, list active egress only)

public setActive(bool $var) : $this

Generated from protobuf field bool active = 3;

Parameters
$var : bool
Return values
$this

setEgressId()

(optional, filter by egress ID)

public setEgressId(string $var) : $this

Generated from protobuf field string egress_id = 2;

Parameters
$var : string
Return values
$this

setRoomName()

(optional, filter by room name)

public setRoomName(string $var) : $this

Generated from protobuf field string room_name = 1;

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results