multimedia-common/com.salesforce.android.smi.multimedia.common.api/MultimediaClient

MultimediaClient

interface MultimediaClient : MultimediaSessionFactory

The primary interface for interacting with multimedia sessions.

A MultimediaClient manages the lifecycle of MultimediaSession instances and provides access to the current session state. Obtain an instance through CoreClient.multimediaClient or via MultimediaExtension.

Requires Android O (API 26) or higher.

Types

Companion

object Companion

Properties

configuration

abstract val configuration: MultimediaConfiguration

The current multimedia configuration.

currentSession

abstract val currentSession: MultimediaSession?

The current MultimediaSession, or null if no session is active.

currentSessionFlow

abstract val currentSessionFlow: StateFlow<MultimediaSession?>

A StateFlow of the current MultimediaSession, or null if no session is active.

Functions

configure

abstract fun configure(configure: MultimediaConfiguration.() -> Unit = { MultimediaConfiguration() }): MultimediaClient

Applies configuration changes to this client.

create

abstract fun create(modalityConnection: ModalityConnection, conversationId: UUID, displayName: String? = null): Result<MultimediaSession>

Creates a new multimedia session for the given conversation.

join

abstract fun join(modalityConnection: ModalityConnection, conversationId: UUID, displayName: String? = null): Result<MultimediaSession>

Joins an existing multimedia session for the given conversation.