100ms Logo

100ms

Docs

Search docs
/

Error Handling

When you make various function calls through HmsInstance, it may return errors with different error codes. ErrorCodes are returned when a problem that cannot be recovered without app intervention has occurred.

These are returned as HMSException in the onError callback of the HMSUpdateListner.

// import HMSUpdateListenerActions class import { HMSUpdateListenerActions, HMSException } from '@100mslive/react-native-hms'; // instance acquired from build() method hmsInstance.addEventListener(HMSUpdateListenerActions.ON_ERROR, onError); const onError = (error: HMSException) => { if (Platform.OS === 'android') { if (data?.code === 4005 || data?.code === 1003) { destroy(); } } else { if (data?.code === 2000) { destroy(); } } };

HMSException Properties

isTerminal

The isTerminal property denotes wether error has caused the current session to terminate and the app will need to call join again to reconnect.

description

The description property denotes what is the source of the error.

code

The code property denotes error code which a unique identifier for the error.

canRetry

It is a iOS only property. The canRetry property denotes wether app can call join again with the same configuration it has used before. The value be false in cases like token expiring or room getting locked. You can use this property while implementing infinite retry in your app.

message

It is a android only property. The message property denotes error information.

name

It is a android only property. The name property denotes error name.

action

It is a android only property. The action property tells what to do when a error occurs. For example SEND_ALL_REQUIRED_KEYS means you have not sent some required key in the API call

Following are the different error codes that are returned in the callback . Before returning any error code, it retries the errors (whichever is possible).

Error CodeCause of the errorAction to be taken
1003Websocket disconnected - Happens due to network issuesMention user to check their network connection or try again after some time.
2002Invalid Endpoint URLCheck the endpoint provided while calling join on HMSSDK.
2003Endpoint is not reachableMention user to check their network connection or try again after some time.
2004Token is not in proper JWT formatThe token passed while calling join is not in correct format. Retry getting a new token.
3001Cant Access Capture DeviceAsk user to check permission granted to audio/video capture devices.
3002Capture Device is not AvailableAsk user to check if the audio/video capture device is connected or not.
3003Capture device is in use by some other application.Show notification to user mentioning that the capturing device is used by some other application currently.
3008Browser has thrown an auto-play exception.Show notification to user mentioning that the browser blocked auto-play.
3012BLUETOOTH_CONNECT permission is not given.Add the BLUETOOTH_CONNECT permission to your app and request it at runtime since it's a dangerous level permission.
3013BLUETOOTH permission is not given.Add the BLUETOOTH permission to your app.
4001WebRTC errorSome webRTC error has occurred. Need more logs to debug.
4002WebRTC errorSome webRTC error has occurred. Need more logs to debug.
4003WebRTC errorSome webRTC error has occurred. Need more logs to debug.
4004WebRTC errorSome webRTC error has occurred. Need more logs to debug.
4005ICE Connection Failed due to network issueMention user to check their network connection or try again after some time.
5001Trying to join a room which is already joinedTrying to join an already joined room.
6002webRTC Error: Error while renegotiatingPlease try again.
40101Token Error: Invalid Access KeyAccess Key provided in the token is wrong.
40102Token Error: Invalid Room IdRoomID provided in the token is wrong.
40103Token Error: Invalid Auth IdAuthID provided in the token is wrong.
40104Token Error: Invalid App IdApp ID provided in the token is wrong.
40105Token Error: Invalid Customer IdCustomer Id provided in the token is wrong.
40107Token Error: Invalid User IdUser ID provided in the token is wrong.
40108Token Error: Invalid RoleThe role provided in the token is wrong.
40109Token Error: Bad JWT TokenBad JWT Token.
40100Generic ErrorNeed to debug further with logs.
40001Invalid RoomRoom ID provided while fetching the token is an invalid room.
40002Room Mismatched with TokenRoom ID provided while fetching the token does not match.
40004Peer already joinedPeer who is trying to join has already joined the room.
41001Peer is goneThe peer is no more present in the room.
7001Platform Not SupportedThe platform is not supported for plugin
7002Plugin Init FailedPlugin initialization has failed
7003Plugin Processing FailedPlugin processing failed
7004Plugin Add Already Going onPlugin add is already in progress