智能小程序 Ray 开发媒体 API —— 音频 API 合集（一）

CreateInnerAudioContextTask createInnerAudioContext

创建内部 audio 上下文 InnerAudioContext 对象

引入

import { createInnerAudioContext } from '@ray-js/ray';

参数

Object object

创建内部 audio 上下文 InnerAudioContext 对象的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

返回值

CreateInnerAudioContextTask 创建内部 audio 上下文 InnerAudioContext 对象

函数定义示例

/**
 * 创建内部audio上下文InnerAudioContext对象
 */
interface CreateInnerAudioContextTask {
  /**
   * 暂停
   */
  pause(params: {
    complete?: () => void;
    success?: (params: null) => void;
    fail?: (params: {
      errorMsg: string;
      errorCode: string | number;
      innerError: {
        errorCode: string | number;
        errorMsg: string;
      };
    }) => void;
  }): void;
 
  /**
   * 恢复
   */
  resume(params: {
    complete?: () => void;
    success?: (params: null) => void;
    fail?: (params: {
      errorMsg: string;
      errorCode: string | number;
      innerError: {
        errorCode: string | number;
        errorMsg: string;
      };
    }) => void;
  }): void;
 
  /**
   * 播放
   */
  play(params: {
    /** src 音频资源的地址 */
    src: string;
    /** startTime 开始播放的位置 */
    startTime?: number;
    /** autoplay 是否自动开始播放 */
    autoplay?: boolean;
    /** 是否循环播放，默认为 false */
    loop?: boolean;
    /** 音量。范围 0~1。默认为 1 */
    volume?: number;
    /** 播放速度。范围 0.5-2.0，默认为 1。（Android 需要 6 及以上版本） */
    playbackRate?: number;
    complete?: () => void;
    success?: (params: null) => void;
    fail?: (params: {
      errorMsg: string;
      errorCode: string | number;
      innerError: {