@gcorevideo/player 2.20.1 → 2.20.4

package/src/internal.types.ts

@@ -2,22 +2,29 @@ import type {
   CorePlugin,
   ContainerPlugin,
   Playback as ClapprPlayback,
-} from "@clappr/core";
+} from '@clappr/core'
 
-import { ContainerSize, PlaybackType, PlayerDebugTag, PlayerMediaSource } from "./types";
-import { PlaybackError } from "./playback.types.js";
+import {
+  ContainerSize,
+  PlaybackType,
+  PlayerDebugTag,
+  PlayerMediaSource,
+  type CorePluginConstructor,
+  type ContainerPluginConstructor,
+} from './types'
+import { PlaybackError } from './playback.types.js'
 
 type ExternalTrack = {
-  kind?: "subtitles" | "captions";
-  src: string;
-  label: string;
-  lang: string;
+  kind?: 'subtitles' | 'captions'
+  src: string
+  label: string
+  lang: string
 }
 
 type MediacontrolStyles = {
   // TODO
-  seekbar?: string;
-  buttons?: string;
+  seekbar?: string
+  buttons?: string
 }
 
 /**
@@ -25,11 +32,11 @@ type MediacontrolStyles = {
  * @beta
  */
 type HlsjsConfig = {
-  debug?: boolean;
-  startLevel?: number;
-} & Record<string, unknown>;
+  debug?: boolean
+  startLevel?: number
+} & Record<string, unknown>
 
-type ShakaConfig = Record<string, unknown>;
+type ShakaConfig = Record<string, unknown>
 
 /**
  * @see {@link https://github.com/clappr/clappr-core?tab=readme-ov-file#playback-configuration | the Clappr playback settings}
@@ -37,25 +44,25 @@ type ShakaConfig = Record<string, unknown>;
  */
 export interface CorePlaybackConfig {
   // audioOnly: boolean;
-  disableContextMenu?: boolean;
-  controls?: boolean;
-  crossOrigin?: 'anonymous' | 'use-credentials';
+  disableContextMenu?: boolean
+  controls?: boolean
+  crossOrigin?: 'anonymous' | 'use-credentials'
   // enableAutomaticABR?: boolean;
-  externalTracks?: ExternalTrack[];
-  hlsjsConfig?: HlsjsConfig;
+  externalTracks?: ExternalTrack[]
+  hlsjsConfig?: HlsjsConfig
   // initialBandwidthEstimate?: number;
   // maxBufferLength?: number;
   // maxBackBufferLength?: number;
   // minBufferLength?: number;
-  minimumDvrSize?: number; // TODO ?
+  minimumDvrSize?: number // TODO ?
   // maxAdaptiveBitrate?: number;
   // maxAdaptiveVideoDimensions?: unknown; // TODO
-  mute?: boolean;
-  playInline: boolean;
-  preload?: 'metadata' | 'auto' | 'none';
+  mute?: boolean
+  playInline: boolean
+  preload?: 'metadata' | 'auto' | 'none'
   // preferredAudioLanguage?: string;
-  recycleVideo?: boolean;
-  shakaConfiguration?: ShakaConfig;
+  recycleVideo?: boolean
+  shakaConfiguration?: ShakaConfig
 }
 
 /**
@@ -63,34 +70,34 @@ export interface CorePlaybackConfig {
  */
 export type CorePlayerEvents = {
   // TODO event arguments types
-  onReady?: () => void;
-  onResize?: (data: ContainerSize) => void;
-  onPlay?: (metadata: unknown) => void;
-  onPause?: (metadata: unknown) => void;
-  onStop?: (metadata: unknown) => void;
-  onEnded?: () => void;
-  onSeek?: (currentTime: number) => void;
-  onError?: (err: PlaybackError) => void;
-  onTimeUpdate?: (timeProgress: { current: number; total: number }) => void;
-  onVolumeUpdate?: (value: number) => void;
-  onSubtitleAvailable?: () => void;
+  onReady?: () => void
+  onResize?: (data: ContainerSize) => void
+  onPlay?: (metadata: unknown) => void
+  onPause?: (metadata: unknown) => void
+  onStop?: (metadata: unknown) => void
+  onEnded?: () => void
+  onSeek?: (currentTime: number) => void
+  onError?: (err: PlaybackError) => void
+  onTimeUpdate?: (timeProgress: { current: number; total: number }) => void
+  onVolumeUpdate?: (value: number) => void
+  onSubtitleAvailable?: () => void
 }
 
 /**
  * @internal
  */
-export type PlaybackPluginFactory = typeof ClapprPlayback;
+export type PlaybackPluginFactory = typeof ClapprPlayback
 
 /**
  * For the plugin development
  * @internal
  */
 export type CorePluginOptions = {
-  core?: CorePlugin[];
-  container?: ContainerPlugin[];
-  playback?: PlaybackPluginFactory[];
-  loadExternalPluginsFirst?: boolean;
-  loadExternalPlaybacksFirst?: boolean;
+  core?: CorePluginConstructor[]
+  container?: ContainerPluginConstructor[]
+  playback?: PlaybackPluginFactory[]
+  loadExternalPluginsFirst?: boolean
+  loadExternalPlaybacksFirst?: boolean
 }
 
 /**
@@ -98,41 +105,41 @@ export type CorePluginOptions = {
  * @internal
  */
 export type CoreOptions = {
-  actualLiveTime?: boolean;
-  actualLiveServerTime?: string;
-  allowUserInteraction?: boolean;
-  autoPlay?: boolean;
-  autoSeekFromUrl?: boolean;
-  chromeless?: boolean;
-  debug?: PlayerDebugTag | boolean;
-  disableCanAutoPlay?: boolean; // custom, for reconfiguration
-  disableKeyboardShortcuts?: boolean;
-  disableVideoTagContextMenu?: boolean;
-  events?: CorePlayerEvents;
-  exitFullscreenOnEnd?: boolean;
-  gaAccount?: string;
-  gaTrackerName?: string;
-  height?: number;
-  hideMediaControl?: boolean;
-  hideVolumeBar?: boolean;
-  language?: string;
-  loop?: boolean;
-  maxBufferLength?: number;
-  mediacontrol?: MediacontrolStyles;
-  mimeType?: string;
-  mute?: boolean;
-  persistConfig?: boolean;
-  preload?: "auto" | "metadata" | "none";
-  parentId?: string;
-  parent?: HTMLElement;
-  playback?: CorePlaybackConfig;
-  playbackNotSupportedMessage?: string;
-  playbackType?: PlaybackType;
-  plugins?: CorePluginOptions | CorePlugin[];
-  poster?: string;
-  source?: string;
-  sources?: PlayerMediaSource[];
-  watermark?: string;
-  watermarkLink?: string;
-  width?: number;
-}
+  actualLiveTime?: boolean
+  actualLiveServerTime?: string
+  allowUserInteraction?: boolean
+  autoPlay?: boolean
+  autoSeekFromUrl?: boolean
+  chromeless?: boolean
+  debug?: PlayerDebugTag | boolean
+  disableCanAutoPlay?: boolean // custom, for reconfiguration
+  disableKeyboardShortcuts?: boolean
+  disableVideoTagContextMenu?: boolean
+  events?: CorePlayerEvents
+  exitFullscreenOnEnd?: boolean
+  gaAccount?: string
+  gaTrackerName?: string
+  height?: number
+  hideMediaControl?: boolean
+  hideVolumeBar?: boolean
+  language?: string
+  loop?: boolean
+  maxBufferLength?: number
+  mediacontrol?: MediacontrolStyles
+  mimeType?: string
+  mute?: boolean
+  persistConfig?: boolean
+  preload?: 'auto' | 'metadata' | 'none'
+  parentId?: string
+  parent?: HTMLElement
+  playback?: CorePlaybackConfig
+  playbackNotSupportedMessage?: string
+  playbackType?: PlaybackType
+  plugins?: CorePluginOptions | CorePlugin[]
+  poster?: string
+  source?: string
+  sources?: PlayerMediaSource[]
+  watermark?: string
+  watermarkLink?: string
+  width?: number
+}