Class: StreamError

AI-generated Key Takeaways

• StreamError is a class used to define stream error data with specific error codes.

• Error codes provide information about the type of error, such as initialization failures, invalid requests, or authorization issues.

• StreamError objects have code and message properties for describing the error.

• ErrorCode is a static enumeration that lists possible error types for stream operations within the SDK.

StreamError

class   public

A class for specifying stream error data.

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.