Error Handling and Notifications
error
Error events are emitted when a connection cannot be established. These events provide critical information about the nature of connection failures, allowing developers to implement appropriate error handling strategies. The SDK throws these errors for various scenarios including device access issues, meeting restrictions, and network connectivity problems.
{
type: 'error',
name
}
| Error Name | Description |
|---|---|
devices, permission, not_readable | No media device is available for access. Note that an audio device is required for joining a meeting. |
session_in_use | A session with the same access-key is currently active. |
meeting_locked | The meeting is locked and no new participants are allowed to join. |
abrupt_disconnect | Critical connections have unexpectedly dropped and could not be automatically re-established. |
request_too_large | Problem occurred during Interactive Connectivity Establishment (ICE) at the beginning of the session. |
ice_failed | The active peer connection has dropped, resulting in no audio/video transmission. |
ice_error | Unable to establish the peer connection to the meeting server. |
session_failed | Generic error indicating the session has failed unexpectedly and has not been able to reconnect. |
warning
Warning events are emitted when non-critical issues are detected during a meeting. These events provide information about potential problems that may affect the user experience but don't necessarily prevent the meeting from functioning. Warnings allow developers to implement appropriate user notifications or fallback strategies.
{
type: 'warning',
name
}
The following warnings are sent by the Eyeson room.
| Warning Name | Description |
|---|---|
ice_disconnected | Interactive Connectivity Establishment (ICE) protocol reports the user's connection is lost. Consider displaying an "offline" warning to your client. |
error:comapi | Request to Communication API (ComAPI) has failed. |
error_NotReadableError | Automatic device mediastream allocation failed because the device is not readable. |
error_DevicesNotFoundError | Automatic device mediastream allocation failed because no devices were found. |
error_NotFoundError | Automatic device mediastream allocation failed because the requested device was not found. |
clear_warning
Clear_warning events are emitted when an issue that previously triggered a warning has been resolved. The name property identifies which specific warning condition has been cleared, allowing developers to update the user interface accordingly or resume normal operation of affected features.
{
type: 'clear_warning',
name
}