serenada-core/app.serenada.core/SerenadaSession

SerenadaSession

class SerenadaSession

Represents an active call session. Created via SerenadaCore.join or SerenadaCore.createRoom.

Observe state for app-facing call state changes and diagnostics for low-level transport/media details. Control the call via leave, end, toggleAudio, toggleVideo, etc. Call close once the host is done with the session object.

Properties

availableAudioDevices

val availableAudioDevices: <Error class: unknown class><List<AudioDevice>>

Audio routes currently published by the active coordinator.

currentAudioDevice

val currentAudioDevice: <Error class: unknown class><AudioDevice?>

Current selected or active output route, or null when no route is available yet.

val diagnostics: <Error class: unknown class><CallDiagnostics>

Real-time connection diagnostics (stats, transport state, ICE state).

val host: String?

val isMicMuted: <Error class: unknown class><Boolean>

Whether the microphone is effectively muted by user action, external audio, or missing input.

isMicMutedByExternalAudio

val isMicMutedByExternalAudio: <Error class: unknown class><Boolean>

Whether the microphone is muted specifically because external audio, such as push-to-talk, is active.

onPermissionsRequired

var onPermissionsRequired: (List<MediaCapability>) -> Unit?

Callback invoked when camera/microphone permissions are needed before joining.

val qualitySummary: CallQualitySummary?

Aggregate call-quality summary. Reflects the live tracker while in-call and the finalized snapshot after the call ends; stays readable after teardown. Null before sampling begins (first InCall).

val roomId: String

The room ID for this call session.

val roomUrl: String?

Full URL for this call session (e.g. "https://serenada.app/call/ABC123").

val state: <Error class: unknown class><CallState>

Primary observable call state. Collect this flow for UI updates.

Functions

adjustLocalCameraZoom

fun adjustLocalCameraZoom(scaleFactor: Float)

Adjust the camera zoom level by the given scale factor.

attachLocalContentRenderer

fun attachLocalContentRenderer(renderer: <Error class: unknown class>)

Attach a sink to the LOCAL content (screen share) track for local preview.

attachLocalRenderer

fun attachLocalRenderer(renderer: <Error class: unknown class>, rendererEvents: <Error class: unknown class>? = null)

Attach a org.webrtc.SurfaceViewRenderer for local video preview.

attachLocalSink

fun attachLocalSink(sink: <Error class: unknown class>)

attachRemoteContentRenderer

fun attachRemoteContentRenderer(renderer: <Error class: unknown class>, participantCid: String)

Attach a sink to a specific peer's remote CONTENT (screen share) track.

attachRemoteRenderer

fun attachRemoteRenderer(renderer: <Error class: unknown class>, rendererEvents: <Error class: unknown class>? = null)

Attach a org.webrtc.SurfaceViewRenderer for remote video.

attachRemoteRendererForCid

fun attachRemoteRendererForCid(cid: String, renderer: <Error class: unknown class>, rendererEvents: <Error class: unknown class>? = null)

attachRemoteSink

fun attachRemoteSink(sink: <Error class: unknown class>)

attachRemoteSinkForCid

fun attachRemoteSinkForCid(cid: String, sink: <Error class: unknown class>)

fun cancelJoin()

Cancel an in-progress join attempt.

captureLocalSnapshot

fun captureLocalSnapshot(onResult: (ByteArray?) -> Unit)

Capture a JPEG snapshot of the local video frame.

captureSnapshot

suspend fun captureSnapshot(source: SnapshotSource = SnapshotSource.Local): SnapshotResult

Capture the current video frame from the chosen stream as JPEG bytes at the source track's full intrinsic resolution.

fun close()

Permanently release this session after the host is done with it.

detachLocalContentRenderer

fun detachLocalContentRenderer(renderer: <Error class: unknown class>)

Detach a previously attached local content renderer.

detachLocalRenderer

fun detachLocalRenderer(renderer: <Error class: unknown class>)

Detach a previously attached local video renderer.

detachLocalSink

fun detachLocalSink(sink: <Error class: unknown class>)

detachRemoteContentRenderer

fun detachRemoteContentRenderer(renderer: <Error class: unknown class>, participantCid: String)

Detach a previously attached remote content renderer for a peer.

detachRemoteRenderer

fun detachRemoteRenderer(renderer: <Error class: unknown class>)

Detach a previously attached remote video renderer.

detachRemoteRendererForCid

fun detachRemoteRendererForCid(cid: String, renderer: <Error class: unknown class>)

detachRemoteSink

fun detachRemoteSink(sink: <Error class: unknown class>)

detachRemoteSinkForCid

fun detachRemoteSinkForCid(cid: String, sink: <Error class: unknown class>)

fun eglContext(): <Error class: unknown class>

Get the EGL context for custom rendering or renderer initialization.

fun end()

End the call for all participants.

fun flipCamera()

Cycle to the next camera mode in the configured preference order.

fun leave()

Leave the call gracefully. The other participant stays in the room.

fun resumeJoin()

Resume joining after camera/microphone permissions have been granted.

selectAudioDevice

fun selectAudioDevice(device: AudioDevice)

Request routing to a coordinator-published audio device.

fun setCameraMode(mode: LocalCameraMode)

Set a specific camera mode. Ignored when mode is not in the configured list.

fun setMicMuted(muted: Boolean)

Set the user-requested microphone mute state.

startScreenShare

fun startScreenShare(intent: <Error class: unknown class>)

Start screen sharing using the given media projection intent.

stopScreenShare

fun stopScreenShare()

Stop screen sharing and return to camera.

fun toggleAudio()

Toggle local audio on or off.

toggleFlashlight

fun toggleFlashlight()

Toggle the device flashlight on or off.

fun toggleVideo()

Toggle local video on or off.