Documentation

CreateRoomRequest extends Message
in package

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

Table of Contents

Properties

$departure_timeout  : mixed
number of seconds to keep the room open after everyone leaves
$egress  : mixed
auto-egress configurations
$empty_timeout  : mixed
number of seconds to keep the room open if no one joins
$max_participants  : mixed
limit number of participants that can be in a room
$max_playout_delay  : mixed
Generated from protobuf field <code>uint32 max_playout_delay = 8;</code>
$metadata  : mixed
metadata of room
$min_playout_delay  : mixed
playout delay of subscriber
$name  : mixed
name of the room
$node_id  : mixed
override the node room is allocated to, for debugging
$replay_enabled  : mixed
replay
$room_preset  : mixed
configuration to use for this room parameters. Setting parameters below override the config defaults.
$sync_streams  : mixed
improves A/V sync when playout_delay set to a value larger than 200ms. It will disables transceiver re-use so not recommended for rooms with frequent subscription changes
$agents  : mixed
Define agents that should be dispatched to this room

Methods

__construct()  : mixed
Constructor.
clearEgress()  : mixed
getAgents()  : RepeatedField<string|int, RoomAgentDispatch>
Define agents that should be dispatched to this room
getDepartureTimeout()  : int
number of seconds to keep the room open after everyone leaves
getEgress()  : RoomEgress|null
auto-egress configurations
getEmptyTimeout()  : int
number of seconds to keep the room open if no one joins
getMaxParticipants()  : int
limit number of participants that can be in a room
getMaxPlayoutDelay()  : int
Generated from protobuf field <code>uint32 max_playout_delay = 8;</code>
getMetadata()  : string
metadata of room
getMinPlayoutDelay()  : int
playout delay of subscriber
getName()  : string
name of the room
getNodeId()  : string
override the node room is allocated to, for debugging
getReplayEnabled()  : bool
replay
getRoomPreset()  : string
configuration to use for this room parameters. Setting parameters below override the config defaults.
getSyncStreams()  : bool
improves A/V sync when playout_delay set to a value larger than 200ms. It will disables transceiver re-use so not recommended for rooms with frequent subscription changes
hasEgress()  : mixed
setAgents()  : $this
Define agents that should be dispatched to this room
setDepartureTimeout()  : $this
number of seconds to keep the room open after everyone leaves
setEgress()  : $this
auto-egress configurations
setEmptyTimeout()  : $this
number of seconds to keep the room open if no one joins
setMaxParticipants()  : $this
limit number of participants that can be in a room
setMaxPlayoutDelay()  : $this
Generated from protobuf field <code>uint32 max_playout_delay = 8;</code>
setMetadata()  : $this
metadata of room
setMinPlayoutDelay()  : $this
playout delay of subscriber
setName()  : $this
name of the room
setNodeId()  : $this
override the node room is allocated to, for debugging
setReplayEnabled()  : $this
replay
setRoomPreset()  : $this
configuration to use for this room parameters. Setting parameters below override the config defaults.
setSyncStreams()  : $this
improves A/V sync when playout_delay set to a value larger than 200ms. It will disables transceiver re-use so not recommended for rooms with frequent subscription changes

Properties

$departure_timeout

number of seconds to keep the room open after everyone leaves

protected mixed $departure_timeout = 0

Generated from protobuf field uint32 departure_timeout = 10;

$egress

auto-egress configurations

protected mixed $egress = null

Generated from protobuf field .livekit.RoomEgress egress = 6;

$empty_timeout

number of seconds to keep the room open if no one joins

protected mixed $empty_timeout = 0

Generated from protobuf field uint32 empty_timeout = 2;

$max_participants

limit number of participants that can be in a room

protected mixed $max_participants = 0

Generated from protobuf field uint32 max_participants = 3;

$max_playout_delay

Generated from protobuf field <code>uint32 max_playout_delay = 8;</code>

protected mixed $max_playout_delay = 0

$metadata

metadata of room

protected mixed $metadata = ''

Generated from protobuf field string metadata = 5 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

$min_playout_delay

playout delay of subscriber

protected mixed $min_playout_delay = 0

Generated from protobuf field uint32 min_playout_delay = 7;

$name

name of the room

protected mixed $name = ''

Generated from protobuf field string name = 1;

$node_id

override the node room is allocated to, for debugging

protected mixed $node_id = ''

Generated from protobuf field string node_id = 4;

$replay_enabled

replay

protected mixed $replay_enabled = false

Generated from protobuf field bool replay_enabled = 13;

$room_preset

configuration to use for this room parameters. Setting parameters below override the config defaults.

protected mixed $room_preset = ''

Generated from protobuf field string room_preset = 12;

$sync_streams

improves A/V sync when playout_delay set to a value larger than 200ms. It will disables transceiver re-use so not recommended for rooms with frequent subscription changes

protected mixed $sync_streams = false

Generated from protobuf field bool sync_streams = 9;

$agents

Define agents that should be dispatched to this room

private mixed $agents

Generated from protobuf field repeated .livekit.RoomAgentDispatch agents = 14;

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 $name
      name of the room
@type string $room_preset
      configuration to use for this room parameters. Setting parameters below override the config defaults.
@type int $empty_timeout
      number of seconds to keep the room open if no one joins
@type int $departure_timeout
      number of seconds to keep the room open after everyone leaves
@type int $max_participants
      limit number of participants that can be in a room
@type string $node_id
      override the node room is allocated to, for debugging
@type string $metadata
      metadata of room
@type \Livekit\RoomEgress $egress
      auto-egress configurations
@type int $min_playout_delay
      playout delay of subscriber
@type int $max_playout_delay
@type bool $sync_streams
      improves A/V sync when playout_delay set to a value larger than 200ms. It will disables transceiver re-use
      so not recommended for rooms with frequent subscription changes
@type bool $replay_enabled
      replay
@type \Livekit\RoomAgentDispatch[] $agents
      Define agents that should be dispatched to this room

}

getAgents()

Define agents that should be dispatched to this room

public getAgents() : RepeatedField<string|int, RoomAgentDispatch>

Generated from protobuf field repeated .livekit.RoomAgentDispatch agents = 14;

Return values
RepeatedField<string|int, RoomAgentDispatch>

getDepartureTimeout()

number of seconds to keep the room open after everyone leaves

public getDepartureTimeout() : int

Generated from protobuf field uint32 departure_timeout = 10;

Return values
int

getEmptyTimeout()

number of seconds to keep the room open if no one joins

public getEmptyTimeout() : int

Generated from protobuf field uint32 empty_timeout = 2;

Return values
int

getMaxParticipants()

limit number of participants that can be in a room

public getMaxParticipants() : int

Generated from protobuf field uint32 max_participants = 3;

Return values
int

getMaxPlayoutDelay()

Generated from protobuf field <code>uint32 max_playout_delay = 8;</code>

public getMaxPlayoutDelay() : int
Return values
int

getMetadata()

metadata of room

public getMetadata() : string

Generated from protobuf field string metadata = 5 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Return values
string

getMinPlayoutDelay()

playout delay of subscriber

public getMinPlayoutDelay() : int

Generated from protobuf field uint32 min_playout_delay = 7;

Return values
int

getName()

name of the room

public getName() : string

Generated from protobuf field string name = 1;

Return values
string

getNodeId()

override the node room is allocated to, for debugging

public getNodeId() : string

Generated from protobuf field string node_id = 4;

Return values
string

getReplayEnabled()

replay

public getReplayEnabled() : bool

Generated from protobuf field bool replay_enabled = 13;

Return values
bool

getRoomPreset()

configuration to use for this room parameters. Setting parameters below override the config defaults.

public getRoomPreset() : string

Generated from protobuf field string room_preset = 12;

Return values
string

getSyncStreams()

improves A/V sync when playout_delay set to a value larger than 200ms. It will disables transceiver re-use so not recommended for rooms with frequent subscription changes

public getSyncStreams() : bool

Generated from protobuf field bool sync_streams = 9;

Return values
bool

setAgents()

Define agents that should be dispatched to this room

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

Generated from protobuf field repeated .livekit.RoomAgentDispatch agents = 14;

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

setDepartureTimeout()

number of seconds to keep the room open after everyone leaves

public setDepartureTimeout(int $var) : $this

Generated from protobuf field uint32 departure_timeout = 10;

Parameters
$var : int
Return values
$this

setEgress()

auto-egress configurations

public setEgress(RoomEgress $var) : $this

Generated from protobuf field .livekit.RoomEgress egress = 6;

Parameters
$var : RoomEgress
Return values
$this

setEmptyTimeout()

number of seconds to keep the room open if no one joins

public setEmptyTimeout(int $var) : $this

Generated from protobuf field uint32 empty_timeout = 2;

Parameters
$var : int
Return values
$this

setMaxParticipants()

limit number of participants that can be in a room

public setMaxParticipants(int $var) : $this

Generated from protobuf field uint32 max_participants = 3;

Parameters
$var : int
Return values
$this

setMaxPlayoutDelay()

Generated from protobuf field <code>uint32 max_playout_delay = 8;</code>

public setMaxPlayoutDelay(int $var) : $this
Parameters
$var : int
Return values
$this

setMetadata()

metadata of room

public setMetadata(string $var) : $this

Generated from protobuf field string metadata = 5 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Parameters
$var : string
Return values
$this

setMinPlayoutDelay()

playout delay of subscriber

public setMinPlayoutDelay(int $var) : $this

Generated from protobuf field uint32 min_playout_delay = 7;

Parameters
$var : int
Return values
$this

setName()

name of the room

public setName(string $var) : $this

Generated from protobuf field string name = 1;

Parameters
$var : string
Return values
$this

setNodeId()

override the node room is allocated to, for debugging

public setNodeId(string $var) : $this

Generated from protobuf field string node_id = 4;

Parameters
$var : string
Return values
$this

setReplayEnabled()

replay

public setReplayEnabled(bool $var) : $this

Generated from protobuf field bool replay_enabled = 13;

Parameters
$var : bool
Return values
$this

setRoomPreset()

configuration to use for this room parameters. Setting parameters below override the config defaults.

public setRoomPreset(string $var) : $this

Generated from protobuf field string room_preset = 12;

Parameters
$var : string
Return values
$this

setSyncStreams()

improves A/V sync when playout_delay set to a value larger than 200ms. It will disables transceiver re-use so not recommended for rooms with frequent subscription changes

public setSyncStreams(bool $var) : $this

Generated from protobuf field bool sync_streams = 9;

Parameters
$var : bool
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results