interface.uts 2.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146

export type Danmu = {
  /**
   * 弹幕文字
   */
  text: string | null,
  /**
   * 弹幕颜色
   */
  color: string | null,
  /**
   * 显示时刻
   */
  time: number | null
};

export type RequestFullScreenOptions = {
  /**
   * direction
   * - 0: 正常竖向
   * - 90: 屏幕逆时针90度
   * - -90: 屏幕顺时针90度
   * @type 0 | 90 | -90
   */
  direction: number | null
};

export interface VideoContext {
  /**
   * @description 播放
   * @uniPlatform {
   *   "app": {
   *     "android": {
   *       "osVer": "4.4",
   *       "uniVer": "√",
   *       "unixVer": "3.9.0"
   *     }
   *   }
   * }
   * @uniVueVersion 2,3
   */
  play(): void;
  /**
   * @description 暂停
   * @uniPlatform {
   *   "app": {
   *     "android": {
   *       "osVer": "4.4",
   *       "uniVer": "√",
   *       "unixVer": "3.9.0"
   *     }
   *   }
   * }
   * @uniVueVersion 2,3
   */
  pause(): void;
  /**
   * @description 跳转到指定位置
   * @param {number} position 跳转到指定位置(秒)
   * @uniPlatform {
   *   "app": {
   *     "android": {
   *       "osVer": "4.4",
   *       "uniVer": "√",
   *       "unixVer": "3.9.0"
   *     }
   *   }
   * }
   * @uniVueVersion 2,3
   */
  seek(position: number): void;
  /**
   * @description 停止视频
   * @uniPlatform {
   *   "app": {
   *     "android": {
   *       "osVer": "4.4",
   *       "uniVer": "√",
   *       "unixVer": "3.9.0"
   *     }
   *   }
   * }
   * @uniVueVersion 2,3
   */
  stop(): void;
  /**
   * @description 发送弹幕
   * @param {Danmu} 属性 text, color
   * @uniPlatform {
   *   "app": {
   *     "android": {
   *       "osVer": "4.4",
   *       "uniVer": "√",
   *       "unixVer": "3.9.0"
   *     }
   *   }
   * }
   * @uniVueVersion 2,3
   */
  sendDanmu(danmu: Danmu): void;
  /**
   * @description 设置倍速播放
   * @param {number} rate, 支持倍率 0.5/0.8/1.0/1.25/1.5
   * @uniPlatform {
   *   "app": {
   *     "android": {
   *       "osVer": "4.4",
   *       "uniVer": "√",
   *       "unixVer": "3.9.0"
   *     }
   *   }
   * }
   * @uniVueVersion 2,3
   */
  playbackRate(rate: number): void;
  /**
   * @description 进入全屏
   * @param {RequestFullScreenOptions} direction, 0|正常竖向, 90|屏幕逆时针90度, -90|屏幕顺时针90度
   * @uniPlatform {
   *   "app": {
   *     "android": {
   *       "osVer": "4.4",
   *       "uniVer": "√",
   *       "unixVer": "3.9.0"
   *     }
   *   }
   * }
   * @uniVueVersion 2,3
   */
  requestFullScreen(direction: RequestFullScreenOptions | null): void;
  /**
   * 退出全屏
   * @description 退出全屏
   * @uniPlatform {
   *   "app": {
   *     "android": {
   *       "osVer": "4.4",
   *       "uniVer": "√",
   *       "unixVer": "3.9.0"
   *     }
   *   }
   * }
   * @uniVueVersion 2,3
   */
  exitFullScreen(): void;
}