Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 7f0a621e 编写于 作者: M magekkkk
浏览文件
操作

remove name change docs 

Signed-off-by: Nmagekkkk <lixin113@huawei.com>
上级 2c5a9a79
隐藏空白更改
内联 并排
Showing with 47 addition and 34 deletion
zh-cn/application-dev/reference/apis/js-apis-audio.md
浏览文件 @ 7f0a621e
...@@ -4308,9 +4308,9 @@ async function selectOutputDeviceByFilter(){ ...@@ -4308,9 +4308,9 @@ async function selectOutputDeviceByFilter(){
} }
``` ```
### getPreferredOutputDeviceForRendererInfo<sup>10+</sup> ### getPreferOutputDeviceForRendererInfo<sup>10+</sup>
getPreferredOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: AsyncCallback&lt;AudioDeviceDescriptors&gt;): void getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: AsyncCallback&lt;AudioDeviceDescriptors&gt;): void
根据音频信息，返回优先级最高的输出设备，使用callback方式异步返回结果。 根据音频信息，返回优先级最高的输出设备，使用callback方式异步返回结果。
...@@ -4323,15 +4323,6 @@ getPreferredOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callbac ...@@ -4323,15 +4323,6 @@ getPreferredOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callbac
| rendererInfo | [AudioRendererInfo](#audiorendererinfo8) | 是 | 表示渲染器信息。 | | rendererInfo | [AudioRendererInfo](#audiorendererinfo8) | 是 | 表示渲染器信息。 |
| callback | AsyncCallback&lt;[AudioDeviceDescriptors](#audiodevicedescriptors)&gt; | 是 | 回调，返回优先级最高的输出设备信息。 | | 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 ```js
let rendererInfo = { let rendererInfo = {
...@@ -4339,8 +4330,8 @@ let rendererInfo = { ...@@ -4339,8 +4330,8 @@ let rendererInfo = {
usage : audio.StreamUsage.STREAM_USAGE_MEDIA, usage : audio.StreamUsage.STREAM_USAGE_MEDIA,
rendererFlags : 0 } rendererFlags : 0 }
async function getPreferredOutputDevice() { async function getPreferOutputDevice() {
audioRoutingManager.getPreferredOutputDeviceForRendererInfo(rendererInfo, (err, desc) => { audioRoutingManager.getPreferOutputDeviceForRendererInfo(rendererInfo, (err, desc) => {
if (err) { if (err) {
console.error(`Result ERROR: ${err}`); console.error(`Result ERROR: ${err}`);
} else { } else {
...@@ -4350,8 +4341,8 @@ async function getPreferredOutputDevice() { ...@@ -4350,8 +4341,8 @@ async function getPreferredOutputDevice() {
} }
``` ```
### getPreferredOutputDeviceForRendererInfo<sup>10+</sup> ### getPreferOutputDeviceForRendererInfo<sup>10+</sup>
getPreferredOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise&lt;AudioDeviceDescriptors&gt; getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise&lt;AudioDeviceDescriptors&gt;
根据音频信息，返回优先级最高的输出设备，使用promise方式异步返回结果。 根据音频信息，返回优先级最高的输出设备，使用promise方式异步返回结果。
...@@ -4369,15 +4360,6 @@ getPreferredOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promis ...@@ -4369,15 +4360,6 @@ getPreferredOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promis
| --------------------- | --------------------------- | | --------------------- | --------------------------- |
| Promise&lt;[AudioDeviceDescriptors](#audiodevicedescriptors)&gt; | Promise返回优先级最高的输出设备信息。 | | Promise&lt;[AudioDeviceDescriptors](#audiodevicedescriptors)&gt; | Promise返回优先级最高的输出设备信息。 |
**错误码：**
以下错误码的详细介绍请参见[音频错误码](../errorcodes/errorcode-audio.md)。
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | if input parameter value error. Return by promise. |
| 6800301 | System error. Return by promise. |
**示例：** **示例：**
```js ```js
...@@ -4386,8 +4368,8 @@ let rendererInfo = { ...@@ -4386,8 +4368,8 @@ let rendererInfo = {
usage : audio.StreamUsage.STREAM_USAGE_MEDIA, usage : audio.StreamUsage.STREAM_USAGE_MEDIA,
rendererFlags : 0 } rendererFlags : 0 }
async function getPreferredOutputDevice() { async function getPreferOutputDevice() {
audioRoutingManager.getPreferredOutputDeviceForRendererInfo(rendererInfo).then((desc) => { audioRoutingManager.getPreferOutputDeviceForRendererInfo(rendererInfo).then((desc) => {
console.info(`device descriptor: ${desc}`); console.info(`device descriptor: ${desc}`);
}).catch((err) => { }).catch((err) => {
console.error(`Result ERROR: ${err}`); console.error(`Result ERROR: ${err}`);
...@@ -4395,9 +4377,9 @@ async function getPreferredOutputDevice() { ...@@ -4395,9 +4377,9 @@ async function getPreferredOutputDevice() {
} }
``` ```
### on('preferredOutputDeviceChangeForRendererInfo')<sup>10+</sup> ### on('preferOutputDeviceChangeForRendererInfo')<sup>10+</sup>
on(type: 'preferredOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererInfo, callback: Callback<AudioDeviceDescriptors\>): void on(type: 'preferOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererInfo, callback: Callback<AudioDeviceDescriptors\>): void
订阅最高优先级输出设备变化事件，使用callback获取最高优先级输出设备。 订阅最高优先级输出设备变化事件，使用callback获取最高优先级输出设备。
...@@ -4407,7 +4389,7 @@ on(type: 'preferredOutputDeviceChangeForRendererInfo', rendererInfo: AudioRender ...@@ -4407,7 +4389,7 @@ on(type: 'preferredOutputDeviceChangeForRendererInfo', rendererInfo: AudioRender
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :------- | :--------------------------------------------------- | :--- | :----------------------------------------- | | :------- | :--------------------------------------------------- | :--- | :----------------------------------------- |
| type | string | 是 | 订阅的事件的类型。支持事件：'preferredOutputDeviceChangeForRendererInfo' | | type | string | 是 | 订阅的事件的类型。支持事件：'preferOutputDeviceChangeForRendererInfo' |
| rendererInfo | [AudioRendererInfo](#audiorendererinfo8) | 是 | 表示渲染器信息。 | | rendererInfo | [AudioRendererInfo](#audiorendererinfo8) | 是 | 表示渲染器信息。 |
| callback | Callback<[AudioDeviceDescriptors](#audiodevicedescriptors)\> | 是 | 获取优先级最高的输出设备信息。 | | callback | Callback<[AudioDeviceDescriptors](#audiodevicedescriptors)\> | 是 | 获取优先级最高的输出设备信息。 |
...@@ -4427,14 +4409,14 @@ let rendererInfo = { ...@@ -4427,14 +4409,14 @@ let rendererInfo = {
usage : audio.StreamUsage.STREAM_USAGE_MEDIA, usage : audio.StreamUsage.STREAM_USAGE_MEDIA,
rendererFlags : 0 } rendererFlags : 0 }
audioRoutingManager.on('preferredOutputDeviceChangeForRendererInfo', rendererInfo, (desc) => { audioRoutingManager.on('preferOutputDeviceChangeForRendererInfo', rendererInfo, (desc) => {
console.info(`device descriptor: ${desc}`); console.info(`device descriptor: ${desc}`);
}); });
``` ```
### off('preferredOutputDeviceChangeForRendererInfo')<sup>10+</sup> ### off('preferOutputDeviceChangeForRendererInfo')<sup>10+</sup>
off(type: 'preferredOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDeviceDescriptors\>): void off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDeviceDescriptors\>): void
取消订阅最高优先级输出音频设备变化事件。 取消订阅最高优先级输出音频设备变化事件。
...@@ -4444,7 +4426,7 @@ off(type: 'preferredOutputDeviceChangeForRendererInfo', callback?: Callback<Audi ...@@ -4444,7 +4426,7 @@ off(type: 'preferredOutputDeviceChangeForRendererInfo', callback?: Callback<Audi
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------ | | -------- | --------------------------------------------------- | ---- | ------------------------------------------ |
| type | string | 是 | 订阅的事件的类型。支持事件：'preferredOutputDeviceChangeForRendererInfo' | | type | string | 是 | 订阅的事件的类型。支持事件：'preferOutputDeviceChangeForRendererInfo' |
| callback | Callback<[AudioDeviceDescriptors](#audiodevicedescriptors)> | 否 | 监听方法的回调函数。 | | callback | Callback<[AudioDeviceDescriptors](#audiodevicedescriptors)> | 否 | 监听方法的回调函数。 |
**错误码：** **错误码：**
...@@ -4458,7 +4440,7 @@ off(type: 'preferredOutputDeviceChangeForRendererInfo', callback?: Callback<Audi ...@@ -4458,7 +4440,7 @@ off(type: 'preferredOutputDeviceChangeForRendererInfo', callback?: Callback<Audi
**示例：** **示例：**
```js ```js
audioRoutingManager.off('preferredOutputDeviceChangeForRendererInfo'); audioRoutingManager.off('preferOutputDeviceChangeForRendererInfo');
``` ```
## AudioRendererChangeInfoArray<sup>9+</sup> ## AudioRendererChangeInfoArray<sup>9+</sup>
......
zh-cn/release-notes/changelogs/OpenHarmony_4.0.11.3/changelogs-multimedia.md → zh-cn/release-notes/changelogs/OpenHarmony_4.0.10.5/changelogs-multimedia.md
浏览文件 @ 7f0a621e
# multimedia子系统ChangeLog # multimedia子系统ChangeLog
## cl.multimedia.1 preferOutputDeviceForRendererInfo系列接口命名变更 ## cl.multimedia.1 @ohos.multimedia.audio.d.ts内带入参的API10接口新增错误码声明
对于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接口新增错误码声明
**变更影响** **变更影响**
...@@ -45,10 +12,6 @@ off(type: 'preferredOutputDeviceChangeForRendererInfo', callback?: Callback<Audi ...@@ -45,10 +12,6 @@ off(type: 'preferredOutputDeviceChangeForRendererInfo', callback?: Callback<Audi
涉及新增错误声明的接口： 涉及新增错误声明的接口：
```ts ```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, callback: AsyncCallback<void>): void;
setAudioEffectMode(mode: AudioEffectMode): Promise<void>; setAudioEffectMode(mode: AudioEffectMode): Promise<void>;
``` ```
...@@ -60,8 +23,6 @@ setAudioEffectMode(mode: AudioEffectMode): Promise<void>; ...@@ -60,8 +23,6 @@ setAudioEffectMode(mode: AudioEffectMode): Promise<void>;
@throws { BusinessError } 401 - If input parameter type or number mismatch. @throws { BusinessError } 401 - If input parameter type or number mismatch.
// 入参值不符合取值范围 // 入参值不符合取值范围
@throws { BusinessError } 6800101 - Invalid parameter error. @throws { BusinessError } 6800101 - Invalid parameter error.
// 系统通用内部错误
@throws { BusinessError } 6800301 - System error.
``` ```
**适配指导** **适配指导**
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或