ty.createInnerAudioContextTask
CreateInnerAudioContextTask ty.createInnerAudioContext
创建内部 audio 上下文 InnerAudioContext 对象
需引入
BaseKit
,且在>=2.3.2
版本才可使用
参数
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: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
/**
* 跳转到指定位置
*/
seek(params: {
/** 跳转的时间,单位 s。精确到小数点后 3 位,即支持 ms 级别精确度 */
position?: number;
complete?: () => void;
success?: (params: null) => void;
fail?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
/**
* 停止。停止后的音频再播放会从头开始播放
*/
stop(params: {
complete?: () => void;
success?: (params: null) => void;
fail?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
/**
* 销毁当前实例
*/
destroy(params: {
complete?: () => void;
success?: (params: null) => void;
fail?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
/**
* 监听音频播放进度更新事件
*/
onTimeUpdate(
listener: (params: {
/** InnerAudioContext 对象 ContextId */
contextId: string;
/** 播放进度 【0 - 1】 */
time: number;
}) => void,
): void;
}
export function createInnerAudioContext(params?: {
complete?: () => void;
success?: (params: null) => void;
fail?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): CreateInnerAudioContextTask;
CreateInnerAudioContextTask
CreateInnerAudioContextTask.pause
暂停
参数
Object object
暂停的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
函数定义示例
/**
* 暂停
*/
export function pause(params: {
complete?: () => void;
success?: (params: null) => void;
fail?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
CreateInnerAudioContextTask.resume
恢复
参数
Object object
恢复的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
函数定义示例
/**
* 恢复
*/
export function resume(params: {
complete?: () => void;
success?: (params: null) => void;
fail?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
👉 立即开发。
CreateInnerAudioContextTask.play
播放
参数
Object object
播放的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
src | string | 是 | src 音频资源的地址 | |
startTime | number | 否 | startTime 开始播放的位置 | |
autoplay | boolean | 否 | autoplay 是否自动开始播放 | |
loop | boolean | 否 | 是否循环播放,默认为 false | |
volume | number | 否 | 音量。范围 0~1。默认为 1 | |
playbackRate | number | 否 | 播放速度。范围 0.5-2.0,默认为 1。(Android 需要 6 及以上版本) | |
complete | function | 否 | 接口调用完成的回调函数(成功或失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
函数定义示例
/**
* 播放
*/
export function 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: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
CreateInnerAudioContextTask.seek
跳转到指定位置
参数
Object object
跳转到指定位置的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
position | number | 否 | 跳转的时间,单位 s。精确到小数点后 3 位,即支持 ms 级别精确度 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
函数定义示例
/**
* 跳转到指定位置
*/
export function seek(params: {
/** 跳转的时间,单位 s。精确到小数点后 3 位,即支持 ms 级别精确度 */
position?: number;
complete?: () => void;
success?: (params: null) => void;
fail?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
CreateInnerAudioContextTask.stop
停止。停止后的音频再播放会从头开始播放
参数
Object object
停止。停止后的音频再播放会从头开始播放的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
函数定义示例
/**
* 停止。停止后的音频再播放会从头开始播放
*/
export function stop(params: {
complete?: () => void;
success?: (params: null) => void;
fail?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
CreateInnerAudioContextTask.destroy
销毁当前实例
参数
Object object
销毁当前实例的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
函数定义示例
/**
* 销毁当前实例
*/
export function destroy(params: {
complete?: () => void;
success?: (params: null) => void;
fail?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
👉 立即开发。
CreateInnerAudioContextTask.onTimeUpdate
监听音频播放进度更新事件
参数
function callback
监听音频播放进度更新事件的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
contextId | string | 是 | InnerAudioContext 对象 ContextId | |
time | number | 是 | 播放进度 【0 - 1】 |
ty.getAudioFileDuration
获取音频文件时长信息
需引入
BaseKit
,且在>=2.4.3
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
path | string | 是 | 音频文件路径 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
object.success 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
duration | number | 音频时长 |
object.fail 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
函数定义示例
/**
* 获取音频文件时长信息
*/
export function getAudioFileDuration(params: {
/** 音频文件路径 */
path: string;
complete?: () => void;
success?: (params: {
/** 音频时长 */
duration: number;
}) => void;
fail?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
ty.getCurrentVolume
获取当前系统音量
需引入
BaseKit
,且在>=2.4.3
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
object.success 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
value | number | 音量,阈值【0 - 1】 |
object.fail 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
函数定义示例
/**
* 获取当前系统音量
*/
export function getCurrentVolume(params?: {
complete?: () => void;
success?: (params: {
/** 音量,阈值【0 - 1】 */
value: number;
}) => void;
fail?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
ty.getCurrentVolumeByMode
获取不同模式的系统音量
需引入
BaseKit
,且在>=3.3.3
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
volumeMode | number | 否 | 音量类型(仅 Android 生效) : - 0 :语音电话的声音- 2 :响铃,通知,系统默认音等- 3 :手机音乐的声音- 4 :手机闹铃的声音- 6 :蓝牙音量 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
object.success 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
value | number | 音量,阈值【0 - 1】 |
volumeMode | number | 音量类型(仅 Android 生效): - 0 :语音电话的声音- 2 :响铃,通知,系统默认音等- 3 :手机音乐的声音- 4 :手机闹铃的声音- 6 :蓝牙音量 |
object.fail 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
函数定义示例
/**
* 获取不同模式的系统音量
*/
export function getCurrentVolumeByMode(params?: {
/**
* 音量类型(仅Android生效)
* 0:语音电话的声音
* 2:响铃,通知,系统默认音等
* 3:手机音乐的声音
* 4:手机闹铃的声音
* 6:蓝牙音量
*/
volumeMode?: number;
/** 接口调用结束的回调函数(调用成功、失败都会执行) */
complete?: () => void;
/** 接口调用成功的回调函数 */
success?: (params: {
/** 音量,阈值【0 - 1】 */
value: number;
/**
* 音量类型(仅Android生效)
* 0:语音电话的声音
* 2:响铃,通知,系统默认音等
* 3:手机音乐的声音
* 4:手机闹铃的声音
* 6:蓝牙音量
*/
volumeMode: number;
}) => void;
/** 接口调用失败的回调函数 */
fail?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
👉 立即开发。