VoiceAgentProtocolError class

Package:: @azure/ai-projects

An error raised when a WebSocket message does not match the voice-agent protocol.

Extends: VoiceAgentRealtimeError

Constructors

VoiceAgentProtocolError(string, { cause?: unknown })

Inherited Properties

cause	The underlying error, when available.
code	A stable code identifying the error category.
message
name
stack
stackTraceLimit	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited Methods

captureStackTrace(object, Function)

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();

prepareStackTrace(Error, CallSite[])

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

Constructor Details

VoiceAgentProtocolError(string, { cause?: unknown })

new VoiceAgentProtocolError(message: string, options?: { cause?: unknown })

Parameters

message: string

options: { cause?: unknown }

Inherited Property Details

cause

The underlying error, when available.

cause?: unknown

Property Value

unknown

Inherited From VoiceAgentRealtimeError.cause

code

A stable code identifying the error category.

code: VoiceAgentRealtimeErrorCode

Property Value

VoiceAgentRealtimeErrorCode

Inherited From VoiceAgentRealtimeError.code

message

message: string

Property Value

string

Inherited From VoiceAgentRealtimeError.message

name

name: string

Property Value

string

Inherited From VoiceAgentRealtimeError.name

stack

stack?: string

Property Value

string

Inherited From VoiceAgentRealtimeError.stack

stackTraceLimit

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

static stackTraceLimit: number

Property Value

number

Inherited From VoiceAgentRealtimeError.stackTraceLimit

Inherited Method Details

captureStackTrace(object, Function)

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();

static function captureStackTrace(targetObject: object, constructorOpt?: Function)

Parameters

targetObject: object

constructorOpt: Function

Inherited From VoiceAgentRealtimeError.captureStackTrace

prepareStackTrace(Error, CallSite[])

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

static function prepareStackTrace(err: Error, stackTraces: CallSite[]): any

Parameters

err: Error

stackTraces: CallSite[]

Returns

any

Inherited From VoiceAgentRealtimeError.prepareStackTrace