videojs-hls-boomstream 1.2.86 → 1.2.89

package/CHANGELOG.md

@@ -1,4 +1,32 @@
 # Changelog of ```videojs-hls-boomstream```
+## 1.2.89
+FIX: Исправлено воспроизведение стрима с ограниченным доступом
+## 1.2.88
+FIX: Исправлено воспроизведение стрима в плейлисте, переделан механизм передачи ключа для расшифровки
+## 1.2.87
+FIX: Убрал вывод ошибки в консоль при ограничении доступа
+## 1.2.86-alpha.10
+FIX: Исправлена ошибка в плагине при вопроизведении видео после оффлайн стрима
+## 1.2.86-alpha.9
+FIX: Исправлена ошибка в плагине при отсутствии доступа к localStorage
+## 1.2.86-alpha.8
+FIX: Исправлена ошибка в плагине при выключенных cookie у клиента
+## 1.2.86-alpha.7
+FIX: Пофикшена работа шифрованных медиа на xiaomi
+## 1.2.86-alpha.6
+FIX: Пофикшена работа шифрованных медиа на macOS
+## 1.2.86-alpha.5
+FIX: Пофикшено отображение качества на андройде в плейлисте
+## 1.2.86-alpha.4
+FIX: Пофикшено приостановление стрим
+## 1.2.86-alpha.3
+FIX: Переписана работа автокачества для андройда
+## 1.2.86-alpha.2
+FIX: Исправлена проблема с автокачеством на macOS и iOS. Отрефакторено глобальное состояние плагина
+## 1.2.86-alpha.1
+FIX: Исправлены проблемы с авто качеством плеера, добавлено API для выбора качества
+## 1.2.86-alpha.0
+FIX: Версия 1.2.86 помечена как alpha
 ## 1.2.86
 FIX: Добавлено автокачество на айфоне и андройде
 ## 1.2.85

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); has quality id as a payload
+
+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
@@ -147,18 +160,6 @@ export type BoomstreamBases = {
   io: string;
 };
 
-export type GlobalState = {
-  players: VideoJsPlayer[];
-  offlineStreamHandler: BMSOfflineStreamHandlerInterface;
-  currentMediaCode: string;
-  isBmsUIUsed: boolean;
-  offlineStreamErrorHandler: () => void;
-  liveVodRequestSender: LiveVodRequestSenderInterface[];
-  googleAnalyticPartnerKey: string;
-  yandexAnalyticPartnerKey: string;
-  typeApp: string;
-}
-
 export type VideoElementDimensions = {
   width: string;
   height: string;
@@ -176,3 +177,142 @@ export type Bases = {
   frontend: string;
   io: string;
 }
+
+export enum SkinType {
+  Light = '',
+  Dark = 'dark',
+  Device = 'device'
+}
+
+export enum Position {
+  Right = 'right',
+  Left = 'left'
+}
+
+export enum AreaTypes {
+  None = '',
+  Chat = 'bms-chat',
+  Playlist = 'bms-playlist',
+  Settings = 'bms-settings',
+  Information = 'bms-information',
+  FrameArea = 'sidebar-frame'
+}
+
+export enum SubscriptionTypes {
+  Subscription = 'subscription',
+  Payment = 'payment',
+  Password = 'password',
+  Collection = 'collection'
+}
+
+export enum TranslationLiveStatus {
+  UNCHEKED,
+  ONLINE,
+  OFFLINE
+}
+
+export interface SubscriptionOptions {
+  about: string;
+  access_expire?: Date;
+  code: string;
+  cost: string;
+  format: string;
+  period: string;
+  preview_time: string;
+  subscription_type: SubscriptionTypes;
+  title: string;
+  usePromocode: boolean;
+}
+
+export interface GatewayOption {
+  id: string;
+  name: string;
+  title: string;
+}
+
+export interface BmsSourcePoster {
+  height: number;
+  link: string;
+  width: number;
+}
+
+export type Media = {
+  code: string;
+  links: {
+    hls: string;
+    raw: string;
+    vtt: string;
+  };
+  posters: Array<Poster>;
+  source: boolean;
+  sources: Array<unknown>;
+  title: string;
+  token: string;
+  tokenToDecrypt?: string;
+};
+
+export type Video = Media & { duration: string };
+
+export type Record = Video & { type: string };
+
+export type Stream = Media & {
+  chatIsEnabled: boolean;
+  checkLiveUrl: string;
+  entityCode: string;
+  isPublish: boolean;
+  link: null | string;
+  message: string;
+  records: Array<Record>;
+  type: string;
+};
+
+export type MediaData = Stream | Video | Array<Stream | Video>;
+
+export interface BmsPlayerConfig {
+  [key: string]: any;
+  bases: {
+    api: string;
+    frontend: string;
+    io: string;
+    parked?: string;
+  };
+  code: string;
+  language: string;
+  id_recovery: null | string;
+  subscriptions?: SubscriptionOptions[];
+  gateways?: GatewayOption[];
+  entity: {
+    code: string;
+    title: string;
+  };
+  device_ban: '0' | '1';
+  time?: Date;
+  recoveryCode?: string;
+  contacts?: {
+    contact: string;
+    phone: string;
+    email: string;
+    site: string;
+    description: string;
+  };
+  posters: BmsSourcePoster[];
+  ppv_logo?: string;
+  ppv_play_button_state_play?: string;
+  mediaData: MediaData;
+}
+
+export interface BmsVideoSource {
+  bms: boolean;
+  code: string;
+  duration: string;
+  encoded: boolean;
+  isLive: boolean;
+  name: string;
+  poster: string;
+  posters: BmsSourcePoster[];
+  src: string;
+  state: string;
+  type: string;
+  token?: string;
+}
+