Class SerenadaCore

Main entry point for the Serenada SDK. Create an instance with a SerenadaConfig, then use join or createRoom to start a call.

Index

Constructors

Methods

createRoom join discardRecoverableSession getRecoverableSession isSupported

Constructors

constructor

new SerenadaCore(config: SerenadaConfig): SerenadaCore
Parameters
- config: SerenadaConfig
Returns SerenadaCore
- Defined in packages/core/src/SerenadaCore.ts:25

Methods

createRoom

createRoom(): Promise<CreateRoomResult>
Create a new room. Returns the room URL and ID. Call join to start the call.

Returns Promise<CreateRoomResult>
- Defined in packages/core/src/SerenadaCore.ts:86

join

join(
url: string,
options?: { displayName?: string; peerId?: string },
): SerenadaSessionHandle
Join an existing call by URL. Returns a session handle.
Parameters
- url: string
- Optionaloptions: { displayName?: string; peerId?: string }
Returns SerenadaSessionHandle
- Defined in packages/core/src/SerenadaCore.ts:58
join(
options: { displayName?: string; peerId?: string; roomId: string },
): SerenadaSessionHandle
Join an existing call by room ID. Returns a session handle.
Parameters
- options: { displayName?: string; peerId?: string; roomId: string }
Returns SerenadaSessionHandle
- Defined in packages/core/src/SerenadaCore.ts:60

`Static`discardRecoverableSession

discardRecoverableSession(): void
Drops any persisted recovery record. Host apps call this when the user explicitly declines to rejoin, so subsequent launches do not keep prompting for the same dead session.

Returns void
- Defined in packages/core/src/SerenadaCore.ts:53

`Static`getRecoverableSession

getRecoverableSession(): RecoveryRecord | null
Returns a recoverable session if the previous tab/page session ended abruptly (reload, OS-level crash) while a call was active and the persisted reconnect token is still within its TTL. Host apps should call this on launch and surface a "Rejoin call?" prompt — calling join with the returned roomId reattaches under the same CID.

Returns null when there is nothing to recover.

Returns RecoveryRecord | null
- Defined in packages/core/src/SerenadaCore.ts:44

`Static`isSupported

isSupported(): boolean
Check if the current browser supports WebRTC calling.

Returns boolean
- Defined in packages/core/src/SerenadaCore.ts:31