From 56889b28ac860d8bcd238675c4397ce5bf246034 Mon Sep 17 00:00:00 2001 From: magekkkk Date: Tue, 22 Aug 2023 15:47:20 +0800 Subject: [PATCH] fix js reference for audio apis change Signed-off-by: magekkkk --- .../reference/apis/js-apis-audio.md | 60 +++++++++++++------ 1 file changed, 43 insertions(+), 17 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-audio.md b/zh-cn/application-dev/reference/apis/js-apis-audio.md index f05ddbff7f..76bfca73c0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-audio.md +++ b/zh-cn/application-dev/reference/apis/js-apis-audio.md @@ -4310,9 +4310,9 @@ async function selectOutputDeviceByFilter(){ } ``` -### getPreferOutputDeviceForRendererInfo10+ +### getPreferredOutputDeviceForRendererInfo10+ -getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: AsyncCallback<AudioDeviceDescriptors>): void +getPreferredOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: AsyncCallback<AudioDeviceDescriptors>): void 根据音频信息，返回优先级最高的输出设备，使用callback方式异步返回结果。 @@ -4325,6 +4325,15 @@ getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: | rendererInfo | [AudioRendererInfo](#audiorendererinfo8) | 是 | 表示渲染器信息。 | | callback | AsyncCallback<[AudioDeviceDescriptors](#audiodevicedescriptors)> | 是 | 回调，返回优先级最高的输出设备信息。 | +**错误码：** + +以下错误码的详细介绍请参见[音频错误码](../errorcodes/errorcode-audio.md)。 + +| 错误码ID | 错误信息 | +| ------- | --------------------------------------------| +| 6800101 | if input parameter value error. Return by callback. | +| 6800301 | System error. Return by callback. | + **示例：** ```js let rendererInfo = { @@ -4332,8 +4341,8 @@ let rendererInfo = { usage : audio.StreamUsage.STREAM_USAGE_MEDIA, rendererFlags : 0 } -async function getPreferOutputDevice() { - audioRoutingManager.getPreferOutputDeviceForRendererInfo(rendererInfo, (err, desc) => { +async function getPreferredOutputDevice() { + audioRoutingManager.getPreferredOutputDeviceForRendererInfo(rendererInfo, (err, desc) => { if (err) { console.error(`Result ERROR: ${err}`); } else { @@ -4343,8 +4352,8 @@ async function getPreferOutputDevice() { } ``` -### getPreferOutputDeviceForRendererInfo10+ -getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise<AudioDeviceDescriptors> +### getPreferredOutputDeviceForRendererInfo10+ +getPreferredOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise<AudioDeviceDescriptors> 根据音频信息，返回优先级最高的输出设备，使用promise方式异步返回结果。 @@ -4368,7 +4377,8 @@ getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise&l | 错误码ID | 错误信息 | | ------- | --------------------------------------------| -| 6800101 | if input parameter value error | +| 6800101 | if input parameter value error. Return by promise. | +| 6800301 | System error. Return by promise. | **示例：** @@ -4378,8 +4388,8 @@ let rendererInfo = { usage : audio.StreamUsage.STREAM_USAGE_MEDIA, rendererFlags : 0 } -async function getPreferOutputDevice() { - audioRoutingManager.getPreferOutputDeviceForRendererInfo(rendererInfo).then((desc) => { +async function getPreferredOutputDevice() { + audioRoutingManager.getPreferredOutputDeviceForRendererInfo(rendererInfo).then((desc) => { console.info(`device descriptor: ${desc}`); }).catch((err) => { console.error(`Result ERROR: ${err}`); @@ -4387,9 +4397,9 @@ async function getPreferOutputDevice() { } ``` -### on('preferOutputDeviceChangeForRendererInfo')10+ +### on('preferredOutputDeviceChangeForRendererInfo')10+ -on(type: 'preferOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererInfo, callback: Callback): void +on(type: 'preferredOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererInfo, callback: Callback): void 订阅最高优先级输出设备变化事件，使用callback获取最高优先级输出设备。 @@ -4399,7 +4409,7 @@ on(type: 'preferOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererI | 参数名 | 类型 | 必填 | 说明 | | :------- | :--------------------------------------------------- | :--- | :----------------------------------------- | -| type | string | 是 | 订阅的事件的类型。支持事件：'preferOutputDeviceChangeForRendererInfo' | +| type | string | 是 | 订阅的事件的类型。支持事件：'preferredOutputDeviceChangeForRendererInfo' | | rendererInfo | [AudioRendererInfo](#audiorendererinfo8) | 是 | 表示渲染器信息。 | | callback | Callback<[AudioDeviceDescriptors](#audiodevicedescriptors)\> | 是 | 获取优先级最高的输出设备信息。 | @@ -4419,14 +4429,14 @@ let rendererInfo = { usage : audio.StreamUsage.STREAM_USAGE_MEDIA, rendererFlags : 0 } -audioRoutingManager.on('preferOutputDeviceChangeForRendererInfo', rendererInfo, (desc) => { +audioRoutingManager.on('preferredOutputDeviceChangeForRendererInfo', rendererInfo, (desc) => { console.info(`device descriptor: ${desc}`); }); ``` -### off('preferOutputDeviceChangeForRendererInfo')10+ +### off('preferredOutputDeviceChangeForRendererInfo')10+ -off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback): void +off(type: 'preferredOutputDeviceChangeForRendererInfo', callback?: Callback): void 取消订阅最高优先级输出音频设备变化事件。 @@ -4436,7 +4446,7 @@ off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback | 否 | 监听方法的回调函数。 | **错误码：** @@ -4450,7 +4460,7 @@ off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback9+ @@ -4830,6 +4840,14 @@ setAudioEffectMode(mode: AudioEffectMode, callback: AsyncCallback\): void | mode | [AudioEffectMode](#audioeffectmode10) | 是 | 音效模式。 | | callback | AsyncCallback\ | 是 | 用于返回执行结果的回调。 | +**错误码：** + +以下错误码的详细介绍请参见[音频错误码](../errorcodes/errorcode-audio.md)。 + +| 错误码ID | 错误信息 | +| ------- | ----------------------------------------------| +| 6800101 | Invalid parameter error. Return by callback. | + **示例：** ```js @@ -4862,6 +4880,14 @@ setAudioEffectMode(mode: AudioEffectMode): Promise\ | -------------- | ------------------------- | | Promise\ | Promise用于返回执行结果。 | +**错误码：** + +以下错误码的详细介绍请参见[音频错误码](../errorcodes/errorcode-audio.md)。 + +| 错误码ID | 错误信息 | +| ------- | ---------------------------------------------| +| 6800101 | Invalid parameter error. Return by promise. | + **示例：** ```js -- GitLab