@dcloudio/uni-app-x 0.3.0 → 0.4.0

package/types/uni/ext/lib/uni-audio/utssdk/interface.d.ts

@@ -0,0 +1,804 @@
+export type EventCallback = (result: any) => void
+
+export interface InnerAudioContext {
+  /**
+   * 当前音频的长度（单位：s），只有在当前有合法的 src 时返回
+   */
+  duration: number;
+  /**
+   * 当前音频的播放位置（单位：s），只有在当前有合法的 src 时返回
+   */
+  currentTime: number;
+  /**
+   * 当前是是否暂停或停止状态，true 表示暂停或停止，false 表示正在播放
+   * @type boolean
+   */
+  paused: boolean;
+  /**
+   * 音频的数据链接，用于直接播放。
+   */
+  src: string;
+  /**
+   * 音频开始播放的位置（单位：s）
+   */
+  startTime: number;
+  /**
+   * 音频缓冲的时间点，仅保证当前播放时间点到此时间点内容已缓冲
+   */
+  buffered: number;
+  /**
+   * 是否自动开始播放，默认 false
+   * @type boolean
+   */
+  autoplay: boolean;
+  /**
+   * 是否循环播放，默认 false
+   * @type boolean
+   */
+  loop: boolean;
+  /**
+   * 是否遵循系统静音开关，当此参数为 false 时，即使用户打开了静音开关，也能继续发出声音，默认值 true
+   * @type boolean
+   */
+  obeyMuteSwitch: boolean;
+  /**
+   * 音量。范围 0~1。
+   */
+  volume: number;
+  /**
+   * 播放的倍率。可取值： 0.5/0.8/1.0/1.25/1.5/2.0，默认值为1.0。（仅 App 支持）
+   */
+  playbackRate: (number) | null;
+  /**
+   * 暂停
+   */
+  pause(): void;
+  /**
+   * 停止
+   * @description 停止
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  stop(): void;
+  /**
+   * 播放
+   * @description 播放
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  play(): void;
+  /**
+   * 跳转到指定位置，单位 s
+   * @description 跳转到指定位置，单位 s
+   * @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
+   */
+  destroy(): void;
+  /**
+   * 音频进入可以播放状态，但不保证后面可以流畅播放
+   * @description 音频进入可以播放状态，但不保证后面可以流畅播放
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onCanplay(callback: EventCallback): void;
+  /**
+   * 音频播放事件
+   * @description 音频播放事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onPlay(callback: EventCallback): void;
+  /**
+   * 音频暂停事件
+   * @description 音频暂停事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onPause(callback: EventCallback): void;
+  /**
+   * 音频停止事件
+   * @description 音频停止事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onStop(callback: EventCallback): void;
+  /**
+   * 音频自然播放结束事件
+   * @description 音频自然播放结束事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onEnded(callback: EventCallback): void;
+  /**
+   * 音频播放进度更新事件
+   * @description 音频播放进度更新事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onTimeUpdate(callback: EventCallback): void;
+  /**
+   * 音频播放错误事件
+   * @description 音频播放错误事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onError(callback: EventCallback): void;
+  /**
+   * 音频加载中事件，当音频因为数据不足，需要停下来加载时会触发
+   * @description 音频加载中事件，当音频因为数据不足，需要停下来加载时会触发
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onWaiting(callback: EventCallback): void;
+  /**
+   * 音频进行 seek 操作事件
+   * @description 音频进行 seek 操作事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onSeeking(callback: EventCallback): void;
+  /**
+   * 音频完成 seek 操作事件
+   * @description 音频完成 seek 操作事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onSeeked(callback: EventCallback): void;
+  /**
+   * 取消监听 onCanplay 事件
+   * @description 取消监听 onCanplay 事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  offCanplay(callback: EventCallback): void;
+  /**
+   * 取消监听 onPlay 事件
+   * @description 取消监听 onPlay 事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  offPlay(callback: EventCallback): void;
+  /**
+   * 取消监听 onPause 事件
+   * @description 取消监听 onPause 事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  offPause(callback: EventCallback): void;
+  /**
+   * 取消监听 onStop 事件
+   * @description 取消监听 onStop 事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  offStop(callback: EventCallback): void;
+  /**
+   * 取消监听 onEnded 事件
+   * @description 取消监听 onEnded 事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  offEnded(callback: EventCallback): void;
+  /**
+   * 取消监听 onTimeUpdate 事件
+   * @description 取消监听 onTimeUpdate 事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  offTimeUpdate(callback: EventCallback): void;
+  /**
+   * 取消监听 onWaiting 事件
+   * @description 取消监听 onWaiting 事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  offError(callback: EventCallback): void;
+  /**
+   * 取消监听 onWaiting 事件
+   * @description 取消监听 onWaiting 事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  offWaiting(callback: EventCallback): void;
+  /**
+   * 取消监听 onSeeking 事件
+   * @description 取消监听 onSeeking 事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  offSeeking(callback: EventCallback): void;
+  /**
+   * 取消监听 onSeeked 事件
+   * @description 取消监听 onSeeked 事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  offSeeked(callback: EventCallback): void;
+}
+
+export interface BackgroundAudioManager {
+  /**
+   * 当前音频的长度（单位：s），只有在当前有合法的 src 时返回
+   */
+  duration: number,
+  /**
+   * 当前音频的播放位置（单位：s），只有在当前有合法的 src 时返回
+   */
+  currentTime: number,
+  /**
+   * 当前是是否暂停或停止状态，true 表示暂停或停止，false 表示正在播放
+   * @type boolean
+   */
+  paused: boolean,
+  /**
+   * 音频的数据源，默认为空字符串，当设置了新的 src 时，会自动开始播放 ，目前支持的格式有 m4a, aac, mp3, wav
+   */
+  src: string,
+  /**
+   * 音频开始播放的位置（单位：s）
+   */
+  startTime: number,
+  /**
+   * 音频缓冲的时间点，仅保证当前播放时间点到此时间点内容已缓冲
+   */
+  buffered: number,
+  /**
+   * 音频标题，用于做原生音频播放器音频标题。原生音频播放器中的分享功能，分享出去的卡片标题，也将使用该值。
+   */
+  title: string,
+  /**
+   * 专辑名，原生音频播放器中的分享功能，分享出去的卡片简介，也将使用该值
+   */
+  epname: string,
+  /**
+   * 歌手名，原生音频播放器中的分享功能，分享出去的卡片简介，也将使用该值
+   */
+  singer: string,
+  /**
+   * 封面图url，用于做原生音频播放器背景图。原生音频播放器中的分享功能，分享出去的卡片配图及背景也将使用该图。
+   */
+  coverImgUrl: string,
+  /**
+   * 页面链接，原生音频播放器中的分享功能，分享出去的卡片简介，也将使用该值
+   */
+  webUrl: string,
+  /**
+   * 音频协议。默认值为 'http'，设置 'hls' 可以支持播放 HLS 协议的直播音频
+   */
+  protocol: string,
+  /**
+   * 播放的倍率。可取值： 0.5/0.8/1.0/1.25/1.5/2.0，默认值为1.0。（仅 App 支持）
+   */
+  playbackRate: number | null,
+  /**
+   * 暂停
+   * @description 暂停
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  pause(): void;
+  /**
+   * 停止
+   * @description 停止
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  stop(): void;
+  /**
+   * 播放
+   * @description 播放
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  play(): void;
+  /**
+   * 跳转到指定位置，单位 s
+   * @description 跳转到指定位置，单位 s
+   * @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
+   */
+  destroy(): void;
+
+  /**
+   * 音频进入可以播放状态，但不保证后面可以流畅播放
+   * @description 音频进入可以播放状态，但不保证后面可以流畅播放
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onCanplay(callback: EventCallback): void;
+  /**
+   * 音频播放事件
+   * @description 音频播放事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onPlay(callback: EventCallback): void;
+  /**
+   * 音频暂停事件
+   * @description 音频暂停事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onPause(callback: EventCallback): void;
+  /**
+   * 音频停止事件
+   * @description 音频停止事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onStop(callback: EventCallback): void;
+  /**
+   * 音频自然播放结束事件
+   * @description 音频自然播放结束事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onEnded(callback: EventCallback): void;
+  /**
+   * 音频播放进度更新事件
+   * @description 音频播放进度更新事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onTimeUpdate(callback: EventCallback): void;
+  /**
+   * 音频播放错误事件
+   * @description 音频播放错误事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onError(callback: EventCallback): void;
+  /**
+   * 音频加载中事件，当音频因为数据不足，需要停下来加载时会触发
+   * @description 音频加载中事件，当音频因为数据不足，需要停下来加载时会触发
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onWaiting(callback: EventCallback): void;
+  /**
+   * 音频进行 seek 操作事件
+   * @description 音频进行 seek 操作事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onSeeking(callback: EventCallback): void;
+  /**
+   * 音频完成 seek 操作事件
+   * @description 音频完成 seek 操作事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  onSeeked(callback: EventCallback): void;
+  /**
+   * 取消监听 onCanplay 事件
+   * @description 取消监听 onCanplay 事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  offCanplay(callback: EventCallback): void;
+  /**
+   * 取消监听 onPlay 事件
+   * @description 取消监听 onPlay 事件
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "3.9.0"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   */
+  offPlay(callback: EventCallback): void;
+  // /**
+  //  * 取消监听 onPause 事件
+  //  */
+  // offPause(callback : EventCallback) : void;
+  // /**
+  //  * 取消监听 onStop 事件
+  //  */
+  // offStop(callback : EventCallback) : void;
+  // /**
+  //  * 取消监听 onEnded 事件
+  //  */
+  // offEnded(callback : EventCallback) : void;
+  // /**
+  //  * 取消监听 onTimeUpdate 事件
+  //  */
+  // offTimeUpdate(callback : EventCallback) : void;
+  // /**
+  //  * 取消监听 onWaiting 事件
+  //  */
+  // offError(callback : EventCallback) : void;
+  // /**
+  //  * 取消监听 onWaiting 事件
+  //  */
+  // offWaiting(callback : EventCallback) : void;
+  // /**
+  //  * 取消监听 onSeeking 事件
+  //  */
+  // offSeeking(callback : EventCallback) : void;
+  // /**
+  //  * 取消监听 onSeeked 事件
+  //  */
+  // offSeeked(callback : EventCallback) : void;
+};
+
+export type CreateInnerAudioContext = () => InnerAudioContext
+export type GetBackgroundAudioManager = () => BackgroundAudioManager;
+
+
+export interface Uni {
+  /**
+   * 创建并返回 audio 上下文 audioContext 对象
+   * @description 创建并返回 audio 上下文 audioContext 对象
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "√"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   * @return {InnerAudioContext} 音频对象
+   * 
+   * @tutorial http://uniapp.dcloud.io/api/media/audio-context?id=createinneraudiocontext
+   *
+   */
+  createInnerAudioContext: CreateInnerAudioContext
+  /**
+   * 获取全局唯一的背景音频管理器 backgroundAudioManager
+   * @description 获取全局唯一的背景音频管理器 backgroundAudioManager
+   * @uniPlatform {
+   *	 "app": {
+   *		"android": {
+   *			"osVer": "4.4",
+   *			"uniVer": "√",
+   *			"unixVer": "√"
+   *		}
+   *	}
+   * }
+   * @uniVueVersion 2,3
+   * @return {BackgroundAudioManager} 背景音频对象
+   *
+   * @tutorial http://uniapp.dcloud.io/api/media/background-audio-manager?id=getbackgroundaudiomanager
+   */
+  getBackgroundAudioManager: GetBackgroundAudioManager
+}