Class: StreamError

  • StreamError is a class used to specify stream error data.

  • The ErrorCode enumeration lists different types of errors reported by the SDK, such as unknown errors, invalid requests, initialization failures, timeouts, and authorization failures.

  • The StreamError class has properties for code (of type ErrorCode) and message (a string) to describe the error.

Enumeration

ErrorCode

constant   static

number

List of error types reported by the SDK.

Value

UNKNOWN_ERROR

An unexpected error occurred and the cause is not known.

INVALID_STREAM_REQUEST

The provided stream request was invalid.

STREAM_INITIALIZATION_FAILED

The requested stream failed to initialize

STREAM_INITIALIZATION_TIMEOUT

The stream request timed out.

STREAM_AUTHORIZATION_FAILED

The authorization for the stream request failed.

Properties

code

constant   public

non-null ErrorCode

message

constant   public

string

ErrorCode

constant   static

number

List of error types reported by the SDK.

Value

UNKNOWN_ERROR

An unexpected error occurred and the cause is not known.

INVALID_STREAM_REQUEST

The provided stream request was invalid.

STREAM_INITIALIZATION_FAILED

The requested stream failed to initialize

STREAM_INITIALIZATION_TIMEOUT

The stream request timed out.

STREAM_AUTHORIZATION_FAILED

The authorization for the stream request failed.