multimedia-common/com.salesforce.android.smi.multimedia.common.api.session/MultimediaSessionFactory/create

create

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

Creates a new multimedia session for the given conversation.

After creation, the session is in MultimediaSessionStatus.Created status. Call MultimediaSession.join to initiate the audio connection.

Return

A Result containing the MultimediaSession on success, or an error on failure.

Parameters

modalityConnection

The modality connection details from the conversation entry.

conversationId

The unique identifier of the conversation.

displayName

An optional display name for the local participant. Falls back to MultimediaConfiguration.displayName if null.

Samples

val result = multimediaClient.create(modalityConnection, conversationId)
if (result is Result.Success) {
    val session = result.data
    session.join()
}