videojs-hls-boomstream 1.2.84 → 1.2.86-alpha.1

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 # Changelog of ```videojs-hls-boomstream```
+## 1.2.86-alpha.1
+FIX: Исправлены проблемы с авто качеством плеера, добавлено API для выбора качества
+## 1.2.86-alpha.0
+FIX: Версия 1.2.86 помечена как alpha
+## 1.2.86
+FIX: Добавлено автокачество на айфоне и андройде
+## 1.2.85
+FIX: Исправление проблем с вопроизведением видео с загружающимся транскодами
 ## 1.2.84
 FIX: Исправление проблем с вопроизведением на ipad в хроме
 ## 1.2.83

package/README.md

@@ -282,6 +282,38 @@ Below will be a description of the playlist methods:
  - ```getCurrentAutoplayConfig(): AutoplayConfig;``` - returns current autoplay config (type is described above).
  - ```getCurrentPlaylist(): BMSPlaylistType;``` - returns **copy** of current playlist (type is described above).
  - ```getCurrentMedia(): BMSPlaylistItem;``` - returns **copy** of current media (type is described above).
+
+## Quality API
+videojs-hls-boomstream creates **bQuality** property on **player** object if you enable quality plugin in options.
+**bQuality** has the following interface:
+```ts
+interface IQualityApi {
+  getQualityList: () => UsersQuality[];
+  getQualityById: (qualityId: string) => UsersQuality | undefined;
+  getSelectedQualityId: () => string;
+  setQualityById: (qualityId: string) => void;
+}
+
+interface UsersQuality {
+  id: string;
+  bandwidth: number;
+  width?: number;
+  height?: number;
+  name?: string;
+};
+```
+
+This api triggers (```player.trigger```) 2 types of events:
+- ```qualities_initialized``` - triggers when quality list has been initialized (once for one media); has ```UsersQuality[]``` as a payload
+- ```new_quality_selected``` - triggers every time a new quality sets by ```setQualityById``` method (not triggers when adaptive bitrate algorithm selects new quality when auto quality is setted)
+
+Below will be a description of the quality api methods:
+- ```getQualityList: () => UsersQuality[]``` - returns a list of  available qualities for current media
+- ```getQualityById: (qualityId: string) => UsersQuality | undefined``` - if ```qualityId``` isn't string print warning in console and return ```undefined```; returns a quality object if found in quality list otherwise return ```undefined```
+- ```getSelectedQualityId: () => string``` - if selected quality is auto returns ```'auto'``` otherwise returns quality id
+- ```setQualityById: (qualityId: string) => void``` - if ```qualityId``` isn't string prints error in console and do nothing; if ```qualityId``` equals id which has already been selected prints warning in console and do nothing; otherwise set new quality and triggers ```new_quality_selected``` event with qualityId payload;
+
+
 ## License
 
 MIT. Copyright (c) support@boomstream.com

package/dist/typings.d.ts

@@ -1,3 +1,5 @@
+import { IQualityApi, CustomQuality } from './quality/QualityApiTypes';
+import { BMSPlaylistLoaderInterface } from './plugin/bms-playlist/playlist-loader/BMSPlaylistLoaderInterface';
 import boomstreamHls, {
   BMSPluginError,
   BMSPluginErrorType,
@@ -11,9 +13,14 @@ import { LiveVodRequestSenderInterface } from 'src/live-vod-request-sender/LiveV
 declare module 'video.js' {
   export interface VideoJsPlayer {
     boomstreamHls(options: Partial<BoomstreamHlsOptions>): void;
-    tech_: {
-      session: number
-    }
+    mediaData: Source;
+    session: number;
+    bases: BoomstreamBases;
+    id_: string;
+    id_recovery: null | string;
+    bPlaylist?: BMSPlaylistLoaderInterface;
+    tech(): BoomstreamPlayerTech;
+    bQuality?: IQualityApi;
   }
 }
 
@@ -64,12 +71,12 @@ export enum VideoMimeTypesEnum {
   LIVE = 'live'
 }
 
-export type VideoMimeTypesList = 
-  'application/x-mpegURL' 
-  | 'application/vnd.apple.mpegurl' 
-  | 'video/3gpp' 
-  | 'video/3gpp2' 
-  | 'video/3gp2' 
+export type VideoMimeTypesList =
+  'application/x-mpegURL'
+  | 'application/vnd.apple.mpegurl'
+  | 'video/3gpp'
+  | 'video/3gpp2'
+  | 'video/3gp2'
   | 'video/mpeg'
   | 'video/mp4'
   | 'video/ogg'
@@ -102,8 +109,14 @@ export type Source = {
 };
 
 export type BoomstreamPlayerTech = videojs.Tech & {
+  vhs: any;
+  hls: any;
   currentSource_: Source;
   session: null | number;
+  qualities?: CustomQuality[];
+  play?: () => void;
+  load?: () => void;
+  setSource?: (source: unknown, onlyQuality: boolean) => void;
 }
 
 // Source[] with at least 1 Source object. There must be at least 1 source for item
@@ -157,6 +170,7 @@ export type GlobalState = {
   googleAnalyticPartnerKey: string;
   yandexAnalyticPartnerKey: string;
   typeApp: string;
+  config: unknown;
 }
 
 export type VideoElementDimensions = {