CompositeVoiceError

Defined in: src/utils/errors.ts:58

Base error class for all CompositeVoice SDK errors.

Remarks

All SDK-specific errors extend this class, making it possible to catch any SDK error with a single instanceof CompositeVoiceError check. Each error carries a machine-readable code string, a recoverable flag, and optional context with additional diagnostic data.

Uses Error.captureStackTrace when available (V8 engines) to maintain clean stack traces that point to the throw site rather than the error constructor.

Example

try {
  await voice.start();
} catch (error) {
  if (error instanceof CompositeVoiceError) {
    console.error(`Error [${error.code}]: ${error.message}`);
    console.log('Recoverable:', error.recoverable);
    console.log('Context:', error.context);
  }
}

Extends

• Error

Extended by

• ProviderInitializationError
• ProviderConnectionError
• AudioCaptureError
• AudioPlaybackError
• MicrophonePermissionError
• ConfigurationError
• InvalidStateError
• ProviderResponseError
• TimeoutError
• WebSocketError

Constructors

Constructor

new CompositeVoiceError(
   message, 
   code, 
   recoverable?, 
   context?): CompositeVoiceError;

Defined in: src/utils/errors.ts:84

Creates a new CompositeVoiceError.

Parameters

Returns

CompositeVoiceError

Default Value

recoverable: false

Overrides

Error.constructor

Properties

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@20.19.22/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@20.19.22/node_modules/@types/node/globals.d.ts:56

Parameters

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace