AmazonChime class

The core Amazon Chime SDK interface. Use AmazonChime.instance to access the SDK methods.

Properties

hashCode int
The hash code for this object.
no setterinherited
onActiveSpeakersChanged Stream<List<String>>
Stream emitting the current list of active speaker attendee IDs.
no setter
onAttendeeDropped Stream<Attendee>
Stream of attendees dropping from the meeting.
no setter
onAttendeeJoined Stream<Attendee>
Stream of attendees joining the meeting.
no setter
onAttendeeLeft Stream<Attendee>
Stream of attendees leaving the meeting.
no setter
onAttendeeMuted Stream<Attendee>
Stream of attendees being muted.
no setter
onAttendeesSignalChanged Stream<List<AttendeeSignal>>
Stream emitting batched signal strength updates for attendees.
no setter
onAttendeesVolumeChanged Stream<List<AttendeeVolume>>
Stream emitting batched volume level updates for attendees.
no setter
onAttendeeUnmuted Stream<Attendee>
Stream of attendees being unmuted.
no setter
onAudioSessionCancelledReconnect Stream<void>
Stream emitting when a reconnect attempt is cancelled.
no setter
onAudioSessionDropped Stream<void>
Stream emitting when the audio session is dropped.
no setter
onAudioSessionStartConnecting Stream<bool>
Stream emitting when the audio session starts connecting. The emitted bool is true when this is a reconnect attempt, false for the initial connection.
no setter
onAudioSessionStarted Stream<void>
Stream emitting when the audio session has started (or successfully reconnected).
no setter
onAudioSessionStopped Stream<void>
Stream emitting when the audio session stops.
no setter
onConnectionQualityChanged Stream<bool>
Stream emitting connection quality changes. true = connection became poor, false = connection recovered.
no setter
onContentShareStateChanged Stream<int>
Stream emitting content share state changes. 0 = started, 1 = stopped.
no setter
onDataMessageReceived Stream<DataMessage>
Stream emitting data messages received from other attendees.
no setter
onMeetingEventReceived Stream<MeetingEvent>
Stream emitting structured SDK analytics events. See MeetingEvent for the event name and attribute map.
no setter
onMeetingMetricsReceived Stream<Map<String, Object?>>
Stream emitting periodic meeting quality metrics. Keys are metric names (e.g. "audioPacketsReceivedFractionLoss"), values are numeric.
no setter
onRemoteVideoSourcesAvailable Stream<List<RemoteVideoSource>>
Stream emitting when remote video sources become available.
no setter
onRemoteVideoSourcesUnavailable Stream<List<RemoteVideoSource>>
Stream emitting when remote video sources become unavailable.
no setter
onVideoTileAdded Stream<VideoTileInfo>
Stream of video tiles being added.
no setter
onVideoTilePaused Stream<VideoTileInfo>
Stream emitting when a video tile is paused.
no setter
onVideoTileRemoved Stream<VideoTileInfo>
Stream of video tiles being removed.
no setter
onVideoTileResumed Stream<VideoTileInfo>
Stream emitting when a video tile is resumed.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

activeCamera() Future<String?>
Returns the currently active camera facing: "front", "back", or null.
hasAudioPermissions() Future<bool>
Returns true if microphone permissions are already granted, without showing a dialog. Use this to decide whether to show a custom rationale UI before calling requestAudioPermissions.
hasVideoPermissions() Future<bool>
Returns true if camera permissions are already granted, without showing a dialog. Use this to decide whether to show a custom rationale UI before calling requestVideoPermissions.
initialAudioSelection() Future<String>
Retrieves the initial audio device selection.
joinMeeting(JoinInfo info) Future<void>
Joins a meeting using the provided JoinInfo.
listAudioDevices() Future<List<String>>
Lists all available audio devices.
mute() Future<void>
Mutes the local attendee.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
requestAudioPermissions() Future<void>
Requests audio permissions. Throws ChimePermissionException if denied.
requestVideoPermissions() Future<void>
Requests video permissions. Throws ChimePermissionException if denied.
sendDataMessage(String topic, String data, {int lifetimeMs = 0}) Future<void>
Sends a real-time data message to all attendees subscribed to topic.
setLocalVideoMaxBitrate(int maxBitrateKbps) Future<void>
Sets the maximum encode bitrate (kbps) for the local video stream.
startLocalVideo() Future<void>
Starts the local video.
startScreenShare() Future<void>
Starts sharing the foreground screen to the meeting.
stopLocalVideo() Future<void>
Stops the local video.
stopMeeting() Future<void>
Stops the current meeting session.
stopScreenShare() Future<void>
Stops sharing the screen.
switchCamera() Future<void>
Switches between front and back camera.
toString() String
A string representation of this object.
inherited
unmute() Future<void>
Unmutes the local attendee.
updateAudioDevice(String device) Future<void>
Updates the audio device to the specified device.
updateVideoSourceSubscriptions({required List<RemoteVideoSource> toAdd, List<RemoteVideoSource> toRemove = const []}) Future<void>
Subscribes to the specified remote video sources and unsubscribes from the removed ones.

Operators

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

Static Properties

instance AmazonChime
The singleton instance of the AmazonChime SDK wrapper.
final