multimedia-common/com.salesforce.android.smi.multimedia.common.api.session/MultimediaSession

MultimediaSession

interface MultimediaSession : MultimediaSessionState, MultimediaSessionOperations, MultimediaSessionFlows

Represents an active voice session within a conversation.

A MultimediaSession provides:

State via MultimediaSessionState -- current status, mute and hold state.
Operations via MultimediaSessionOperations -- join, leave, muteMicrophone, hold.
Reactive streams via MultimediaSessionFlows -- event, localParticipant, remoteParticipants.

Lifecycle

A session is created in MultimediaSessionStatus.Created status.
Call join to begin the audio connection (MultimediaSessionStatus.Connecting).
Once connected, status becomes MultimediaSessionStatus.Connected or MultimediaSessionStatus.Answered when a remote participant joins.
Call end (or leave) to terminate the session (MultimediaSessionStatus.Ended).

Observe lifecycle transitions via the event flow, which emits MultimediaSessionEvent instances.

See also

MultimediaSessionState

MultimediaSessionOperations

MultimediaSessionFlows

Samples

session.muteMicrophone()
session.unmuteMicrophone()
session.hold(true)
session.activate()
session.end()

scope.launch {
    session.event.collect { event ->
        when (event) {
            is MultimediaSessionEvent.Connection.Connected -> {
                // Call connected successfully
            }
            is MultimediaSessionEvent.Connection.Reconnecting -> {
                // Network interruption, attempting to reconnect
            }
            is MultimediaSessionEvent.Connection.Disconnected -> {
                // Call ended or lost connection
            }
            is MultimediaSessionEvent.ParticipantChanged -> {
                // Agent joined or participant state changed
            }
            is MultimediaSessionEvent.Error -> {
                val errorCode = event.code
            }
            else -> {}
        }
    }
}

Properties

abstract val address: String

The address associated with this session (typically the phone number or SIP URI).

abstract val conversationId: UUID

The unique identifier of the conversation this session belongs to.

abstract val createdAt: Long

The timestamp in milliseconds (epoch) when this session was created.

abstract val displayName: String

The display name for this session, shown in notifications and the telecom framework.

abstract val event: SharedFlow<MultimediaSessionEvent>

A stream of MultimediaSessionEvent instances emitted during the session lifecycle.

abstract val identifier: Int

A numeric identifier for this session, used internally for telecom framework integration.

abstract val isActive: Boolean

Whether this session is currently active (not on hold). false when the session is held.

isMicrophoneMuted

abstract val isMicrophoneMuted: Boolean

Whether the microphone is currently muted.

abstract val isSpeakerMuted: Boolean

Whether the speaker is currently muted.

localParticipant

abstract val localParticipant: Flow<MultimediaParticipant>

A stream of the local MultimediaParticipant.

remoteParticipants

abstract val remoteParticipants: Flow<List<MultimediaParticipant>>

A stream of remote MultimediaParticipant instances currently in the session.

abstract val status: MultimediaSessionStatus

The current MultimediaSessionStatus of this session.

Functions

open fun activate()

Takes the session off hold. Equivalent to hold(onHold = false).

abstract fun audioInput(muteMicrophone: Boolean)

Enables or disables the microphone (audio input).

abstract fun audioOutput(muteSpeaker: Boolean)

Enables or disables the speaker (audio output).

open fun deactivate()

Places the session on hold. Equivalent to hold(onHold = true).

open fun end()

Ends the session. Equivalent to leave.

abstract fun hold(onHold: Boolean)

Places the session on hold or takes it off hold.

abstract fun join()

Joins the multimedia session, initiating the audio connection.

abstract fun leave()

Leaves the multimedia session and tears down the audio connection.

open fun muteMicrophone()

Mutes the microphone. Equivalent to audioInput(muteMicrophone = true).

open fun muteSpeakers()

Mutes the speaker. Equivalent to audioOutput(muteSpeaker = true).

unmuteMicrophone

open fun unmuteMicrophone()

Unmutes the microphone. Equivalent to audioInput(muteMicrophone = false).

open fun unmuteSpeakers()

Unmutes the speaker. Equivalent to audioOutput(muteSpeaker = false).