CallSession class
Represents an active call session. Provides methods for call controls and listener management.
Requirements: 4.7, 4.8, 4.9
Properties
-
Returns the count of registered button click listeners.
no setter
-
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isAudioMuted → bool
-
Returns whether audio is currently muted
no setter
- isHandRaised → bool
-
Returns whether hand is currently raised
no setter
- isRecording → bool
-
Returns whether recording is active
no setter
- isVideoPaused → bool
-
Returns whether video is currently paused
no setter
- layoutListener ↔ LayoutListeners?
-
getter/setter pair
- mediaEventsListenerCount → int
-
Returns the count of registered media event listeners.
no setter
-
mediaEventsListeners
→ Set<
MediaEventListeners> -
no setter
- participantEventListenerCount → int
-
Returns the count of registered participant event listeners.
no setter
-
participantEventListeners
→ Set<
ParticipantEventListeners> -
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sessionStatusListenerCount → int
-
Returns the count of registered session status listeners.
no setter
-
sessionStatusListeners
→ Set<
SessionStatusListeners> -
no setter
Methods
-
addButtonClickListener(
ButtonClickListeners listener) → void -
addMediaEventsListener(
MediaEventListeners listener) → void -
addParticipantEventListener(
ParticipantEventListeners listener) → void -
addSessionStatusListener(
SessionStatusListeners listener) → void -
clearAllListeners(
) → void - Clears all registered listeners. Useful for cleanup when leaving a session.
-
disablePictureInPictureLayout(
) → Future< void> - Disables Picture-in-Picture layout.
-
enablePictureInPictureLayout(
) → Future< void> - Enables Picture-in-Picture layout.
-
endCallSession(
) → Future< void> - Ends the call session (alias for leaveSession).
-
enterPipMode(
) → Future< bool> - Enters system Picture-in-Picture mode. Returns true if PiP was entered successfully.
-
hideSettingsPanel(
) → Future< void> - Hides the settings panel.
-
isCallSessionActive(
) → bool -
isPipSupported(
) → Future< bool> - Checks if Picture-in-Picture is supported on the device.
-
leaveSession(
) → Future< void> - Leaves the current call session and releases resources.
-
lowerHand(
) → Future< void> - Lowers hand.
-
muteAudio(
) → Future< void> - Mutes audio for the local user.
-
muteParticipant(
String participantId) → Future< void> - Mutes a specific participant.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
openCallSettingsPanel(
) → Future< void> - Opens the call settings panel.
-
openVirtualBackgroundSettingsPanel(
) → Future< void> - Opens the virtual background settings panel.
-
pauseParticipantVideo(
String participantId) → Future< void> - Pauses video for a specific participant.
-
pauseVideo(
) → Future< void> - Pauses video for the local user.
-
pinParticipant(
String? participantId) → Future< void> - Pins a participant to the main view.
-
raiseHand(
) → Future< void> - Raises hand to indicate wanting to speak.
-
removeButtonClickListener(
ButtonClickListeners listener) → void -
removeMediaEventsListener(
MediaEventListeners listener) → void -
removeParticipantEventListener(
ParticipantEventListeners listener) → void -
removeSessionStatusListener(
SessionStatusListeners listener) → void -
resetState(
) → void - Resets the session state
-
resumeVideo(
) → Future< void> - Resumes video for the local user.
-
setAudioModeType(
AudioMode audioMode) → Future< void> - Sets the audio output mode (speaker, earpiece, bluetooth).
-
setCallActive(
bool active) → void - Sets the call active state
-
setCallLayoutType(
LayoutType layoutType) → Future< void> - Sets the call layout type (alias for setLayout).
-
setChatButtonUnreadCount(
int count) → Future< void> - Sets the unread count badge on the chat button.
-
setLayout(
LayoutType layoutType) → Future< void> - Sets the call layout type (tile, sidebar, spotlight).
-
startCallRecording(
) → Future< void> - Starts call recording (alias for startRecording).
-
startRecording(
) → Future< void> - Starts call recording.
-
stopCallRecording(
) → Future< void> - Stops call recording (alias for stopRecording).
-
stopRecording(
) → Future< void> - Stops call recording.
-
switchCamera(
) → Future< void> - Switches between front and back camera.
-
toggleCameraSource(
) → Future< void> - Toggles camera source (alias for switchCamera).
-
toggleMuteAudio(
) → Future< void> - Toggles audio mute state.
-
togglePauseVideo(
) → Future< void> - Toggles video pause state.
-
toggleRaiseHand(
) → Future< void> - Toggles hand raise state.
-
toString(
) → String -
A string representation of this object.
inherited
-
unMuteAudio(
) → Future< void> - Unmutes audio for the local user.
-
unPinParticipant(
) → Future< void> - Unpins the currently pinned participant.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
getInstance(
) → CallSession? -
setInstance(
CallSession session) → void