clappr

{ "project": { "name": "Clappr", "description": "An extensible media player for the web", "version": "0.2.41", "url": "https://github.com/clappr/clappr", "logo": "https://cloud.githubusercontent.com/assets/244265/6373134/a845eb50-bce7-11e4-80f2-592ba29972ab.png" }, "files": { "src/base/base_object.js": { "name": "src/base/base_object.js", "modules": { "base": 1 }, "classes": { "BaseObject": 1 }, "fors": {}, "namespaces": {} }, "src/base/container_plugin.js": { "name": "src/base/container_plugin.js", "modules": {}, "classes": { "ContainerPlugin": 1 }, "fors": {}, "namespaces": {} }, "src/base/events.js": { "name": "src/base/events.js", "modules": {}, "classes": { "Events": 1 }, "fors": {}, "namespaces": {} }, "src/base/playback.js": { "name": "src/base/playback.js", "modules": {}, "classes": { "Playback": 1 }, "fors": {}, "namespaces": {} }, "src/base/ui_container_plugin.js": { "name": "src/base/ui_container_plugin.js", "modules": {}, "classes": { "UIContainerPlugin": 1 }, "fors": {}, "namespaces": {} }, "src/base/ui_object.js": { "name": "src/base/ui_object.js", "modules": {}, "classes": { "UIObject": 1 }, "fors": {}, "namespaces": {} }, "src/components/container/container.js": { "name": "src/components/container/container.js", "modules": {}, "classes": { "Container": 1 }, "fors": {}, "namespaces": {} }, "src/components/container_factory/container_factory.js": { "name": "src/components/container_factory/container_factory.js", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} }, "src/components/core/core.js": { "name": "src/components/core/core.js", "modules": { "components": 1 }, "classes": { "Core": 1 }, "fors": {}, "namespaces": {} }, "src/components/core_factory/core_factory.js": { "name": "src/components/core_factory/core_factory.js", "modules": {}, "classes": { "CoreFactory": 1 }, "fors": {}, "namespaces": {} }, "src/components/loader/loader.js": { "name": "src/components/loader/loader.js", "modules": {}, "classes": { "Loader": 1 }, "fors": {}, "namespaces": {} }, "src/components/media_control/media_control.js": { "name": "src/components/media_control/media_control.js", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} }, "src/components/mediator.js": { "name": "src/components/mediator.js", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} }, "src/components/player.js": { "name": "src/components/player.js", "modules": {}, "classes": { "Player": 1 }, "fors": {}, "namespaces": {} }, "src/playbacks/flash/flash.js": { "name": "src/playbacks/flash/flash.js", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} }, "src/playbacks/flashls/flashls.js": { "name": "src/playbacks/flashls/flashls.js", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} }, "src/playbacks/html5_video/html5_video.js": { "name": "src/playbacks/html5_video/html5_video.js", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} } }, "modules": { "base": { "name": "base", "submodules": {}, "classes": { "BaseObject": 1, "ContainerPlugin": 1, "Events": 1, "Playback": 1, "UIContainerPlugin": 1, "UIObject": 1, "Container": 1 }, "fors": {}, "namespaces": {}, "tag": "module", "file": "src/components/container/container.js", "line": 16 }, "components": { "name": "components", "submodules": {}, "classes": { "Core": 1, "CoreFactory": 1, "Loader": 1, "Player": 1 }, "fors": {}, "namespaces": {}, "tag": "module", "file": "src/components/player.js", "line": 18, "description": "The Core is responsible to manage Containers, the mediator, MediaControl\nand the player state." } }, "classes": { "BaseObject": { "name": "BaseObject", "shortname": "BaseObject", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "base", "file": "src/base/base_object.js", "line": 8, "is_constructor": 1, "extends": "Events" }, "ContainerPlugin": { "name": "ContainerPlugin", "shortname": "ContainerPlugin", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "base", "namespace": "", "file": "src/base/container_plugin.js", "line": 4, "description": "The base class for a container plugin", "is_constructor": 1, "extends": "UIObject" }, "Events": { "name": "Events", "shortname": "Events", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "base", "namespace": "", "file": "src/base/events.js", "line": 47, "is_constructor": 1 }, "Playback": { "name": "Playback", "shortname": "Playback", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "base", "namespace": "", "file": "src/base/playback.js", "line": 4, "description": "An abstraction to represent a generic playback, it's like an interface to be implemented by subclasses.", "is_constructor": 1, "extends": "UIObject" }, "UIContainerPlugin": { "name": "UIContainerPlugin", "shortname": "UIContainerPlugin", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "base", "namespace": "", "file": "src/base/ui_container_plugin.js", "line": 9, "description": "The base class for an ui container plugin", "is_constructor": 1, "extends": "UIObject" }, "UIObject": { "name": "UIObject", "shortname": "UIObject", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "base", "namespace": "", "file": "src/base/ui_object.js", "line": 12, "description": "A base class to create ui object.", "is_constructor": 1, "extends": "BaseObject" }, "Container": { "name": "Container", "shortname": "Container", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "base", "namespace": "", "file": "src/components/container/container.js", "line": 16, "description": "An abstraction to represent a container for a given playback\nTODO: describe its responsabilities", "is_constructor": 1, "extends": "UIObject" }, "Core": { "name": "Core", "shortname": "Core", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "components", "namespace": "", "file": "src/components/core/core.js", "line": 21, "description": "The Core is responsible to manage Containers, the mediator, MediaControl\nand the player state.", "is_constructor": 1, "extends": "UIObject" }, "CoreFactory": { "name": "CoreFactory", "shortname": "CoreFactory", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "components", "namespace": "", "file": "src/components/core_factory/core_factory.js", "line": 8, "description": "The Core Factory is responsible for instantiate the core and it's plugins.", "is_constructor": 1, "extends": "BaseObject" }, "Loader": { "name": "Loader", "shortname": "Loader", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "components", "namespace": "", "file": "src/components/loader/loader.js", "line": 33, "description": "It keeps a list of the default plugins (playback, container, core) and it merges external plugins with its internals.", "is_constructor": 1, "extends": "BaseObject" }, "Player": { "name": "Player", "shortname": "Player", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "components", "namespace": "", "file": "src/components/player.js", "line": 18, "is_constructor": 1, "extends": "BaseObject", "example": [ "\n### Using the Player\n\nAdd the following script on your HTML:\n```html\n<head>\n <script type=\"text/javascript\" src=\"http://cdn.clappr.io/latest/clappr.min.js\"></script>\n</head>\n```\nNow, create the player:\n```html\n<body>\n <div id=\"player\"></div>\n <script>\n var player = new Clappr.Player({source: \"http://your.video/here.mp4\", parentId: \"#player\"});\n </script>\n</body>\n```" ] } }, "classitems": [ { "file": "src/base/base_object.js", "line": 15, "itemtype": "method", "name": "constructor", "params": [ { "name": "options", "description": "", "type": "Object" } ], "class": "BaseObject", "module": "base" }, { "file": "src/base/base_object.js", "line": 23, "description": "a unique id prefixed with `'o'`, `o1, o232`", "itemtype": "property", "name": "uniqueId", "type": "String", "class": "BaseObject", "module": "base" }, { "file": "src/base/container_plugin.js", "line": 19, "description": "provides the read-only options to the container plugin", "itemtype": "property", "name": "options", "type": "Object", "default": "\"`{}`\"", "class": "ContainerPlugin", "module": "base" }, { "file": "src/base/events.js", "line": 53, "description": "listen to an event indefinitely, if you want to stop you need to call `off`", "itemtype": "method", "name": "on", "params": [ { "name": "name", "description": "", "type": "String" }, { "name": "callback", "description": "", "type": "Function" }, { "name": "context", "description": "", "type": "Object" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 68, "description": "listen to an event only once", "itemtype": "method", "name": "once", "params": [ { "name": "name", "description": "", "type": "String" }, { "name": "callback", "description": "", "type": "Function" }, { "name": "context", "description": "", "type": "Object" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 86, "description": "stop listening to an event", "itemtype": "method", "name": "off", "params": [ { "name": "name", "description": "", "type": "String" }, { "name": "callback", "description": "", "type": "Function" }, { "name": "context", "description": "", "type": "Object" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 122, "description": "triggers an event given its `name`", "itemtype": "method", "name": "trigger", "params": [ { "name": "name", "description": "", "type": "String" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 144, "description": "stop listening an event for a given object", "itemtype": "method", "name": "stopListening", "params": [ { "name": "obj", "description": "", "type": "Object" }, { "name": "name", "description": "", "type": "String" }, { "name": "callback", "description": "", "type": "Function" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 167, "description": "listen to an event indefinitely for a given `obj`", "itemtype": "method", "name": "listenTo", "params": [ { "name": "obj", "description": "", "type": "Object" }, { "name": "name", "description": "", "type": "String" }, { "name": "callback", "description": "", "type": "Function" }, { "name": "context", "description": "", "type": "Object" } ], "example": [ "\n```javascript\nthis.listenTo(this.core.playback, Events.PLAYBACK_PAUSE, this.callback)\n```" ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 179, "description": "listen to an event once for a given `obj`", "itemtype": "method", "name": "listenToOnce", "params": [ { "name": "obj", "description": "", "type": "Object" }, { "name": "name", "description": "", "type": "String" }, { "name": "callback", "description": "", "type": "Function" }, { "name": "context", "description": "", "type": "Object" } ], "example": [ "\n```javascript\nthis.listenToOnce(this.core.playback, Events.PLAYBACK_PAUSE, this.callback)\n```" ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 205, "description": "Fired when the player is ready on startup", "itemtype": "event", "name": "PLAYER_READY", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 211, "description": "Fired when player resizes", "itemtype": "event", "name": "PLAYER_RESIZE", "params": [ { "name": "currentSize", "description": "an object with the current size", "type": "Object" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 218, "description": "Fired when player changes its fullscreen state", "itemtype": "event", "name": "PLAYER_FULLSCREEN", "params": [ { "name": "whether", "description": "or not the player is on fullscreen mode", "type": "Boolean" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 225, "description": "Fired when player starts to play", "itemtype": "event", "name": "PLAYER_PLAY", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 231, "description": "Fired when player pauses", "itemtype": "event", "name": "PLAYER_PAUSE", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 237, "description": "Fired when player stops", "itemtype": "event", "name": "PLAYER_STOP", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 243, "description": "Fired when player ends the video", "itemtype": "event", "name": "PLAYER_ENDED", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 249, "description": "Fired when player seeks the video", "itemtype": "event", "name": "PLAYER_SEEK", "params": [ { "name": "time", "description": "the current time in seconds", "type": "Number" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 256, "description": "Fired when player receives an error", "itemtype": "event", "name": "PLAYER_ERROR", "params": [ { "name": "error", "description": "the error", "type": "Object" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 263, "description": "Fired when the time is updated on player", "itemtype": "event", "name": "PLAYER_TIMEUPDATE", "params": [ { "name": "progress", "description": "Data\nprogress object", "type": "Object", "props": [ { "name": "current", "description": "\ncurrent time", "type": "Number", "optional": true }, { "name": "total", "description": "\ntotal time", "type": "Number", "optional": true } ] } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 275, "description": "Fired when player updates its volume", "itemtype": "event", "name": "PLAYER_VOLUMEUPDATE", "params": [ { "name": "volume", "description": "the current volume", "type": "Number" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 284, "description": "Fired when the playback is downloading the media", "itemtype": "event", "name": "PLAYBACK_PROGRESS", "params": [ { "name": "progress", "description": "Data\nprogress object", "type": "Object", "props": [ { "name": "start", "description": "\ninitial downloaded content", "type": "Number", "optional": true }, { "name": "current", "description": "\ncurrent dowloaded content", "type": "Number", "optional": true }, { "name": "total", "description": "\ntotal content to be downloaded", "type": "Number", "optional": true } ] } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 298, "description": "Fired when the time is updated on playback", "itemtype": "event", "name": "PLAYBACK_TIMEUPDATE", "params": [ { "name": "progress", "description": "Data\nprogress object", "type": "Object", "props": [ { "name": "current", "description": "\ncurrent time", "type": "Number", "optional": true }, { "name": "total", "description": "\ntotal time", "type": "Number", "optional": true } ] } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 310, "description": "Fired when playback is ready", "itemtype": "event", "name": "PLAYBACK_READY", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 316, "description": "Fired when the playback starts having to buffer because\nplayback can currently not be smooth.\n\nThis corresponds to the playback `buffering` property being\n`true`.", "itemtype": "event", "name": "PLAYBACK_BUFFERING", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 326, "description": "Fired when the playback has enough in the buffer to be\nable to play smoothly, after previously being unable to\ndo this.\n\nThis corresponds to the playback `buffering` property being\n`false`.", "itemtype": "event", "name": "PLAYBACK_BUFFERFULL", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 337, "description": "Fired when playback changes any settings (volume, seek and etc)", "itemtype": "event", "name": "PLAYBACK_SETTINGSUPDATE", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 343, "description": "Fired when playback loaded its metadata", "itemtype": "event", "name": "PLAYBACK_LOADEDMETADATA", "params": [ { "name": "metadata", "description": "Data\nsettings object", "type": "Object", "props": [ { "name": "duration", "description": "\nthe playback duration", "type": "Number", "optional": true }, { "name": "data", "description": "\nextra meta data", "type": "Object", "optional": true } ] } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 355, "description": "Fired when playback updates its video quality", "itemtype": "event", "name": "PLAYBACK_HIGHDEFINITIONUPDATE", "params": [ { "name": "isHD\ntrue", "description": "when is on HD, false otherwise", "type": "Boolean" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 363, "description": "Fired when playback updates its bitrate", "itemtype": "event", "name": "PLAYBACK_BITRATE", "params": [ { "name": "bitrate", "description": "Data\nbitrate object", "type": "Object", "props": [ { "name": "bandwidth", "description": "\nbitrate bandwidth when it's available", "type": "Number", "optional": true }, { "name": "width", "description": "\nplayback width (ex: 720, 640, 1080)", "type": "Number", "optional": true }, { "name": "height", "description": "\nplayback height (ex: 240, 480, 720)", "type": "Number", "optional": true }, { "name": "level", "description": "\nplayback level when it's available, it could be just a map for width (0 => 240, 1 => 480, 2 => 720)", "type": "Number", "optional": true } ] } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 379, "description": "Fired when the playback has its levels", "itemtype": "event", "name": "PLAYBACK_LEVELS_AVAILABLE", "params": [ { "name": "levels\nthe", "description": "ordered levels, each one with the following format `{id: 1, label: '500kbps'}` ps: id should be a number >= 0", "type": "Array" }, { "name": "initial\nthe", "description": "initial level otherwise -1 (AUTO)", "type": "Number" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 389, "description": "Fired when the playback starts to switch level", "itemtype": "event", "name": "PLAYBACK_LEVEL_SWITCH_START", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 396, "description": "Fired when the playback ends the level switch", "itemtype": "event", "name": "PLAYBACK_LEVEL_SWITCH_END", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 404, "description": "Fired when playback internal state changes", "itemtype": "event", "name": "PLAYBACK_PLAYBACKSTATE", "params": [ { "name": "state", "description": "Data\nstate object", "type": "Object", "props": [ { "name": "type", "description": "\nthe playback type", "type": "String", "optional": true } ] } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 414, "description": "Fired when DVR becomes enabled/disabled.", "itemtype": "event", "name": "PLAYBACK_DVR", "params": [ { "name": "state", "description": "true if dvr enabled", "type": "Boolean" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 425, "description": "Fired when the media for a playback ends.", "itemtype": "event", "name": "PLAYBACK_ENDED", "params": [ { "name": "name", "description": "the name of the playback", "type": "String" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 432, "description": "Fired when the media for a playback starts playing.\nThis is not necessarily when the user requests `play()`\nThe media may have to buffer first.\nI.e. `isPlaying()` might return `true` before this event is fired,\nbecause `isPlaying()` represents the intended state.", "itemtype": "event", "name": "PLAYBACK_PLAY", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 442, "description": "Fired when the media for a playback pauses.", "itemtype": "event", "name": "PLAYBACK_PAUSE", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 448, "description": "Fired when the media for a playback is stopped.", "itemtype": "event", "name": "PLAYBACK_STOP", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 454, "description": "Fired if an error occurs in the playback.", "itemtype": "event", "name": "PLAYBACK_ERROR", "params": [ { "name": "error", "description": "An object containing the error details", "type": "Object" }, { "name": "name", "description": "Playback name", "type": "String" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 469, "description": "Fired when the options were changed for the core", "itemtype": "event", "name": "CORE_OPTIONS_CHANGE", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 475, "description": "Fired after creating containers, when the core is ready", "itemtype": "event", "name": "CORE_READY", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 481, "description": "Fired when the fullscreen state change", "params": [ { "name": "whether", "description": "or not the player is on fullscreen mode", "type": "Boolean" } ], "itemtype": "event", "name": "CORE_READY", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 490, "description": "Fired when the container internal state changes", "itemtype": "event", "name": "CONTAINER_PLAYBACKSTATE", "params": [ { "name": "state", "description": "Data\nstate object", "type": "Object", "props": [ { "name": "type", "description": "\nthe playback type", "type": "String", "optional": true } ] } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 501, "description": "Fired when the container updates its bitrate", "itemtype": "event", "name": "CONTAINER_BITRATE", "params": [ { "name": "bitrate", "description": "Data\nbitrate object", "type": "Object", "props": [ { "name": "bandwidth", "description": "\nbitrate bandwidth when it's available", "type": "Number", "optional": true }, { "name": "width", "description": "\nplayback width (ex: 720, 640, 1080)", "type": "Number", "optional": true }, { "name": "height", "description": "\nplayback height (ex: 240, 480, 720)", "type": "Number", "optional": true }, { "name": "level", "description": "\nplayback level when it's available, it could be just a map for width (0 => 240, 1 => 480, 2 => 720)", "type": "Number", "optional": true } ] } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 519, "description": "Fired when the container is ready", "itemtype": "event", "name": "CONTAINER_READY", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 526, "description": "Fired when the container loaded its metadata", "itemtype": "event", "name": "CONTAINER_LOADEDMETADATA", "params": [ { "name": "metadata", "description": "Data\nsettings object", "type": "Object", "props": [ { "name": "duration", "description": "\nthe playback duration", "type": "Number", "optional": true }, { "name": "data", "description": "\nextra meta data", "type": "Object", "optional": true } ] } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 538, "description": "Fired when the time is updated on container", "itemtype": "event", "name": "CONTAINER_TIMEUPDATE", "params": [ { "name": "progress", "description": "Data\nprogress object", "type": "Object", "props": [ { "name": "current", "description": "\ncurrent time", "type": "Number", "optional": true }, { "name": "total", "description": "\ntotal time", "type": "Number", "optional": true } ] } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 550, "description": "Fired when the container is downloading the media", "itemtype": "event", "name": "CONTAINER_PROGRESS", "params": [ { "name": "progress", "description": "Data\nprogress object", "type": "Object", "props": [ { "name": "start", "description": "\ninitial downloaded content", "type": "Number", "optional": true }, { "name": "current", "description": "\ncurrent dowloaded content", "type": "Number", "optional": true }, { "name": "total", "description": "\ntotal content to be downloaded", "type": "Number", "optional": true } ] } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 573, "description": "Fired when the container seeks the video", "itemtype": "event", "name": "CONTAINER_SEEK", "params": [ { "name": "time", "description": "the current time in seconds", "type": "Number" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 582, "description": "Fired when container is buffering", "itemtype": "event", "name": "CONTAINER_STATE_BUFFERING", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 588, "description": "Fired when the container filled the buffer", "itemtype": "event", "name": "CONTAINER_STATE_BUFFERFULL", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 594, "description": "Fired when the container changes any settings (volume, seek and etc)", "itemtype": "event", "name": "CONTAINER_SETTINGSUPDATE", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 600, "description": "Fired when container updates its video quality", "itemtype": "event", "name": "CONTAINER_HIGHDEFINITIONUPDATE", "params": [ { "name": "isHD\ntrue", "description": "when is on HD, false otherwise", "type": "Boolean" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 609, "description": "Fired when the media control shows", "itemtype": "event", "name": "CONTAINER_MEDIACONTROL_SHOW", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 615, "description": "Fired when the media control hides", "itemtype": "event", "name": "CONTAINER_MEDIACONTROL_HIDE", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 625, "description": "Fired when the options were changed for the container", "itemtype": "event", "name": "CONTAINER_OPTIONS_CHANGE", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 634, "description": "Fired when the player enters/exit on fullscreen", "itemtype": "event", "name": "MEDIACONTROL_FULLSCREEN", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 640, "description": "Fired when the media control shows", "itemtype": "event", "name": "MEDIACONTROL_SHOW", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 646, "description": "Fired when the media control hides", "itemtype": "event", "name": "MEDIACONTROL_HIDE", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 652, "description": "Fired when mouse enters on the seekbar", "itemtype": "event", "name": "MEDIACONTROL_MOUSEMOVE_SEEKBAR", "params": [ { "name": "event\nthe", "description": "javascript event", "type": "Object" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 660, "description": "Fired when mouse leaves the seekbar", "itemtype": "event", "name": "MEDIACONTROL_MOUSELEAVE_SEEKBAR", "params": [ { "name": "event\nthe", "description": "javascript event", "type": "Object" } ], "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 668, "description": "Fired when the media is being played", "itemtype": "event", "name": "MEDIACONTROL_PLAYING", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 674, "description": "Fired when the media is not being played", "itemtype": "event", "name": "MEDIACONTROL_NOTPLAYING", "class": "Events", "module": "base" }, { "file": "src/base/events.js", "line": 680, "description": "Fired when the container was changed", "itemtype": "event", "name": "MEDIACONTROL_CONTAINERCHANGED", "class": "Events", "module": "base" }, { "file": "src/base/playback.js", "line": 12, "description": "Determine if the playback has ended.", "itemtype": "property", "name": "ended", "type": "Boolean", "class": "Playback", "module": "base" }, { "file": "src/base/playback.js", "line": 21, "description": "Determine if the playback is having to buffer in order for\nplayback to be smooth.\n(i.e if a live stream is playing smoothly, this will be false)", "itemtype": "property", "name": "buffering", "type": "Boolean", "class": "Playback", "module": "base" }, { "file": "src/base/playback.js"