ty.getRecorderManagerTask
GetRecorderManagerTask ty.getRecorderManager
获取全局唯一的录音管理器
参数
Object object
获取全局唯一的录音管理器的回调函数
录音前需要调用
ty.authorize
获取scope.record
权限。
回调参数 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 } |
返回值
GetRecorderManagerTask 获取全局唯一的录音管理器
函数定义示例
/**
* 获取全局唯一的录音管理器
*/
interface GetRecorderManagerTask {
/**
* 开始录音
*/
start(params: {
/** 录音的时长,单位 ms,最大值 600000(10 分钟) */
duration?: number;
/** 采样率 */
sampleRate?: number;
/** 录音通道数 */
numberOfChannels?: number;
/** 编码码率,有效值见下表格 */
encodeBitRate?: number;
/** 音频格式 */
format?: string;
/** 指定帧大小,单位 KB。传入 frameSize 后,每录制指定帧大小的内容后,会回调录制的文件内容,不指定则不会回调。暂仅支持 mp3、pcm 格式。 */
frameSize: number;
/** 指定录音的音频输入源 */
audioSource?: string;
complete?: () => void;
success?: (params: {
/** 录音文件的临时路径 (本地路径) */
tempFilePath: string;
}) => void;
failure?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
/**
* 继续录音
*/
resume(params: {
complete?: () => void;
success?: (params: {
/** 录音文件的临时路径 (本地路径) */
tempFilePath: string;
}) => void;
failure?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
/**
* 暂停录音
*/
pause(params: {
complete?: () => void;
success?: (params: {
/** 录音文件的临时路径 (本地路径) */
tempFilePath: string;
}) => void;
failure?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
/**
* 停止录音
*/
stop(params: {
complete?: () => void;
success?: (params: {
/** 录音文件的临时路径 (本地路径) */
tempFilePath: string;
}) => void;
failure?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
/**
* 开始持续录音
*/
startRecording(params: {
/** 间隔时间 ms */
period: number;
complete?: () => void;
success?: (params: null) => void;
failure?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
/**
* 停止持续录音
*/
stopRecording(params: {
complete?: () => void;
success?: (params: null) => void;
failure?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
}
export function getRecorderManager(params?: {
complete?: () => void;
success?: (params: null) => void;
failure?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): GetRecorderManagerTask;
GetRecorderManagerTask
GetRecorderManagerTask.start
开始录音
参数
Object object
开始录音的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
duration | number | 否 | 录音的时长,单位 ms,最大值 600000(10 分钟) | |
sampleRate | number | 否 | 采样率 | |
numberOfChannels | number | 否 | 录音通道数 | |
encodeBitRate | number | 否 | 编码码率,有效值见下表格 | |
format | string | 否 | 音频格式 | |
frameSize | number | 是 | 指定帧大小,单位 KB。传入 frameSize 后,每录制指定帧大小的内容后,会回调录制的文件内容,不指定则不会回调。暂仅支持 mp3、pcm 格式。 | |
audioSource | string | 否 | 指定录音的音频输入源 | |
complete | function | 否 | 接口调用完成的回调函数(成功失败都会回调) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
object.success 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
tempFilePath | string | 录音文件的临时路径 (本地路径) |
object.fail 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
函数定义示例
/**
* 开始录音
*/
export function start(params: {
/** 录音的时长,单位 ms,最大值 600000(10 分钟) */
duration?: number;
/** 采样率 */
sampleRate?: number;
/** 录音通道数 */
numberOfChannels?: number;
/** 编码码率,有效值见下表格 */
encodeBitRate?: number;
/** 音频格式 */
format?: string;
/** 指定帧大小,单位 KB。传入 frameSize 后,每录制指定帧大小的内容后,会回调录制的文件内容,不指定则不会回调。暂仅支持 mp3、pcm 格式。 */
frameSize: number;
/** 指定录音的音频输入源 */
audioSource?: string;
complete?: () => void;
success?: (params: {
/** 录音文件的临时路径 (本地路径) */
tempFilePath: string;
}) => void;
failure?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
👉 立即开发。
GetRecorderManagerTask.resume
继续录音
参数
Object object
继续录音的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
object.success 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
tempFilePath | string | 录音文件的临时路径 (本地路径) |
object.fail 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
函数定义示例
/**
* 继续录音
*/
export function resume(params: {
complete?: () => void;
success?: (params: {
/** 录音文件的临时路径 (本地路径) */
tempFilePath: string;
}) => void;
failure?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
GetRecorderManagerTask.pause
暂停录音
参数
Object object
暂停录音的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
object.success 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
tempFilePath | string | 录音文件的临时路径 (本地路径) |
object.fail 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
函数定义示例
/**
* 暂停录音
*/
export function pause(params: {
complete?: () => void;
success?: (params: {
/** 录音文件的临时路径 (本地路径) */
tempFilePath: string;
}) => void;
failure?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
GetRecorderManagerTask.stop
停止录音
参数
Object object
停止录音的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
object.success 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
tempFilePath | string | 录音文件的临时路径 (本地路径) |
object.fail 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
函数定义示例
/**
* 停止录音
*/
export function stop(params: {
complete?: () => void;
success?: (params: {
/** 录音文件的临时路径 (本地路径) */
tempFilePath: string;
}) => void;
failure?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
GetRecorderManagerTask.startRecording
开始持续录音
参数
Object object
开始持续录音的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
period | number | 是 | 间隔时间 ms | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
函数定义示例
/**
* 开始持续录音
*/
export function startRecording(params: {
/** 间隔时间 ms */
period: number;
complete?: () => void;
success?: (params: null) => void;
failure?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
GetRecorderManagerTask.stopRecording
停止持续录音
参数
Object object
停止持续录音的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
函数定义示例
/**
* 停止持续录音
*/
export function stopRecording(params: {
complete?: () => void;
success?: (params: null) => void;
failure?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
ty.onRecordingEvent
持续录音事件
需引入
BaseKit
,且在>=2.3.2
版本才可使用
参数
function callback
持续录音事件的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
buffer | array | 是 | 数据流 |
函数定义示例
/**
* 持续录音事件
*/
export function onRecordingEvent(
listener: (params: {
/** 数据流 */
buffer: number[];
}) => void,
): void;
ty.offRecordingEvent
取消监听:持续录音事件
需引入
BaseKit
,且在>=2.3.2
版本才可使用
参数
function callback
取消监听:持续录音事件的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
buffer | array | 是 | 数据流 |
函数定义示例
/**
* 取消监听:持续录音事件
*/
export function offRecordingEvent(
listener: (params: {
/** 数据流 */
buffer: number[];
}) => void,
): void;
👉 立即开发。