API Docs for: 0.2.41
Show:

Events Class

Defined in: src/base/events.js:47
Module: base

Constructor

Events

()

Methods

listenTo

(
  • obj
  • name
  • callback
  • context
)

listen to an event indefinitely for a given obj

Parameters:

Example:

this.listenTo(this.core.playback, Events.PLAYBACK_PAUSE, this.callback)

listenToOnce

(
  • obj
  • name
  • callback
  • context
)

listen to an event once for a given obj

Parameters:

Example:

this.listenToOnce(this.core.playback, Events.PLAYBACK_PAUSE, this.callback)

off

(
  • name
  • callback
  • context
)

stop listening to an event

Parameters:

on

(
  • name
  • callback
  • context
)

listen to an event indefinitely, if you want to stop you need to call off

Parameters:

once

(
  • name
  • callback
  • context
)

listen to an event only once

Parameters:

stopListening

(
  • obj
  • name
  • callback
)

stop listening an event for a given object

Parameters:

trigger

(
  • name
)

triggers an event given its name

Parameters:

Events

CONTAINER_BITRATE

Fired when the container updates its bitrate

Event Payload:

  • bitrate Object

    Data bitrate object

    • [bandwidth] Number optional

      bitrate bandwidth when it's available

    • [width] Number optional

      playback width (ex: 720, 640, 1080)

    • [height] Number optional

      playback height (ex: 240, 480, 720)

    • [level] Number optional

      playback level when it's available, it could be just a map for width (0 => 240, 1 => 480, 2 => 720)

CONTAINER_HIGHDEFINITIONUPDATE

Fired when container updates its video quality

Event Payload:

  • isHD true Boolean

    when is on HD, false otherwise

CONTAINER_LOADEDMETADATA

Fired when the container loaded its metadata

Event Payload:

  • metadata Object

    Data settings object

    • [duration] Number optional

      the playback duration

    • [data] Object optional

      extra meta data

CONTAINER_MEDIACONTROL_HIDE

Fired when the media control hides

CONTAINER_MEDIACONTROL_SHOW

Fired when the media control shows

CONTAINER_OPTIONS_CHANGE

Fired when the options were changed for the container

CONTAINER_PLAYBACKSTATE

Fired when the container internal state changes

Event Payload:

  • state Object

    Data state object

    • [type] String optional

      the playback type

CONTAINER_PROGRESS

Fired when the container is downloading the media

Event Payload:

  • progress Object

    Data progress object

    • [start] Number optional

      initial downloaded content

    • [current] Number optional

      current dowloaded content

    • [total] Number optional

      total content to be downloaded

CONTAINER_READY

Fired when the container is ready

CONTAINER_SEEK

Fired when the container seeks the video

Event Payload:

  • time Number

    the current time in seconds

CONTAINER_SETTINGSUPDATE

Fired when the container changes any settings (volume, seek and etc)

CONTAINER_STATE_BUFFERFULL

Fired when the container filled the buffer

CONTAINER_STATE_BUFFERING

Fired when container is buffering

CONTAINER_TIMEUPDATE

Fired when the time is updated on container

Event Payload:

  • progress Object

    Data progress object

    • [current] Number optional

      current time

    • [total] Number optional

      total time

CORE_OPTIONS_CHANGE

Fired when the options were changed for the core

CORE_READY

Fired after creating containers, when the core is ready

CORE_READY

Fired when the fullscreen state change

Event Payload:

  • whether Boolean

    or not the player is on fullscreen mode

MEDIACONTROL_CONTAINERCHANGED

Fired when the container was changed

MEDIACONTROL_FULLSCREEN

Fired when the player enters/exit on fullscreen

MEDIACONTROL_HIDE

Fired when the media control hides

MEDIACONTROL_MOUSELEAVE_SEEKBAR

Fired when mouse leaves the seekbar

Event Payload:

  • event the Object

    javascript event

MEDIACONTROL_MOUSEMOVE_SEEKBAR

Fired when mouse enters on the seekbar

Event Payload:

  • event the Object

    javascript event

MEDIACONTROL_NOTPLAYING

Fired when the media is not being played

MEDIACONTROL_PLAYING

Fired when the media is being played

MEDIACONTROL_SHOW

Fired when the media control shows

PLAYBACK_BITRATE

Fired when playback updates its bitrate

Event Payload:

  • bitrate Object

    Data bitrate object

    • [bandwidth] Number optional

      bitrate bandwidth when it's available

    • [width] Number optional

      playback width (ex: 720, 640, 1080)

    • [height] Number optional

      playback height (ex: 240, 480, 720)

    • [level] Number optional

      playback level when it's available, it could be just a map for width (0 => 240, 1 => 480, 2 => 720)

PLAYBACK_BUFFERFULL

Fired when the playback has enough in the buffer to be able to play smoothly, after previously being unable to do this.

This corresponds to the playback buffering property being false.

PLAYBACK_BUFFERING

Fired when the playback starts having to buffer because playback can currently not be smooth.

This corresponds to the playback buffering property being true.

PLAYBACK_DVR

Fired when DVR becomes enabled/disabled.

Event Payload:

  • state Boolean

    true if dvr enabled

PLAYBACK_ENDED

Fired when the media for a playback ends.

Event Payload:

  • name String

    the name of the playback

PLAYBACK_ERROR

Fired if an error occurs in the playback.

Event Payload:

  • error Object

    An object containing the error details

  • name String

    Playback name

PLAYBACK_HIGHDEFINITIONUPDATE

Fired when playback updates its video quality

Event Payload:

  • isHD true Boolean

    when is on HD, false otherwise

PLAYBACK_LEVEL_SWITCH_END

Fired when the playback ends the level switch

PLAYBACK_LEVEL_SWITCH_START

Fired when the playback starts to switch level

PLAYBACK_LEVELS_AVAILABLE

Fired when the playback has its levels

Event Payload:

  • levels the Array

    ordered levels, each one with the following format {id: 1, label: '500kbps'} ps: id should be a number >= 0

  • initial the Number

    initial level otherwise -1 (AUTO)

PLAYBACK_LOADEDMETADATA

Fired when playback loaded its metadata

Event Payload:

  • metadata Object

    Data settings object

    • [duration] Number optional

      the playback duration

    • [data] Object optional

      extra meta data

PLAYBACK_PAUSE

Fired when the media for a playback pauses.

PLAYBACK_PLAY

Fired when the media for a playback starts playing. This is not necessarily when the user requests play() The media may have to buffer first. I.e. isPlaying() might return true before this event is fired, because isPlaying() represents the intended state.

PLAYBACK_PLAY_INTENT

Fired when user requests play()

PLAYBACK_PLAYBACKSTATE

Fired when playback internal state changes

Event Payload:

  • state Object

    Data state object

    • [type] String optional

      the playback type

PLAYBACK_PROGRESS

Fired when the playback is downloading the media

Event Payload:

  • progress Object

    Data progress object

    • [start] Number optional

      initial downloaded content

    • [current] Number optional

      current dowloaded content

    • [total] Number optional

      total content to be downloaded

PLAYBACK_READY

Fired when playback is ready

PLAYBACK_SETTINGSUPDATE

Fired when playback changes any settings (volume, seek and etc)

PLAYBACK_STOP

Fired when the media for a playback is stopped.

PLAYBACK_TIMEUPDATE

Fired when the time is updated on playback

Event Payload:

  • progress Object

    Data progress object

    • [current] Number optional

      current time

    • [total] Number optional

      total time

PLAYER_ENDED

Fired when player ends the video

PLAYER_ERROR

Fired when player receives an error

Event Payload:

PLAYER_FULLSCREEN

Fired when player changes its fullscreen state

Event Payload:

  • whether Boolean

    or not the player is on fullscreen mode

PLAYER_PAUSE

Fired when player pauses

PLAYER_PLAY

Fired when player starts to play

PLAYER_READY

Fired when the player is ready on startup

PLAYER_RESIZE

Fired when player resizes

Event Payload:

  • currentSize Object

    an object with the current size

PLAYER_SEEK

Fired when player seeks the video

Event Payload:

  • time Number

    the current time in seconds

PLAYER_STOP

Fired when player stops

PLAYER_TIMEUPDATE

Fired when the time is updated on player

Event Payload:

  • progress Object

    Data progress object

    • [current] Number optional

      current time

    • [total] Number optional

      total time

PLAYER_VOLUMEUPDATE

Fired when player updates its volume

Event Payload:

  • volume Number

    the current volume