diff --git a/uni_modules/uni-video/utssdk/interface.uts b/uni_modules/uni-video/utssdk/interface.uts index ecbc1a37dc50c1dcfd8de6deac9ce097dc74aff2..ee975a0dbf56026e80c7dadee67ef0bd5a595541 100644 --- a/uni_modules/uni-video/utssdk/interface.uts +++ b/uni_modules/uni-video/utssdk/interface.uts @@ -1,35 +1,35 @@ -export type CreateVideoContext = (videoId : string.VideoIdString, component ?: ComponentPublicInstance | null) => VideoContext | null; +export type CreateVideoContext = (videoId: string.VideoIdString, component?: ComponentPublicInstance | null) => VideoContext | null; export type Danmu = { - /** - * 弹幕文字 - */ - text ?: string | null, - /** - * 弹幕颜色 - */ - color ?: string | null, - /** - * 显示时刻 - */ - time ?: number | null + /** + * 弹幕文字 + */ + text?: string | null, + /** + * 弹幕颜色 + */ + color?: string | null, + /** + * 显示时刻 + */ + time?: number | null }; export type RequestFullScreenOptions = { - /** - * direction - * - 0: 正常竖向 - * - 90: 屏幕逆时针90度 - * - -90: 屏幕顺时针90度 - * @type 0 | 90 | -90 - * @uniPlatform { + /** + * direction + * - 0: 正常竖向 + * - 90: 屏幕逆时针90度 + * - -90: 屏幕顺时针90度 + * @type 0 | 90 | -90 + * @uniPlatform { * "app": { * "android": { * "osVer": "4.4", * "uniVer": "√", * "unixVer": "3.9.0" * }, - * "ios": { + * "ios": { * "osVer": "12.0", * "uniVer": "√", * "unixVer": "4.11" @@ -39,7 +39,7 @@ export type RequestFullScreenOptions = { * "weixin": { * "hostVer": "√", * "uniVer": "√", - * "unixVer": "4.35" + * "unixVer": "4.41" * }, * "alipay": { * "hostVer": "√", @@ -81,22 +81,22 @@ export type RequestFullScreenOptions = { * "uniVer": "x", * "unixVer": "x" * } - * } - */ - direction ?: number | null + * } + */ + direction?: number | null }; export interface VideoContext { - /** - * @description 播放 - * @uniPlatform { - * "app": { - * "android": { - * "osVer": "4.4", - * "uniVer": "√", - * "unixVer": "3.9.0" - * }, - * "ios": { + /** + * @description 播放 + * @uniPlatform { + * "app": { + * "android": { + * "osVer": "4.4", + * "uniVer": "√", + * "unixVer": "3.9.0" + * }, + * "ios": { * "osVer": "12.0", * "uniVer": "√", * "unixVer": "4.11" @@ -106,12 +106,12 @@ export interface VideoContext { * "uniVer": "4.23", * "unixVer": "x" * } - * }, + * }, * "mp": { * "weixin": { * "hostVer": "√", * "uniVer": "√", - * "unixVer": "4.35" + * "unixVer": "4.41" * }, * "alipay": { * "hostVer": "√", @@ -149,24 +149,24 @@ export interface VideoContext { * "unixVer": "x" * } * }, - * "web": { + * "web": { * "uniVer": "√", * "unixVer": "4.0" * } - * } - * @uniVueVersion 2,3 - */ - play() : void; - /** - * @description 暂停 - * @uniPlatform { - * "app": { - * "android": { - * "osVer": "4.4", - * "uniVer": "√", - * "unixVer": "3.9.0" - * }, - * "ios": { + * } + * @uniVueVersion 2,3 + */ + play(): void; + /** + * @description 暂停 + * @uniPlatform { + * "app": { + * "android": { + * "osVer": "4.4", + * "uniVer": "√", + * "unixVer": "3.9.0" + * }, + * "ios": { * "osVer": "12.0", * "uniVer": "√", * "unixVer": "4.11" @@ -176,12 +176,12 @@ export interface VideoContext { * "uniVer": "4.23", * "unixVer": "x" * } - * }, + * }, * "mp": { * "weixin": { * "hostVer": "√", * "uniVer": "√", - * "unixVer": "4.35" + * "unixVer": "4.41" * }, * "alipay": { * "hostVer": "√", @@ -219,25 +219,25 @@ export interface VideoContext { * "unixVer": "x" * } * }, - * "web": { + * "web": { * "uniVer": "√", * "unixVer": "4.0" * } - * } - * @uniVueVersion 2,3 - */ - pause() : void; - /** - * @description 跳转到指定位置 - * @param {number} position 跳转到指定位置(秒) - * @uniPlatform { - * "app": { - * "android": { - * "osVer": "4.4", - * "uniVer": "√", - * "unixVer": "3.9.0" - * }, - * "ios": { + * } + * @uniVueVersion 2,3 + */ + pause(): void; + /** + * @description 跳转到指定位置 + * @param {number} position 跳转到指定位置(秒) + * @uniPlatform { + * "app": { + * "android": { + * "osVer": "4.4", + * "uniVer": "√", + * "unixVer": "3.9.0" + * }, + * "ios": { * "osVer": "12.0", * "uniVer": "√", * "unixVer": "4.11" @@ -247,12 +247,12 @@ export interface VideoContext { * "uniVer": "4.23", * "unixVer": "x" * } - * }, + * }, * "mp": { * "weixin": { * "hostVer": "√", * "uniVer": "√", - * "unixVer": "4.35" + * "unixVer": "4.41" * }, * "alipay": { * "hostVer": "√", @@ -290,24 +290,24 @@ export interface VideoContext { * "unixVer": "x" * } * }, - * "web": { + * "web": { * "uniVer": "√", * "unixVer": "4.0" * } - * } - * @uniVueVersion 2,3 - */ - seek(position : number) : void; - /** - * @description 停止视频 - * @uniPlatform { - * "app": { - * "android": { - * "osVer": "4.4", - * "uniVer": "√", - * "unixVer": "3.9.0" - * }, - * "ios": { + * } + * @uniVueVersion 2,3 + */ + seek(position: number): void; + /** + * @description 停止视频 + * @uniPlatform { + * "app": { + * "android": { + * "osVer": "4.4", + * "uniVer": "√", + * "unixVer": "3.9.0" + * }, + * "ios": { * "osVer": "12.0", * "uniVer": "√", * "unixVer": "4.11" @@ -317,12 +317,12 @@ export interface VideoContext { * "uniVer": "4.23", * "unixVer": "x" * } - * }, + * }, * "mp": { * "weixin": { * "hostVer": "√", * "uniVer": "√", - * "unixVer": "4.35" + * "unixVer": "4.41" * }, * "alipay": { * "hostVer": "√", @@ -360,25 +360,25 @@ export interface VideoContext { * "unixVer": "x" * } * }, - * "web": { + * "web": { * "uniVer": "√", * "unixVer": "4.0" * } - * } - * @uniVueVersion 2,3 - */ - stop() : void; - /** - * @description 发送弹幕 - * @param {Danmu} 属性 text, color - * @uniPlatform { - * "app": { - * "android": { - * "osVer": "4.4", - * "uniVer": "√", - * "unixVer": "3.9.0" - * }, - * "ios": { + * } + * @uniVueVersion 2,3 + */ + stop(): void; + /** + * @description 发送弹幕 + * @param {Danmu} 属性 text, color + * @uniPlatform { + * "app": { + * "android": { + * "osVer": "4.4", + * "uniVer": "√", + * "unixVer": "3.9.0" + * }, + * "ios": { * "osVer": "12.0", * "uniVer": "√", * "unixVer": "4.11" @@ -388,12 +388,12 @@ export interface VideoContext { * "uniVer": "4.23", * "unixVer": "x" * } - * }, + * }, * "mp": { * "weixin": { * "hostVer": "√", * "uniVer": "√", - * "unixVer": "4.35" + * "unixVer": "4.41" * }, * "alipay": { * "hostVer": "√", @@ -431,25 +431,25 @@ export interface VideoContext { * "unixVer": "x" * } * }, - * "web": { + * "web": { * "uniVer": "√", * "unixVer": "4.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" - * }, - * "ios": { + * } + * @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" + * }, + * "ios": { * "osVer": "12.0", * "uniVer": "√", * "unixVer": "4.11" @@ -459,12 +459,12 @@ export interface VideoContext { * "uniVer": "4.23", * "unixVer": "x" * } - * }, + * }, * "mp": { * "weixin": { * "hostVer": "√", * "uniVer": "√", - * "unixVer": "4.35" + * "unixVer": "4.41" * }, * "alipay": { * "hostVer": "√", @@ -502,25 +502,25 @@ export interface VideoContext { * "unixVer": "x" * } * }, - * "web": { + * "web": { * "uniVer": "√", * "unixVer": "4.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" - * }, - * "ios": { + * } + * @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" + * }, + * "ios": { * "osVer": "12.0", * "uniVer": "√", * "unixVer": "4.11" @@ -530,12 +530,12 @@ export interface VideoContext { * "uniVer": "4.23", * "unixVer": "x" * } - * }, + * }, * "mp": { * "weixin": { * "hostVer": "√", * "uniVer": "√", - * "unixVer": "4.35" + * "unixVer": "4.41" * }, * "alipay": { * "hostVer": "√", @@ -573,25 +573,25 @@ export interface VideoContext { * "unixVer": "x" * } * }, - * "web": { + * "web": { * "uniVer": "√", * "unixVer": "4.0" * } - * } - * @uniVueVersion 2,3 - */ - requestFullScreen(direction ?: RequestFullScreenOptions | null) : void; - /** - * 退出全屏 - * @description 退出全屏 - * @uniPlatform { - * "app": { - * "android": { - * "osVer": "4.4", - * "uniVer": "√", - * "unixVer": "3.9.0" - * }, - * "ios": { + * } + * @uniVueVersion 2,3 + */ + requestFullScreen(direction?: RequestFullScreenOptions | null): void; + /** + * 退出全屏 + * @description 退出全屏 + * @uniPlatform { + * "app": { + * "android": { + * "osVer": "4.4", + * "uniVer": "√", + * "unixVer": "3.9.0" + * }, + * "ios": { * "osVer": "12.0", * "uniVer": "√", * "unixVer": "4.11" @@ -601,12 +601,12 @@ export interface VideoContext { * "uniVer": "4.23", * "unixVer": "x" * } - * }, + * }, * "mp": { * "weixin": { * "hostVer": "√", * "uniVer": "√", - * "unixVer": "4.35" + * "unixVer": "4.41" * }, * "alipay": { * "hostVer": "√", @@ -644,27 +644,27 @@ export interface VideoContext { * "unixVer": "x" * } * }, - * "web": { + * "web": { * "uniVer": "√", * "unixVer": "4.0" * } - * } - * @uniVueVersion 2,3 - */ - exitFullScreen() : void; + * } + * @uniVueVersion 2,3 + */ + exitFullScreen(): void; } export interface Uni { - /** - * 创建并返回 video 上下文 videoContext 对象 - * @uniPlatform { - * "app": { - * "android": { - * "osVer": "4.4", - * "uniVer": "√", - * "unixVer": "√" - * }, - * "ios": { + /** + * 创建并返回 video 上下文 videoContext 对象 + * @uniPlatform { + * "app": { + * "android": { + * "osVer": "4.4", + * "uniVer": "√", + * "unixVer": "√" + * }, + * "ios": { * "osVer": "12.0", * "uniVer": "√", * "unixVer": "4.11" @@ -674,63 +674,63 @@ export interface Uni { * "uniVer": "4.23", * "unixVer": "x" * } - * }, + * }, * "web": { * "uniVer": "√", * "unixVer": "4.0" * }, - * "mp": { - * "weixin": { - * "hostVer": "√", - * "uniVer": "√", - * "unixVer": "4.35" - * }, - * "alipay": { - * "hostVer": "1.10.0", - * "uniVer": "√", - * "unixVer": "x" - * }, - * "baidu": { - * "hostVer": "√", - * "uniVer": "√", - * "unixVer": "x" - * }, - * "toutiao": { - * "hostVer": "√", - * "uniVer": "√", - * "unixVer": "x" - * }, - * "lark": { - * "hostVer": "√", - * "uniVer": "√", - * "unixVer": "x" - * }, - * "qq": { - * "hostVer": "√", - * "uniVer": "√", - * "unixVer": "x" - * }, - * "kuaishou": { - * "hostVer": "√", - * "uniVer": "√", - * "unixVer": "x" - * }, - * "jd": { - * "hostVer": "√", - * "uniVer": "√", - * "unixVer": "x" - * } - * } - * } - * @uniVueVersion 2,3 - * @return {VideoContext} video组件上下文对象 - * - * @tutorial-uni-app https://uniapp.dcloud.net.cn/api/media/video-context.html#createvideocontext - * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/create-video-context.html#createvideocontext - * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/create-video-context.html#createvideocontext - * - */ - createVideoContext : CreateVideoContext + * "mp": { + * "weixin": { + * "hostVer": "√", + * "uniVer": "√", + * "unixVer": "4.41" + * }, + * "alipay": { + * "hostVer": "1.10.0", + * "uniVer": "√", + * "unixVer": "x" + * }, + * "baidu": { + * "hostVer": "√", + * "uniVer": "√", + * "unixVer": "x" + * }, + * "toutiao": { + * "hostVer": "√", + * "uniVer": "√", + * "unixVer": "x" + * }, + * "lark": { + * "hostVer": "√", + * "uniVer": "√", + * "unixVer": "x" + * }, + * "qq": { + * "hostVer": "√", + * "uniVer": "√", + * "unixVer": "x" + * }, + * "kuaishou": { + * "hostVer": "√", + * "uniVer": "√", + * "unixVer": "x" + * }, + * "jd": { + * "hostVer": "√", + * "uniVer": "√", + * "unixVer": "x" + * } + * } + * } + * @uniVueVersion 2,3 + * @return {VideoContext} video组件上下文对象 + * + * @tutorial-uni-app https://uniapp.dcloud.net.cn/api/media/video-context.html#createvideocontext + * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/create-video-context.html#createvideocontext + * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/create-video-context.html#createvideocontext + * + */ + createVideoContext: CreateVideoContext } /** @@ -738,38 +738,38 @@ export interface Uni { * 临时方案,规避组件Event接口无法直接继承UniEvent的问题 */ interface UniVideoEvent { - /** - * 是否冒泡 - */ - bubbles : boolean - /** - * 是否可以取消 - */ - cancelable : boolean - /** - * 事件类型 - */ - type : string - /** - * 触发事件的组件 - */ - target ?: UniElement | null - /** - * 当前组件 - */ - currentTarget ?: UniElement | null - /** - * 事件发生时的时间戳 - */ - timeStamp : Long - /** - * 阻止当前事件的进一步传播 - */ - stopPropagation() : void - /** - * 阻止当前事件的默认行为 - */ - preventDefault() : void + /** + * 是否冒泡 + */ + bubbles: boolean + /** + * 是否可以取消 + */ + cancelable: boolean + /** + * 事件类型 + */ + type: string + /** + * 触发事件的组件 + */ + target?: UniElement | null + /** + * 当前组件 + */ + currentTarget?: UniElement | null + /** + * 事件发生时的时间戳 + */ + timeStamp: Long + /** + * 阻止当前事件的进一步传播 + */ + stopPropagation(): void + /** + * 阻止当前事件的默认行为 + */ + preventDefault(): void } /** @@ -777,18 +777,18 @@ interface UniVideoEvent { * 播放进度变化时触发 */ export interface UniVideoTimeUpdateEvent extends UniVideoEvent { - detail : UniVideoTimeUpdateEventDetail + detail: UniVideoTimeUpdateEventDetail } export type UniVideoTimeUpdateEventDetail = { - /** - * 当前进度 - */ - currentTime : number, - /** - * 总进度 - */ - duration : number + /** + * 当前进度 + */ + currentTime: number, + /** + * 总进度 + */ + duration: number } /** @@ -796,18 +796,18 @@ export type UniVideoTimeUpdateEventDetail = { * 当视频进入和退出全屏是触发 */ export interface UniVideoFullScreenChangeEvent extends UniVideoEvent { - detail : UniVideoFullScreenChangeEventDetail + detail: UniVideoFullScreenChangeEventDetail } export type UniVideoFullScreenChangeEventDetail = { - /** - * 是否全屏 - */ - fullScreen : boolean, - /** - * 横竖屏,取值 vertical 或 horizontal - */ - direction : string + /** + * 是否全屏 + */ + fullScreen: boolean, + /** + * 横竖屏,取值 vertical 或 horizontal + */ + direction: string } /** @@ -815,7 +815,7 @@ export type UniVideoFullScreenChangeEventDetail = { * 视频播放出错时触发 */ export interface UniVideoErrorEvent extends UniVideoEvent { - detail : VideoError + detail: VideoError } /** @@ -827,7 +827,7 @@ export interface UniVideoErrorEvent extends UniVideoEvent { export type VideoErrorCode = 100001 | 200001 | 300001 export interface VideoError extends IUniError { - errCode : VideoErrorCode + errCode: VideoErrorCode } /** @@ -835,14 +835,14 @@ export interface VideoError extends IUniError { * 加载进度变化时触发 */ export interface UniVideoProgressEvent extends UniVideoEvent { - detail : UniVideoProgressEventDetail + detail: UniVideoProgressEventDetail } export type UniVideoProgressEventDetail = { - /** - * 加载进度百分比 - */ - buffered : number + /** + * 加载进度百分比 + */ + buffered: number } /** @@ -850,26 +850,26 @@ export type UniVideoProgressEventDetail = { * 视频播放全屏播放时点击事件 */ export interface UniVideoFullScreenClickEvent extends UniVideoEvent { - detail : UniVideoFullScreenClickEventDetail + detail: UniVideoFullScreenClickEventDetail } export type UniVideoFullScreenClickEventDetail = { - /** - * 点击点相对于屏幕左侧边缘的 X 轴坐标 - */ - screenX : number, - /** - * 点击点相对于屏幕顶部边缘的 Y 轴坐标 - */ - screenY : number, - /** - * 屏幕总宽度 - */ - screenWidth : number, - /** - * 屏幕总高度 - */ - screenHeight : number + /** + * 点击点相对于屏幕左侧边缘的 X 轴坐标 + */ + screenX: number, + /** + * 点击点相对于屏幕顶部边缘的 Y 轴坐标 + */ + screenY: number, + /** + * 屏幕总宽度 + */ + screenWidth: number, + /** + * 屏幕总高度 + */ + screenHeight: number } /** @@ -877,14 +877,14 @@ export type UniVideoFullScreenClickEventDetail = { * 切换播放控件显示隐藏时触发 */ export interface UniVideoControlsToggleEvent extends UniVideoEvent { - detail : UniVideoControlsToggleEventDetail + detail: UniVideoControlsToggleEventDetail } export type UniVideoControlsToggleEventDetail = { - /** - * 是否显示 - */ - show : boolean + /** + * 是否显示 + */ + show: boolean } export type VideoTimeUpdateEvent = UniVideoTimeUpdateEvent