未验证 提交 fb385f7c 编写于 作者: O openharmony_ci 提交者: Gitee

!22409 add changelog for audio apis change

Merge pull request !22409 from AOL/master
......@@ -4308,9 +4308,9 @@ async function selectOutputDeviceByFilter(){
}
```
### getPreferOutputDeviceForRendererInfo<sup>10+</sup>
### getPreferredOutputDeviceForRendererInfo<sup>10+</sup>
getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: AsyncCallback&lt;AudioDeviceDescriptors&gt;): void
getPreferredOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: AsyncCallback&lt;AudioDeviceDescriptors&gt;): void
根据音频信息,返回优先级最高的输出设备,使用callback方式异步返回结果。
......@@ -4323,6 +4323,15 @@ getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback:
| rendererInfo | [AudioRendererInfo](#audiorendererinfo8) | 是 | 表示渲染器信息。 |
| callback | AsyncCallback&lt;[AudioDeviceDescriptors](#audiodevicedescriptors)&gt; | 是 | 回调,返回优先级最高的输出设备信息。 |
**错误码:**
以下错误码的详细介绍请参见[音频错误码](../errorcodes/errorcode-audio.md)
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | if input parameter value error. Return by callback. |
| 6800301 | System error. Return by callback. |
**示例:**
```js
let rendererInfo = {
......@@ -4330,8 +4339,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 {
......@@ -4341,8 +4350,8 @@ async function getPreferOutputDevice() {
}
```
### getPreferOutputDeviceForRendererInfo<sup>10+</sup>
getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise&lt;AudioDeviceDescriptors&gt;
### getPreferredOutputDeviceForRendererInfo<sup>10+</sup>
getPreferredOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise&lt;AudioDeviceDescriptors&gt;
根据音频信息,返回优先级最高的输出设备,使用promise方式异步返回结果。
......@@ -4366,7 +4375,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. |
**示例:**
......@@ -4376,8 +4386,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}`);
......@@ -4385,9 +4395,9 @@ async function getPreferOutputDevice() {
}
```
### on('preferOutputDeviceChangeForRendererInfo')<sup>10+</sup>
### on('preferredOutputDeviceChangeForRendererInfo')<sup>10+</sup>
on(type: 'preferOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererInfo, callback: Callback<AudioDeviceDescriptors\>): void
on(type: 'preferredOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererInfo, callback: Callback<AudioDeviceDescriptors\>): void
订阅最高优先级输出设备变化事件,使用callback获取最高优先级输出设备。
......@@ -4397,7 +4407,7 @@ on(type: 'preferOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererI
| 参数名 | 类型 | 必填 | 说明 |
| :------- | :--------------------------------------------------- | :--- | :----------------------------------------- |
| type | string | 是 | 订阅的事件的类型。支持事件:'preferOutputDeviceChangeForRendererInfo' |
| type | string | 是 | 订阅的事件的类型。支持事件:'preferredOutputDeviceChangeForRendererInfo' |
| rendererInfo | [AudioRendererInfo](#audiorendererinfo8) | 是 | 表示渲染器信息。 |
| callback | Callback<[AudioDeviceDescriptors](#audiodevicedescriptors)\> | 是 | 获取优先级最高的输出设备信息。 |
......@@ -4417,14 +4427,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')<sup>10+</sup>
### off('preferredOutputDeviceChangeForRendererInfo')<sup>10+</sup>
off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDeviceDescriptors\>): void
off(type: 'preferredOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDeviceDescriptors\>): void
取消订阅最高优先级输出音频设备变化事件。
......@@ -4434,7 +4444,7 @@ off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDe
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------ |
| type | string | 是 | 订阅的事件的类型。支持事件:'preferOutputDeviceChangeForRendererInfo' |
| type | string | 是 | 订阅的事件的类型。支持事件:'preferredOutputDeviceChangeForRendererInfo' |
| callback | Callback<[AudioDeviceDescriptors](#audiodevicedescriptors)> | 否 | 监听方法的回调函数。 |
**错误码:**
......@@ -4448,7 +4458,7 @@ off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDe
**示例:**
```js
audioRoutingManager.off('preferOutputDeviceChangeForRendererInfo');
audioRoutingManager.off('preferredOutputDeviceChangeForRendererInfo');
```
## AudioRendererChangeInfoArray<sup>9+</sup>
......@@ -4828,6 +4838,14 @@ setAudioEffectMode(mode: AudioEffectMode, callback: AsyncCallback\<void>): void
| mode | [AudioEffectMode](#audioeffectmode10) | 是 | 音效模式。 |
| callback | AsyncCallback\<void> | 是 | 用于返回执行结果的回调。 |
**错误码:**
以下错误码的详细介绍请参见[音频错误码](../errorcodes/errorcode-audio.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------------------------------|
| 6800101 | Invalid parameter error. Return by callback. |
**示例:**
```js
......@@ -4860,6 +4878,14 @@ setAudioEffectMode(mode: AudioEffectMode): Promise\<void>
| -------------- | ------------------------- |
| Promise\<void> | Promise用于返回执行结果。 |
**错误码:**
以下错误码的详细介绍请参见[音频错误码](../errorcodes/errorcode-audio.md)
| 错误码ID | 错误信息 |
| ------- | ---------------------------------------------|
| 6800101 | Invalid parameter error. Return by promise. |
**示例:**
```js
......
# multimedia子系统ChangeLog
## cl.multimedia.1 preferOutputDeviceForRendererInfo系列接口命名变更
对于getPreferOutputDeviceForRendererInfo和对应的on/off订阅接口,命名内preferOutput变更为preferredOutput,与新增的preferredInput相匹配,满足英文翻译要求
**变更影响**
已在Beta版本发布的ts接口,影响使用此三方应用的兼容性。
**关键的接口/组件变更**
修改前的接口原型:
```ts
getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: AsyncCallback<AudioDeviceDescriptors>): void;
getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise<AudioDeviceDescriptors>;
on(type: 'preferOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererInfo, callback: Callback<AudioDeviceDescriptors>): void;
off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDeviceDescriptors>): void;
```
修改后的接口原型:
```ts
getPreferredOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: AsyncCallback<AudioDeviceDescriptors>): void;
getPreferredOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise<AudioDeviceDescriptors>;
on(type: 'preferredOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererInfo, callback: Callback<AudioDeviceDescriptors>): void;
off(type: 'preferredOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDeviceDescriptors>): void;
```
**适配指导**
修改后开发者调用该接口时,需要使用修改后的接口命名定义。
系统会暂时兼容两种命名方式的接口调用,但建议在使用新版本SDK后立即修改适配。
## cl.multimedia.2 @ohos.multimedia.audio.d.ts内带入参的API10接口新增错误码声明
**变更影响**
携带入参的接口,当开发者参数类型或数量传错情况下,接口会同步抛出401错误码的异常,当参数值不符合取值范围,当接口为同步接口,会抛出相应错误码的异常,当接口为异步接口,会通过异步error返回错误码。
如果接口使用符合定义要求,则无兼容性影响。
**关键的接口/组件变更**
涉及新增错误声明的接口:
```ts
getPreferredOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: AsyncCallback<AudioDeviceDescriptors>): void;
getPreferredOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise<AudioDeviceDescriptors>;
on(type: 'preferredOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererInfo, callback: Callback<AudioDeviceDescriptors>): void;
off(type: 'preferredOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDeviceDescriptors>): void;
setAudioEffectMode(mode: AudioEffectMode, callback: AsyncCallback<void>): void;
setAudioEffectMode(mode: AudioEffectMode): Promise<void>;
```
涉及新增的错误码类型:
```ts
// 入参类型或数量缺少
@throws { BusinessError } 401 - If input parameter type or number mismatch.
// 入参值不符合取值范围
@throws { BusinessError } 6800101 - Invalid parameter error.
// 系统通用内部错误
@throws { BusinessError } 6800301 - System error.
```
**适配指导**
接口使用时,当发现抛出错误码为401的异常,开发者需要检查传入的参数类型和数量是否符合接口定义。
当发现接口异步返回了错误,可以根据错误码,检查接口错误的原因,进行合理的异常处置。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册