@vkontakte/videoplayer-core 2.0.69 → 2.0.71

package/index.d.ts

@@ -1,6 +1,6 @@
 import { VideoFormat, IMpegSource, IDashSource, IHLSSource, IDashURLSource, IHLSLiveSource, StartStatus, ISeekRequest, URLSource, RawSource, URLSourceWithSeek } from "./player/types";
 import Player from "./player/Player";
-import { IPlayer, PlaybackState, IPlayerInfo, IPlayerEvents, IConfig, ISources, ICueSettings, ChromecastState, HttpConnectionType, IExternalTextTrack, ITextTrack } from "./player/types";
+import { IPlayer, PlaybackState, IPlayerInfo, IPlayerEvents, IConfig, ISources, ICueSettings, ChromecastState, HttpConnectionType, IExternalTextTrack, ITextTrack, PlaybackRate } from "./player/types";
 import { VideoQuality, ExactVideoQuality } from "./utils/quality/types";
 import type { ISubscription, IUnsubscriber, IEmitter, IObservable, IValueObservable, IValue, IOperator, IListener, ILogEntry, IRange } from '@vkontakte/videoplayer-shared';
 import { Subscription, Observable, Subject, ValueSubject } from '@vkontakte/videoplayer-shared';
@@ -8,4 +8,4 @@ import { Subscription, Observable, Subject, ValueSubject } from '@vkontakte/vide
  * Версия sdk
  */
 declare const SDK_VERSION: string;
-export { Player, IPlayer, PlaybackState, IPlayerInfo, IPlayerEvents, IConfig, ILogEntry, ISources, IExternalTextTrack, ITextTrack, ChromecastState, HttpConnectionType, Subscription, ISubscription, IUnsubscriber, IObservable, IEmitter, IValueObservable, IValue, IOperator, IListener, VideoFormat, IMpegSource, IDashSource, IDashURLSource, IHLSSource, IHLSLiveSource, URLSource, RawSource, URLSourceWithSeek, VideoQuality, ExactVideoQuality, Observable, Subject, ValueSubject, IRange, StartStatus, ISeekRequest, ICueSettings, SDK_VERSION, };
+export { Player, IPlayer, PlaybackState, IPlayerInfo, IPlayerEvents, IConfig, ILogEntry, ISources, IExternalTextTrack, ITextTrack, ChromecastState, HttpConnectionType, Subscription, ISubscription, IUnsubscriber, IObservable, IEmitter, IValueObservable, IValue, IOperator, IListener, VideoFormat, IMpegSource, IDashSource, IDashURLSource, IHLSSource, IHLSLiveSource, URLSource, RawSource, URLSourceWithSeek, VideoQuality, ExactVideoQuality, Observable, Subject, ValueSubject, IRange, StartStatus, ISeekRequest, ICueSettings, SDK_VERSION, PlaybackRate, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vkontakte/videoplayer-core",
-  "version": "2.0.69",
+  "version": "2.0.71",
   "author": "vk.com",
   "description": "Videoplayer core library based on the vk.com platform",
   "homepage": "https://vk.com",

package/packages/core/src/providers/WebRTCLiveProvider/interface/WebRTCLiveClientOptions.d.ts

@@ -0,0 +1,9 @@
+import { IError, ISubject } from '@vkontakte/videoplayer-shared';
+/**
+ * WebRTCLiveClient options description
+ */
+export interface WebRTCLiveClientOptions {
+    stunServerList: string[];
+    maxRetryNumber: number;
+    errorChanel: ISubject<IError> | null;
+}

package/packages/core/src/providers/types.d.ts

@@ -3,7 +3,7 @@ import { ITuningConfig } from "../utils/tuningConfig";
 import { ILogger, ISubject, IValueSubject, Milliseconds, Seconds, IRange, IError } from '@vkontakte/videoplayer-shared';
 import { IChromecastInitializer } from "./ChromecastProvider/ChromecastInitializer/types";
 import { HttpConnectionType, ICueSettings, SeekState } from "../player/types";
-import { IExternalTextTrack, ITextTrack, IVideoTrack, IVolumeState, PlaybackState } from "../player/types";
+import { IExternalTextTrack, ITextTrack, IVideoTrack, IVolumeState, PlaybackState, PlaybackRate } from "../player/types";
 import { IStateMachine } from "../utils/StateMachine/types";
 import ThroughputEstimator from "../utils/ThroughputEstimator";
 export interface IProvider {
@@ -27,6 +27,7 @@ export interface IDesiredState {
     playbackState: IStateMachine<PlaybackState>;
     seekState: IStateMachine<SeekState>;
     volume: IStateMachine<IVolumeState>;
+    playbackRate: IStateMachine<PlaybackRate>;
     videoTrack: IStateMachine<IVideoTrack['id'] | undefined>;
     autoVideoTrackSwitching: IStateMachine<boolean>;
     autoVideoTrackLimits: IStateMachine<QualityLimits>;

package/player/Player.d.ts

@@ -1,4 +1,4 @@
-import { HttpConnectionType, ICueSettings, StartEnd } from "./types";
+import { HttpConnectionType, ICueSettings, StartEnd, PlaybackRate } from "./types";
 import { QualityLimits, VideoQuality } from "../utils/quality/types";
 import { IOptionalTuningConfig } from "../utils/tuningConfig";
 import { IError, ILogEntry, Seconds, Subject, ValueSubject } from '@vkontakte/videoplayer-shared';
@@ -28,6 +28,7 @@ export default class Player implements IPlayer {
         isAutoQualityEnabled$: ValueSubject<boolean>;
         autoQualityLimitingAvailable$: ValueSubject<boolean>;
         autoQualityLimits$: ValueSubject<QualityLimits>;
+        currentPlaybackRate$: ValueSubject<number>;
         currentBuffer$: ValueSubject<StartEnd<number>>;
         isBuffering$: ValueSubject<boolean>;
         isStalled$: ValueSubject<boolean>;
@@ -93,6 +94,7 @@ export default class Player implements IPlayer {
     setQuality(quality: VideoQuality): IPlayer;
     setAutoQuality(enable: boolean): IPlayer;
     setAutoQualityLimits(limits: QualityLimits): IPlayer;
+    setPlaybackRate(playbackRate: PlaybackRate): IPlayer;
     setExternalTextTracks(tracks: Omit<IExternalTextTrack, 'type'>[]): IPlayer;
     selectTextTrack(id: ITextTrack['id'] | undefined): IPlayer;
     setTextTrackCueSettings(settings: ICueSettings): IPlayer;

package/player/types.d.ts

@@ -35,6 +35,7 @@ export interface IPlayer {
     setQuality(quality: VideoQuality): IPlayer;
     setAutoQuality(enable: boolean): IPlayer;
     setAutoQualityLimits(limit: QualityLimits): IPlayer;
+    setPlaybackRate(playbackRate: PlaybackRate): IPlayer;
     setLooped(isLooped: boolean): IPlayer;
     setExternalTextTracks(tracks: Omit<IExternalTextTrack, 'type'>[]): IPlayer;
     selectTextTrack(id: ITextTrack['id'] | undefined): IPlayer;
@@ -206,6 +207,10 @@ export interface IPlayerInfo {
      * Текущие лимиты авто-качества
      */
     autoQualityLimits$: IValueObservable<QualityLimits>;
+    /**
+     * Текущая скорость воспроизведения
+     */
+    currentPlaybackRate$: IValueObservable<PlaybackRate>;
     /**
      * Текущий буффер (тот, который содержит текущую позицию воспроизведения)
      *
@@ -319,6 +324,7 @@ export interface ISources {
     [VideoFormat.HLS]?: IHLSSource;
     [VideoFormat.HLS_ONDEMAND]?: IHLSSource;
     [VideoFormat.HLS_LIVE]?: IHLSLiveSource;
+    [VideoFormat.WEB_RTC_LIVE]?: URLSource;
 }
 export interface IMetadata {
     title?: string;
@@ -361,7 +367,8 @@ export declare enum VideoFormat {
     HLS_ONDEMAND = "HLS_ONDEMAND",
     /** @deprecated Используйте HLS */
     HLS_JS = "HLS",
-    HLS_LIVE = "HLS_LIVE"
+    HLS_LIVE = "HLS_LIVE",
+    WEB_RTC_LIVE = "WEB_RTC_LIVE"
 }
 export interface IVideoTrack {
     id: string;
@@ -430,4 +437,5 @@ declare type SeekStateNotNone = {
 };
 export declare type SeekState = SeekStateNone | SeekStateNotNone;
 export declare type FpsByQuality = Partial<Record<VideoQuality, number>>;
+export declare type PlaybackRate = number;
 export {};

package/providers/DashLiveProvider/utils/LiveDashPlayer.d.ts

@@ -0,0 +1,135 @@
+import { Milliseconds } from '@vkontakte/videoplayer-shared';
+import { IRepresentation } from '../types';
+interface IParams {
+    videoElement: HTMLVideoElement;
+    playerCallback: (...args: any) => void;
+    config: {
+        minBuffer: Milliseconds;
+        lowLatencyMinBuffer: Milliseconds;
+        minBufferSegments: number;
+        lowLatencyMinBufferSegments: number;
+        maxParallelRequests: number;
+    };
+    logger: (...args: any[]) => void;
+}
+export default class LiveDashPlayer {
+    private paused;
+    private autoQuality;
+    private maxAutoQuality;
+    private buffering;
+    private destroyed;
+    private videoPlayStarted;
+    private lowLatency;
+    private rep?;
+    private bitrate;
+    private manifest;
+    private bitrateSwitcher?;
+    private filesFetcher?;
+    private sourceBuffer?;
+    private mediaSource?;
+    private currentManifestEntry?;
+    private manifestRequest?;
+    private manifestRefetchTimer?;
+    private bufferStates;
+    private downloadRate?;
+    private sourceJitter;
+    private chunkRateEstimator;
+    private manifestUrl;
+    private urlResolver;
+    private params;
+    constructor(params: IParams);
+    attachSource(manifestUrl: string): void;
+    /**
+     * switch to auto quality
+     */
+    setAutoQualityEnabled(enabled: boolean): void;
+    setMaxAutoQuality(height: number | undefined): void;
+    /**
+     * switch quality by name
+     */
+    switchByName(name: string): void;
+    /**
+     * seek to actual video position
+     */
+    catchUp(): void;
+    stop(): void;
+    pause(): void;
+    play(onPlayNotAllowed?: () => void): void;
+    startPlay(targetQ: IRepresentation, autoQuality: boolean): void;
+    /**
+     * destroy player
+     */
+    destroy(): void;
+    reinit(newManifestUrl: string): void;
+    /**
+     * if all retries fail...
+     */
+    private _handleNetworkError;
+    /**
+     * Retry request
+     */
+    private _retryCallback;
+    /**
+     * how many seconds are there in the buffer
+     */
+    private _getBufferSizeSec;
+    /**
+     * send buffering notification to player
+     */
+    private _notifyBuffering;
+    /**
+     * initialize video tag, add necessary event listeners
+     * @private
+     */
+    private _initVideo;
+    /**
+     * there may be small gaps of several milliseconds when switching quality
+     * we jump over these gaps here
+     */
+    private _fixupStall;
+    /**
+     * return best quality for rate
+     */
+    private _selectQuality;
+    private shouldPlay;
+    /**
+     * set video source
+     */
+    private _setVideoSrc;
+    /**
+     * initialize player with target quality
+     */
+    private _initPlayerWith;
+    /**
+     * represents specific quality stream
+     */
+    private _representation;
+    /**
+     * switch to quality
+     * TODO: Если новое качество выше старого – переключиться сразу. Если хуже, доиграть буфер
+     */
+    private _switchToQuality;
+    /**
+     * check if quality is available
+     */
+    private _qualityAvailable;
+    /**
+     * analyze bitrate data and switch qualities accordingly
+     */
+    private _initBitrateSwitcher;
+    /**
+     * load and parse manifest file
+     */
+    private _fetchManifest;
+    private _playVideoElement;
+    /**
+     * update internal state when manifest was received from remote
+     */
+    private _handleManifestUpdate;
+    /**
+     * schedule manifest update after delay
+     */
+    private _refetchManifest;
+    private _initManifest;
+}
+export {};

package/providers/WebRTCLiveProvider/WebRTCLiveClient.d.ts

@@ -0,0 +1,188 @@
+import { WebRTCLiveClientOptions } from "./interface/WebRTCLiveClientOptions";
+/**
+ *
+ */
+export declare class WebRTCLiveClient {
+    private options;
+    private ws;
+    private peerConnection;
+    serverUrl: string;
+    streamKey: string;
+    stream: MediaStream | null;
+    signalingType: string;
+    private retryTimeout;
+    private retryCount;
+    private externalStartCallback;
+    private externalStopCallback;
+    private externalErrorCallback;
+    /**
+     * @param url
+     * @param options
+     */
+    constructor(url: string, options?: Partial<WebRTCLiveClientOptions>);
+    /**
+     * Sets start streaming callback
+     *
+     * @param cb
+     */
+    onStart(cb: (stream: MediaStream) => void): void;
+    /**
+     * Sets stop streaming callback
+     *
+     * @param cb
+     */
+    onStop(cb: () => void): void;
+    /**
+     * Sets streaming or connection error callback
+     *
+     * @param cb
+     */
+    onError(cb: (e: Error) => void): void;
+    /**
+     * Start connection dialog
+     */
+    connect(): void;
+    /**
+     * Kill connection
+     */
+    disconnect(): void;
+    /**
+     * Begins socket opening
+     * @private
+     */
+    private connectWS;
+    /**
+     * Socket opened event handler
+     * Begins login process
+     * @private
+     */
+    private onSocketOpen;
+    /**
+     * Socket close event handler
+     * @param e
+     * @private
+     */
+    private onSocketClose;
+    /**
+     * Socket connection error handler
+     * @param e
+     * @private
+     */
+    private onSocketError;
+    /**
+     * Socket message handler
+     * @param message
+     * @private
+     */
+    private onSocketMessage;
+    /**
+     * Socket JOIN message handler
+     * @param message
+     * @private
+     */
+    private handleJoinMessage;
+    /**
+     * Socket STATUS message handler
+     * @param message
+     * @private
+     */
+    private handleStatusMessage;
+    /**
+     * Socket UPDATE message handler
+     * @param message
+     * @private
+     */
+    private handleUpdateMessage;
+    /**
+     * Handles peer connection login process
+     * @private
+     */
+    private handleLogin;
+    /**
+     * Adds received remote offer to peer connection
+     * @private
+     */
+    private handleAnswer;
+    /**
+     * Adds ICE candidate to peer connection
+     * @param candidate
+     * @private
+     */
+    private handleCandidate;
+    /**
+     * Live stream finish handler
+     * @private
+     */
+    private handleUnpublished;
+    /**
+     * Handles system failures
+     */
+    private handleSystemError;
+    /**
+     * Peer connection stream received handler
+     * @param e
+     * @private
+     */
+    private onPeerConnectionStream;
+    /**
+     * ICE candidate received handler
+     * @param e
+     * @private
+     */
+    private onPeerConnectionIceCandidate;
+    /**
+     * Peer connection ICE connection state change handler
+     * @private
+     */
+    private onPeerConnectionIceConnectionStateChange;
+    /**
+     * Returns newly created offer
+     * @private
+     */
+    private createOffer;
+    /**
+     * Handles RTC connection error
+     * @param e
+     * @private
+     */
+    private handleRTCError;
+    /**
+     * Handles network error
+     * @private
+     */
+    private handleNetworkError;
+    /**
+     * Sends message to websocket
+     * @param message
+     * @private
+     */
+    private send;
+    /**
+     * Parses JSON message to object
+     * @param message
+     */
+    private parseMessage;
+    /**
+     * Closes all connections (ws and peer connection)
+     * @private
+     */
+    private closeConnections;
+    /**
+     * Kills peer connection
+     * @private
+     */
+    private removePeerConnection;
+    /**
+     * Schedules connection retry
+     *
+     * @private
+     */
+    private scheduleRetry;
+    /**
+     * Returns normalized options with all defaults set
+     *
+     * @param userOptions
+     * @private
+     */
+    private normalizeOptions;
+}

package/providers/WebRTCLiveProvider/WebRTCLiveProvider.d.ts

@@ -0,0 +1,60 @@
+import { IProvider, IProviderParams } from "../types";
+import { URLSource } from "../../player/types";
+/**
+ * @class WebRTCLiveProvider
+ *
+ * Provides implementation of WEBRTC live streaming support
+ */
+export default class WebRTCLiveProvider implements IProvider {
+    private readonly subscription;
+    private readonly params;
+    private log;
+    private video;
+    private videoState;
+    private liveStreamClient;
+    private maxSeekBackTime$;
+    /**
+     * @param params
+     */
+    constructor(params: IProviderParams<URLSource>);
+    /**
+     * Destroys the provider
+     */
+    destroy(): void;
+    /**
+     * Creates all needed provider subscriptions
+     * @private
+     */
+    private subscribe;
+    /**
+     * Live stream start handler
+     * @private
+     */
+    private onLiveStreamStart;
+    /**
+     * Live stream stop handler
+     * @private
+     */
+    private onLiveStreamStop;
+    /**
+     * Live stream error handler
+     * @private
+     */
+    private onLiveStreamError;
+    /**
+     * Tries to start playing
+     * @private
+     */
+    private playIfAllowed;
+    /**
+     * Runs preparation phase
+     * Starts live client connection
+     * @private
+     */
+    private prepare;
+    /**
+     * Performs synchronization between desired state and video state
+     * @private
+     */
+    private syncPlayback;
+}

package/providers/utils/observableVideo.d.ts

@@ -1,5 +1,5 @@
 import { Seconds, IRange, IObservable, IError } from '@vkontakte/videoplayer-shared';
-import { IVolumeState } from "../../player/types";
+import { IVolumeState, PlaybackRate } from "../../player/types";
 interface IObservableVideo {
     playing$: IObservable<undefined>;
     pause$: IObservable<undefined>;
@@ -18,6 +18,7 @@ interface IObservableVideo {
     isBuffering$: IObservable<boolean>;
     currentBuffer$: IObservable<IRange<Seconds>>;
     volumeState$: IObservable<IVolumeState>;
+    playbackRateState$: IObservable<PlaybackRate>;
 }
 export declare const observe: (video: HTMLVideoElement) => IObservableVideo;
 export {};

package/providers/utils/syncDesiredState.d.ts

@@ -1,5 +1,5 @@
 import { IListener, IObservable, ISubscription } from '@vkontakte/videoplayer-shared';
-import { IVolumeState } from "../../player/types";
+import { IVolumeState, PlaybackRate } from "../../player/types";
 import { IStateMachine } from "../../utils/StateMachine/types";
 declare const syncDesiredState: <Value>(desiredState: IStateMachine<Value | undefined>, get: () => Value | undefined, set: (value: Value | undefined) => void, { equal, changed$, onError, }?: {
     equal?: ((a: Value | undefined, b: Value | undefined) => boolean) | undefined;
@@ -8,4 +8,5 @@ declare const syncDesiredState: <Value>(desiredState: IStateMachine<Value | unde
 }) => ISubscription;
 export declare const syncVideoLooped: (video: HTMLVideoElement, desiredState: IStateMachine<boolean>, onError?: IListener<Error | unknown>) => ISubscription;
 export declare const syncVideoVolumeState: (video: HTMLVideoElement, desiredState: IStateMachine<IVolumeState>, changed$: IObservable<IVolumeState>, onError?: IListener<Error | unknown>) => ISubscription;
+export declare const syncVideoPlaybackRate: (video: HTMLVideoElement, desiredState: IStateMachine<PlaybackRate>, changed$: IObservable<PlaybackRate>, onError?: IListener<Error | unknown>) => ISubscription;
 export default syncDesiredState;

package/utils/buffer/isPositionBuffered.d.ts

@@ -0,0 +1,3 @@
+import { Milliseconds } from '@vkontakte/videoplayer-shared';
+declare const _default: (timeRanges: TimeRanges, position: Milliseconds) => boolean;
+export default _default;

package/utils/tuningConfig.d.ts

@@ -65,6 +65,9 @@ export declare type ITuningConfig = {
     requestQuick: boolean;
     useDashJs: boolean;
     useHlsJs: boolean;
+    webrtc: {
+        connectionRetryMaxNumber: number;
+    };
 };
 export declare type IOptionalTuningConfig = {
     [key in keyof ITuningConfig]?: Partial<ITuningConfig[key]>;