@mediakind/mkplayer 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +125 -0
- package/azure-pipelines.yml +34 -0
- package/dist/BufferLevel.d.ts +4 -0
- package/dist/Logger.d.ts +9 -0
- package/dist/MKPlayer.d.ts +26 -0
- package/dist/MKPlayerConfiguration.d.ts +6 -0
- package/dist/MKStream.d.ts +16 -0
- package/dist/SubtitleTrack.d.ts +4 -0
- package/dist/events/MKEvent.d.ts +13 -0
- package/dist/events/MKPlayerEventCallback.d.ts +4 -0
- package/dist/index.d.ts +4 -0
- package/dist/mkplayer.js +1 -0
- package/doc/assets/css/main.css +1 -0
- package/doc/assets/images/icons.png +0 -0
- package/doc/assets/images/icons@2x.png +0 -0
- package/doc/assets/images/widgets.png +0 -0
- package/doc/assets/images/widgets@2x.png +0 -0
- package/doc/assets/js/main.js +51 -0
- package/doc/assets/js/search.json +1 -0
- package/doc/classes/mkplayer.html +588 -0
- package/doc/enums/mkevent.html +303 -0
- package/doc/globals.html +146 -0
- package/doc/index.html +309 -0
- package/doc/interfaces/bufferlevel.html +140 -0
- package/doc/interfaces/mkplayerconfiguration.html +233 -0
- package/doc/interfaces/mkplayereventcallback.html +167 -0
- package/doc/interfaces/subtitletrack.html +195 -0
- package/favicon.ico +0 -0
- package/index.html +430 -0
- package/mk_logo.png +0 -0
- package/mkplayer-ui.min.css +2 -0
- package/mkplayer.zip +0 -0
- package/package.json +51 -0
- package/src/BufferLevel.ts +7 -0
- package/src/Logger.ts +51 -0
- package/src/MKPlayer.ts +289 -0
- package/src/MKPlayerConfiguration.ts +24 -0
- package/src/MKStream.ts +74 -0
- package/src/SubtitleTrack.ts +14 -0
- package/src/events/MKEvent.ts +16 -0
- package/src/events/MKPlayerEventCallback.ts +8 -0
- package/src/index.ts +4 -0
- package/tsconfig.json +20 -0
- package/tslint.json +72 -0
- package/typedoc.json +11 -0
|
@@ -0,0 +1,588 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html class="default no-js">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
+
<title>MKPlayer</title>
|
|
7
|
+
<meta name="description" content="Documentation for MKPlayer">
|
|
8
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
+
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
+
</head>
|
|
11
|
+
<body>
|
|
12
|
+
<header>
|
|
13
|
+
<div class="tsd-page-toolbar">
|
|
14
|
+
<div class="container">
|
|
15
|
+
<div class="table-wrap">
|
|
16
|
+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
17
|
+
<div class="field">
|
|
18
|
+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
19
|
+
<input id="tsd-search-field" type="text" />
|
|
20
|
+
</div>
|
|
21
|
+
<ul class="results">
|
|
22
|
+
<li class="state loading">Preparing search index...</li>
|
|
23
|
+
<li class="state failure">The search index is not available</li>
|
|
24
|
+
</ul>
|
|
25
|
+
<a href="../index.html" class="title">MKPlayer</a>
|
|
26
|
+
</div>
|
|
27
|
+
<div class="table-cell" id="tsd-widgets">
|
|
28
|
+
<div id="tsd-filter">
|
|
29
|
+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
30
|
+
<div class="tsd-filter-group">
|
|
31
|
+
<div class="tsd-select" id="tsd-filter-visibility">
|
|
32
|
+
<span class="tsd-select-label">All</span>
|
|
33
|
+
<ul class="tsd-select-list">
|
|
34
|
+
<li data-value="public">Public</li>
|
|
35
|
+
<li data-value="protected">Public/Protected</li>
|
|
36
|
+
<li data-value="private" class="selected">All</li>
|
|
37
|
+
</ul>
|
|
38
|
+
</div>
|
|
39
|
+
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
40
|
+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
41
|
+
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
42
|
+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
43
|
+
</div>
|
|
44
|
+
</div>
|
|
45
|
+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
46
|
+
</div>
|
|
47
|
+
</div>
|
|
48
|
+
</div>
|
|
49
|
+
</div>
|
|
50
|
+
<div class="tsd-page-title">
|
|
51
|
+
<div class="container">
|
|
52
|
+
<ul class="tsd-breadcrumb">
|
|
53
|
+
<li>
|
|
54
|
+
<a href="../globals.html">Globals</a>
|
|
55
|
+
</li>
|
|
56
|
+
<li>
|
|
57
|
+
<a href="mkplayer.html">MKPlayer</a>
|
|
58
|
+
</li>
|
|
59
|
+
</ul>
|
|
60
|
+
<h1>Class MKPlayer</h1>
|
|
61
|
+
</div>
|
|
62
|
+
</div>
|
|
63
|
+
</header>
|
|
64
|
+
<div class="container container-main">
|
|
65
|
+
<div class="row">
|
|
66
|
+
<div class="col-8 col-content">
|
|
67
|
+
<section class="tsd-panel tsd-comment">
|
|
68
|
+
<div class="tsd-comment tsd-typography">
|
|
69
|
+
<div class="lead">
|
|
70
|
+
<p>MKPlayer is an HTML5 video player used for playback of HLS and DASH adaptive bitrate streams</p>
|
|
71
|
+
</div>
|
|
72
|
+
</div>
|
|
73
|
+
</section>
|
|
74
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
75
|
+
<h3>Hierarchy</h3>
|
|
76
|
+
<ul class="tsd-hierarchy">
|
|
77
|
+
<li>
|
|
78
|
+
<span class="target">MKPlayer</span>
|
|
79
|
+
</li>
|
|
80
|
+
</ul>
|
|
81
|
+
</section>
|
|
82
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
83
|
+
<h2>Index</h2>
|
|
84
|
+
<section class="tsd-panel tsd-index-panel">
|
|
85
|
+
<div class="tsd-index-content">
|
|
86
|
+
<section class="tsd-index-section ">
|
|
87
|
+
<h3>Constructors</h3>
|
|
88
|
+
<ul class="tsd-index-list">
|
|
89
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="mkplayer.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
90
|
+
</ul>
|
|
91
|
+
</section>
|
|
92
|
+
<section class="tsd-index-section ">
|
|
93
|
+
<h3>Methods</h3>
|
|
94
|
+
<ul class="tsd-index-list">
|
|
95
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mkplayer.html#destroy" class="tsd-kind-icon">destroy</a></li>
|
|
96
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mkplayer.html#getbufferlevels" class="tsd-kind-icon">get<wbr>Buffer<wbr>Levels</a></li>
|
|
97
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mkplayer.html#getcurrenttime" class="tsd-kind-icon">get<wbr>Current<wbr>Time</a></li>
|
|
98
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mkplayer.html#load" class="tsd-kind-icon">load</a></li>
|
|
99
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mkplayer.html#mute" class="tsd-kind-icon">mute</a></li>
|
|
100
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mkplayer.html#off" class="tsd-kind-icon">off</a></li>
|
|
101
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mkplayer.html#on" class="tsd-kind-icon">on</a></li>
|
|
102
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mkplayer.html#pause" class="tsd-kind-icon">pause</a></li>
|
|
103
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mkplayer.html#play" class="tsd-kind-icon">play</a></li>
|
|
104
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mkplayer.html#setvolume" class="tsd-kind-icon">set<wbr>Volume</a></li>
|
|
105
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mkplayer.html#unload" class="tsd-kind-icon">unload</a></li>
|
|
106
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mkplayer.html#unmute" class="tsd-kind-icon">unmute</a></li>
|
|
107
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mkplayer.html#version" class="tsd-kind-icon">version</a></li>
|
|
108
|
+
</ul>
|
|
109
|
+
</section>
|
|
110
|
+
</div>
|
|
111
|
+
</section>
|
|
112
|
+
</section>
|
|
113
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
114
|
+
<h2>Constructors</h2>
|
|
115
|
+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
116
|
+
<a name="constructor" class="tsd-anchor"></a>
|
|
117
|
+
<h3>constructor</h3>
|
|
118
|
+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
119
|
+
<li class="tsd-signature tsd-kind-icon">new MKPlayer<span class="tsd-signature-symbol">(</span>containerElement<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, mkPlayerConfiguration<span class="tsd-signature-symbol">: </span><a href="../interfaces/mkplayerconfiguration.html" class="tsd-signature-type">MKPlayerConfiguration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mkplayer.html" class="tsd-signature-type">MKPlayer</a></li>
|
|
120
|
+
</ul>
|
|
121
|
+
<ul class="tsd-descriptions">
|
|
122
|
+
<li class="tsd-description">
|
|
123
|
+
<aside class="tsd-sources">
|
|
124
|
+
<ul>
|
|
125
|
+
<li>Defined in MKPlayer.ts:16</li>
|
|
126
|
+
</ul>
|
|
127
|
+
</aside>
|
|
128
|
+
<div class="tsd-comment tsd-typography">
|
|
129
|
+
<div class="lead">
|
|
130
|
+
<p>constructor used to create a new MKPlayer instance</p>
|
|
131
|
+
</div>
|
|
132
|
+
</div>
|
|
133
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
134
|
+
<ul class="tsd-parameters">
|
|
135
|
+
<li>
|
|
136
|
+
<h5>containerElement: <span class="tsd-signature-type">HTMLElement</span></h5>
|
|
137
|
+
<div class="tsd-comment tsd-typography">
|
|
138
|
+
<div class="lead">
|
|
139
|
+
<p>container that the video player will be rendered in</p>
|
|
140
|
+
</div>
|
|
141
|
+
</div>
|
|
142
|
+
</li>
|
|
143
|
+
<li>
|
|
144
|
+
<h5>mkPlayerConfiguration: <a href="../interfaces/mkplayerconfiguration.html" class="tsd-signature-type">MKPlayerConfiguration</a></h5>
|
|
145
|
+
<div class="tsd-comment tsd-typography">
|
|
146
|
+
<div class="lead">
|
|
147
|
+
<p>configuration for this MKPlayer instance</p>
|
|
148
|
+
</div>
|
|
149
|
+
</div>
|
|
150
|
+
</li>
|
|
151
|
+
</ul>
|
|
152
|
+
<h4 class="tsd-returns-title">Returns <a href="mkplayer.html" class="tsd-signature-type">MKPlayer</a></h4>
|
|
153
|
+
</li>
|
|
154
|
+
</ul>
|
|
155
|
+
</section>
|
|
156
|
+
</section>
|
|
157
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
158
|
+
<h2>Methods</h2>
|
|
159
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
160
|
+
<a name="destroy" class="tsd-anchor"></a>
|
|
161
|
+
<h3>destroy</h3>
|
|
162
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
163
|
+
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
164
|
+
</ul>
|
|
165
|
+
<ul class="tsd-descriptions">
|
|
166
|
+
<li class="tsd-description">
|
|
167
|
+
<aside class="tsd-sources">
|
|
168
|
+
<ul>
|
|
169
|
+
<li>Defined in MKPlayer.ts:90</li>
|
|
170
|
+
</ul>
|
|
171
|
+
</aside>
|
|
172
|
+
<div class="tsd-comment tsd-typography">
|
|
173
|
+
<div class="lead">
|
|
174
|
+
<p>destroys the video player. You must create a new MKPlayer if this method is called</p>
|
|
175
|
+
</div>
|
|
176
|
+
</div>
|
|
177
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
178
|
+
</li>
|
|
179
|
+
</ul>
|
|
180
|
+
</section>
|
|
181
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
182
|
+
<a name="getbufferlevels" class="tsd-anchor"></a>
|
|
183
|
+
<h3>get<wbr>Buffer<wbr>Levels</h3>
|
|
184
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
185
|
+
<li class="tsd-signature tsd-kind-icon">get<wbr>Buffer<wbr>Levels<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/bufferlevel.html" class="tsd-signature-type">BufferLevel</a></li>
|
|
186
|
+
</ul>
|
|
187
|
+
<ul class="tsd-descriptions">
|
|
188
|
+
<li class="tsd-description">
|
|
189
|
+
<aside class="tsd-sources">
|
|
190
|
+
<ul>
|
|
191
|
+
<li>Defined in MKPlayer.ts:183</li>
|
|
192
|
+
</ul>
|
|
193
|
+
</aside>
|
|
194
|
+
<div class="tsd-comment tsd-typography">
|
|
195
|
+
<div class="lead">
|
|
196
|
+
<p>gets the current audio and video buffer levels</p>
|
|
197
|
+
</div>
|
|
198
|
+
</div>
|
|
199
|
+
<h4 class="tsd-returns-title">Returns <a href="../interfaces/bufferlevel.html" class="tsd-signature-type">BufferLevel</a></h4>
|
|
200
|
+
</li>
|
|
201
|
+
</ul>
|
|
202
|
+
</section>
|
|
203
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
204
|
+
<a name="getcurrenttime" class="tsd-anchor"></a>
|
|
205
|
+
<h3>get<wbr>Current<wbr>Time</h3>
|
|
206
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
207
|
+
<li class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>Time<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
|
|
208
|
+
</ul>
|
|
209
|
+
<ul class="tsd-descriptions">
|
|
210
|
+
<li class="tsd-description">
|
|
211
|
+
<aside class="tsd-sources">
|
|
212
|
+
<ul>
|
|
213
|
+
<li>Defined in MKPlayer.ts:174</li>
|
|
214
|
+
</ul>
|
|
215
|
+
</aside>
|
|
216
|
+
<div class="tsd-comment tsd-typography">
|
|
217
|
+
<div class="lead">
|
|
218
|
+
<p>gets the player's current time</p>
|
|
219
|
+
</div>
|
|
220
|
+
</div>
|
|
221
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
222
|
+
</li>
|
|
223
|
+
</ul>
|
|
224
|
+
</section>
|
|
225
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
226
|
+
<a name="load" class="tsd-anchor"></a>
|
|
227
|
+
<h3>load</h3>
|
|
228
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
229
|
+
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>stream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MKStream</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
230
|
+
</ul>
|
|
231
|
+
<ul class="tsd-descriptions">
|
|
232
|
+
<li class="tsd-description">
|
|
233
|
+
<aside class="tsd-sources">
|
|
234
|
+
<ul>
|
|
235
|
+
<li>Defined in MKPlayer.ts:99</li>
|
|
236
|
+
</ul>
|
|
237
|
+
</aside>
|
|
238
|
+
<div class="tsd-comment tsd-typography">
|
|
239
|
+
<div class="lead">
|
|
240
|
+
<p>Loads a new stream for playback</p>
|
|
241
|
+
</div>
|
|
242
|
+
</div>
|
|
243
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
244
|
+
<ul class="tsd-parameters">
|
|
245
|
+
<li>
|
|
246
|
+
<h5>stream: <span class="tsd-signature-type">MKStream</span></h5>
|
|
247
|
+
<div class="tsd-comment tsd-typography">
|
|
248
|
+
<p>the stream the player will load</p>
|
|
249
|
+
</div>
|
|
250
|
+
</li>
|
|
251
|
+
</ul>
|
|
252
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
253
|
+
</li>
|
|
254
|
+
</ul>
|
|
255
|
+
</section>
|
|
256
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
257
|
+
<a name="mute" class="tsd-anchor"></a>
|
|
258
|
+
<h3>mute</h3>
|
|
259
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
260
|
+
<li class="tsd-signature tsd-kind-icon">mute<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
261
|
+
</ul>
|
|
262
|
+
<ul class="tsd-descriptions">
|
|
263
|
+
<li class="tsd-description">
|
|
264
|
+
<aside class="tsd-sources">
|
|
265
|
+
<ul>
|
|
266
|
+
<li>Defined in MKPlayer.ts:193</li>
|
|
267
|
+
</ul>
|
|
268
|
+
</aside>
|
|
269
|
+
<div class="tsd-comment tsd-typography">
|
|
270
|
+
<div class="lead">
|
|
271
|
+
<p>mutes the player</p>
|
|
272
|
+
</div>
|
|
273
|
+
</div>
|
|
274
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
275
|
+
</li>
|
|
276
|
+
</ul>
|
|
277
|
+
</section>
|
|
278
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
279
|
+
<a name="off" class="tsd-anchor"></a>
|
|
280
|
+
<h3>off</h3>
|
|
281
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
282
|
+
<li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol">(</span>eventType<span class="tsd-signature-symbol">: </span><a href="../enums/mkevent.html" class="tsd-signature-type">MKEvent</a>, callback<span class="tsd-signature-symbol">: </span><a href="../interfaces/mkplayereventcallback.html" class="tsd-signature-type">MKPlayerEventCallback</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
283
|
+
</ul>
|
|
284
|
+
<ul class="tsd-descriptions">
|
|
285
|
+
<li class="tsd-description">
|
|
286
|
+
<aside class="tsd-sources">
|
|
287
|
+
<ul>
|
|
288
|
+
<li>Defined in MKPlayer.ts:146</li>
|
|
289
|
+
</ul>
|
|
290
|
+
</aside>
|
|
291
|
+
<div class="tsd-comment tsd-typography">
|
|
292
|
+
<div class="lead">
|
|
293
|
+
<p>Removes a handler for a MKEvent</p>
|
|
294
|
+
</div>
|
|
295
|
+
</div>
|
|
296
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
297
|
+
<ul class="tsd-parameters">
|
|
298
|
+
<li>
|
|
299
|
+
<h5>eventType: <a href="../enums/mkevent.html" class="tsd-signature-type">MKEvent</a></h5>
|
|
300
|
+
</li>
|
|
301
|
+
<li>
|
|
302
|
+
<h5>callback: <a href="../interfaces/mkplayereventcallback.html" class="tsd-signature-type">MKPlayerEventCallback</a></h5>
|
|
303
|
+
<div class="tsd-comment tsd-typography">
|
|
304
|
+
</div>
|
|
305
|
+
</li>
|
|
306
|
+
</ul>
|
|
307
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
308
|
+
</li>
|
|
309
|
+
</ul>
|
|
310
|
+
</section>
|
|
311
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
312
|
+
<a name="on" class="tsd-anchor"></a>
|
|
313
|
+
<h3>on</h3>
|
|
314
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
315
|
+
<li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventType<span class="tsd-signature-symbol">: </span><a href="../enums/mkevent.html" class="tsd-signature-type">MKEvent</a>, callback<span class="tsd-signature-symbol">: </span><a href="../interfaces/mkplayereventcallback.html" class="tsd-signature-type">MKPlayerEventCallback</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
316
|
+
</ul>
|
|
317
|
+
<ul class="tsd-descriptions">
|
|
318
|
+
<li class="tsd-description">
|
|
319
|
+
<aside class="tsd-sources">
|
|
320
|
+
<ul>
|
|
321
|
+
<li>Defined in MKPlayer.ts:158</li>
|
|
322
|
+
</ul>
|
|
323
|
+
</aside>
|
|
324
|
+
<div class="tsd-comment tsd-typography">
|
|
325
|
+
<div class="lead">
|
|
326
|
+
<p>Subscribes and event handler to a MKEvent</p>
|
|
327
|
+
</div>
|
|
328
|
+
</div>
|
|
329
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
330
|
+
<ul class="tsd-parameters">
|
|
331
|
+
<li>
|
|
332
|
+
<h5>eventType: <a href="../enums/mkevent.html" class="tsd-signature-type">MKEvent</a></h5>
|
|
333
|
+
</li>
|
|
334
|
+
<li>
|
|
335
|
+
<h5>callback: <a href="../interfaces/mkplayereventcallback.html" class="tsd-signature-type">MKPlayerEventCallback</a></h5>
|
|
336
|
+
<div class="tsd-comment tsd-typography">
|
|
337
|
+
</div>
|
|
338
|
+
</li>
|
|
339
|
+
</ul>
|
|
340
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
341
|
+
</li>
|
|
342
|
+
</ul>
|
|
343
|
+
</section>
|
|
344
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
345
|
+
<a name="pause" class="tsd-anchor"></a>
|
|
346
|
+
<h3>pause</h3>
|
|
347
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
348
|
+
<li class="tsd-signature tsd-kind-icon">pause<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
349
|
+
</ul>
|
|
350
|
+
<ul class="tsd-descriptions">
|
|
351
|
+
<li class="tsd-description">
|
|
352
|
+
<aside class="tsd-sources">
|
|
353
|
+
<ul>
|
|
354
|
+
<li>Defined in MKPlayer.ts:83</li>
|
|
355
|
+
</ul>
|
|
356
|
+
</aside>
|
|
357
|
+
<div class="tsd-comment tsd-typography">
|
|
358
|
+
<div class="lead">
|
|
359
|
+
<p>pauses playback on the player</p>
|
|
360
|
+
</div>
|
|
361
|
+
</div>
|
|
362
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
363
|
+
</li>
|
|
364
|
+
</ul>
|
|
365
|
+
</section>
|
|
366
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
367
|
+
<a name="play" class="tsd-anchor"></a>
|
|
368
|
+
<h3>play</h3>
|
|
369
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
370
|
+
<li class="tsd-signature tsd-kind-icon">play<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
371
|
+
</ul>
|
|
372
|
+
<ul class="tsd-descriptions">
|
|
373
|
+
<li class="tsd-description">
|
|
374
|
+
<aside class="tsd-sources">
|
|
375
|
+
<ul>
|
|
376
|
+
<li>Defined in MKPlayer.ts:76</li>
|
|
377
|
+
</ul>
|
|
378
|
+
</aside>
|
|
379
|
+
<div class="tsd-comment tsd-typography">
|
|
380
|
+
<div class="lead">
|
|
381
|
+
<p>start playback or resumes playback after the player has been paused</p>
|
|
382
|
+
</div>
|
|
383
|
+
</div>
|
|
384
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
385
|
+
</li>
|
|
386
|
+
</ul>
|
|
387
|
+
</section>
|
|
388
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
389
|
+
<a name="setvolume" class="tsd-anchor"></a>
|
|
390
|
+
<h3>set<wbr>Volume</h3>
|
|
391
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
392
|
+
<li class="tsd-signature tsd-kind-icon">set<wbr>Volume<span class="tsd-signature-symbol">(</span>volume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
393
|
+
</ul>
|
|
394
|
+
<ul class="tsd-descriptions">
|
|
395
|
+
<li class="tsd-description">
|
|
396
|
+
<aside class="tsd-sources">
|
|
397
|
+
<ul>
|
|
398
|
+
<li>Defined in MKPlayer.ts:210</li>
|
|
399
|
+
</ul>
|
|
400
|
+
</aside>
|
|
401
|
+
<div class="tsd-comment tsd-typography">
|
|
402
|
+
<div class="lead">
|
|
403
|
+
<p>sets the player's volume in the range of 0 (silent) to 100 (max volume)</p>
|
|
404
|
+
</div>
|
|
405
|
+
</div>
|
|
406
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
407
|
+
<ul class="tsd-parameters">
|
|
408
|
+
<li>
|
|
409
|
+
<h5>volume: <span class="tsd-signature-type">number</span></h5>
|
|
410
|
+
<div class="tsd-comment tsd-typography">
|
|
411
|
+
<p>The volume to set between 0 and 100</p>
|
|
412
|
+
</div>
|
|
413
|
+
</li>
|
|
414
|
+
</ul>
|
|
415
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
416
|
+
</li>
|
|
417
|
+
</ul>
|
|
418
|
+
</section>
|
|
419
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
420
|
+
<a name="unload" class="tsd-anchor"></a>
|
|
421
|
+
<h3>unload</h3>
|
|
422
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
423
|
+
<li class="tsd-signature tsd-kind-icon">unload<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
424
|
+
</ul>
|
|
425
|
+
<ul class="tsd-descriptions">
|
|
426
|
+
<li class="tsd-description">
|
|
427
|
+
<aside class="tsd-sources">
|
|
428
|
+
<ul>
|
|
429
|
+
<li>Defined in MKPlayer.ts:167</li>
|
|
430
|
+
</ul>
|
|
431
|
+
</aside>
|
|
432
|
+
<div class="tsd-comment tsd-typography">
|
|
433
|
+
<div class="lead">
|
|
434
|
+
<p>unloads the current playing stream</p>
|
|
435
|
+
</div>
|
|
436
|
+
</div>
|
|
437
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
438
|
+
</li>
|
|
439
|
+
</ul>
|
|
440
|
+
</section>
|
|
441
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
442
|
+
<a name="unmute" class="tsd-anchor"></a>
|
|
443
|
+
<h3>unmute</h3>
|
|
444
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
445
|
+
<li class="tsd-signature tsd-kind-icon">unmute<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
446
|
+
</ul>
|
|
447
|
+
<ul class="tsd-descriptions">
|
|
448
|
+
<li class="tsd-description">
|
|
449
|
+
<aside class="tsd-sources">
|
|
450
|
+
<ul>
|
|
451
|
+
<li>Defined in MKPlayer.ts:200</li>
|
|
452
|
+
</ul>
|
|
453
|
+
</aside>
|
|
454
|
+
<div class="tsd-comment tsd-typography">
|
|
455
|
+
<div class="lead">
|
|
456
|
+
<p>unmute the player</p>
|
|
457
|
+
</div>
|
|
458
|
+
</div>
|
|
459
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
460
|
+
</li>
|
|
461
|
+
</ul>
|
|
462
|
+
</section>
|
|
463
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
464
|
+
<a name="version" class="tsd-anchor"></a>
|
|
465
|
+
<h3>version</h3>
|
|
466
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
467
|
+
<li class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
468
|
+
</ul>
|
|
469
|
+
<ul class="tsd-descriptions">
|
|
470
|
+
<li class="tsd-description">
|
|
471
|
+
<aside class="tsd-sources">
|
|
472
|
+
<ul>
|
|
473
|
+
<li>Defined in MKPlayer.ts:217</li>
|
|
474
|
+
</ul>
|
|
475
|
+
</aside>
|
|
476
|
+
<div class="tsd-comment tsd-typography">
|
|
477
|
+
<div class="lead">
|
|
478
|
+
<p>returns the current player version</p>
|
|
479
|
+
</div>
|
|
480
|
+
</div>
|
|
481
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
482
|
+
</li>
|
|
483
|
+
</ul>
|
|
484
|
+
</section>
|
|
485
|
+
</section>
|
|
486
|
+
</div>
|
|
487
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
488
|
+
<nav class="tsd-navigation primary">
|
|
489
|
+
<ul>
|
|
490
|
+
<li class="globals ">
|
|
491
|
+
<a href="../globals.html"><em>Globals</em></a>
|
|
492
|
+
</li>
|
|
493
|
+
</ul>
|
|
494
|
+
</nav>
|
|
495
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
496
|
+
<ul class="before-current">
|
|
497
|
+
<li class=" tsd-kind-enum">
|
|
498
|
+
<a href="../enums/mkevent.html" class="tsd-kind-icon">MKEvent</a>
|
|
499
|
+
</li>
|
|
500
|
+
</ul>
|
|
501
|
+
<ul class="current">
|
|
502
|
+
<li class="current tsd-kind-class">
|
|
503
|
+
<a href="mkplayer.html" class="tsd-kind-icon">MKPlayer</a>
|
|
504
|
+
<ul>
|
|
505
|
+
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
506
|
+
<a href="mkplayer.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
507
|
+
</li>
|
|
508
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
509
|
+
<a href="mkplayer.html#destroy" class="tsd-kind-icon">destroy</a>
|
|
510
|
+
</li>
|
|
511
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
512
|
+
<a href="mkplayer.html#getbufferlevels" class="tsd-kind-icon">get<wbr>Buffer<wbr>Levels</a>
|
|
513
|
+
</li>
|
|
514
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
515
|
+
<a href="mkplayer.html#getcurrenttime" class="tsd-kind-icon">get<wbr>Current<wbr>Time</a>
|
|
516
|
+
</li>
|
|
517
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
518
|
+
<a href="mkplayer.html#load" class="tsd-kind-icon">load</a>
|
|
519
|
+
</li>
|
|
520
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
521
|
+
<a href="mkplayer.html#mute" class="tsd-kind-icon">mute</a>
|
|
522
|
+
</li>
|
|
523
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
524
|
+
<a href="mkplayer.html#off" class="tsd-kind-icon">off</a>
|
|
525
|
+
</li>
|
|
526
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
527
|
+
<a href="mkplayer.html#on" class="tsd-kind-icon">on</a>
|
|
528
|
+
</li>
|
|
529
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
530
|
+
<a href="mkplayer.html#pause" class="tsd-kind-icon">pause</a>
|
|
531
|
+
</li>
|
|
532
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
533
|
+
<a href="mkplayer.html#play" class="tsd-kind-icon">play</a>
|
|
534
|
+
</li>
|
|
535
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
536
|
+
<a href="mkplayer.html#setvolume" class="tsd-kind-icon">set<wbr>Volume</a>
|
|
537
|
+
</li>
|
|
538
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
539
|
+
<a href="mkplayer.html#unload" class="tsd-kind-icon">unload</a>
|
|
540
|
+
</li>
|
|
541
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
542
|
+
<a href="mkplayer.html#unmute" class="tsd-kind-icon">unmute</a>
|
|
543
|
+
</li>
|
|
544
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
545
|
+
<a href="mkplayer.html#version" class="tsd-kind-icon">version</a>
|
|
546
|
+
</li>
|
|
547
|
+
</ul>
|
|
548
|
+
</li>
|
|
549
|
+
</ul>
|
|
550
|
+
<ul class="after-current">
|
|
551
|
+
<li class=" tsd-kind-interface">
|
|
552
|
+
<a href="../interfaces/bufferlevel.html" class="tsd-kind-icon">Buffer<wbr>Level</a>
|
|
553
|
+
</li>
|
|
554
|
+
<li class=" tsd-kind-interface">
|
|
555
|
+
<a href="../interfaces/mkplayerconfiguration.html" class="tsd-kind-icon">MKPlayer<wbr>Configuration</a>
|
|
556
|
+
</li>
|
|
557
|
+
<li class=" tsd-kind-interface">
|
|
558
|
+
<a href="../interfaces/mkplayereventcallback.html" class="tsd-kind-icon">MKPlayer<wbr>Event<wbr>Callback</a>
|
|
559
|
+
</li>
|
|
560
|
+
<li class=" tsd-kind-interface">
|
|
561
|
+
<a href="../interfaces/subtitletrack.html" class="tsd-kind-icon">Subtitle<wbr>Track</a>
|
|
562
|
+
</li>
|
|
563
|
+
</ul>
|
|
564
|
+
</nav>
|
|
565
|
+
</div>
|
|
566
|
+
</div>
|
|
567
|
+
</div>
|
|
568
|
+
<footer class="with-border-bottom">
|
|
569
|
+
<div class="container">
|
|
570
|
+
<h2>Legend</h2>
|
|
571
|
+
<div class="tsd-legend-group">
|
|
572
|
+
<ul class="tsd-legend">
|
|
573
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
574
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
575
|
+
</ul>
|
|
576
|
+
<ul class="tsd-legend">
|
|
577
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
578
|
+
</ul>
|
|
579
|
+
</div>
|
|
580
|
+
</div>
|
|
581
|
+
</footer>
|
|
582
|
+
<div class="container tsd-generator">
|
|
583
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
584
|
+
</div>
|
|
585
|
+
<div class="overlay"></div>
|
|
586
|
+
<script src="../assets/js/main.js"></script>
|
|
587
|
+
</body>
|
|
588
|
+
</html>
|