Skip to main content
Version: v1.39.0

StageErrorCode

Stage error codes. Stage error codes are returned when a problem is encountered that the SDK cannot recover from and require app intervention.

Enumeration Members​

CANCELED​

CANCELED: 5

Operation canceled. Check application code and ensure no repeated joins/leaves/refreshStrategy/replaceStrategy invocations which may cause repeated operations to be started and canceled before completion.


CODEC_MISMATCH​

CODEC_MISMATCH: 7

Codec is not supported by the stage. Check browser/platform for codec support.


FAILED​

FAILED: 4

Operation failed. Fatal condition encountered attempting operation. Check error details.


PARTICIPANT_DISCONNECTED​

PARTICIPANT_DISCONNECTED: 10

If a participant is disconnected while actively in a session, they will be gracefully disconnected. If a participant tries to join again, an error will be thrown during the join establishment.


STAGE_AT_CAPACITY​

STAGE_AT_CAPACITY: 6

Stage is at capacity. Try again when stage is no longer at capacity.


STAGE_DELETED​

STAGE_DELETED: 9

If a stage is deleted while a participant is actively in a session, they will be gracefully disconnected. If a participant tries to join a deleted stage, an error will be thrown during the join establishment.


TIMEOUT​

TIMEOUT: 3

Operation timed out. If the StageErrorCategory is JOIN_ERROR then check if the stage exists and the token is valid. If the stage exists and the token is valid, this failure is likely a network issue. In that case, wait for the device’s connectivity to recover and either refresh the strategy or leave and rejoin the stage.


TOKEN_EXCHANGE_FAILED​

TOKEN_EXCHANGE_FAILED: 12

Token exchange failed due to server error, rejection, or timeout. The server rejected the token exchange request or did not respond.


TOKEN_EXCHANGE_REQUEST_INVALID​

TOKEN_EXCHANGE_REQUEST_INVALID: 11

Token exchange failed due to invalid or incompatible token. The token may be malformed, have incompatible immutable properties (stageARN, participantID, eventsURL, whipURL, topic), or be otherwise invalid. Check error details for specific validation failures. Create a valid token with matching immutable properties and retry.


TOKEN_EXPIRED​

TOKEN_EXPIRED: 2

Token is expired. Create a non-expired token and retry joining.


TOKEN_MALFORMED​

TOKEN_MALFORMED: 1

Token is malformed. Ensure the token is not being unexpectantly modified (i.e. spaces inserted, characters changed, etc.) before being passed to the stage. Create a valid token and retry joining.


TOKEN_NOT_ALLOWED​

TOKEN_NOT_ALLOWED: 8

Token does not have permission for the operation. Recreate the token with the correct permission(s) and try again.