RoomConfiguration class
Configuration for a LiveKit room.
This class contains various settings that control room behavior such as timeouts, participant limits, and agent dispatching.
- Annotations
Constructors
-
RoomConfiguration({String? name, int? emptyTimeout, int? departureTimeout, int? maxParticipants, String? metadata, int? minPlayoutDelay, int? maxPlayoutDelay, bool? syncStreams, List<
RoomAgentDispatch> ? agents}) -
const
-
RoomConfiguration.fromJson(Map<
String, dynamic> json) -
factory
Properties
-
agents
→ List<
RoomAgentDispatch> ? -
Define agents that should be dispatched to this room.
final
- departureTimeout → int?
-
Number of seconds to keep the room open after everyone leaves.
final
- emptyTimeout → int?
-
Number of seconds to keep the room open if no one joins.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- maxParticipants → int?
-
Limit number of participants that can be in a room, excluding Egress and Ingress participants.
final
- maxPlayoutDelay → int?
-
Maximum playout delay of subscriber.
final
- metadata → String?
-
Metadata of room.
final
- minPlayoutDelay → int?
-
Minimum playout delay of subscriber.
final
- name → String?
-
Room name, used as ID, must be unique.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- syncStreams → bool?
-
Improves A/V sync when playout delay set to a value larger than 200ms.
It will disable transceiver re-use so not recommended for rooms with frequent subscription changes.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited