Method Detail

• getName

   abstract String getName()

  Used as ID, must be unique
  

  string name = 1;

• getNameBytes

   abstract ByteString getNameBytes()

  Used as ID, must be unique
  

  string name = 1;

• 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 = 3;

• getMaxParticipants

   abstract int getMaxParticipants()

  limit number of participants that can be in a room, excluding Egress and Ingress participants
  

  uint32 max_participants = 4;

• getMetadata

   abstract String getMetadata()

  metadata of room
  

  string metadata = 11;

• getMetadataBytes

   abstract ByteString getMetadataBytes()

  metadata of room
  

  string metadata = 11;

• hasEgress

   abstract boolean hasEgress()

  egress
  

  .livekit.RoomEgress egress = 5;

• getEgress

   abstract LivekitRoom.RoomEgress getEgress()

  egress
  

  .livekit.RoomEgress egress = 5;

• 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;

• getAgentsList

   abstract List<LivekitAgentDispatch.RoomAgentDispatch> getAgentsList()

  Define agents that should be dispatched to this room
  

  repeated .livekit.RoomAgentDispatch agents = 10;

• getAgents

   abstract LivekitAgentDispatch.RoomAgentDispatch getAgents(int index)

  Define agents that should be dispatched to this room
  

  repeated .livekit.RoomAgentDispatch agents = 10;

• getAgentsCount

   abstract int getAgentsCount()

  Define agents that should be dispatched to this room
  

  repeated .livekit.RoomAgentDispatch agents = 10;