@hanifhan1f/vidstack 1.12.13 → 1.12.18

package/src/core/api/player-state.ts

@@ -1,940 +0,0 @@
-import fscreen from 'fscreen';
-import { State, tick, type Store } from 'maverick.js';
-import { isNumber } from 'maverick.js/std';
-
-import type { LogLevel } from '../../foundation/logger/log-level';
-import type { MediaProviderLoader } from '../../providers/types';
-import { canOrientScreen, IS_IPHONE } from '../../utils/support';
-import type { VideoQuality } from '../quality/video-quality';
-import { getTimeRangesEnd, getTimeRangesStart, TimeRange } from '../time-ranges';
-import type { AudioTrack } from '../tracks/audio/audio-tracks';
-import { isTrackCaptionKind, type TextTrack } from '../tracks/text/text-track';
-import type { Src } from './src-types';
-import type {
-  MediaCrossOrigin,
-  MediaErrorDetail,
-  MediaStreamType,
-  MediaType,
-  MediaViewType,
-  RemotePlaybackInfo,
-  RemotePlaybackType,
-} from './types';
-
-export interface MediaPlayerState extends MediaState {}
-
-export const mediaState = new State<MediaState>({
-  artist: '',
-  artwork: null,
-  audioTrack: null,
-  audioTracks: [],
-  autoPlay: false,
-  autoPlayError: null,
-  audioGain: null,
-  buffered: new TimeRange(),
-  canLoad: false,
-  canLoadPoster: false,
-  canFullscreen: false,
-  canOrientScreen: canOrientScreen(),
-  canPictureInPicture: false,
-  canPlay: false,
-  clipStartTime: 0,
-  clipEndTime: 0,
-  controls: false,
-  get iOSControls() {
-    return (
-      IS_IPHONE &&
-      this.mediaType === 'video' &&
-      (!this.playsInline || (!fscreen.fullscreenEnabled && this.fullscreen))
-    );
-  },
-  get nativeControls() {
-    return this.controls || this.iOSControls;
-  },
-  controlsVisible: false,
-  get controlsHidden() {
-    return !this.controlsVisible;
-  },
-  crossOrigin: null,
-  ended: false,
-  error: null,
-  fullscreen: false,
-  get loop() {
-    return this.providedLoop || this.userPrefersLoop;
-  },
-  logLevel: __DEV__ ? 'warn' : 'silent',
-  mediaType: 'unknown',
-  muted: false,
-  paused: true,
-  played: new TimeRange(),
-  playing: false,
-  playsInline: false,
-  pictureInPicture: false,
-  preload: 'metadata',
-  playbackRate: 1,
-  qualities: [],
-  quality: null,
-  autoQuality: false,
-  canSetQuality: true,
-  canSetPlaybackRate: true,
-  canSetVolume: false,
-  canSetAudioGain: false,
-  seekable: new TimeRange(),
-  seeking: false,
-  source: { src: '', type: '' },
-  sources: [],
-  started: false,
-  textTracks: [],
-  textTrack: null,
-  get hasCaptions() {
-    return this.textTracks.filter(isTrackCaptionKind).length > 0;
-  },
-  volume: 1,
-  waiting: false,
-  realCurrentTime: 0,
-  get currentTime() {
-    return this.ended
-      ? this.duration
-      : this.clipStartTime > 0
-        ? Math.max(0, Math.min(this.realCurrentTime - this.clipStartTime, this.duration))
-        : this.realCurrentTime;
-  },
-  providedDuration: -1,
-  intrinsicDuration: 0,
-  get duration() {
-    return this.seekableWindow;
-  },
-  get title() {
-    return this.providedTitle || this.inferredTitle;
-  },
-  get poster() {
-    return this.providedPoster || this.inferredPoster;
-  },
-  get viewType() {
-    return this.providedViewType !== 'unknown' ? this.providedViewType : this.inferredViewType;
-  },
-  get streamType() {
-    return this.providedStreamType !== 'unknown'
-      ? this.providedStreamType
-      : this.inferredStreamType;
-  },
-  get currentSrc() {
-    return this.source;
-  },
-  get bufferedStart() {
-    const start = getTimeRangesStart(this.buffered) ?? 0;
-    return Math.max(start, this.clipStartTime);
-  },
-  get bufferedEnd() {
-    const end = getTimeRangesEnd(this.buffered) ?? 0;
-    return Math.min(this.seekableEnd, Math.max(0, end - this.clipStartTime));
-  },
-  get bufferedWindow() {
-    return Math.max(0, this.bufferedEnd - this.bufferedStart);
-  },
-  get seekableStart() {
-    if (this.isLiveDVR && this.liveDVRWindow > 0) {
-      return Math.max(0, this.seekableEnd - this.liveDVRWindow);
-    }
-
-    const start = getTimeRangesStart(this.seekable) ?? 0;
-    return Math.max(start, this.clipStartTime);
-  },
-  get seekableEnd() {
-    if (this.providedDuration > 0) return this.providedDuration;
-
-    const end =
-      this.liveSyncPosition > 0
-        ? this.liveSyncPosition
-        : this.canPlay
-          ? (getTimeRangesEnd(this.seekable) ?? Infinity)
-          : 0;
-
-    return this.clipEndTime > 0 ? Math.min(this.clipEndTime, end) : end;
-  },
-  get seekableWindow() {
-    const window = this.seekableEnd - this.seekableStart;
-    return !isNaN(window) ? Math.max(0, window) : Infinity;
-  },
-
-  // ~~ remote playback ~~
-  canAirPlay: false,
-  canGoogleCast: false,
-  remotePlaybackState: 'disconnected',
-  remotePlaybackType: 'none',
-  remotePlaybackLoader: null,
-  remotePlaybackInfo: null,
-  get isAirPlayConnected() {
-    return this.remotePlaybackType === 'airplay' && this.remotePlaybackState === 'connected';
-  },
-  get isGoogleCastConnected() {
-    return this.remotePlaybackType === 'google-cast' && this.remotePlaybackState === 'connected';
-  },
-
-  // ~~ responsive design ~~
-  pointer: 'fine',
-  orientation: 'landscape',
-  width: 0,
-  height: 0,
-  mediaWidth: 0,
-  mediaHeight: 0,
-  lastKeyboardAction: null,
-
-  // ~~ user props ~~
-  userBehindLiveEdge: false,
-
-  // ~~ live props ~~
-  liveEdgeTolerance: 10,
-  minLiveDVRWindow: 60,
-  get canSeek() {
-    return (
-      /unknown|on-demand|:dvr/.test(this.streamType) &&
-      Number.isFinite(this.duration) &&
-      (!this.isLiveDVR || this.duration >= this.liveDVRWindow)
-    );
-  },
-  get live() {
-    return this.streamType.includes('live') || !Number.isFinite(this.duration);
-  },
-  get liveEdgeStart() {
-    return this.live && Number.isFinite(this.seekableEnd)
-      ? Math.max(0, this.seekableEnd - this.liveEdgeTolerance)
-      : 0;
-  },
-  get liveEdge() {
-    return (
-      this.live &&
-      (!this.canSeek || (!this.userBehindLiveEdge && this.currentTime >= this.liveEdgeStart))
-    );
-  },
-  get liveEdgeWindow() {
-    return this.live && Number.isFinite(this.seekableEnd)
-      ? this.seekableEnd - this.liveEdgeStart
-      : 0;
-  },
-  get isLiveDVR() {
-    return /:dvr/.test(this.streamType);
-  },
-  get liveDVRWindow() {
-    return Math.max(this.inferredLiveDVRWindow, this.minLiveDVRWindow);
-  },
-
-  // ~~ internal props ~~
-  autoPlaying: false,
-  providedTitle: '',
-  inferredTitle: '',
-  providedLoop: false,
-  userPrefersLoop: false,
-  providedPoster: '',
-  inferredPoster: '',
-  inferredViewType: 'unknown',
-  providedViewType: 'unknown',
-  providedStreamType: 'unknown',
-  inferredStreamType: 'unknown',
-  liveSyncPosition: null,
-  inferredLiveDVRWindow: 0,
-  savedState: null,
-});
-
-const RESET_ON_SRC_QUALITY_CHANGE = new Set<keyof MediaState>([
-  'autoPlayError',
-  'autoPlaying',
-  'buffered',
-  'canPlay',
-  'error',
-  'paused',
-  'played',
-  'playing',
-  'seekable',
-  'seeking',
-  'waiting',
-]);
-
-const RESET_ON_SRC_CHANGE = new Set<keyof MediaState>([
-  ...RESET_ON_SRC_QUALITY_CHANGE,
-  'ended',
-  'inferredPoster',
-  'inferredStreamType',
-  'inferredTitle',
-  'intrinsicDuration',
-  'inferredLiveDVRWindow',
-  'liveSyncPosition',
-  'realCurrentTime',
-  'savedState',
-  'started',
-  'userBehindLiveEdge',
-]);
-
-/**
- * Resets all media state and leaves general player state intact.
- */
-export function softResetMediaState($media: MediaStore, isSourceQualityChange = false) {
-  const filter = isSourceQualityChange ? RESET_ON_SRC_QUALITY_CHANGE : RESET_ON_SRC_CHANGE;
-  mediaState.reset($media, (prop) => filter.has(prop));
-  tick();
-}
-
-export interface MediaStore extends Store<MediaState> {}
-
-export interface PlayerStore extends MediaStore {}
-
-export interface MediaState {
-  /**
-   * Whether playback should automatically begin as soon as enough media is available to do so
-   * without interruption.
-   *
-   * Sites which automatically play audio (or videos with an audio track) can be an unpleasant
-   * experience for users, so it should be avoided when possible. If you must offer auto-play
-   * functionality, you should make it opt-in (requiring a user to specifically enable it).
-   *
-   * However, auto-play can be useful when creating media elements whose source will be set at a
-   * later time, under user control.
-   *
-   * @defaultValue false
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/autoplay}
-   */
-  autoPlay: boolean;
-  /**
-   * Set to an error when auto-play has failed to begin playback. This can be used to determine
-   * when to show a recovery UI in the event auto-play fails.
-   *
-   * @defaultValue null
-   */
-  autoPlayError: { muted: boolean; error: Error } | null;
-  /**
-   * Returns a `TimeRanges` object that indicates the ranges of the media source that the
-   * browser has buffered (if any) at the moment the buffered property is accessed. This is usually
-   * contiguous but if the user jumps about while media is buffering, it may contain holes.
-   *
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/TimeRanges}
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/buffered}
-   * @defaultValue TimeRanges
-   */
-  buffered: TimeRanges;
-  /**
-   * The earliest time in seconds for which media has been buffered (i.e., downloaded by the
-   * browser).
-   *
-   * @defaultValue 0
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/buffered}
-   */
-  readonly bufferedStart: number;
-  /**
-   * The latest time in seconds for which media has been buffered (i.e., downloaded by the
-   * browser).
-   *
-   * @defaultValue 0
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/buffered}
-   */
-  readonly bufferedEnd: number;
-  /**
-   * The length of the buffered window in seconds from `bufferedStart` to `bufferedEnd`.
-   */
-  readonly bufferedWindow: number;
-  /**
-   * A `double` indicating the total playback length of the media in seconds. If no media data is
-   * available, the returned value is `0`. If the media is of indefinite length (such as
-   * streamed live media, a WebRTC call's media, or similar), the value is `+Infinity`.
-   *
-   * @defaultValue 0
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/duration}
-   */
-  readonly duration: number;
-  /**
-   * Whether Apple AirPlay is available for casting and playing media on another device such as a
-   * TV.
-   */
-  canAirPlay: boolean;
-  /**
-   * Whether Google Cast is available for casting and playing media on another device such as a TV.
-   */
-  canGoogleCast: boolean;
-  /**
-   * The current remote playback state when using AirPlay or Google Cast.
-   */
-  remotePlaybackState: RemotePlaybackState;
-  /**
-   * The type of remote playback that is currently connecting or connected.
-   */
-  remotePlaybackType: RemotePlaybackType;
-  /**
-   * An active remote playback loader such as the `GoogleCastLoader`.
-   */
-  remotePlaybackLoader: MediaProviderLoader | null;
-  /**
-   * Information about the current remote playback.
-   */
-  remotePlaybackInfo: RemotePlaybackInfo | null;
-  /**
-   * Whether AirPlay is connected.
-   */
-  readonly isAirPlayConnected: boolean;
-  /**
-   * Whether Google Cast is connected.
-   */
-  readonly isGoogleCastConnected: boolean;
-  /**
-   * Whether the native browser Fullscreen API is available, or the current provider can
-   * toggle fullscreen mode. This does not mean that the operation is guaranteed to be successful,
-   * only that it can be attempted.
-   *
-   * @defaultValue false
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API}
-   */
-  canFullscreen: boolean;
-  /**
-   * Whether the native Screen Orientation API and required methods (lock/unlock) are available.
-   *
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Screen_Orientation_API}
-   */
-  canOrientScreen: boolean;
-  /**
-   * Whether picture-in-picture mode is supported by the current media provider.
-   *
-   * @defaultValue false
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Picture-in-Picture_API}
-   */
-  canPictureInPicture: boolean;
-  /**
-   * Whether media is allowed to begin loading. This depends on the `load` player prop.
-   *
-   * @see {@link https://vidstack.io/docs/player/core-concepts/loading#load-strategies}
-   */
-  canLoad: boolean;
-  /**
-   * Whether the media poster is allowed to begin loading. This depends on the `posterLoad`
-   * player prop.
-   *
-   * @see {@link https://vidstack.io/docs/player/core-concepts/loading#load-strategies}
-   */
-  canLoadPoster: boolean;
-  /**
-   * Whether the user agent can play the media, but estimates that **not enough** data has been
-   * loaded to play the media up to its end without having to stop for further buffering of
-   * content.
-   *
-   * @defaultValue false
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/canplay_event}
-   */
-  canPlay: boolean;
-  /**
-   * Whether seeking operations are possible on the current stream. This generally false for
-   * live streams that are loaded natively.
-   *
-   * @defaultValue true
-   */
-  readonly canSeek: boolean;
-  /**
-   * Limit playback to only play _after_ a certain time. Playback will begin from this time.
-   *
-   * @defaultValue 0
-   */
-  clipStartTime: number;
-  /**
-   * Limit playback to only play _before_ a certain time. Playback will end at this time.
-   *
-   * @defaultValue 0
-   */
-  clipEndTime: number;
-  /**
-   * Indicates whether a user interface should be shown for controlling the resource. Set this to
-   * `false` when you want to provide your own custom controls, and `true` if you want the current
-   * provider to supply its own default controls. Depending on the provider, changing this prop
-   * may cause the player to completely reset.
-   *
-   * @defaultValue false
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/controls}
-   */
-  controls: boolean;
-  /**
-   * Whether iOS Safari video controls are visible. This will be true if `playsinline` is not set
-   * or in fullscreen due to lack of a Fullscreen API.
-   */
-  readonly iOSControls: boolean;
-  /**
-   * Whether native controls should be shown due to the `controls` state or `iOSControls` state.
-   */
-  readonly nativeControls: boolean;
-  /**
-   * Defines how the media element handles cross-origin requests, thereby enabling the
-   * configuration of the CORS requests for the element's fetched data.
-   *
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/crossorigin}
-   */
-  crossOrigin: MediaCrossOrigin | null;
-  /**
-   * The URL of the current poster. Defaults to `''` if no media/poster has been given or
-   * loaded.
-   *
-   * @defaultValue ''
-   */
-  readonly poster: string;
-  /**
-   * A `double` indicating the current playback time in seconds. Defaults to `0` if the media has
-   * not started to play and has not seeked. Setting this value seeks the media to the new
-   * time. The value can be set to a minimum of `0` and maximum of the total length of the
-   * media (indicated by the duration prop).
-   *
-   * @defaultValue 0
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/currentTime}
-   */
-  readonly currentTime: number;
-  /**
-   * Whether media playback has reached the end. In other words it'll be true
-   * if `currentTime === duration`.
-   *
-   * @defaultValue false
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/ended}
-   */
-  ended: boolean;
-  /**
-   * Contains the most recent media error or undefined if there's been none. You can listen for
-   * `error` event updates and examine this object to debug further.
-   *
-   * @defaultValue null
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/error}
-   */
-  error: MediaErrorDetail | null;
-  /**
-   * Whether the player is currently in fullscreen mode.
-   *
-   * @defaultValue false
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API}
-   */
-  fullscreen: boolean;
-  /**
-   * Whether the controls are visible. By default, controls will be hidden when media playback
-   * is progressing (playing) without any detected user activity for a set period of time
-   * (default is 2.5s).
-   *
-   * @defaultValue false
-   */
-  controlsVisible: boolean;
-  /**
-   * Whether controls are hidden.
-   */
-  readonly controlsHidden: boolean;
-  /**
-   * Whether the user has intentionally seeked behind the live edge. The user must've seeked
-   * roughly 2 or more seconds behind during a live stream for this to be considered true.
-   *
-   * @defaultValue false
-   */
-  userBehindLiveEdge: boolean;
-  /**
-   * Whether media should automatically start playing from the beginning (replay) every time
-   * it ends.
-   *
-   * @defaultValue false
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/loop}
-   */
-  readonly loop: boolean;
-  /**
-   * The current log level. Values in order of priority are: `silent`, `error`, `warn`, `info`,
-   * and `debug`.
-   */
-  logLevel: LogLevel;
-  /**
-   * Whether the current media stream is live (i.e., being broadcast right now).
-   */
-  live: boolean;
-  /**
-   * The number of seconds that `currentTime` can be behind `liveEdgeStart` and still be considered
-   * at the edge. The default value is 10, meaning the user can be up to 10 seconds behind the
-   * live edge start and still be considered live.
-   *
-   * @defaultValue 10
-   */
-  liveEdgeTolerance: number;
-  /**
-   * The minimum seekable length in seconds before seeking operations are permitted on live streams.
-   *
-   * @defaultValue 60
-   */
-  minLiveDVRWindow: number;
-  /**
-   * The inferred length of the live DVR window.
-   */
-  readonly liveDVRWindow: number;
-  /**
-   * Whether the live stream has Digital Video Recording (DVR) enabled.
-   */
-  readonly isLiveDVR: boolean;
-  /**
-   * Whether the current stream is at the live edge. This is true if:
-   *
-   * 1. The player is _not_ in a paused state.
-   * 2. The user has _not_ intentionally seeked behind live edge start.
-   * 3. The `currentTime` is greater or equal than `liveEdgeStart`.
-   *
-   * This value will default to `false` for non-live streams.
-   *
-   * @defaultValue false
-   */
-  readonly liveEdge: boolean;
-  /**
-   * This is the starting edge of the live stream.
-   *
-   * A delay is applied in `hls.js` that's specified by the `liveSyncDurationCount` which is
-   * expressed as a multiple of `EXT-X-TARGETDURATION` (default value is safely set to 3). If
-   * set to `m`, playback will start from the fragment at `n-m`, where `n` is the last fragment
-   * of the live playlist. Decreasing this value is likely to cause playback stalls.
-   *
-   * The `seekableEnd` value is used as the live edge start in native playback engines.
-   *
-   * @see {@link https://github.com/video-dev/hls.js/blob/master/docs/API.md#hlslivesyncposition}
-   * @see {@link https://github.com/video-dev/hls.js/blob/master/docs/API.md#livesyncdurationcount}
-   * @see {@link https://github.com/video-dev/media-ui-extensions/blob/main/proposals/0007-live-edge.md}
-   */
-  readonly liveEdgeStart: number;
-  /**
-   * The length of the live edge window in seconds starting from `liveEdgeStart` and ending at
-   * `seekableEnd`. If the `duration` of the stream is `Infinity` or the stream is non-live then
-   * this value will default to 0.
-   */
-  readonly liveEdgeWindow: number;
-  /**
-   * The type of media that is currently active, whether it's audio or video. Defaults
-   * to `unknown` when no media has been loaded or the type cannot be determined.
-   *
-   * @defaultValue 'unknown'
-   */
-  mediaType: MediaType;
-  /**
-   * Whether the audio is muted or not.
-   *
-   * @defaultValue false
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/muted}
-   */
-  muted: boolean;
-  /**
-   * Whether playback should be paused. Defaults to `true` if no media has loaded or playback has
-   * not started. Setting this to `false` will begin/resume playback.
-   *
-   * @defaultValue true
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/paused}
-   */
-  paused: boolean;
-  /**
-   * Contains the ranges of the media source that the browser has played, if any.
-   *
-   * @defaultValue TimeRanges
-   */
-  played: TimeRanges;
-  /**
-   * Whether media is actively playing back. Defaults to `false` if no media has
-   * loaded or playback has not started.
-   *
-   * @defaultValue false
-   */
-  playing: boolean;
-  /**
-   * Whether the video is to be played "inline", that is within the element's playback area. Note
-   * that setting this to `false` does not imply that the video will always be played in fullscreen.
-   * Depending on the provider, changing this prop may cause the player to completely reset.
-   *
-   * @defaultValue false
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video#attr-playsinline}
-   */
-  playsInline: boolean;
-  /**
-   * Sets the rate at which the media is being played back. This is used to implement user
-   * controls for fast forward, slow motion, and so forth. The normal playback rate is multiplied
-   * by this value to obtain the current rate, so a value of 1.0 indicates normal speed.
-   *
-   * Examples:
-   *
-   * - `0.5` = slow down to 50% of the normal speed
-   * - `1.5` = speed up normal speed by 50%
-   * - `2` = double the normal speed
-   *
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/playbackRate}
-   */
-  playbackRate: number;
-  /**
-   * Whether the player is currently in picture-in-picture mode.
-   *
-   * @defaultValue false
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Picture-in-Picture_API}
-   */
-  pictureInPicture: boolean;
-  /**
-   * Configures the preload setting of the underlying media provider once it can load (see
-   * `loading` property).
-   *
-   * The `preload` attribute provides a hint to the browser about what the author thinks will
-   * lead to the best user experience with regards to what content is loaded before the video is
-   * played. The recommended default is `metadata`.
-   *
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video#attr-preload}
-   */
-  preload: 'none' | 'metadata' | 'auto';
-  /**
-   * Whether auto quality selection is active.
-   */
-  autoQuality: boolean;
-  /**
-   * The list of available video qualities/renditions. This will be empty if quality information
-   * is not provided by the current media provider.
-   */
-  qualities: VideoQuality[];
-  /**
-   * The current playback quality. This will be `null` if quality information is not provided
-   * by the current media provider.
-   */
-  quality: VideoQuality | null;
-  /**
-   * The list of available audio tracks. This will be empty if audio track information is not
-   * provided by the current media provider.
-   */
-  audioTracks: AudioTrack[];
-  /**
-   * The current audio track. This will be `null` if audio track information is not provided by
-   *  the current media provider.
-   */
-  audioTrack: AudioTrack | null;
-  /**
-   * The current audio gain. This will be `null` if audio gain is not supported or is not set.
-   */
-  audioGain: number | null;
-  /**
-   * Whether the current video quality list is read-only, meaning quality selections can only
-   * be set internally by the media provider. This will only be `false` when working with particular
-   * third-party embeds such as YouTube.
-   */
-  canSetQuality: boolean;
-  /**
-   * Whether the current playback rate can be set. This will only be `false` when working with
-   * particular third-party embeds such as Vimeo (only available to pro/business accounts).
-   */
-  canSetPlaybackRate: boolean;
-  /**
-   * Whether the current volume can be changed. This depends on the current provider and browser
-   * environment. It will generally be `false` on mobile devices as it's set by system controls.
-   */
-  canSetVolume: boolean;
-  /**
-   * Whether the current audio gain can be changed. This depends on the current provider and browser
-   * environment. It generally depends on browser's Web Audio API support.
-   *
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API}
-   */
-  canSetAudioGain: boolean;
-  /**
-   * Contains the time ranges that the user is able to seek to, if any. This tells us which parts
-   * of the media can be played without delay; this is irrespective of whether that part has
-   * been downloaded or not.
-   *
-   * Some parts of the media may be seekable but not buffered if byte-range
-   * requests are enabled on the server. Byte range requests allow parts of the media file to
-   * be delivered from the server and so can be ready to play almost immediately — thus they are
-   * seekable.
-   *
-   * @defaultValue TimeRanges
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/TimeRanges}
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/seekable}
-   */
-  seekable: TimeRanges;
-  /**
-   * Contains the earliest time in seconds at which media can be seeked to. Generally this is
-   * zero, but for live streams it may start at a non-zero value.
-   *
-   * @defaultValue 0
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/seekable}
-   */
-  readonly seekableStart: number;
-  /**
-   * The latest time in seconds at which media can be seeked to. This will default to `Infinity`
-   * if no seekable range is found. If byte-range requests are enabled on the server this should
-   * be equal to the media duration - note for live streams duration is a moving target.
-   *
-   * @defaultValue Infinity
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/seekable}
-   */
-  readonly seekableEnd: number;
-  /**
-   * The length of the seekable window in seconds starting from `seekableStart` and ending at
-   * `seekableEnd`.
-   *
-   * @defaultValue 0
-   */
-  readonly seekableWindow: number;
-  /**
-   * Whether media is actively seeking to a new playback position.
-   *
-   * @defaultValue false
-   */
-  seeking: boolean;
-  /**
-   * The URL and optionally type of the current media resource/s to be considered for playback.
-   * Use `source` to get the currently loaded resource.
-   *
-   * @defaultValue []
-   */
-  sources: Src[];
-  /**
-   * The chosen media resource. Defaults to `{ src: '', type: '' }` if no media has been loaded.
-   *
-   * @defaultValue { src: '', type: '' }
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/currentSrc}
-   */
-  source: Src;
-  /** Alias for `source`. */
-  currentSrc: Src;
-  /**
-   * Whether media playback has started. In other words it will be true if `currentTime > 0`.
-   *
-   * @defaultValue false
-   */
-  started: boolean;
-  /**
-   * The current media stream type. This value helps determine what type of UI should be
-   * displayed and whether seeking operations are permitted during live streams. If seeking
-   * is permitted, set this value to `live:dvr` or `ll-live:dvr`.
-   */
-  streamType: MediaStreamType;
-  /**
-   * The title of the current media.
-   */
-  readonly title: string;
-  /**
-   * The artist or channel name for which this content belongs to. This can be used in your
-   * layout and it will be included in the Media Session API.
-   */
-  artist: string;
-  /**
-   * Images to be included in the Media Session API.
-   */
-  artwork: MediaImage[] | null;
-  /**
-   * The list of all available text tracks.
-   */
-  textTracks: TextTrack[];
-  /**
-   * The current captions/subtitles text track that is showing.
-   */
-  textTrack: TextTrack | null;
-  /**
-   * Whether there are any captions or subtitles available.
-   */
-  readonly hasCaptions: boolean;
-  /**
-   * The type of player view that should be used (i.e., audio or video). By default this is set
-   * to `video`.
-   *
-   * @defaultValue 'unknown'
-   */
-  viewType: MediaViewType;
-  /**
-   * An `int` between `0` (silent) and `1` (loudest) indicating the audio volume. Defaults to `1`.
-   *
-   * @defaultValue 1
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/volume}
-   */
-  volume: number;
-  /**
-   * Whether playback has temporarily stopped because of a lack of temporary data.
-   *
-   * @defaultValue false
-   */
-  waiting: boolean;
-
-  // !!! Responsive Design !!!
-
-  /**
-   * The user's pointing device type.
-   *
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@media/pointer}
-   */
-  pointer: 'fine' | 'coarse';
-  /**
-   * The current screen orientation.
-   */
-  orientation: 'portrait' | 'landscape';
-  /**
-   * The width of the media player container in pixels.
-   */
-  width: number;
-  /**
-   * The height of the media player container in pixels.
-   */
-  height: number;
-  /**
-   * The width of the media provider in pixels.
-   */
-  mediaWidth: number;
-  /**
-   * The height of the media in provider pixels.
-   */
-  mediaHeight: number;
-  /**
-   *  The last keyboard shortcut that was triggered.
-   */
-  lastKeyboardAction: {
-    action: string;
-    event: KeyboardEvent;
-  } | null;
-
-  // !!! INTERNALS !!!
-
-  /** @internal */
-  autoPlaying: boolean;
-  /** @internal */
-  providedTitle: string;
-  /** @internal */
-  inferredTitle: string;
-  /** @internal */
-  providedLoop: boolean;
-  /** @internal */
-  userPrefersLoop: boolean;
-  /** @internal - Unclipped current time. */
-  realCurrentTime: number;
-  /** @internal */
-  providedPoster: string;
-  /** @internal */
-  intrinsicDuration: number;
-  /** @internal */
-  providedDuration: number;
-  /** @internal */
-  inferredPoster: string;
-  /** @internal */
-  inferredViewType: MediaViewType;
-  /** @internal */
-  providedViewType: MediaViewType;
-  /** @internal */
-  providedStreamType: MediaStreamType;
-  /** @internal */
-  inferredStreamType: MediaStreamType;
-  inferredLiveDVRWindow: number;
-  /** @internal */
-  liveSyncPosition: number | null;
-  /** @internal */
-  savedState: { paused?: boolean; currentTime?: number } | null;
-}
-
-export interface MediaPlayerQuery {
-  (state: MediaPlayerState): boolean;
-}
-
-export function boundTime(time: number, store: MediaStore) {
-  const clippedTime = time + store.clipStartTime(),
-    isStart = Math.floor(time) === Math.floor(store.seekableStart()),
-    isEnd = Math.floor(clippedTime) === Math.floor(store.seekableEnd());
-
-  if (isStart) {
-    return store.seekableStart();
-  }
-
-  if (isEnd) {
-    return store.seekableEnd();
-  }
-
-  if (
-    store.isLiveDVR() &&
-    store.liveDVRWindow() > 0 &&
-    clippedTime < store.seekableEnd() - store.liveDVRWindow()
-  ) {
-    return store.bufferedStart();
-  }
-
-  return Math.min(Math.max(store.seekableStart() + 0.1, clippedTime), store.seekableEnd() - 0.1);
-}