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

MultimediaSession

interface MultimediaSession : MultimediaSessionState, MultimediaSessionOperations, MultimediaSessionFlows

Represents an active multimedia session within a conversation.

A MultimediaSession combines session metadata with state, operations, and reactive flows. Obtain a session through MultimediaSessionFactory.create or MultimediaSessionFactory.join.

Properties

address

abstract val address: String

The address associated with this session.

conversationId

abstract val conversationId: UUID

The unique identifier of the conversation this session belongs to.

createdAt

abstract val createdAt: Long

The timestamp in milliseconds when this session was created.

displayName

abstract val displayName: String

The display name for this session.

event

abstract val event: SharedFlow<MultimediaSessionEvent>

A stream of MultimediaSessionEvent instances emitted during the session lifecycle.

identifier

abstract val identifier: Int

A numeric identifier for this session.

isActive

abstract val isActive: Boolean

Whether this session is currently active (not on hold).

isMicrophoneMuted

abstract val isMicrophoneMuted: Boolean

Whether the microphone is currently muted.

isSpeakerMuted

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.

status

abstract val status: MultimediaSessionStatus

The current MultimediaSessionStatus of this session.

Functions

activate

open fun activate()

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

audioInput

abstract fun audioInput(muteMicrophone: Boolean)

Enables or disables the microphone (audio input).

audioOutput

abstract fun audioOutput(muteSpeaker: Boolean)

Enables or disables the speaker (audio output).

deactivate

open fun deactivate()

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

end

open fun end()

Ends the session. Equivalent to leave.

hold

abstract fun hold(onHold: Boolean)

Places the session on hold or takes it off hold.

join

abstract fun join()

Joins the multimedia session.

leave

abstract fun leave()

Leaves the multimedia session.

muteMicrophone

open fun muteMicrophone()

Mutes the microphone. Equivalent to audioInput(false).

muteSpeakers

open fun muteSpeakers()

Mutes the speaker. Equivalent to audioOutput(false).

unmuteMicrophone

open fun unmuteMicrophone()

Unmutes the microphone. Equivalent to audioInput(true).

unmuteSpeakers

open fun unmuteSpeakers()

Unmutes the speaker. Equivalent to audioOutput(true).

MultimediaSession

See also

Properties

Functions