serenada-core/app.serenada.core

Package-level declarations

Types

class AndroidSerenadaLogger : SerenadaLogger

data class CallDiagnostics(val isSignalingConnected: Boolean = false, val iceConnectionState: IceConnectionState = IceConnectionState.NEW, val peerConnectionState: PeerConnectionState = PeerConnectionState.NEW, val rtcSignalingState: RtcSignalingState = RtcSignalingState.STABLE, val activeTransport: String? = null, val callStats: CallStats = CallStats(), val realtimeStats: RealtimeCallStats? = null, val isFrontCamera: Boolean = true, val isScreenSharing: Boolean = false, val isFlashAvailable: Boolean = false, val isFlashEnabled: Boolean = false, val remoteContentCid: String? = null, val remoteContentType: String? = null, val featureDegradations: List<FeatureDegradationState> = emptyList())

CallError

sealed class CallError

Typed error representation for SDK call errors. Matches the iOS CallError enum for cross-platform parity.

CallQualitySummary

data class CallQualitySummary(val mosScore: Double? = null, val packetLossPct: Double? = null, val medianLatencyMs: Int? = null, val medianJitterMs: Int? = null, val countDisconnects: Int = 0, val countReconnects: Int = 0, val totalDropoutDurationMs: Long = 0, val qualitySampleCount: Int = 0)

Immutable snapshot of aggregate call quality, computed by the SDK and consumed by hosts to populate their call-ended analytics. Updated live during the call and finalized at call end; remains readable after the session stops.

CallState

data class CallState(val phase: CallPhase = CallPhase.Idle, val roomId: String? = null, val localCid: String? = null, val isHost: Boolean = false, val participantCount: Int = 0, val callStartedAtMs: Long? = null, val localAudioEnabled: Boolean = true, val localVideoEnabled: Boolean = true, val localCameraEnabled: Boolean = true, val localContent: ParticipantContent? = null, val localDisplayName: String? = null, val localAudioLevel: Float = 0.0f, val remoteParticipants: List<RemoteParticipant> = emptyList(), val connectionStatus: ConnectionStatus = ConnectionStatus.Connected, val signalingState: SignalingState = SignalingState.Connected, val localCameraMode: LocalCameraMode = LocalCameraMode.SELFIE, val availableCameraModes: List<LocalCameraMode> = DEFAULT_CAMERA_MODES, val error: CallError? = null, val requiredPermissions: List<MediaCapability> = emptyList())

SDK-native call state. This is the primary observable state for SDK consumers. Does not include host-app concerns (saved rooms, settings, etc.).

CallStats

data class CallStats(val bitrate: Double? = null, val packetLoss: Double? = null, val jitter: Double? = null, val codec: String? = null, val iceCandidatePair: String? = null, val roundTripTime: Double? = null, val audioRxKbps: Double? = null, val audioTxKbps: Double? = null, val videoRxKbps: Double? = null, val videoTxKbps: Double? = null, val videoFps: Double? = null, val videoResolution: String? = null, val realtimeStats: RealtimeCallStats? = null, val updatedAtMs: Long = 0)

Aggregated call statistics exposed to SDK consumers. Populated from WebRTC getStats() periodically during an active call.

CheckOutcome

sealed class CheckOutcome

ConnectionEvent

sealed class ConnectionEvent

Connection-quality event emitted by the SDK through SerenadaCoreDelegate.onConnectionEvent.

ConnectionInfo

data class ConnectionInfo(val transport: String? = null)

ConnectivityReport

data class ConnectivityReport(val roomApi: CheckOutcome = CheckOutcome.NotRun, val webSocket: CheckOutcome = CheckOutcome.NotRun, val sse: CheckOutcome = CheckOutcome.NotRun, val diagnosticToken: CheckOutcome = CheckOutcome.NotRun, val turnCredentials: CheckOutcome = CheckOutcome.NotRun)

CreateRoomResult

data class CreateRoomResult(val roomId: String, val roomUrl: String)

DeviceInfo

data class DeviceInfo(val id: String, val name: String, val kind: String)

DiagnosticCheckResult

enum DiagnosticCheckResult : Enum<DiagnosticCheckResult>

DiagnosticsReport

data class DiagnosticsReport(val camera: DiagnosticCheckResult, val microphone: DiagnosticCheckResult, val speaker: DiagnosticCheckResult, val network: DiagnosticCheckResult, val signaling: SignalingCheckResult, val turn: TurnCheckResult, val devices: List<DeviceInfo>)

DropoutTrigger

enum DropoutTrigger : Enum<DropoutTrigger>

Reason a dropout began, carried so hosts can distinguish recovery causes.

EndReason

sealed class EndReason

ErrorEvent

data class ErrorEvent(val code: String, val message: String)

FeatureDegradation

enum FeatureDegradation : Enum<FeatureDegradation>

FeatureDegradationState

data class FeatureDegradationState(val kind: FeatureDegradation, val reason: String? = null)

IceConnectionState

enum IceConnectionState : Enum<IceConnectionState>

IceProbeReport

data class IceProbeReport(val stunPassed: Boolean, val turnPassed: Boolean, val logs: List<String>, val iceServersSummary: String = "n/a")

JoinedEvent

data class JoinedEvent(val peerId: String, val participants: List<SignalingProviderParticipant>, val hostPeerId: String? = null, val maxParticipants: Int? = null, val epoch: Long? = null, val reconnectOutcome: JoinReconnectOutcome? = null, val reconnectToken: String? = null, val reconnectTokenTTLMs: Long? = null)

JoinOptions

data class JoinOptions(val reconnectPeerId: String? = null, val maxParticipants: Int? = null, val displayName: String? = null, val appPeerId: String? = null, val independentContentVideo: Boolean = false, val videoMediaEnabled: Boolean = true)

JoinReconnectOutcome

enum JoinReconnectOutcome : Enum<JoinReconnectOutcome>

Disposition of a join, surfaced by the server in joined.reconnect. Drives whether the SDK preserves media-active peer connections, schedules dirty-pair renegotiation, or starts ground-up.

MediaCapability

enum MediaCapability : Enum<MediaCapability>

Device media capabilities required for a call.

NegotiationDirtyEvent

data class NegotiationDirtyEvent(val withCid: String)

Server tells an active peer that a previously-suspended peer has reattached AND there was pending negotiation traffic to it during the suspension. The SDK should perform glare-safe fresh negotiation / ICE restart for the named CID.

ParticipantSignalingStatus

enum ParticipantSignalingStatus : Enum<ParticipantSignalingStatus>

Wire-level status values for a remote participant's signaling transport. The server uses "suspended" to indicate a participant whose transport dropped but whose room slot is being held open for reconnect. "active" is the default for participants with a live transport attached.

PeerConnectionState

enum PeerConnectionState : Enum<PeerConnectionState>

PeerEvent

data class PeerEvent(val peerId: String, val joinedAt: Long? = null, val displayName: String? = null, val appPeerId: String? = null)

PeerMessage

data class PeerMessage(val from: String, val type: String, val payload: <Error class: unknown class>? = null)

ProviderCapabilities

data class ProviderCapabilities(val handlesReconnection: Boolean = false)

ReconnectTokenRefreshedEvent

data class ReconnectTokenRefreshedEvent(val reconnectToken: String, val reconnectTokenTTLMs: Long? = null)

RecoveryRecord

data class RecoveryRecord(val roomId: String, val cid: String, val reconnectToken: String, val lastEpoch: Long?, val sessionStartTs: Long, val expiresAtMs: Long)

Persisted call-recovery state — surfaced to host apps so a relaunched process can prompt the user to rejoin an in-flight call instead of silently dropping them on the home screen.

RelayFailedEvent

data class RelayFailedEvent(val reason: String, val targets: List<String>, val of: String? = null)

Server tells the sender it could not deliver a relay because the target had no transport.

RoomEndedEvent

data class RoomEndedEvent(val by: String? = null, val reason: String)

RoomOccupancy

data class RoomOccupancy(val count: Int, val maxParticipants: Int? = null)

RoomStateEvent

data class RoomStateEvent(val participants: List<SignalingProviderParticipant>, val hostPeerId: String? = null, val maxParticipants: Int? = null, val epoch: Long? = null)

RoomWatcher

class RoomWatcher constructor(okHttpClient: <Error class: unknown class> = OkHttpClient.Builder().build(), handler: <Error class: unknown class> = Handler(Looper.getMainLooper()))

Monitors room occupancy via signaling. Use this to show room status before joining.

RoomWatcherDelegate

interface RoomWatcherDelegate

RtcSignalingState

enum RtcSignalingState : Enum<RtcSignalingState>

SerenadaConfig

data class SerenadaConfig(val serverHost: String? = null, val signalingProvider: SignalingProvider? = null, val defaultAudioEnabled: Boolean = true, val defaultVideoEnabled: Boolean = true, val videoMediaEnabled: Boolean = true, val enableIndependentContentVideo: Boolean = false, val cameraModes: List<LocalCameraMode>? = null, val isHdVideoExperimentalEnabled: Boolean = false, val deferInitialAnswer: Boolean = false, val transports: List<SerenadaTransport> = listOf(SerenadaTransport.WS, SerenadaTransport.SSE), val proximityMonitoringEnabled: Boolean = false, val audioCoordinator: SerenadaAudioCoordinator? = null, val audioIntent: AudioIntent = AudioIntent(), val enableOpusRed: Boolean = false, val enableOpusDtx: Boolean = false)

Configuration for the Serenada SDK.

SerenadaCore

class SerenadaCore(val config: SerenadaConfig, context: <Error class: unknown class>)

Main entry point for the Serenada SDK.

SerenadaCoreDelegate

interface SerenadaCoreDelegate

Delegate interface for receiving SDK lifecycle callbacks. All methods have default no-op implementations so only relevant callbacks need overriding.

SerenadaDiagnostics

class SerenadaDiagnostics

Pre-flight diagnostics utility. Checks device capabilities and server connectivity without prompting for permissions.

SerenadaLogger

interface SerenadaLogger

SerenadaLogLevel

enum SerenadaLogLevel : Enum<SerenadaLogLevel>

SerenadaSession

class SerenadaSession

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

SerenadaTransport

enum SerenadaTransport : Enum<SerenadaTransport>

Available signaling transport types.

SignalingCheckResult

sealed class SignalingCheckResult

SignalingProvider

interface SignalingProvider

Transport-agnostic signaling contract for Android SDK sessions.

SignalingProviderParticipant

data class SignalingProviderParticipant(val peerId: String, val joinedAt: Long? = null, val displayName: String? = null, val appPeerId: String? = null, val audioEnabled: Boolean? = null, val videoEnabled: Boolean? = null, val connectionStatus: ParticipantSignalingStatus = ParticipantSignalingStatus.ACTIVE, val contentState: SignalingProviderParticipantContentState? = null, val capabilities: SignalingProviderParticipantCapabilities? = null, val mediaPolicy: SignalingProviderParticipantMediaPolicy? = null)

SignalingProviderParticipantCapabilities

data class SignalingProviderParticipantCapabilities(val independentContentVideo: Boolean = false)

Allowlisted static capabilities a participant advertised at join, surfaced verbatim by the provider. Unknown keys are dropped upstream.

SignalingProviderParticipantContentState

data class SignalingProviderParticipantContentState(val active: Boolean, val contentType: String? = null, val updatedAtMs: Long? = null, val epoch: Long? = null, val revision: Long? = null)

SignalingProviderParticipantMediaPolicy

data class SignalingProviderParticipantMediaPolicy(val videoMediaEnabled: Boolean = true)

Allowlisted per-session media policy a participant advertised at join.

SignalingState

sealed interface SignalingState

Richer view of the local signaling transport state. Apps can use this to render reconnect spinners, "you have been disconnected" UI, and a hard- eviction countdown when applicable. CallState.connectionStatus remains the simpler tri-value summary.

SnapshotError

sealed class SnapshotError : RuntimeException

Errors thrown by SerenadaSession.captureSnapshot. Each variant has a machine-readable identity via type checks (e.g. is SnapshotError.StreamNotActive).

SnapshotResult

data class SnapshotResult(val jpeg: ByteArray, val width: Int, val height: Int, val timestampMs: Long, val source: SnapshotSource)

A single decoded JPEG frame plus its metadata, returned from SerenadaSession.captureSnapshot on success.

SnapshotSource

sealed interface SnapshotSource

Identifies which video stream a snapshot should capture.

TurnCheckResult

sealed class TurnCheckResult

Properties

DEFAULT_CAMERA_MODES

val DEFAULT_CAMERA_MODES: List<LocalCameraMode>

Default preference order for SerenadaConfig.cameraModes when left null.