Error Events - iOS
VideoSDK provides onError
event which will notify you of any error happening during the meeting.
onError
- This event will be triggered whenever any invalid configuration provided or server/network errors arise, this event will trigger with a specific error code and message.
- This event is helpful for development level troubleshooting while integrating SDK.
- You can implement this method of the abstract Class
MeetingEventListener
and add the listener toMeeting
class using theaddEventListener()
method ofMeeting
Class.
Example
- Swift
import VideoSDKRTC
extension MeetingViewController: MeetingEventListener {
func onError(error: VideoSDKError) {
switch error {
case .INVALID_TOKEN: print("Invalid Token")
case .INVALID_MEETING_ID: print("Invalid Meeting Id")
case .INVALID_API_KEY: print("Invalid API Key")
case .INVALID_PERMISSIONS: print("Invalid Permissions")
case .INVALID_PARTICIPANT_ID: print("Invalid Participant ID")
...
}
}
}
Error Codes
We have depicted a specific constant with code and message in the below table.
1. Errors associated with Organization
This table lists errors that occur due to the configuration and limitations within your organization’s account. These include account status, participant limits, and add-on service availability.
Type | Code | Message |
---|---|---|
ACCOUNT_DEACTIVATED | 4006 | Your account has been deactivated. Please contact VideoSDK support. |
ACCOUNT_DISCONTINUED | 4007 | Your account has been discontinued. Please reach out to support for more details. |
MAX_PARTICIPANT_REACHED | 4009 | You have reached the maximum participant limit for this meeting. |
MAX_SPEAKER_REACHED | 4010 | The maximum number of speakers for this meeting has been reached. |
MAX_SPEAKER_LIMIT_REACHED_ON_ORGANIZATION | 4026 | Your organization has reached the maximum number of speakers allowed. |
MAX_VIEWER_LIMIT_REACHED_ON_ORGANIZATION | 4027 | Your organization has reached the maximum number of viewers allowed. |
ADD_ON_SERVICES_DISABLED | 4021 | Add-On services have been disabled. Please contact support to enable them. |
MAX_RECORDING_LIMIT_REACHED_ON_ORGANIZATION | 4028 | You have reached max limit of recording on organization. To increase contact at support@videosdk.live |
MAX_HLS_LIMIT_REACHED_ON_ORGANIZATION | 4029 | You have reached max limit of hls on organization. To increase contact at support@videosdk.live |
MAX_LIVESTREAM_LIMIT_REACHED_ON_ORGANIZATION | 4030 | You have reached max limit of livestream on organization. To increase contact at support@videosdk.live |
2. Errors associated with Token
Errors listed here are related to issues with the API key, authentication tokens, or permissions assigned to users. These errors can occur when tokens are missing, expired, or improperly configured.
Type | Code | Message |
---|---|---|
INVALID_API_KEY | 4001 | The provided API key is either missing or invalid. |
INVALID_TOKEN | 4002 | The provided token is empty, invalid, or has expired. |
INVALID_PERMISSIONS | 4008 | The permissions in the token are incorrect. Please verify them. |
UNAUTHORIZED_MEETING_ID | 4022 | The provided token is not authorized for this meeting ID. |
UNAUTHORIZED_PARTICIPANT_ID | 4023 | The provided token is not authorized for this participant ID. |
UNAUTHORIZED_ROLE | 4024 | The role specified in the token is not valid for joining this meeting. |
UNAUTHORIZED_REQUEST | 4025 | Your request does not match the security configuration. |
3. Errors associated with Meeting and Participant
This table lists errors resulting from invalid or missing meeting or participant details, including cases where a participant attempts to join with a duplicate ID.
Type | Code | Message |
---|---|---|
INVALID_MEETING_ID | 4003 | The meeting ID provided is either invalid or missing. |
INVALID_PARTICIPANT_ID | 4004 | The participant ID is either invalid or missing. |
DUPLICATE_PARTICIPANT | 4005 | This participant has joined from another device. |
4. Errors associated with Add-on Service
This section addresses errors that occur while using VideoSDK's add-on services such as recording, livestreaming, HLS streaming, and transcription.
Recording-related errors
Type | Code | Message |
---|---|---|
START_RECORDING_FAILED | 4011 | Failed to start recording. Please try again. |
STOP_RECORDING_FAILED | 4012 | Failed to stop recording. Please try again. |
RECORDING_FAILED | 5001 | Recording was stopped due to an error. |
START_PARTICIPANT_RECORDING_FAILED | 4035 | Failed to start participant recording. Please check the request. |
STOP_PARTICIPANT_RECORDING_FAILED | 4036 | Failed to stop participant recording. |
PARTICIPANT_RECORDING_FAILED | 5012 | Participant recording has stopped due to an error. |
START_TRACK_RECORDING_FAILED | 4037 | Failed to start track recording. |
STOP_TRACK_RECORDING_FAILED | 4038 | Failed to stop track recording. |
TRACK_RECORDING_FAILED | 5013 | Track recording stopped due to an unknown error. |
PREV_RECORDING_PROCESSING | 4018 | Previous recording session is being processed, please try again after few seconds. |
RECORDING_DURATION_LIMIT_REACHED | 5004 | Recording stopped due to maximum duration being reached. |
Livestream-related errors
Type | Code | Message |
---|---|---|
INVALID_LIVESTREAM_CONFIG | 4015 | Livestream 'outputs' configuration provided was invalid |
START_LIVESTREAM_FAILED | 4013 | Failed to start livestream. Please try again. |
STOP_LIVESTREAM_FAILED | 4014 | Failed to stop livestream. Please try again. |
LIVESTREAM_FAILED | 5002 | Livestream stopped due to an error. |
PREV_RTMP_RECORDING_PROCESSING | 4019 | Previous RTMP recording session is being processed, please try again after few seconds! |
LIVESTREAM_DURATION_LIMIT_REACHED | 5005 | Livestream stopped due to maximum duration being reached. |
HLS-related errors
Type | Code | Message |
---|---|---|
START_HLS_FAILED | 4016 | Failed to start HLS stream. |
STOP_HLS_FAILED | 4017 | Failed to stop HLS stream. |
HLS_FAILED | 5003 | HLS streaming stopped due to an error. |
PREV_HLS_STREAMING_PROCESSING | 4020 | Previous HLS streaming session is still being processed. |
HLS_DURATION_LIMIT_REACHED | 5006 | HLS stream stopped due to maximum duration being reached. |
Transcription-related errors
Type | Code | Message |
---|---|---|
START_TRANSCRIPTION_FAILED | 4031 | Failed to start transcription. Please try again. |
STOP_TRANSCRIPTION_FAILED | 4032 | Failed to stop transcription. |
TRANSCRIPTION_FAILED | 5007 | Transcription stopped due to an error. |
5.Errors associated with Media
These errors involve media access, device availability, or permission-related issues affecting camera, microphone, and screen sharing.
Device permission-related errors
Type | Code | Message |
---|---|---|
ERROR_GET_VIDEO_MEDIA_PERMISSION_DENIED | 3014 | Video capture permission denied. |
ERROR_GET_AUDIO_MEDIA_PERMISSION_DENIED | 3015 | Audio capture permission denied. |
ERROR_GET_DISPLAY_MEDIA_PERMISSION_DENIED | 3016 | Screen sharing permission denied. |
ERROR_RN_CAMERA_ACCESS_DENIED_OR_DISMISSED | 3017 | Oops! It seems like camera access was denied or dismissed. To proceed, kindly grant access through your App settings. |
Device-related errors
Type | Code | Message |
---|---|---|
ERROR_GET_VIDEO_MEDIA | 3011 | Your browser/Device does not support Video. |
ERROR_GET_AUDIO_MEDIA | 3012 | Your browser/Device does not support Audio. |
ERROR_GET_DISPLAY_MEDIA | 3013 | Your browser/Device does not support Screen Sharing. |
API Reference
The API references for all the methods and events utilised in this guide are provided below.
Got a Question? Ask us on discord