AuxiliaryLegTimeoutError

View as MarkdownOpen in Claude

An auxiliary leg — a screen share or an additional input device — did not finish connecting within its 15-second budget. The clock starts once local media is in hand, so a slow device picker or an unanswered permission prompt never spends it; only the offer, ICE gathering, invite, answer, and DTLS do.

Typed rather than a bare RxJS TimeoutError so the leg and the underlying cause survive.

Extends

  • Error

Constructors

Constructor

new AuxiliaryLegTimeoutError(leg, originalError?): AuxiliaryLegTimeoutError

Parameters

leg
'main' | 'screenshare' | 'additional-device'Required

Which auxiliary leg timed out, e.g. 'screenshare'.

originalError
Error

The underlying RxJS TimeoutError, also set as this error’s cause.

Properties

leg
'main' | 'screenshare' | 'additional-device'Required

Read-only. Which auxiliary leg timed out.

originalError
Error

Read-only. The underlying RxJS TimeoutError.

Examples

import { AuxiliaryLegTimeoutError } from '@signalwire/js';
try {
await call.self.addAdditionalDevice({ video: true });
} catch (error) {
if (error instanceof AuxiliaryLegTimeoutError) {
toast(`The ${error.leg} leg could not connect. The call is unaffected.`);
}
}

See