Errors are used to notify a user when a critical issue has occurred or to log recoverable issues. An error object consists of three mandatory parameters:
- Error Severity
- Error Category
- Error Code
- Error Custom Data - An optional object with additional information about the issue.
There are two severities to an error:
- A critical error is triggered in an error event and is shown to the user as error overlay in the player itself.
- A recoverable error is not shown to an end user, but appears in the console.
You’ll find the full lists of errors here:
You can listen to errors the player emits by listening to an ‘
error’ event as follows:
If you wish to change / emit an error event, you’ll need to create an error object in the following manner:
Next, you’ll need to dispatch an
You can find additional information about dispatching events here.
Use the debug mode in the player to view explicit error messages in the console, which look something like this:
[Error] Category:1 | Code:1002 | 'Http Error'
You can find additional information about debugging and troubleshooting the player here.