multimedia-common/com.salesforce.android.smi.multimedia.common.internal/MultimediaProviderSession

MultimediaProviderSession

interface MultimediaProviderSession : MultimediaSessionOperations, MultimediaSessionFlows

Properties

event

abstract val event: SharedFlow<MultimediaSessionEvent>

A stream of MultimediaSessionEvent instances emitted during the session lifecycle.

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.

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).