le-player
Version:
The best HTML5 video player made for Lectoriy.
3,040 lines (959 loc) • 89.7 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Player - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Player.html">Player</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#.plugin">plugin</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#.preset">preset</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#changeQuality">changeQuality</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#createElement">createElement</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#exitFullscreen">exitFullscreen</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#getControls">getControls</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#getData">getData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#getWidth">getWidth</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#load">load</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#onDelView">onDelView</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#onSetView">onSetView</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#pause">pause</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#play">play</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#requestFullscreen">requestFullscreen</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#toggleFullscreen">toggleFullscreen</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Player.html#togglePlay">togglePlay</a></span></li><li class="nav-heading">Events</li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:canplay">canplay</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:canplaythrough">canplaythrough</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:dbclick">dbclick</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:durationchange">durationchange</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:ended">ended</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:error">error</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:firstplay">firstplay</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:fullscreenchange">fullscreenchange</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:inited">inited</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:loadstart">loadstart</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:pause">pause</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:play">play</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:playing">playing</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:progress">progress</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:qualitychange">qualitychange</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:rate">rate</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:sectionsinit">sectionsinit</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:seeked">seeked</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:seeking">seeking</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:timeupdate">timeupdate</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:trackschange">trackschange</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:useractive">useractive</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:volumechange">volumechange</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="Player.html#event:waiting">waiting</a></span></li>
</nav>
<div id="main">
<h1 class="page-title">Player</h1>
<section>
<header>
<h2>
Player
</h2>
</header>
<article>
<div class="container-overview">
<div class="section-method">
<h4 class="name" id="Player"><span class="type-signature"></span>new Player<span class="signature">(element, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="le-player.js.html">le-player.js</a>, <a href="le-player.js.html#line239">line 239</a>
</li></ul></dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>element</code></td>
<td class="type">
<span class="param-type"><code>jQuery</code></span>
</td>
<td class="attributes">
</td>
<td class="description last">
Element when player will init
</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>autoplay</code></td>
<td class="type">
<span class="param-type"><code>Boolean</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">
When present, the video will automatically start playing as soon as it can do so without stopping.
</td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
|
<span class="param-type"><code>Number</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'auto'
</td>
<td class="description last">
Height of video container
</td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">
Width of video container
</td>
</tr>
<tr>
<td class="name"><code>loop</code></td>
<td class="type">
<span class="param-type"><code>Boolean</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">
When present, it specifies that the video will start over again, every time it is finished.
</td>
</tr>
<tr>
<td class="name"><code>muted</code></td>
<td class="type">
<span class="param-type"><code>Boolean</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">
When present, it specifies that the audio output of the video should be muted.
</td>
</tr>
<tr>
<td class="name"><code>preload</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'metadata'
</td>
<td class="description last">
Can be ('auto'|'metadata'|'none')
</td>
</tr>
<tr>
<td class="name"><code>poster</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">
Path to poster of video
</td>
</tr>
<tr>
<td class="name"><code>svgPath</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">
Path to svg sprite for icons
</td>
</tr>
<tr>
<td class="name"><code>rate</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">
Rate options
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>step</code></td>
<td class="type">
<span class="param-type"><code>Number</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
0.25
</td>
<td class="description last">
Step of increase/decrease by rate control
</td>
</tr>
<tr>
<td class="name"><code>min</code></td>
<td class="type">
<span class="param-type"><code>Number</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
0.5
</td>
<td class="description last">
Min of rate
</td>
</tr>
<tr>
<td class="name"><code>max</code></td>
<td class="type">
<span class="param-type"><code>Number</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
4.0
</td>
<td class="description last">
Max of rate
</td>
</tr>
<tr>
<td class="name"><code>default</code></td>
<td class="type">
<span class="param-type"><code>Number</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
1
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>playback</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">
Playback options
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>step</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>short</code></td>
<td class="type">
<span class="param-type"><code>Nubmer</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
5
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>medium</code></td>
<td class="type">
<span class="param-type"><code>Nubmer</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
30
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>long</code></td>
<td class="type">
<span class="param-type"><code>Nubmer</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
60
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>controls</code></td>
<td class="type">
<span class="param-type"><code>Obejct</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">
Object of controls
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>common</code></td>
<td class="type">
<span class="param-type"><code>Array.<String></code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
Array of controls for default view
</td>
</tr>
<tr>
<td class="name"><code>fullscreen</code></td>
<td class="type">
<span class="param-type"><code>Array.<String></code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
Array of control for fullsreen view
</td>
</tr>
<tr>
<td class="name"><code>mini</code></td>
<td class="type">
<span class="param-type"><code>Array.<String></code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
Array of control for miniplayer
</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>excludeControls</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">
Object of exclude controls. Structure is the same as that of options.controls
</td>
</tr>
<tr>
<td class="name"><code>volume</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">
Volume's options
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>default</code></td>
<td class="type">
<span class="param-type"><code>Number</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
0.4
</td>
<td class="description last">
Default volume
</td>
</tr>
<tr>
<td class="name"><code>mutelimit</code></td>
<td class="type">
<span class="param-type"><code>Number</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
0.05
</td>
<td class="description last">
Delta when volume is muted
</td>
</tr>
<tr>
<td class="name"><code>step</code></td>
<td class="type">
<span class="param-type"><code>Number</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
0.05
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>keybinding</code></td>
<td class="type">
<span class="param-type"><code>Array.<Object></code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">
Object with keybinding options, when key it's name of key binding, and value it's key binding settings
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type"><code>Number</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
Code of key binding (for example 32 it's space)
</td>
</tr>
<tr>
<td class="name"><code>info</code></td>
<td class="type">
<span class="param-type"><code>Array.<String></code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
Array of keystrokes order
</td>
</tr>
<tr>
<td class="name"><code>description</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes">
</td>
<td class="description last">
Description of key binding
</td>
</tr>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type"><code>function</code></span>
</td>
<td class="attributes">
</td>
<td class="description last">
Callback
</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>miniplayer</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
|
<span class="param-type"><code>Boolean</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
Width of miniplayer container
</td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
MiniPlayer's width
</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>sectionContainer</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">
Selector for sections
</td>
</tr>
<tr>
<td class="name"><code>plugins</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">
Keys of objects are name of plugin, value - plugin options
</td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
|
<span class="param-type"><code>Object</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">
Url or JSON with data for player
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sections</code></td>
<td class="type">
<span class="param-type"><code>Array</code></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
Sections array
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li>Component</li>
</ul>
<h3 class="subsection-title">Members</h3>
<div class="section-members">
<h4 class="name" id=".getComponent"><span class="type-signature">(static) </span>getComponent<span class="type-signature"></span></h4>
<div class="description">
Get by name registered component
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="le-player.js.html">le-player.js</a>, <a href="le-player.js.html#line1631">line 1631</a>
</li></ul></dd>
</dl>
</div>
<div class="section-members">
<h4 class="name" id=".getControl"><span class="type-signature">(static) </span>getControl<span class="type-signature"></span></h4>
<div class="description">
Register control
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="le-player.js.html">le-player.js</a>, <a href="le-player.js.html#line1654">line 1654</a>
</li></ul></dd>
</dl>
</div>
<div class="section-members">
<h4 class="name" id=".registerComponent"><span class="type-signature">(static) </span>registerComponent<span class="type-signature"></span></h4>
<div class="description">
Register component
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="le-player.js.html">le-player.js</a>, <a href="le-player.js.html#line1644">line 1644</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>Player.registerComponent('ErrorDisplay', ErrorDisplay);</code></pre>
</div>
<div class="section-members">
<h4 class="name" id=".registerControl"><span class="type-signature">(static) </span>registerControl<span class="type-signature"></span></h4>
<div class="description">
Get by name registered control
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="le-player.js.html">le-player.js</a>, <a href="le-player.js.html#line1667">line 1667</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>Player.registerControl('backward', BackwardControl);</code></pre>
</div>
<div class="section-members">
<h4 class="name" id=".secondsToTime"><span class="type-signature">(static) </span>secondsToTime<span class="type-signature"></span></h4>
<div class="description">
Convert seconds to format string 'hh?:mm:ss'
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="le-player.js.html">le-player.js</a>, <a href="le-player.js.html#line1678">line 1678</a>
</li></ul></dd>
</dl>
</div>
<div class="section-members">
<h4 class="name" id="currentTime"><span class="type-signature"></span>Player#currentTime<span class="type-signature"> :Nubmer</span></h4>
<div class="description">
Get and set the current playback position in the audio/video (in seconds)
Getter and setter
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="le-player.js.html">le-player.js</a>, <a href="le-player.js.html#line866">line 866</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>Nubmer</code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="duration"><span class="type-signature"></span>Player#duration<span class="type-signature"> :Nubmer</span></h4>
<div class="description">
Returns the length of the current audio/video (in seconds)
Getter
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="le-player.js.html">le-player.js</a>, <a href="le-player.js.html#line882">line 882</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>Nubmer</code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="ended"><span class="type-signature"></span>Player#ended<span class="type-signature"> :Boolean</span></h4>
<div class="description">
Returns whether the playback of the audio/video has ended or not
Getter
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="le-player.js.html">le-player.js</a>, <a href="le-player.js.html#line893">line 893</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>Boolean</code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="error"><span class="type-signature"></span>Player#error<span class="type-signature"> :MediaError|String</span></h4>
<div class="description">
Returns and set whether the playback of the audio/video has ended or not
Getter and setter
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="le-player.js.html">le-player.js</a>, <a href="le-player.js.html#line906">line 906</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>MediaError</code></span>
|
<span class="param-type"><code>String</code></span>
</li>
</ul>
<h5>Fires:</h5>
<ul>
<li><a href="Player.html#event:error">Player#event:error</a></li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="height"><span class="type-signature"></span>Player#height<span class="type-signature"> :Number</span></h4>
<div class="description">
Return the height of player. If you want get height only of video element, use this.video.height or whatever
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="le-player.js.html">le-player.js</a>, <a href="le-player.js.html#line956">line 956</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>Number</code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="videoHeight"><span class="type-signature"></span>Player#videoHeight<span class="type-signature"> :Number</span></h4>
<div class="description">
Return unnecessary video heigth
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="le-player.js.html">le-player.js</a>, <a href="le-player.js.html#line966">line 966</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>Number</code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="view"><span class="type-signature"></span>Player#view<span class="type-signature"> :String</span></h4>
<div class="description">
Set and get player view. View Can be 'common', 'fullscreen', 'mini'w
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="le-player.js.html">le-player.js</a>, <a href="le-player.js.html#line1001">line 1001</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>String</code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="this.element"><span class="type-signature"></span>this.element<span class="type-signature"> :jQuery</span></h4>
<div class="description">
DOM container to hold all player
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="le-player.js.html">le-player.js</a>, <a href="le-player.js.html#line322">line 322</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>jQuery</code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="this.errorDisplay"><span class="type-signature"></span>this.errorDisplay<span class="type-signature"> :ErrorDisplay</span></h4>
<div class="description">
Error display component.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>