Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
fb385f7c
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
fb385f7c
编写于
8月 22, 2023
作者:
O
openharmony_ci
提交者:
Gitee
8月 22, 2023
浏览文件
操作
浏览文件
下载
差异文件
!22409 add changelog for audio apis change
Merge pull request !22409 from AOL/master
上级
f0ff5513
56889b28
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
113 addition
and
17 deletion
+113
-17
zh-cn/application-dev/reference/apis/js-apis-audio.md
zh-cn/application-dev/reference/apis/js-apis-audio.md
+43
-17
zh-cn/release-notes/changelogs/OpenHarmony_4.0.11.3/changelogs-multimedia.md
.../changelogs/OpenHarmony_4.0.11.3/changelogs-multimedia.md
+70
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-audio.md
浏览文件 @
fb385f7c
...
@@ -4308,9 +4308,9 @@ async function selectOutputDeviceByFilter(){
...
@@ -4308,9 +4308,9 @@ async function selectOutputDeviceByFilter(){
}
}
```
```
### getPreferOutputDeviceForRendererInfo<sup>10+</sup>
### getPrefer
red
OutputDeviceForRendererInfo<sup>10+</sup>
getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: AsyncCallback
<
AudioDeviceDescriptors
>
): void
getPrefer
red
OutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: AsyncCallback
<
AudioDeviceDescriptors
>
): void
根据音频信息,返回优先级最高的输出设备,使用callback方式异步返回结果。
根据音频信息,返回优先级最高的输出设备,使用callback方式异步返回结果。
...
@@ -4323,6 +4323,15 @@ getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback:
...
@@ -4323,6 +4323,15 @@ getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback:
| rendererInfo |
[
AudioRendererInfo
](
#audiorendererinfo8
)
| 是 | 表示渲染器信息。 |
| rendererInfo |
[
AudioRendererInfo
](
#audiorendererinfo8
)
| 是 | 表示渲染器信息。 |
| callback | AsyncCallback
<
[AudioDeviceDescriptors](#audiodevicedescriptors)
>
| 是 | 回调,返回优先级最高的输出设备信息。 |
| 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
```
js
let
rendererInfo
=
{
let
rendererInfo
=
{
...
@@ -4330,8 +4339,8 @@ let rendererInfo = {
...
@@ -4330,8 +4339,8 @@ let rendererInfo = {
usage
:
audio
.
StreamUsage
.
STREAM_USAGE_MEDIA
,
usage
:
audio
.
StreamUsage
.
STREAM_USAGE_MEDIA
,
rendererFlags
:
0
}
rendererFlags
:
0
}
async
function
getPreferOutputDevice
()
{
async
function
getPrefer
red
OutputDevice
()
{
audioRoutingManager
.
getPreferOutputDeviceForRendererInfo
(
rendererInfo
,
(
err
,
desc
)
=>
{
audioRoutingManager
.
getPrefer
red
OutputDeviceForRendererInfo
(
rendererInfo
,
(
err
,
desc
)
=>
{
if
(
err
)
{
if
(
err
)
{
console
.
error
(
`Result ERROR:
${
err
}
`
);
console
.
error
(
`Result ERROR:
${
err
}
`
);
}
else
{
}
else
{
...
@@ -4341,8 +4350,8 @@ async function getPreferOutputDevice() {
...
@@ -4341,8 +4350,8 @@ async function getPreferOutputDevice() {
}
}
```
```
### getPreferOutputDeviceForRendererInfo<sup>10+</sup>
### getPrefer
red
OutputDeviceForRendererInfo<sup>10+</sup>
getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise
<
AudioDeviceDescriptors
>
getPrefer
red
OutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise
<
AudioDeviceDescriptors
>
根据音频信息,返回优先级最高的输出设备,使用promise方式异步返回结果。
根据音频信息,返回优先级最高的输出设备,使用promise方式异步返回结果。
...
@@ -4366,7 +4375,8 @@ getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise&l
...
@@ -4366,7 +4375,8 @@ getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise&l
| 错误码ID | 错误信息 |
| 错误码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 = {
...
@@ -4376,8 +4386,8 @@ let rendererInfo = {
usage
:
audio
.
StreamUsage
.
STREAM_USAGE_MEDIA
,
usage
:
audio
.
StreamUsage
.
STREAM_USAGE_MEDIA
,
rendererFlags
:
0
}
rendererFlags
:
0
}
async
function
getPreferOutputDevice
()
{
async
function
getPrefer
red
OutputDevice
()
{
audioRoutingManager
.
getPreferOutputDeviceForRendererInfo
(
rendererInfo
).
then
((
desc
)
=>
{
audioRoutingManager
.
getPrefer
red
OutputDeviceForRendererInfo
(
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
}
`
);
...
@@ -4385,9 +4395,9 @@ async function getPreferOutputDevice() {
...
@@ -4385,9 +4395,9 @@ async function getPreferOutputDevice() {
}
}
```
```
### on('preferOutputDeviceChangeForRendererInfo')<sup>10+</sup>
### on('prefer
red
OutputDeviceChangeForRendererInfo')<sup>10+</sup>
on(type: 'preferOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererInfo, callback: Callback<AudioDeviceDescriptors
\>
): void
on(type: 'prefer
red
OutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererInfo, callback: Callback<AudioDeviceDescriptors
\>
): void
订阅最高优先级输出设备变化事件,使用callback获取最高优先级输出设备。
订阅最高优先级输出设备变化事件,使用callback获取最高优先级输出设备。
...
@@ -4397,7 +4407,7 @@ on(type: 'preferOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererI
...
@@ -4397,7 +4407,7 @@ on(type: 'preferOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererI
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| :------- | :--------------------------------------------------- | :--- | :----------------------------------------- |
| :------- | :--------------------------------------------------- | :--- | :----------------------------------------- |
| type | string | 是 | 订阅的事件的类型。支持事件:'preferOutputDeviceChangeForRendererInfo' |
| type | string | 是 | 订阅的事件的类型。支持事件:'prefer
red
OutputDeviceChangeForRendererInfo' |
| rendererInfo |
[
AudioRendererInfo
](
#audiorendererinfo8
)
| 是 | 表示渲染器信息。 |
| rendererInfo |
[
AudioRendererInfo
](
#audiorendererinfo8
)
| 是 | 表示渲染器信息。 |
| callback | Callback<
[
AudioDeviceDescriptors
](
#audiodevicedescriptors
)
\>
| 是 | 获取优先级最高的输出设备信息。 |
| callback | Callback<
[
AudioDeviceDescriptors
](
#audiodevicedescriptors
)
\>
| 是 | 获取优先级最高的输出设备信息。 |
...
@@ -4417,14 +4427,14 @@ let rendererInfo = {
...
@@ -4417,14 +4427,14 @@ let rendererInfo = {
usage
:
audio
.
StreamUsage
.
STREAM_USAGE_MEDIA
,
usage
:
audio
.
StreamUsage
.
STREAM_USAGE_MEDIA
,
rendererFlags
:
0
}
rendererFlags
:
0
}
audioRoutingManager
.
on
(
'
preferOutputDeviceChangeForRendererInfo
'
,
rendererInfo
,
(
desc
)
=>
{
audioRoutingManager
.
on
(
'
prefer
red
OutputDeviceChangeForRendererInfo
'
,
rendererInfo
,
(
desc
)
=>
{
console
.
info
(
`device descriptor:
${
desc
}
`
);
console
.
info
(
`device descriptor:
${
desc
}
`
);
});
});
```
```
### off('preferOutputDeviceChangeForRendererInfo')<sup>10+</sup>
### off('prefer
red
OutputDeviceChangeForRendererInfo')<sup>10+</sup>
off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDeviceDescriptors
\>
): void
off(type: 'prefer
red
OutputDeviceChangeForRendererInfo', callback?: Callback<AudioDeviceDescriptors
\>
): void
取消订阅最高优先级输出音频设备变化事件。
取消订阅最高优先级输出音频设备变化事件。
...
@@ -4434,7 +4444,7 @@ off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDe
...
@@ -4434,7 +4444,7 @@ off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDe
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------ |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------ |
| type | string | 是 | 订阅的事件的类型。支持事件:'preferOutputDeviceChangeForRendererInfo' |
| type | string | 是 | 订阅的事件的类型。支持事件:'prefer
red
OutputDeviceChangeForRendererInfo' |
| callback | Callback
<
[
AudioDeviceDescriptors
](
#audiodevicedescriptors
)
>
| 否 | 监听方法的回调函数。 |
| callback | Callback
<
[
AudioDeviceDescriptors
](
#audiodevicedescriptors
)
>
| 否 | 监听方法的回调函数。 |
**错误码:**
**错误码:**
...
@@ -4448,7 +4458,7 @@ off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDe
...
@@ -4448,7 +4458,7 @@ off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDe
**示例:**
**示例:**
```
js
```
js
audioRoutingManager
.
off
(
'
preferOutputDeviceChangeForRendererInfo
'
);
audioRoutingManager
.
off
(
'
prefer
red
OutputDeviceChangeForRendererInfo
'
);
```
```
## AudioRendererChangeInfoArray<sup>9+</sup>
## AudioRendererChangeInfoArray<sup>9+</sup>
...
@@ -4828,6 +4838,14 @@ setAudioEffectMode(mode: AudioEffectMode, callback: AsyncCallback\<void>): void
...
@@ -4828,6 +4838,14 @@ setAudioEffectMode(mode: AudioEffectMode, callback: AsyncCallback\<void>): void
| mode |
[
AudioEffectMode
](
#audioeffectmode10
)
| 是 | 音效模式。 |
| mode |
[
AudioEffectMode
](
#audioeffectmode10
)
| 是 | 音效模式。 |
| callback | AsyncCallback
\<
void> | 是 | 用于返回执行结果的回调。 |
| callback | AsyncCallback
\<
void> | 是 | 用于返回执行结果的回调。 |
**错误码:**
以下错误码的详细介绍请参见
[
音频错误码
](
../errorcodes/errorcode-audio.md
)
。
| 错误码ID | 错误信息 |
| ------- | ----------------------------------------------|
| 6800101 | Invalid parameter error. Return by callback. |
**示例:**
**示例:**
```
js
```
js
...
@@ -4860,6 +4878,14 @@ setAudioEffectMode(mode: AudioEffectMode): Promise\<void>
...
@@ -4860,6 +4878,14 @@ setAudioEffectMode(mode: AudioEffectMode): Promise\<void>
| -------------- | ------------------------- |
| -------------- | ------------------------- |
| Promise
\<
void> | Promise用于返回执行结果。 |
| Promise
\<
void> | Promise用于返回执行结果。 |
**错误码:**
以下错误码的详细介绍请参见
[
音频错误码
](
../errorcodes/errorcode-audio.md
)
。
| 错误码ID | 错误信息 |
| ------- | ---------------------------------------------|
| 6800101 | Invalid parameter error. Return by promise. |
**示例:**
**示例:**
```
js
```
js
...
...
zh-cn/release-notes/changelogs/OpenHarmony_4.0.11.3/changelogs-multimedia.md
0 → 100644
浏览文件 @
fb385f7c
# 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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录