Share via

VoiceLiveProtocolError class

Package:
@azure/ai-voicelive

Protocol error class for Voice Live message operations

Extends
VoiceLiveConnectionError

Constructors

VoiceLiveProtocolError(string, string, Error)

Inherited Properties

cause

The original error that caused this error, if any
code

Error code identifying the specific error type
context

Context information about where the error occurred
message
name
recoverable

Indicates whether this error is potentially recoverable
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.
timestamp

Timestamp when the error occurred

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

VoiceLiveProtocolError(string, string, Error) 

new VoiceLiveProtocolError(message: string, code: string, cause?: Error)

Parameters

message

string

code

string

cause

Error

Inherited Property Details

cause

The original error that caused this error, if any

cause?: Error

Property Value

Error

Inherited From VoiceLiveConnectionError.cause

code

Error code identifying the specific error type

code: string

Property Value

string

Inherited From VoiceLiveConnectionError.code

context

Context information about where the error occurred

context: string

Property Value

string

Inherited From VoiceLiveConnectionError.context

message 

message: string

Property Value

string

Inherited From VoiceLiveConnectionError.message

name 

name: string

Property Value

string

Inherited From VoiceLiveConnectionError.name

recoverable

Indicates whether this error is potentially recoverable

recoverable: boolean

Property Value

boolean

Inherited From VoiceLiveConnectionError.recoverable

stack 

stack?: string

Property Value

string

Inherited From VoiceLiveConnectionError.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 VoiceLiveConnectionError.stackTraceLimit

timestamp

Timestamp when the error occurred

timestamp: Date

Property Value

Date

Inherited From VoiceLiveConnectionError.timestamp

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 VoiceLiveConnectionError.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 VoiceLiveConnectionError.prepareStackTrace