XmaxErrorCode enum

An error code reported by XmaxSDK.

Inheritance
Available extensions

Values

invalidAPIKey → const XmaxErrorCode

The API key is empty or invalid.

const XmaxErrorCode('INVALID_API_KEY')
invalidConfiguration → const XmaxErrorCode

The parameters or configuration violate the API contract.

const XmaxErrorCode('INVALID_CONFIGURATION')
internalError → const XmaxErrorCode

An otherwise unclassified internal failure.

const XmaxErrorCode('INTERNAL_ERROR')
networkError → const XmaxErrorCode

An HTTP transport failure.

const XmaxErrorCode('NETWORK_ERROR')
apiError → const XmaxErrorCode

A server API request failure.

const XmaxErrorCode('API_ERROR')
sessionError → const XmaxErrorCode

Invalid server session state or RTC credentials.

const XmaxErrorCode('SESSION_ERROR')
rtcError → const XmaxErrorCode

An RTC engine, room, or media transport failure.

const XmaxErrorCode('RTC_ERROR')
mediaError → const XmaxErrorCode

A local media capture or processing failure.

const XmaxErrorCode('MEDIA_ERROR')
frameInterpolationUnsupported → const XmaxErrorCode

The runtime does not support the requested frame interpolation capability.

const XmaxErrorCode('FRAME_INTERPOLATION_UNSUPPORTED')
cameraPermissionDenied → const XmaxErrorCode

Camera permission was denied.

const XmaxErrorCode('CAMERA_PERMISSION_DENIED')
microphonePermissionDenied → const XmaxErrorCode

Microphone permission was denied.

const XmaxErrorCode('MICROPHONE_PERMISSION_DENIED')
uploadError → const XmaxErrorCode

An object upload failure.

const XmaxErrorCode('UPLOAD_ERROR')
downloadError → const XmaxErrorCode

A file download or destination write failure.

const XmaxErrorCode('DOWNLOAD_ERROR')
unsafeImage → const XmaxErrorCode

The image failed its content safety check.

const XmaxErrorCode('UNSAFE_IMAGE')
cancelled → const XmaxErrorCode

The operation was cancelled.

const XmaxErrorCode('CANCELLED')
timeout → const XmaxErrorCode

The operation exceeded its deadline.

const XmaxErrorCode('TIMEOUT')

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
value → String
The serialized value.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<XmaxErrorCode>
A constant List of the values in this enum, in order of their declaration.