myetv-player 1.1.0 → 1.1.2

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 CHANGED
@@ -119,6 +119,7 @@ const player = new MYETVvideoplayer('my-video', {
119
119
  | `brandLogoEnabled` | boolean | `false` | Show/hide the brand logo in the controlbar |
120
120
  | `brandLogoUrl` | string | `''` | Brand logo url in the controlbar (png, jpg, gif) - image height 44px - image width 120px |
121
121
  | `brandLogoLinkUrl` | string | `''` | Optional URL to open in a new page when clicking the brand logo in the controlbar
122
+ | `brandLogoTooltipText` | string | `''` | Optional Custom tooltip of the brand logo (the default is the url of the brand logo, if present)
122
123
  | `watermarkUrl` | string | `''` | Optional URL of the image watermark over the video, reccomended dimension: width: 180px, height: 100px
123
124
  | `watermarkLink` | string | `''` | Optional URL to open in a new page when clicking the watermark logo in the video
124
125
  | `watermarkPosition` | string | `''` | Optional where to show the watermark logo in the video (values are: top-left, top-right, bottom-left, bottom-right)
@@ -283,8 +284,21 @@ console.log(player.getCurrentResolution()); // Get current resolution
283
284
  ```
284
285
  ## API Events
285
286
  The MYETV Video Player includes a comprehensive custom event system that allows you to monitor all player state changes in real-time.
287
+ ### on player ready
288
+ Description: Triggered when the video player is ready
289
+
290
+ When: Player is ready to receive other events
291
+ ```
292
+ player.addEventListener('playerready', (event) => {
293
+ console.log('Player is ready!', event);
294
+ //now it's secure to call other apis method
295
+ player.setVolume(0.8);
296
+ player.play();
297
+ });
298
+ ```
286
299
  ### on played
287
300
  Description: Triggered when the video starts playing
301
+
288
302
  When: User presses play or video starts automatically
289
303
  ```
290
304
  player.addEventListener('played', (event) => {
@@ -294,24 +308,72 @@ player.addEventListener('played', (event) => {
294
308
  });
295
309
  });
296
310
  ```
311
+ ### on playing
312
+ Description: Triggered when the video is playing
313
+
314
+ When: Video is effectively playing
315
+ ```
316
+ player.addEventListener('playing', (event) => {
317
+ console.log('Video is playing at', event.currentTime);
318
+ });
319
+ ```
297
320
  ### on paused
298
321
  Description: Triggered when the video is pause
322
+
299
323
  When: User presses pause or video stops
300
324
  ```
301
325
  player.addEventListener('paused', (event) => {
302
326
  console.log('Video paused at:', event.currentTime + 's');
303
327
  });
304
328
  ```
329
+ ### on waiting
330
+ Description: Triggered when the video is buffering
331
+
332
+ When: Video is buffering and is waiting
333
+ ```
334
+ player.addEventListener('waiting', (event) => {
335
+ console.log('Video is buffering...');
336
+ });
337
+ ```
338
+ ### on seeking
339
+ Description: Triggered when the video is being seeking
340
+
341
+ When: The user is seeking over the video
342
+ ```
343
+ player.addEventListener('seeking', (event) => {
344
+ console.log('User is seeking to', event.targetTime);
345
+ });
346
+ ```
347
+ ### on seeked
348
+ Description: Triggered when the video is finished seeked
349
+
350
+ When: The user have finished seeking and seeked the video
351
+ ```
352
+ player.addEventListener('seeked', (event) => {
353
+ console.log('Seek completed at', event.currentTime);
354
+ });
355
+ ```
305
356
  ### on ended
306
357
  Description: Triggered when the video is ended
358
+
307
359
  When: Video is ended
308
360
  ```
309
361
  player.addEventListener('ended', (e) => {
310
362
  console.log('Video terminato!', e.currentTime, e.duration, e.playlistInfo);
311
363
  });
312
364
  ```
365
+ ### on error
366
+ Description: Triggered when the video have some error
367
+
368
+ When: Video have some error on load
369
+ ```
370
+ player.addEventListener('error', (event) => {
371
+ console.error('Playback error:', event.message);
372
+ });
373
+ ```
313
374
  ### on subtitle change
314
375
  Description: Triggered when subtitles are enabled/disabled or track changes
376
+
315
377
  When: User toggles subtitles or switches subtitle tracks
316
378
  ```
317
379
  player.addEventListener('subtitlechange', (event) => {
@@ -324,6 +386,7 @@ player.addEventListener('subtitlechange', (event) => {
324
386
  ```
325
387
  ### on chapters change
326
388
  Description: Triggered when chapters are changes
389
+
327
390
  When: User switches chapters tracks
328
391
  ```
329
392
  player.on('chapterchange', (data) => {
@@ -332,6 +395,7 @@ player.on('chapterchange', (data) => {
332
395
  ```
333
396
  ### on pip change
334
397
  Description: Triggered when Picture-in-Picture mode changes
398
+
335
399
  When: Video enters or exits PiP mode
336
400
  ```
337
401
  player.addEventListener('pipchange', (event) => {
@@ -340,6 +404,7 @@ player.addEventListener('pipchange', (event) => {
340
404
  ```
341
405
  ### on fullscreen change
342
406
  Description: Triggered when fullscreen mode changes
407
+
343
408
  When: Player enters or exits fullscreen mode
344
409
  ```
345
410
  player.addEventListener('fullscreenchange', (event) => {
@@ -348,6 +413,7 @@ player.addEventListener('fullscreenchange', (event) => {
348
413
  ```
349
414
  ### on speed change
350
415
  Description: Triggered when playback speed changes
416
+
351
417
  When: User modifies playback speed (0.5x, 1x, 1.5x, 2x, etc.)
352
418
  ```
353
419
  player.addEventListener('speedchange', (event) => {
@@ -356,6 +422,7 @@ player.addEventListener('speedchange', (event) => {
356
422
  ```
357
423
  ### on time update
358
424
  Description: Triggered during playback to update progress
425
+
359
426
  When: Every 250ms during playback (throttled for performance)
360
427
  ```
361
428
  player.addEventListener('timeupdate', (event) => {
@@ -366,6 +433,7 @@ player.addEventListener('timeupdate', (event) => {
366
433
  ```
367
434
  ### on volumechange
368
435
  Description: Triggered when volume or mute state changes
436
+
369
437
  When: User modifies volume or toggles mute
370
438
  ```
371
439
  player.addEventListener('volumechange', (event) => {
@@ -384,6 +452,7 @@ player.addEventListener('playlistchange', (e) => {
384
452
  ```
385
453
  ### Main APIs
386
454
  getEventData()
455
+
387
456
  Returns all requested state data in a single object:
388
457
  ```
389
458
  const state = player.getEventData();