MediaError

new MediaError(value)

A Custom MediaError class which mimics the standard HTML5 MediaError class.

Parameters:
NameTypeDescription
valuenumber | string | Object | MediaError

This can be of multiple types: - number: should be a standard error code - string: an error message (the code will be 0) - Object: arbitrary properties - MediaError (native): used to populate a video.js MediaError object - MediaError (video.js): will return itself if it's already a video.js MediaError object.

Source
See

Members

(static, constant) defaultMessages :Array

The default MediaError messages based on the MediaError.errorTypes.

Type:
  • Array
Source

(static, readonly) errorTypes :array

Errors indexed by the W3C standard. The order CANNOT CHANGE! See the specification listed under MediaError for more information.

Type:
  • array
Properties
NameTypeDescription
0string

MEDIA_ERR_CUSTOM

1string

MEDIA_ERR_ABORTED

2string

MEDIA_ERR_NETWORK

3string

MEDIA_ERR_DECODE

4string

MEDIA_ERR_SRC_NOT_SUPPORTED

5string

MEDIA_ERR_ENCRYPTED

Source

(static, constant) MEDIA_ERR_ABORTED :number

W3C error code for media error aborted.

Type:
  • number
Default Value
  • 1
Source

(static, constant) MEDIA_ERR_CUSTOM :number

W3C error code for any custom error.

Type:
  • number
Default Value
  • 0
Source

(static, constant) MEDIA_ERR_DECODE :number

W3C error code for any decoding error.

Type:
  • number
Default Value
  • 3
Source

(static, constant) MEDIA_ERR_ENCRYPTED :number

W3C error code for any time that a source is encrypted.

Type:
  • number
Default Value
  • 5
Source

(static, constant) MEDIA_ERR_NETWORK :number

W3C error code for any network error.

Type:
  • number
Default Value
  • 2
Source

(static, constant) MEDIA_ERR_SRC_NOT_SUPPORTED :number

W3C error code for any time that a source is not supported.

Type:
  • number
Default Value
  • 4
Source

code :Number

The error code that refers two one of the defined MediaError types

Type:
  • Number
Source

(constant) MEDIA_ERR_ABORTED :number

W3C error code for media error aborted.

Type:
  • number
Default Value
  • 1
Source

(constant) MEDIA_ERR_CUSTOM :number

W3C error code for any custom error.

Type:
  • number
Default Value
  • 0
Source

(constant) MEDIA_ERR_DECODE :number

W3C error code for any decoding error.

Type:
  • number
Default Value
  • 3
Source

(constant) MEDIA_ERR_ENCRYPTED :number

W3C error code for any time that a source is encrypted.

Type:
  • number
Default Value
  • 5
Source

(constant) MEDIA_ERR_NETWORK :number

W3C error code for any network error.

Type:
  • number
Default Value
  • 2
Source

(constant) MEDIA_ERR_SRC_NOT_SUPPORTED :number

W3C error code for any time that a source is not supported.

Type:
  • number
Default Value
  • 4
Source

message :String

An optional message that to show with the error. Message is not part of the HTML5 video spec but allows for more informative custom errors.

Type:
  • String
Source

metadata :ErrorMetadata

An optional object to give more detail about the error. This can be used to give a higher level of specificity to an error versus the more generic MediaError codes. metadata expects an errorType string that should align with the values from videojs.Error.

Type:
  • ErrorMetadata
Source

status :Array

An optional status code that can be set by plugins to allow even more detail about the error. For example a plugin might provide a specific HTTP status code and an error message for that code. Then when the plugin gets that error this class will know how to display an error message for it. This allows a custom message to show up on the Player error overlay.

Type:
  • Array
Source