CallSettingsBuilder class
Builder for CallSettings. Provides a fluent API for configuring call options.
@deprecated Use SessionSettingsBuilder instead. This class is deprecated and will be removed in a future version.
Requirements: 5.1, 5.2, 5.3, 5.4
- Annotations
-
- @Deprecated('Use SessionSettingsBuilder instead. This class will be removed in a future version.')
Constructors
Properties
- enableDefaultLayout ← bool
-
v4 alias: enables default layout.
no getter
- hashCode → int
-
The hash code for this object.
no setterinherited
- listener ← CometChatCallsEventsListener?
-
Sets the v4 CometChatCallsEventsListener on this builder.
no getter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- setAudioOnlyCall ← bool?
-
v4 alias: sets audio-only call mode.
no getter
- startWithAudioMuted ← bool
-
v4 alias: sets whether audio should start muted.
no getter
- startWithVideoMuted ← bool
-
v4 alias: sets whether video should start muted (paused).
no getter
Methods
-
build(
) → CallSettings - Builds the CallSettings object. Requirements: 5.1
-
enableAudioOnlyMode(
bool enabled) → CallSettingsBuilder - Enables or disables audio-only mode.
-
enableAutoCallRecording(
bool enabled) → CallSettingsBuilder - Enables or disables auto call recording.
-
enableCallRecording(
bool enabled) → CallSettingsBuilder - Enables or disables call recording feature.
-
enableLowBandwidthMode(
bool enabled) → CallSettingsBuilder - Enables or disables low bandwidth mode.
-
enableRaiseHand(
bool enabled) → CallSettingsBuilder - Enables or disables raise hand feature.
-
enableScreenSharing(
bool enabled) → CallSettingsBuilder - Enables or disables screen sharing feature.
-
enableVirtualBackground(
bool enabled) → CallSettingsBuilder - Enables or disables virtual background feature.
-
hideChatButton(
) → CallSettingsBuilder - Hides or shows the chat button. Requirements: 5.4
-
hideControlPanel(
) → CallSettingsBuilder - Hides or shows the control panel.
-
hideEndCallButton(
) → CallSettingsBuilder - Hides or shows the end call button.
-
hideHeaderPanel(
) → CallSettingsBuilder - Hides or shows the header panel.
-
hideLayoutToggleButton(
) → CallSettingsBuilder - Hides or shows the layout toggle button.
-
hideParticipantListButton(
) → CallSettingsBuilder - Hides or shows the participant list button.
-
hideRaiseHandButton(
) → CallSettingsBuilder - Hides or shows the raise hand button.
-
hideScreenSharingButton(
) → CallSettingsBuilder - Hides or shows the screen sharing button. Requirements: 5.4
-
hideSettings(
) → CallSettingsBuilder - Hides or shows the settings panel.
- Hides or shows the share invite button. Requirements: 5.4
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setAudioMode(
AudioMode mode, bool setAsDefault) → CallSettingsBuilder - Sets the audio mode and whether it's the default. Requirements: 5.2
-
setDefaultCameraFacing(
CameraFacing facing) → CallSettingsBuilder - Sets the default camera facing direction.
-
setDefaultLayout(
LayoutType layoutType) → CallSettingsBuilder - Sets the default layout type. Requirements: 5.2
-
setIdleTimeoutPeriod(
int timeoutSeconds) → CallSettingsBuilder - Sets the idle timeout period in seconds.
-
setLayoutType(
LayoutType layoutType) → CallSettingsBuilder - Alias for setDefaultLayout.
-
setTitle(
String title) → CallSettingsBuilder - Sets the title for the call.
-
showChatButton(
) → CallSettingsBuilder - Shows the chat button.
-
showMuteAudioButton(
bool show) → CallSettingsBuilder - Shows or hides the mute audio button. Requirements: 5.3
-
showPauseVideoButton(
bool show) → CallSettingsBuilder - Shows or hides the pause video button. Requirements: 5.3
-
showRecordingButton(
bool show) → CallSettingsBuilder - Shows or hides the recording button. Requirements: 5.3
-
showSwitchCameraButton(
bool show) → CallSettingsBuilder - Shows or hides the switch camera button. Requirements: 5.3
-
startAudioMuted(
bool muted) → CallSettingsBuilder - Sets whether audio should start muted. Requirements: 5.2
-
startVideoPaused(
bool paused) → CallSettingsBuilder - Sets whether video should start paused. Requirements: 5.2
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited