Method Detail

• getName

   abstract String getName()

  name of the room
  

  string name = 1;

• getNameBytes

   abstract ByteString getNameBytes()

  name of the room
  

  string name = 1;

• getRoomPreset

   abstract String getRoomPreset()

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

  string room_preset = 12;

• getRoomPresetBytes

   abstract ByteString getRoomPresetBytes()

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

  string room_preset = 12;

• getEmptyTimeout

   abstract int getEmptyTimeout()

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

  uint32 empty_timeout = 2;

• getDepartureTimeout

   abstract int getDepartureTimeout()

  number of seconds to keep the room open after everyone leaves
  

  uint32 departure_timeout = 10;

• getMaxParticipants

   abstract int getMaxParticipants()

  limit number of participants that can be in a room
  

  uint32 max_participants = 3;

• getNodeId

   abstract String getNodeId()

  override the node room is allocated to, for debugging
  

  string node_id = 4;

• getNodeIdBytes

   abstract ByteString getNodeIdBytes()

  override the node room is allocated to, for debugging
  

  string node_id = 4;

• getMetadata

   abstract String getMetadata()

  metadata of room
  

  string metadata = 5;

• getMetadataBytes

   abstract ByteString getMetadataBytes()

  metadata of room
  

  string metadata = 5;

• hasEgress

   abstract boolean hasEgress()

  auto-egress configurations
  

  .livekit.RoomEgress egress = 6;

• getEgress

   abstract LivekitRoom.RoomEgress getEgress()

  auto-egress configurations
  

  .livekit.RoomEgress egress = 6;

• getMinPlayoutDelay

   abstract int getMinPlayoutDelay()

  playout delay of subscriber
  

  uint32 min_playout_delay = 7;

• getMaxPlayoutDelay

   abstract int getMaxPlayoutDelay()

  uint32 max_playout_delay = 8;

• getSyncStreams

   abstract boolean 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
  

  bool sync_streams = 9;

• getReplayEnabled

   abstract boolean getReplayEnabled()

  replay
  

  bool replay_enabled = 13;

• getAgentsList

   abstract List<LivekitAgentDispatch.RoomAgentDispatch> getAgentsList()

  Define agents that should be dispatched to this room
  

  repeated .livekit.RoomAgentDispatch agents = 14;

• getAgents

   abstract LivekitAgentDispatch.RoomAgentDispatch getAgents(int index)

  Define agents that should be dispatched to this room
  

  repeated .livekit.RoomAgentDispatch agents = 14;

• getAgentsCount

   abstract int getAgentsCount()

  Define agents that should be dispatched to this room
  

  repeated .livekit.RoomAgentDispatch agents = 14;