CallConfig class

The configuration of a room.

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

Annotations
  • @freezed

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

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent 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