@volcengine/veplayer 1.15.1 → 1.15.2-rc.1

package/src/constants/event.ts

@@ -0,0 +1,577 @@
+/** {zh}
+ * @brief 播放器媒体事件。由浏览器 `video` 元素触发，SDK 代理。
+ * @detail Event
+ * @name MediaEvents
+ * @kind event
+ * @example
+ * 监听播放错误
+ * ```
+ * playerSdkIns.on(VePlayer.Events.ERROR, (error) => {
+ *   // error 处理
+ * })
+ * ```
+ * 监听播放
+ * ```
+ * playerSdkIns.on(VePlayer.Events.PLAY, () => {
+ *   // TODO after play
+ * })
+ * ```
+ * 监听播放时间更新
+ * ```
+ * playerSdkIns.on(VePlayer.Events.TIME_UPDATE, (data) => {
+ *   const { currentTime } = data;
+ *   console.log('currentTime: ', currentTime);
+ * })
+ * ```
+ */
+/** {en}
+ * @detail Event
+ * @name MediaEvents
+ * @kind event
+ * @brief Player media events. Triggered by the browser's `video` element, and proxied by the SDK.
+ */
+export const MediaEvents = {
+  /** {zh}
+   * @brief 在播放被终止时触发。例如当播放中的视频重新开始播放。
+   */
+  ABORT: 'abort',
+  /** {zh}
+   * @brief 视频缓冲足够数据、可以播放时触发。
+   */
+  CANPLAY: 'canplay',
+  /** {zh}
+   * @brief 视频可以流畅播放时触发。
+   */
+  CANPLAY_THROUGH: 'canplaythrough',
+  /** {zh}
+   * @brief 视频时长发生变化时触发。
+   */
+  DURATION_CHANGE: 'durationchange',
+  /** {zh}
+   * @deprecated
+   * @brief （已废弃）媒体被清空时触发，通常是由于初始化。
+   */
+  EMPITED: 'empited',
+  /** {zh}
+   * @brief 媒体被清空时触发，通常是由于初始化。
+   */
+  EMPTIED: 'emptied',
+  /** {zh}
+   * @brief 视频播放完毕时触发。
+   */
+  /** {en}
+   * @brief Video playback ends.
+   */
+  ENDED: 'ended',
+  /** {zh}
+   * @brief 发生错误时触发。
+   */
+  ERROR: 'error',
+  /** {zh}
+   * @brief 视频起播数据加载完成时触发。
+   */
+  LOADED_DATA: 'loadeddata',
+  /** {zh}
+   * @brief 媒体的元数据已加载完毕，`playerSdkIns.player.video` 可获取所有的 `video` 属性。
+   */
+  LOADED_META_DATA: 'loadedmetadata',
+  /** {zh}
+   * @brief 媒体内容开始加载时触发。
+   */
+  LOAD_START: 'loadstart',
+  /** {zh}
+   * @brief 视频暂停播放时触发。
+   */
+  /** {en}
+   * @brief Video playback pauses.
+   */
+  PAUSE: 'pause',
+  /** {zh}
+   * @brief 视频开始播放时触发。
+   */
+  /** {en}
+   * @brief Video playback starts.
+   */
+  PLAY: 'play',
+  /** {zh}
+   * @brief 恢复播放时触发，包括暂停后恢复播放或卡顿后恢复播放。
+   */
+  /** {en}
+   * @brief Video playback resumes after a pause or freeze.
+   */
+  PLAYING: 'playing',
+  /** {zh}
+   * @brief 报告媒体下载进度，即已缓存播放数据进度。
+   */
+  PROGRESS: 'progress',
+  /** {zh}
+   * @brief 播放速率变化时触发。
+   */
+  RATE_CHANGE: 'ratechange',
+  /** {zh}
+   * @brief Seek 操作完成时触发。
+   */
+  SEEKED: 'seeked',
+  /** {zh}
+   * @brief Seek 操作开始时触发。
+   */
+  SEEKING: 'seeking',
+  /** {zh}
+   * @brief 在尝试获取媒体数据、但数据不可用时触发。
+   */
+  STALLED: 'stalled',
+  /** {zh}
+   * @brief 媒体资源加载终止时触发。这可能是因为下载已完成或因为其他原因暂停。
+   */
+  SUSPEND: 'suspend',
+  /** {zh}
+   * @brief 视频播放时间更新时触发。
+   */
+  /** {en}
+   * @brief The video playback time is updated.
+   */
+  TIME_UPDATE: 'timeupdate',
+  /** {zh}
+   * @brief 视频音量发生变化时触发。
+   */
+  /** {en}
+   * @brief The video volume changes.
+   */
+  VOLUME_CHANGE: 'volumechange',
+  /** {zh}
+   * @brief 等待加载数据时触发。
+   */
+  /** {en}
+   * @brief The player is loading data.
+   */
+  WAITING: 'waiting',
+};
+
+/** {zh}
+ * @detail Event
+ * @brief SDK 事件，由 SDK 内部触发。
+ * @name SDKEvents
+ * @kind event
+ * @example
+ * 监听播放器创建完成
+ * ```
+ * playerSdkIns.on(VePlayer.Events.COMPLETE, () => {
+ *   // can execute the apis and get the attributes of player core after sdk build complete
+ *   console.log('player core: ', playerSdkIns.player);
+ * })
+ * ```
+ * 监听清晰度切换
+ * ```
+ * playerSdkIns.on(VePlayer.Events.DEFINITION_CHANGE, (data) => {
+ *   const { to } = data;
+ *   const { definition, url } = to;
+ *   console.log('target definition is ', definition);
+ *   console.log('target url is ', url);
+ * })
+ * ```
+ * 监听全屏状态切换
+ * ```
+ * playerSdkIns.on(VePlayer.Events.FULLSCREEN_CHANGE, (isFullScreen) => {
+ *   console.log('current fullscreen: ', isFullScreen);
+ * })
+ * ```
+ */
+/** {en}
+ * @detail Event
+ * @name SDKEvents
+ * @kind event
+ * @brief SDK events, triggered internally by the SDK.
+ */
+export const SDKEvents = {
+  /** {zh}
+   * @brief 播放器实例创建完成时触发。
+   */
+  /** {en}
+   * @brief The player is instantiated.
+   */
+  READY: 'ready',
+  /** {zh}
+   * @brief 播放器创建 `video` 完成时触发，表示可以开始播放。
+   */
+  /** {en}
+   * @brief The player has created the video and the playback is ready to start.
+   */
+  COMPLETE: 'complete',
+  /** {zh}
+   * @brief 播放资源发生变化。
+   */
+  /** {en}
+   * @brief The playback address changes.
+   */
+  URL_CHANGE: 'urlchange',
+  /** {zh}
+   * @brief 播放器聚焦，同时会展示 Control 栏控件，包含播放按钮、进度条等。
+   */
+  /** {en}
+   * @brief The player is active and the control bar will appear showing options like play button, progress bar, and other controls.
+   */
+  PLAYER_FOCUS: 'focus',
+  /** {zh}
+   * @brief 播放器失焦，同时会隐藏 Control 栏控件，包含播放按钮、进度条等。
+   */
+  /** {en}
+   * @brief The player is inactive and the control bar will vanish, hiding options such as the play button, progress bar, and other controls.
+   */
+  PLAYER_BLUR: 'blur',
+  /** {zh}
+   * @brief 系统全屏状态切换。
+   */
+  /** {en}
+   * @brief The player switches to or from full-window mode, in which the player covers the entire desktop.
+   */
+  FULLSCREEN_CHANGE: 'fullscreen_change',
+  /** {zh}
+   * @brief 网页全屏状态切换。
+   */
+  /** {en}
+   * @brief The player switches to or from full-screen mode, in which the player covers the browser window.
+   */
+  CSS_FULLSCREEN_CHANGE: 'cssFullscreen_change',
+  /** {zh}
+   * @brief 画中画模式切换。
+   */
+  MINI_STATE_CHANGE: 'mini_state_change',
+  /** {zh}
+   * @brief 播放器销毁。
+   */
+  /** {en}
+   * @brief The player is destroyed.
+   */
+  DESTROY: 'destroy',
+  /** {zh}
+   * @brief 播放器重新播放。
+   */
+  /** {en}
+   * @brief Replay starts.
+   */
+  REPLAY: 'replay',
+  /** {zh}
+   * @brief 播放器重试。
+   */
+  RETRY: 'retry',
+  /** {zh}
+   * @brief 清晰度发生变化
+   */
+  /** {en}
+   * @brief The video resolution changes.
+   */
+  DEFINITION_CHANGE: 'definition_change',
+  /** {zh}
+   * @hidden
+   */
+  /** {en}
+   * @hidden
+   */
+  Before_DEFINITION_CHANGE: 'before_definition_change',
+  /** {zh}
+   * @hidden
+   */
+  /** {en}
+   * @hidden
+   */
+  AFTER_DEFINITION_CHANGE: 'after_definition_change',
+  /** {zh}
+   * @brief 播放器容器尺寸发生变化。
+   */
+  /** {en}
+   * @brief The size of the player container changes.
+   */
+  VIDEO_RESIZE: 'video_resize',
+  /** {zh}
+   * @brief 画中画状态切换。
+   */
+  /** {en}
+   * @brief The player switches to or from Picture-in-Picture (PIP) mode.
+   */
+  PIP_CHANGE: 'pip_change',
+  /** {zh}
+   * @brief 播放器发生旋转。
+   */
+  /** {en}
+   * @brief The player is rotated.
+   */
+  ROTATE: 'rotate',
+  /** {zh}
+   * @brief 播放器内置快捷键事件被触发。
+   */
+  /** {en}
+   * A built-in shortcut event occurs within the player.
+   */
+  SHORTCUT: 'shortcut',
+  /** {zh}
+   * @deprecated
+   * @brief （已废弃）SEI 信息解析。
+   */
+  /** {en}
+   * @deprecated
+   * @brief The player parses the SEI information.
+   */
+  SEI_PARSED: 'SEI_PARSED',
+  /** {zh}
+   * @brief 内置插件用户行为触发。所有内置插件用户行为交互都会下发该事件，可用于用户行为埋点。
+   */
+  /** {en}
+   * @brief A user event occurs within a built-in plug-in. This event applies to all built-in plug-ins and can be used for tracking user behaviors.
+   */
+  USER_ACTION: 'user_action',
+  /** {zh}
+   * @brief 自动播放成功时触发。
+   */
+  /** {en}
+   * @brief Autoplay starts successfully.
+   */
+  AUTOPLAY_STARTED: 'autoplay_started',
+  /** {zh}
+   * @brief 自动播放失败时触发。
+   */
+  /** {en}
+   * @brief Autoplay fails to start.
+   */
+  AUTOPLAY_PREVENTED: 'autoplay_was_prevented',
+  /** {zh}
+   * @brief 播放器完成创建。
+   */
+  PLAYER_CREATED_FINISH: 'player_create_finish',
+  /** {zh}
+   * @brief 播放器重建。
+   */
+  PLAYER_REBUILD: 'player_rebuild',
+  /** {zh}
+   * @brief 硬解不支持时触发。
+   */
+  NOT_SUPPORT_HARDWARE_DECODER: 'not_support_hardware_decoder',
+  /** {zh}
+   * @brief 软解不支持时触发。
+   */
+  NOT_SUPPORT_SOFT_DECODER: 'not_support_soft_decoder',
+  /** {zh}
+   * @brief `playAuthToken` 过期。
+   */
+  TOKEN_EXPIRED: 'playAuthToken_expired',
+  /** {zh}
+   * @brief UMD 加载失败。
+   */
+  UMD_LOAD_FAIL: 'umd_load_fail',
+  /** {zh}
+   * @brief 切换下一个视频。调用 `playNext` 后触发。
+   */
+  PLAYNEXT: 'playnext',
+  /** {zh}
+   * @brief 视频地址为空。
+   */
+  URL_NULL: 'urlNull',
+  /** {zh}
+   * @brief 鼠标移出。
+   */
+  LEAVE_PLAYER: 'leaveplayer',
+  /** {zh}
+   * @brief 鼠标移入。
+   */
+  ENTER_PLAYER: 'enterplayer',
+  /** {zh}
+   * @brief 播放器状态重置。
+   */
+  RESET: 'reset',
+  /** {zh}
+   * @brief `<source>` 加载错误，表示 `<source>` 不支持或播放失败。
+   */
+  SOURCE_ERROR: 'source_error',
+  /** {zh}
+   * @brief `<source>` 加载成功。
+   */
+  SOURCE_SUCCESS: 'source_success',
+
+  /** {zh}
+   * @brief license 提醒
+   */
+  LICENSE_STATUS_WARNING: 'license_status_warning',
+};
+
+/** {zh}
+ * @detail Event
+ * @brief 插件事件，由插件内部触发。
+ * @name PluginEvents
+ * @kind event
+ * @example
+ * 监听自动播放成功
+ * ```
+ * playerSdkIns.on(VePlayer.Events.AUTOPLAY_SUCCESS, () => {
+ *   // TODO something
+ * })
+ * ```
+ *
+ */
+/** {en}
+ * @detail Event
+ * @name PluginEvents
+ * @kind event
+ */
+export const PluginEvents = {
+  /** {zh}
+   * @brief 弹幕配置发生变化。
+   */
+  DANMU_CHANGE: 'danmu_change',
+  /** {zh}
+   * @hidden
+   */
+  TIME_SHIFT_CHANGE: 'time_shift_change', // 切换时移状态
+  /** {zh}
+   * @hidden
+   */
+  AI_SUBTITLE_LANG_CHANGE: 'ai_subtitle_lang_change', // ai字幕语言切换
+  /** {zh}
+   * @hidden
+   */
+  AI_SUBTITLE_MATCH: 'ai_subtitle_match', // ai字幕匹配
+  /** {zh}
+   * @brief 取消静音。
+   */
+  CANCEL_UNMUTE: 'cancel_unmute',
+  /** {zh}
+   * @brief 刷新按钮被点击。
+   */
+  REFRESH_CLICK: 'refresh_click',
+  /** {zh}
+   * @brief 发生报错，卡顿时，在同清晰度等级下，触发降级至 fallbackUrl。
+   */
+  PLAY_BACKUP_CHANGE: 'play_backup_change', // { currentUrl: String, nextUrl: String, retryTimes: Number }
+  /** {zh}
+   * @brief 发生报错，卡顿时，在同清晰度等级下，触发降级至 fallbackUrl, 所有可执行降级结束，无可用 fallbackUrl
+   */
+  PLAY_BACKUP_CHANGE_FINISH: 'play_backup_change_finish',
+  /** {zh}
+   * @brief 报错时触发重试。
+   */
+  PLAY_ERROR_BUTTON_CLICK: 'play_error_button_click',
+  /** {zh}
+   * @brief 播放 URL 改变。
+   */
+  PlAY_URL_CHANGE: 'play_url_change', // {url:String , from: String}
+  /** {zh}
+   * @brief 展示报错。
+   */
+  SHOW_PLAY_ERROR: 'show_play_error',
+  /** {zh}
+   * @hidden
+   */
+  PLAYER_EXTEND_BUTTON: 'player_extend_button',
+  /** {zh}
+   * @brief 发生长时间卡顿时触发。播放器会在事件发生时自动进行清晰度降级或提醒用户手动切换晰度降级。
+   */
+  LONG_WAITING: 'long_waiting', // 长时间waiting
+  /** {zh}
+   * @brief 发生频繁卡顿时触发。
+   */
+  OFTEN_WAITING: 'often_waiting', // 频繁waiting
+  /** {zh}
+   * @brief 清晰度降级。
+   */
+  DEFINITION_DEMOTE: 'definition_demote', // 清晰度降级  {currentDef,willChangeDef,next}
+  /** {zh}
+   * @brief 已降至最低清晰度。
+   */
+  DEFINITION_DEMOTE_ALL_DONE: 'definition_demote_all_done', // 已降至最低清晰度
+  /** {zh}
+   * @brief 所有可执行的降级操作均执行完毕。如果用户同时开启了 definition 降级和 fallbackUrl 降级，
+   * 无论两者哪个优先级更高，待所有可执行的降级操作均执行完毕，会触发该事件。
+   */
+  DEMOTE_ALL_DONE: 'demote_all_done', // 所有可执行的降级操作均执行完毕
+  /** {zh}
+   * @hidden
+   */
+  LARKWINDOW_CHANGE: 'larkWindow_change', // 飞书小窗状态切换
+  /** {zh}
+   * @hidden
+   */
+  PANEL_MODE_CHANGE: 'panel_mode_change', // 移动端面板模式切换
+  /** {zh}
+   * @brief 清晰度切换。
+   */
+  INNER_DEFINITION_CHANGE: 'inner_definition_change', // 清晰度切换
+  /** {zh}
+   * @brief 线路切换。
+   */
+  LINE_CHANGE: 'line_change', // 线路切换
+  /** {zh}
+   * @brief 播放器通过 `playAuthToken` 获取 URL 失败。
+   */
+  GET_PLAY_URL_ERR: 'get_play_url_err', // playAuthToken获取url失败
+  /** {zh}
+   * @brief 资源过期。
+   */
+  MEDIA_EXPIRED: 'MEDIA_EXPIRED',
+  /** {zh}
+   * @brief 镜像开启。
+   */
+  MIRROR_CHANGE: 'mirror_change',
+  /** {zh}
+   * @brief 音乐播放器快进或快退。
+   */
+  TIME_SCALE_CHANGE: 'time_scale_change',
+  /** {zh}
+   * @brief 音乐播放模式切换。
+   */
+  MUSIC_MODE_CHANGE: 'music_mode_change',
+  /** {zh}
+   * @brief 音乐播放模式下切换音乐。
+   */
+  MUSIC_CHANGE: 'music_change',
+  /** {zh}
+   * @brief 音乐播放列表发生变化。
+   */
+  MUSIC_LIST_CHANGE: 'music_list_change',
+  /** {zh}
+   * @brief 自动播放成功。
+   */
+  AUTOPLAY_SUCCESS: 'autoplay_success',
+  /** {zh}
+   * @brief 自动播放失败。
+   */
+  AUTOPLAY_FAILED: 'autoplay_failed',
+  /** {zh}
+   * @brief 右键菜单事件。事件 `data` 中包含具体信息。
+   */
+  MENU_LOG: 'MENU_LOG',
+  /** {zh}
+   * @brief 点击了右键菜单的反馈按钮。
+   */
+  MENU_REPORT: 'MENU_REPORT',
+  /** {zh}
+   * @brief 播放列表更新。
+   */
+  PLAY_LIST_CHANGE: 'play_list_change',
+  /** {zh}
+   * @brief 播放列表播放项变更。
+   */
+  PLAY_LIST_ITEM_CHANGE: 'play_list_item_change',
+  /** {zh}
+   * @brief `playNext` 开始。
+   */
+  PLAY_NEXT_START: 'play_next_start',
+  /** {zh}
+   * @brief `playNext` 结束。
+   */
+  PLAY_NEXT_END: 'play_next_end',
+  /** {zh}
+   * @brief 多码率自适应播放时，自动挡位对应的清晰度改变。
+   */
+  ABR_AUTO_DESC_CHANGE: 'ABR_AUTO_DESC_CHANGE',
+};
+
+const Events = {
+  ...MediaEvents,
+  ...SDKEvents,
+  ...PluginEvents,
+};
+
+// 兼容旧的导出
+export const Event = {
+  SDKEvents,
+  PluginEvents,
+};
+export default Events;

package/src/constants/player.ts

@@ -0,0 +1,84 @@
+export const DefinitionLinked: any = {
+  origin: {
+    index: 1,
+    next: 'uhd',
+    prev: null,
+  },
+  uhd: {
+    index: 2,
+    next: 'hd',
+    prev: 'origin',
+  },
+  hd: {
+    index: 3,
+    next: 'sd',
+    prev: 'uhd',
+  },
+  sd: {
+    index: 4,
+    next: 'ld',
+    prev: 'hd',
+  },
+  ld: {
+    index: 5,
+    next: 'ao',
+    prev: 'sd',
+  },
+  ao: {
+    index: 6,
+    next: null,
+    prev: 'ld',
+  },
+};
+
+export const PLAYER_LANGS = ['zh', 'en', 'jp', 'zh-hk'];
+
+// 移动端播放器模式
+export const PLAYER_MODE = {
+  NORMAL: 0,
+  INNER: 1,
+  FULLSCREEN: 2,
+};
+
+// 视频状态：https://bytedance.feishu.cn/wiki/wikcnpqNM9c8P8Cp8zBSco3oOKe#Ro7GZU
+export enum VIDEO_STATUS_TYPE {
+  VALID = 10,
+  TRANSCODING = 30,
+  NO_SET_AUDIT = 1000,
+  OFFLINE = 1002,
+  NO_AUTH = 2001,
+  UN_AUTH = 2002,
+}
+
+/**
+ * 无限大时间戳: 单位秒
+ */
+export const MAX_TIMESTAMP = 5000000000;
+
+/**
+ * 地址过期检查的默认diff，即距离过期时间还剩多少时就判定过期，单位秒
+ */
+export const DEFAULT_URL_EXPIRE_DIFF = 60;
+
+/**
+ * 地址过期检查的默认间隔，单位毫秒
+ */
+export const DEFAULT_URL_CHECK_EXPIRE_INTERVAL = 400;
+
+/**
+ * 触发MEDIA_EXPIRED事件的最小间隔: 单位秒
+ */
+export const MIN_EXPIRE_INTERVAL = 300;
+
+export const cancelTips = {
+  jp: 'キャンセル',
+  en: 'Cancel',
+  zh: '取消',
+  'zh-hk': '取消',
+};
+
+export const enum KeySystemType {
+  WIDEVINE = 'widevine',
+  FAIRPLAY = 'fairplay',
+  PLAYREADY = 'playready',
+}

package/src/constants/plugin.ts

@@ -0,0 +1,19 @@
+/*
+ * 与plugin相关的常量
+ */
+
+// control栏icon的顺序权重，值越小，越靠近右侧
+// key为插件名称
+export const CONTROL_ICON_INDEX: { [key: string]: number } = {
+  sdkDefinitionPlugin: 30, // 清晰度
+  DanmuPlugin: 30, // 弹幕
+  sdkMultilinePlugin: 40, // 多线路
+  mirrorPlugin: 50, // 镜像
+  Subtitle: 60, // 字幕
+};
+
+export const CONTROL_LEFT_ICON_INDEX: { [key: string]: number } = {
+  playListPlugin: 20, // 播放列表
+};
+
+export const OLD_UNMUTE_PLUGIN_LOWERCASE_NAME = 'sdkunmuteplugin';