Class: RecoveryController

Extends

• Emitter<ControllerEvents>

Constructors

Constructor

new RecoveryController(
   callbacks, 
   timings, 
   clock, 
   random?
): RecoveryController;

Parameters

Parameter	Type	Default value
callbacks	ControllerCallbacks	undefined
timings	Timings	undefined
clock	Clock	undefined
random	() => number	Math.random

Returns

RecoveryController

Overrides

Emitter.constructor

Accessors

recovering

Get Signature

get recovering(): boolean;

True while either path is working. One flag, two paths, as promised.

Returns

boolean

---

state

Get Signature

get state(): ConnectionState;

Returns

ConnectionState

Methods

emit()

emit<K>(event, ...args): void;

A throwing listener must not stop the others, and must not fail the transition that emitted the event: an exception in a host's onError handler would otherwise tear down the call it was reporting on.

Type Parameters

Type Parameter
K extends keyof ControllerEvents

Parameters

Parameter	Type
event	K
...args	ControllerEvents[K]

Returns

void

Inherited from

Emitter.emit

---

listenerCount()

listenerCount(event): number;

Parameters

Parameter	Type
event	keyof ControllerEvents

Returns

number

Inherited from

Emitter.listenerCount

---

off()

off<K>(event, listener): void;

Type Parameters

Type Parameter
K extends keyof ControllerEvents

Parameters

Parameter	Type
event	K
listener	Listener<ControllerEvents[K]>

Returns

void

Inherited from

Emitter.off

---

on()

on<K>(event, listener): () => void;

Type Parameters

Type Parameter
K extends keyof ControllerEvents

Parameters

Parameter	Type
event	K
listener	Listener<ControllerEvents[K]>

Returns

() => void

Inherited from

Emitter.on

---

once()

once<K>(event, listener): () => void;

Type Parameters

Type Parameter
K extends keyof ControllerEvents

Parameters

Parameter	Type
event	K
listener	Listener<ControllerEvents[K]>

Returns

() => void

Inherited from

Emitter.once

---

onIceDisconnected()

onIceDisconnected(): void;

ICE said disconnected: nothing has arrived for the browser's own silence window. If it is still so iceDisconnectedGraceMs later, that is the sustained failure step 1 is for. The quality samples cannot say it: a stream that receives nothing reports no loss.

Returns

void

---

onIceFailed()

onIceFailed(): void;

ICE said failed, which needs no streak: it is already terminal for that connection.

Returns

void

---

onMediaHealthy()

onMediaHealthy(): void;

Media is flowing. Resets the streak, the ladder, and a pending disconnect.

Returns

void

---

onQuality()

onQuality(bad): void;

A quality sample. Three consecutive bad ones start the media ladder.

Parameters

Parameter	Type
bad	boolean

Returns

void

---

onSignalingLost()

onSignalingLost(cause): void;

The socket is gone, or has stopped answering. Either way this is the same path: back off, then resume.

Parameters

Parameter	Type
cause	ReconnectCause

Returns

void

---

removeAllListeners()

removeAllListeners(): void;

Returns

void

Inherited from

Emitter.removeAllListeners

---

start()

start(): Promise<void>;

The first connect. Failures here are the host's to see immediately — a bad token is not something to retry behind a spinner.

Returns

Promise<void>

---

stop()

stop(): void;

Returns

void