join
abstract fun join(modalityConnection: ModalityConnection, conversationId: UUID, displayName: String? = null): Result<MultimediaSession>
Joins an existing multimedia session for the given conversation.
Use this to reconnect to a session that was previously created. After joining, the session transitions through MultimediaSessionStatus.Connecting to MultimediaSessionStatus.Connected.
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.join(modalityConnection, conversationId, displayName = "Customer")
if (result is Result.Success) {
result.data.join()
}Content copied to clipboard