@volcengine/veplayer 1.15.1 → 1.15.2-rc.1

package/src/env.d.ts

@@ -0,0 +1,47 @@
+/// <reference types="vite/client" />
+
+// vite 全局变量类型定义文件，无法export，否则类型无法引用
+// API 服务区域配置
+type TAPIRegionConfig = {
+  __PLAY_DOMAIN__: string;
+  __BACKUP_PLAY_DOMAIN__?: string;
+};
+
+// 用户相关区域配置，包括tea及umd拉取域名配置
+type TUserRegionConfig = {
+  __LOG_TEA_ID__: number;
+  __LOG_CHANNEL__: TLogChannel;
+  __LOG_CUSTOM_REGION__?: string;
+  __UMD_PRE_PATH__: string;
+};
+
+type TLogChannel = 'cn' | 'va' | 'sg';
+type TRegionType = 'cn' | 'mya' | 'va' | 'sg';
+
+type TPlatoform = 'volcengine' | 'byteplus';
+
+interface ImportMetaEnv {
+  readonly __SDK_VERSION__?: string;
+  readonly __PLATFORM__: TPlatoform;
+
+  // LIVE
+  readonly __LIVE_LOG_TEA_ID__: number;
+  readonly __LIVE_LOG_CHANNEL__: 'cn' | 'va' | 'sg';
+
+  // VOD config
+  // readonly __API_DEFAULT_REGION__: string;
+  readonly __API_DEFAULT_REGION__: TRegionType;
+  // readonly __API_REGION_CONFIG__: Record<TRegionType, TAPIRegionConfig>;
+  readonly __API_REGION_CONFIG__: Record<TRegionType, TAPIRegionConfig>;
+
+  // readonly __USER_DEFAULT_REGION__: string;
+  readonly __USER_DEFAULT_REGION__: TRegionType;
+  // readonly __USER_REGION_CONFIG__: Record<TRegionType, TUserRegionConfig>;
+  readonly __USER_REGION_CONFIG__: Record<TRegionType, TUserRegionConfig>;
+
+  // 更多环境变量...
+}
+
+interface ImportMeta {
+  readonly env: ImportMetaEnv;
+}

package/src/index.ts

@@ -0,0 +1,24 @@
+import VePlayer from './core/index';
+
+export default VePlayer;
+
+export * from './interface';
+
+export { default as Music } from './music';
+export { default as LiveSubtitlesIconPlugin } from './plugins/external/aiSubtitleIconPlugin';
+export { default as LiveSubtitlesPlugin } from './plugins/external/aiSubtitlePlugin';
+export { default as Subtitle } from './plugins/external/subtitle';
+export { default as AdsPlugin } from './plugins/external/ad/adsPlugin';
+export { default as DynamicWatermarkPlugin } from './plugins/external/watermark/dynamicWatermarkPlugin';
+export { default as DefinitionDemotePlugin } from './plugins/external/definitionDemotePlugin';
+export { default as TimeShiftPlugin } from './plugins/external/timeShiftPlugin';
+export { default as MirrorPlugin } from './plugins/external/mirrorPlugin';
+export { default as MemoryPlay } from './plugins/external/memoryPlay';
+export { default as PlayListPlugin } from './plugins/external/playList';
+export { default as Service } from 'xgplayer-service';
+export { default as LiveInfoPanel } from './plugins/external/LiveInfoPanel';
+export { default as SdkPlugin } from './sdkPlugin/sdkPlugin';
+
+export { default as Events, Event } from './constants/event';
+export { getI18N } from './core/player';
+export * from 'xgplayer';

package/src/index.umd.ts

@@ -0,0 +1,54 @@
+import VePlayer, { getI18N } from './index';
+
+import Music from './music';
+import LiveSubtitlesIconPlugin from './plugins/external/aiSubtitleIconPlugin';
+import LiveSubtitlesPlugin from './plugins/external/aiSubtitlePlugin';
+import DefinitionDemotePlugin from './plugins/external/definitionDemotePlugin';
+import TimeShiftPlugin from './plugins/external/timeShiftPlugin';
+import MirrorPlugin from './plugins/external/mirrorPlugin';
+import MemoryPlay from './plugins/external/memoryPlay';
+import Subtitle from './plugins/external/subtitle';
+import DynamicWatermarkPlugin from './plugins/external/watermark/dynamicWatermarkPlugin';
+import PlayListPlugin from './plugins/external/playList';
+import Service from 'xgplayer-service';
+import LiveInfoPanel from './plugins/external/LiveInfoPanel';
+import AdsPlugin from './plugins/external/ad/adsPlugin';
+import SdkPlugin from './sdkPlugin/sdkPlugin';
+import { default as Events, Event } from './constants/event';
+import {
+  BasePlugin,
+  Plugin,
+  Sniffer,
+  Util,
+  STATE_CLASS,
+  I18N,
+  STATES,
+} from 'xgplayer';
+
+export default class VePlayerUmd extends VePlayer {
+  static Music = Music;
+  static LiveSubtitlesIconPlugin = LiveSubtitlesIconPlugin;
+  static LiveSubtitlesPlugin = LiveSubtitlesPlugin;
+  static DefinitionDemotePlugin = DefinitionDemotePlugin;
+  static TimeShiftPlugin = TimeShiftPlugin;
+  static MirrorPlugin = MirrorPlugin;
+  static MemoryPlay = MemoryPlay;
+  static Subtitle = Subtitle;
+  static DynamicWatermarkPlugin = DynamicWatermarkPlugin;
+  static PlayListPlugin = PlayListPlugin;
+  static Service = Service;
+  static LiveInfoPanel = LiveInfoPanel;
+  static AdsPlugin = AdsPlugin;
+  static Events = Events;
+  // 兼容旧的导出
+  static Event = Event;
+  static getI18N = getI18N;
+  static BasePlugin = BasePlugin;
+  static Plugin = Plugin;
+  static Sniffer = Sniffer;
+  static Util = Util;
+  static STATE_CLASS = STATE_CLASS;
+  static I18N = I18N;
+  static STATES = STATES;
+  static SdkPlugin = SdkPlugin;
+}

package/src/interface/adaptRange.d.ts

@@ -0,0 +1,33 @@
+/** {zh}
+ * @list Options
+ * @brief Range拆分（动态Buffer）
+ * @kind property
+ * @hidden
+ */
+export interface IAdaptRange {
+  /** {zh}
+   * @brief 是否开启Range拆分
+   * @default false
+   */
+  enable: boolean;
+  /** {zh}
+   * @brief 最小剩余Buffer缓存时长
+   * @default 30s
+   */
+  minCacheDuration?: number;
+  /** {zh}
+   * @brief 最大剩余Buffer缓存时长
+   * @default 60s
+   */
+  maxCacheDuration?: number;
+  /**
+   * @hidden
+   * @brief 最小range长度
+   */
+  minRangeDuration?: number;
+  /**
+   * @hidden
+   * @brief 最大range长度
+   */
+  maxRangeDuration?: number;
+}

package/src/interface/api.ts

@@ -0,0 +1,132 @@
+import type {
+  ICodecType,
+  EVideoFormat,
+  EAudioFormat,
+  EDRMTYPE,
+} from '@/interface/index';
+
+export interface IVolume {
+  Loudness: number;
+  Peak: number;
+}
+
+/** {zh}
+ * @hidden
+ */
+export interface IPlayInfoListItem {
+  BackupPlayUrl: string;
+  BackupUrlExpire: string;
+  BarrageMaskOffset: string;
+  Bitrate: number;
+  CheckInfo: string;
+  Codec: ICodecType;
+  Definition: string;
+  Duration: number;
+  FileId: string;
+  FileType: string;
+  Format: EVideoFormat | EAudioFormat;
+  Height: number;
+  IndexRange: string;
+  InitRange: string;
+  KeyFrameAlignment: string;
+  LogoType: string;
+  MainPlayUrl: string;
+  MainUrlExpire: string;
+  Md5: string;
+  PlayAuth: string;
+  PlayAuthId: string;
+  Quality: string;
+  Size: number;
+  Volume?: number;
+  Width: number;
+  DrmType?: EDRMTYPE;
+}
+
+/** {zh}
+ * @hidden
+ * @brief 音频封装格式
+ */
+export interface ISubtitleInfoList {
+  CreateTime: string;
+  FileId: string;
+  Format: string;
+  Language: string;
+  LanguageId: number;
+  Source: string;
+  Status: string;
+  StoreUri: string;
+  SubtitleId: string;
+  SubtitleUrl: string;
+  Tag: string;
+  Title: string;
+  Version: string;
+  Vid: string;
+}
+
+/** {zh}
+ * @hidden
+ */
+export interface IThumbInfoItem {
+  CaptureNum: number;
+  CellHeight: number;
+  CellWidth: number;
+  Format: string;
+  ImgXLen: number;
+  ImgYLen: number;
+  Interval: number;
+  StoreUrls: string[];
+}
+
+/** {zh}
+ * @brief 蒙版弹幕信息
+ * @hidden
+ */
+export interface IBarrageMaskInfo {
+  Version: string;
+  BarrageMaskUrl: string;
+  FileId: string;
+  FileSize: number;
+  FileHash: string;
+  UpdatedAt: string;
+  Bitrate: number;
+  HeadLen: number;
+}
+
+/** {zh}
+ * @hidden
+ */
+interface DashAdaptiveInfo {
+  AdaptiveType: string;
+  BackupPlayUrl: string;
+  MainPlayUrl: string;
+}
+
+/** {zh}
+ * @hidden
+ */
+export interface ABRInfo {
+  AbrFormat: string;
+  BackupPlayUrl: string;
+  MainPlayUrl: string;
+}
+
+/** {zh}
+ * @hidden
+ */
+export interface IGetPlayInfoRes {
+  Vid: string;
+  AdaptiveInfo?: DashAdaptiveInfo;
+  AdaptiveBitrateStreamingInfo?: ABRInfo;
+  BarrageMaskInfo?: IBarrageMaskInfo;
+  BarrageMaskUrl: string;
+  Duration: number;
+  EnableAdaptive: boolean;
+  FileType: string;
+  PlayInfoList: IPlayInfoListItem[];
+  PosterUrl: string;
+  Status: number;
+  SubtitleInfoList: ISubtitleInfoList[];
+  ThumbInfoList: IThumbInfoItem[];
+  TotalCount: number;
+  Version: number;
+}

package/src/interface/autoBitrate.d.ts

@@ -0,0 +1,41 @@
+/** {zh}
+ * @list Options
+ * @brief 自适应码率配置。
+ * @kind property
+ */
+export interface IAutoBitrateOpts {
+  /** {zh}
+   * @brief 是否开启自适应码率功能。
+   * @default false
+   */
+  enable: boolean;
+  /** {zh}
+   * @brief 是否以自动清晰度档位起播。开启自适应码率功能且 `defaultDefinition` 为 `auto` 时，才会以自动清晰度档位起播。
+   * @default false
+   */
+  startWithAuto?: boolean;
+  /** {zh}
+   * @brief 自动清晰度档位是否展示当前实际清晰度，如自动（720p）。
+   * @default false
+   */
+  showRealDefinition?: boolean;
+  /** {zh}
+   * @brief 自动清晰度档位的显示文案。
+   * @default 自动
+   */
+  /** {en}
+   * @brief the show text of auto definition
+   * @default auto
+   */
+  autoDefinitionText?: string;
+  /** {zh}
+   * @brief 自动清晰度档位的多语言 key。
+   * @default DEFINITION_AUTO
+   */
+  definitionTextKey?: string;
+  /**
+   * @hidden
+   * @brief 软解module
+   */
+  module?: unknown;
+}