CallConfig class Null safety

The configuration of a room.

See Configuring Room Settings for more information and tips on how to set up your room.

Annotations

Constructors

CallConfig({required String roomName, String? initialUserName, String? userId, required bool isOwner, required bool initialCameraEnabled, required bool initialMicrophoneEnabled, required RecordingMode recordingMode, @JsonKey(fromJson: _dateTimeFromInt) DateTime? roomExpiration, @JsonKey(fromJson: _durationFromInt) Duration? tokenExpiration, @JsonKey(fromJson: _dateTimeFromInt) DateTime? roomNotBefore, @JsonKey(fromJson: _dateTimeFromInt) DateTime? tokenNotBefore, required bool ejectAtRoomExpiration, required bool ejectAtTokenExpiration, required ParticipantPermissions permissionsOnJoin, @Default([]) List<StreamingEndpoint> defaultStreamingEndpoints, required bool terseLoggingEnabled})
const
factory
CallConfig.fromJson(Map<String, dynamic> json)
factory

Properties

copyWith → $CallConfigCopyWith<CallConfig>
read-onlyinherited
defaultStreamingEndpoints List<StreamingEndpoint>
Default streaming endpoints for the room.
read-onlyinherited
ejectAtRoomExpiration bool
Whether or not all users are ejected from the room when it expires.
read-onlyinherited
ejectAtTokenExpiration bool
Whether or not a user that entered a private room using a token will be ejected when their token expires.
read-onlyinherited
hashCode int
The hash code for this object.
read-onlyinherited
initialCameraEnabled bool
Whether participants' camera will initially be enabled by default when joining the room.
read-onlyinherited
initialMicrophoneEnabled bool
Whether participants' microphone will initially be enabled by default when joining the room.
read-onlyinherited
initialUserName String?
An optional displayed username that clients will initially assigned when connecting to the room. Clients can change their username using CallClient.setUsername.
read-onlyinherited
isOwner bool
Whether the current user is the owner of this room.
read-onlyinherited
permissionsOnJoin ParticipantPermissions
Initial default permissions for a non-meeting-owner participant joining a call.
read-onlyinherited
recordingMode RecordingMode
The recording mode set for the room.
read-onlyinherited
roomExpiration DateTime?
If set, users will be unable to join the room after this time.
read-onlyinherited
roomName String
The name of the room.
read-onlyinherited
roomNotBefore DateTime?
If set, the room cannot be entered before this time.
read-onlyinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
terseLoggingEnabled bool
If true, logging is limited to reduce performance overhead.
read-onlyinherited
tokenExpiration Duration?
If set, tokens to enter private rooms expire after this duration.
read-onlyinherited
tokenNotBefore DateTime?
If set, tokens to enter private rooms cannot be used before this time.
read-onlyinherited
userId String?
The current user's ID.
read-onlyinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toJson() Map<String, dynamic>
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited