Class SerenadaDiagnostics

Pre-flight diagnostics utility. Checks device capabilities (camera, mic, speaker) and server connectivity (signaling, TURN) before joining a call.

Index

Constructors

Methods

checkCamera checkMicrophone checkNetwork checkSignaling checkSpeaker checkTurn runAll runConnectivityChecks runIceProbe validateServerHost

Constructors

constructor

new SerenadaDiagnostics(config: SerenadaConfig): SerenadaDiagnostics
Parameters
- config: SerenadaConfig
Returns SerenadaDiagnostics
- Defined in SerenadaDiagnostics.ts:32

Methods

checkCamera

checkCamera(): Promise<DiagnosticCheckResult>
Check if a camera is available and authorized.

Returns Promise<DiagnosticCheckResult>
- Defined in SerenadaDiagnostics.ts:104

checkMicrophone

checkMicrophone(): Promise<DiagnosticCheckResult>
Check if a microphone is available and authorized.

Returns Promise<DiagnosticCheckResult>
- Defined in SerenadaDiagnostics.ts:110

checkNetwork

checkNetwork(): Promise<DiagnosticCheckResult>
Check if the browser reports network connectivity.

Returns Promise<DiagnosticCheckResult>
- Defined in SerenadaDiagnostics.ts:122

checkSignaling

checkSignaling(): Promise<DiagnosticCheckResult & { transport?: string }>
Check if the signaling server is reachable.

Returns Promise<DiagnosticCheckResult & { transport?: string }>
- Defined in SerenadaDiagnostics.ts:132

checkSpeaker

checkSpeaker(): Promise<DiagnosticCheckResult>
Check if a speaker/audio output device is available.

Returns Promise<DiagnosticCheckResult>
- Defined in SerenadaDiagnostics.ts:116

checkTurn

checkTurn(): Promise<DiagnosticCheckResult & { latencyMs?: number }>
Check if the TURN relay endpoint is reachable.

Returns Promise<DiagnosticCheckResult & { latencyMs?: number }>
- Defined in SerenadaDiagnostics.ts:151

runAll

runAll(): Promise<DiagnosticsReport>
Run all diagnostic checks and return a full report.

Returns Promise<DiagnosticsReport>
- Defined in SerenadaDiagnostics.ts:37

runConnectivityChecks

runConnectivityChecks(): Promise<ConnectivityReport>
Test server connectivity: room API, WebSocket, SSE, and TURN credentials.

Returns Promise<ConnectivityReport>
- Defined in SerenadaDiagnostics.ts:51

runIceProbe

runIceProbe(
turnsOnly: boolean,
onCandidateLog?: (candidate: string) => void,
): Promise<IceProbeReport>
Probe ICE connectivity (STUN/TURN) by gathering candidates with a real peer connection.
Parameters
- turnsOnly: boolean
- OptionalonCandidateLog: (candidate: string) => void
Returns Promise<IceProbeReport>
- Defined in SerenadaDiagnostics.ts:78

validateServerHost

validateServerHost(host?: string): Promise<void>
Validate that a server host is reachable by requesting a room ID.
Parameters
- host: string = ...
Returns Promise<void>
- Defined in SerenadaDiagnostics.ts:93