Package-level declarations

Types

Link copied to clipboard
data class AudioDevice(val type: Int, val label: String, val id: String?, var isSelected: Boolean)

Represents an audio output device available on the current platform.

Link copied to clipboard
Link copied to clipboard
class AudioVideoObserverImpl(onConnectionStatusChanged: (ConnectionStatus) -> Unit, onRemoteVideoAvailable: (isAvailable: Boolean, sourceCount: Int) -> Unit, onCameraSendAvailable: (available: Boolean) -> Unit, onSessionError: (message: String, isRecoverable: Boolean) -> Unit, onVideoNeedsRestart: () -> Unit, isJoiningOnMute: Boolean) : AudioVideoObserver
Link copied to clipboard

Which camera to use for local video capture.

Link copied to clipboard
Link copied to clipboard
class ChimeLogger : Logger
Link copied to clipboard
Link copied to clipboard

Lifecycle state of the active meeting session.

Link copied to clipboard
class DeviceObserver(meetingSession: DefaultMeetingSession, realTimeEventListener: RealTimeEventListener) : DeviceChangeObserver
Link copied to clipboard
object MeetingActiveSpeakerObserver : ActiveSpeakerObserver
Link copied to clipboard
data class MeetingInformation(val externalMeetingId: String = "", val meetingId: String = "", val audioHostURL: String = "", val audioFallbackURL: String = "", val turnControlURL: String = "", val signalingURL: String = "", val ingestionURL: String = "", val attendeeId: String = "", val externalUserId: String = "", val joinToken: String = "")

All credentials required to join a Chime meeting as a single attendee.

Link copied to clipboard

Callbacks for real-time attendee and audio events within a meeting session.

Link copied to clipboard
class RealTimeObserver : RealtimeObserver
Link copied to clipboard
data class TextMessage(val topic: String, val senderId: String, val content: String, val timestamp: Long)

A real-time data message received on a subscribed topic.

Link copied to clipboard
object VideoTileManager : VideoTileObserver

Properties

Link copied to clipboard
lateinit var appContext: Context
Link copied to clipboard
var meetingSession: DefaultMeetingSession?

Functions

Link copied to clipboard
actual fun joinMeeting(externalMeetingId: String, meetingId: String, audioHostURL: String, audioFallbackURL: String, turnControlURL: String, signalingURL: String, ingestionURL: String, attendeeId: String, externalUserId: String, joinToken: String, realTimeListener: RealTimeEventListener, onActiveSpeakersChanged: (Set<String>) -> Unit, cameraFacing: CameraFacing, onLocalVideoTileAdded: (Int?) -> Unit?, onConnectionStatusChanged: (ConnectionStatus) -> Unit, onRemoteVideoAvailable: (isAvailable: Boolean, sourceCount: Int) -> Unit, onCameraSendAvailable: (available: Boolean) -> Unit, onSessionError: (message: String, isRecoverable: Boolean) -> Unit, onVideoNeedsRestart: () -> Unit, onLocalVideoTileRemoved: () -> Unit?, preferredAudioInputDeviceType: String?, onRemoteTileAdded: (Int) -> Unit?, onRemoteTileRemoved: (Int) -> Unit?, isJoiningOnMute: Boolean, onLocalAttendeeIdAvailable: (String) -> Unit)
expect fun joinMeeting(externalMeetingId: String, meetingId: String, audioHostURL: String, audioFallbackURL: String, turnControlURL: String, signalingURL: String, ingestionURL: String, attendeeId: String, externalUserId: String, joinToken: String, realTimeListener: RealTimeEventListener, onActiveSpeakersChanged: (Set<String>) -> Unit, cameraFacing: CameraFacing = CameraFacing.FRONT, onLocalVideoTileAdded: (Int?) -> Unit? = null, onConnectionStatusChanged: (ConnectionStatus) -> Unit = {}, onRemoteVideoAvailable: (isAvailable: Boolean, sourceCount: Int) -> Unit = { _, _ -> }, onCameraSendAvailable: (available: Boolean) -> Unit = {}, onSessionError: (message: String, isRecoverable: Boolean) -> Unit = { _, _ -> }, onVideoNeedsRestart: () -> Unit = {}, onLocalVideoTileRemoved: () -> Unit? = null, preferredAudioInputDeviceType: String? = null, onRemoteTileAdded: (Int) -> Unit? = null, onRemoteTileRemoved: (Int) -> Unit? = null, isJoiningOnMute: Boolean = false, onLocalAttendeeIdAvailable: (String) -> Unit = {})

Joins a Chime meeting and starts audio/video.

actual fun joinMeeting(externalMeetingId: String, meetingId: String, audioHostURL: String, audioFallbackURL: String, turnControlURL: String, signalingURL: String, ingestionURL: String, attendeeId: String, externalUserId: String, joinToken: String, realTimeListener: <Error class: unknown class>, onActiveSpeakersChanged: (Set<String>) -> Unit, cameraFacing: <Error class: unknown class>, onLocalVideoTileAdded: (Int?) -> Unit?, onConnectionStatusChanged: (<Error class: unknown class>) -> Unit, onRemoteVideoAvailable: (isAvailable: Boolean, sourceCount: Int) -> Unit, onCameraSendAvailable: (available: Boolean) -> Unit, onSessionError: (message: String, isRecoverable: Boolean) -> Unit, onVideoNeedsRestart: () -> Unit, onLocalVideoTileRemoved: () -> Unit?, preferredAudioInputDeviceType: String?, onRemoteTileAdded: (Int) -> Unit?, onRemoteTileRemoved: (Int) -> Unit?, isJoiningOnMute: Boolean, onLocalAttendeeIdAvailable: (String) -> Unit)
Link copied to clipboard
actual fun leaveMeeting()
expect fun leaveMeeting()

Ends the active meeting session and releases all resources.

actual fun leaveMeeting()
Link copied to clipboard
actual fun LocalVideoView(modifier: Modifier, cameraFacing: CameraFacing, isOnTop: Boolean)
expect fun LocalVideoView(modifier: Modifier, cameraFacing: CameraFacing, isOnTop: Boolean)

Composable that renders the local camera preview.

actual fun LocalVideoView(modifier: Modifier, cameraFacing: <Error class: unknown class>, isOnTop: Boolean)
Link copied to clipboard
actual fun RemoteVideoView(modifier: Modifier, tileId: Int, isOnTop: Boolean)
expect fun RemoteVideoView(modifier: Modifier, tileId: Int, isOnTop: Boolean)

Composable that renders a remote participant's video tile.

actual fun RemoteVideoView(modifier: Modifier, tileId: Int, isOnTop: Boolean)
Link copied to clipboard
actual fun sendRealtimeMessage(topic: String, data: String, lifetimeMs: Long)
expect fun sendRealtimeMessage(topic: String, data: String, lifetimeMs: Long = 0)

Broadcasts a real-time data message on topic.

actual fun sendRealtimeMessage(topic: String, data: String, lifetimeMs: Long)
Link copied to clipboard
actual fun setMute(shouldMute: Boolean): Boolean
expect fun setMute(shouldMute: Boolean): Boolean

Mutes or unmutes the local microphone.

actual fun setMute(shouldMute: Boolean): Boolean
Link copied to clipboard
actual fun startLocalVideo()
expect fun startLocalVideo()

Starts capturing and sending local camera video.

actual fun startLocalVideo()
Link copied to clipboard
actual fun stopLocalVideo()
expect fun stopLocalVideo()

Stops capturing and sending local camera video.

actual fun stopLocalVideo()
Link copied to clipboard
actual fun subscribeToTopic(topic: String, listener: (TextMessage) -> Unit)
expect fun subscribeToTopic(topic: String, listener: (TextMessage) -> Unit)

Subscribes to incoming data messages on topic. Call after joinMeeting.

actual fun subscribeToTopic(topic: String, listener: (<Error class: unknown class>) -> Unit)
Link copied to clipboard
actual fun switchAudioDevice(deviceId: String?)
expect fun switchAudioDevice(deviceId: String?)

Routes audio output to the given device.

actual fun switchAudioDevice(deviceId: String?)
Link copied to clipboard
actual fun switchCamera()
expect fun switchCamera()

Toggles between front and back cameras.

actual fun switchCamera()
Link copied to clipboard
actual fun unsubscribeFromTopic(topic: String)
expect fun unsubscribeFromTopic(topic: String)

Unsubscribes from data messages on topic.

actual fun unsubscribeFromTopic(topic: String)