Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
405fc817
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看板
提交
405fc817
编写于
11月 18, 2022
作者:
J
jiao_yanlin
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Sample code and interface consistency check
Signed-off-by:
N
jiao_yanlin
<
jiaoyanlin@huawei.com
>
上级
91f37c7d
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
60 addition
and
44 deletion
+60
-44
zh-cn/application-dev/reference/apis/js-apis-audio.md
zh-cn/application-dev/reference/apis/js-apis-audio.md
+53
-37
zh-cn/application-dev/reference/errorcodes/errorcode-audio.md
...n/application-dev/reference/errorcodes/errorcode-audio.md
+7
-7
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-audio.md
浏览文件 @
405fc817
...
...
@@ -337,7 +337,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Volume
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ---------------------------- | ------ | ---------- |
| VOICE_CALL
<sup>
8+
</sup>
| 0 | 语音电话。 |
| RINGTONE | 2 | 铃声。 |
...
...
@@ -353,7 +353,7 @@ async function createTonePlayer(){
**系统接口:**
该接口为系统接口
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ---------------------------- | ------ | ---------- |
| INTERRUPT_REQUEST_GRANT | 0 | 请求音频中断成功。 |
| INTERRUPT_REQUEST_REJECT | 1 | 请求音频中断失败,可能具有较高优先级类型。 |
...
...
@@ -364,7 +364,7 @@ async function createTonePlayer(){
**系统能力:**
SystemCapability.Multimedia.Audio.Interrupt
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ---------------------------- | ------ | ---------- |
| SHARE_MODE | 0 | 共享焦点模式。 |
| INDEPENDENT_MODE | 1 | 独立焦点模式。 |
...
...
@@ -375,7 +375,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Device
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ------------------------------- | ------ | ------------------------------------------------- |
| NONE_DEVICES_FLAG
<sup>
9+
</sup>
| 0 | 无
<br/>
此接口为系统接口。 |
| OUTPUT_DEVICES_FLAG | 1 | 输出设备。 |
...
...
@@ -391,7 +391,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Device
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ------------- | ------ | -------------- |
| INPUT_DEVICE | 1 | 输入设备角色。 |
| OUTPUT_DEVICE | 2 | 输出设备角色。 |
...
...
@@ -402,7 +402,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Device
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ---------------------| ------ | --------------------------------------------------------- |
| INVALID | 0 | 无效设备。 |
| EARPIECE | 1 | 听筒。 |
...
...
@@ -421,7 +421,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Communication
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ------------- | ------ | -------------|
| SPEAKER | 2 | 扬声器。 |
...
...
@@ -431,7 +431,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Communication
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ------------------- | ------ | ---------- |
| RINGER_MODE_SILENT | 0 | 静音模式。 |
| RINGER_MODE_VIBRATE | 1 | 震动模式。 |
...
...
@@ -443,7 +443,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Core
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ---------------------------------- | ------ | -------------------------- |
| SAMPLE_FORMAT_INVALID | -1 | 无效格式。 |
| SAMPLE_FORMAT_U8 | 0 | 无符号8位整数。 |
...
...
@@ -474,7 +474,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Core
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| --------- | -------- | -------- |
| CHANNEL_1 | 0x1 << 0 | 单声道。 |
| CHANNEL_2 | 0x1 << 1 | 双声道。 |
...
...
@@ -485,7 +485,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Core
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ----------------- | ------ | --------------- |
| SAMPLE_RATE_8000 | 8000 | 采样率为8000。 |
| SAMPLE_RATE_11025 | 11025 | 采样率为11025。 |
...
...
@@ -505,7 +505,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Core
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| --------------------- | ------ | --------- |
| ENCODING_TYPE_INVALID | -1 | 无效。 |
| ENCODING_TYPE_RAW | 0 | PCM编码。 |
...
...
@@ -516,7 +516,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Core
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ---------------------------------- | ------ | ---------- |
| CONTENT_TYPE_UNKNOWN | 0 | 未知类型。 |
| CONTENT_TYPE_SPEECH | 1 | 语音。 |
...
...
@@ -531,7 +531,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Core
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ------------------------------------------| ------ | ---------- |
| STREAM_USAGE_UNKNOWN | 0 | 未知类型。 |
| STREAM_USAGE_MEDIA | 1 | 音频。 |
...
...
@@ -547,7 +547,7 @@ async function createTonePlayer(){
**系统能力:**
SystemCapability.Multimedia.Audio.Interrupt
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ---------------------------------- | ------ | ------------------------- |
| INTERRUPT_REQUEST_TYPE_DEFAULT | 0 | 默认类型,可中断音频请求。 |
...
...
@@ -557,7 +557,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Core
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| -------------- | ------ | ---------------- |
| STATE_INVALID | -1 | 无效状态。 |
| STATE_NEW | 0 | 创建新实例状态。 |
...
...
@@ -573,7 +573,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Renderer
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ------------------ | ------ | ---------- |
| RENDER_RATE_NORMAL | 0 | 正常速度。 |
| RENDER_RATE_DOUBLE | 1 | 2倍速。 |
...
...
@@ -585,7 +585,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Renderer
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| -------------------- | ------ | ---------------------- |
| INTERRUPT_TYPE_BEGIN | 1 | 音频播放中断事件开始。 |
| INTERRUPT_TYPE_END | 2 | 音频播放中断事件结束。 |
...
...
@@ -596,7 +596,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Renderer
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| --------------- | ------ | ------------------------------------ |
| INTERRUPT_FORCE | 0 | 由系统进行操作,强制打断音频播放。 |
| INTERRUPT_SHARE | 1 | 由应用进行操作,可以选择打断或忽略。 |
...
...
@@ -607,7 +607,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Renderer
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ---------------------------------- | ------ | -------------------------------------------- |
| INTERRUPT_HINT_NONE
<sup>
8+
</sup>
| 0 | 无提示。 |
| INTERRUPT_HINT_RESUME | 1 | 提示音频恢复。 |
...
...
@@ -711,7 +711,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Volume
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| :------------------------------ | :----- | :--------------------- |
| CONNECT_TYPE_LOCAL | 1 | 本地设备。 |
| CONNECT_TYPE_DISTRIBUTED | 2 | 分布式设备。 |
...
...
@@ -737,7 +737,7 @@ async function createTonePlayer(){
| networkId
<sup>
9+
</sup>
| string | 是 | 否 | 组网络id。 |
| groupId
<sup>
9+
</sup>
| number | 是 | 否 | 组设备组id。 |
| mappingId
<sup>
9+
</sup>
| number | 是 | 否 | 组映射id。 |
| groupName
<sup>
9+
</sup>
|
number
| 是 | 否 | 组名。 |
| groupName
<sup>
9+
</sup>
|
string
| 是 | 否 | 组名。 |
| type
<sup>
9+
</sup>
|
[
ConnectType
](
#connecttype9
)
| 是 | 否 | 连接设备类型。 |
## DeviceChangeAction
...
...
@@ -757,7 +757,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Device
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| :--------- | :----- | :------------- |
| CONNECT | 0 | 设备连接。 |
| DISCONNECT | 1 | 断开设备连接。 |
...
...
@@ -790,7 +790,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Core
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| :------------------------------------------- | :----- | :--------------------- |
| SOURCE_TYPE_INVALID | -1 | 无效的音频源。 |
| SOURCE_TYPE_MIC | 0 | Mic音频源。 |
...
...
@@ -803,7 +803,7 @@ async function createTonePlayer(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Communication
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| :--------------------- | :----- | :-------------------------------------------- |
| AUDIO_SCENE_DEFAULT | 0 | 默认音频场景。 |
| AUDIO_SCENE_RINGING | 1 | 响铃模式。
<br/>
此接口为系统接口。 |
...
...
@@ -1171,7 +1171,7 @@ getVolumeGroupManager(groupId: number, callback: AsyncCallback<AudioVolumeGroupM
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | -------------------- |
| groupId | number | 是 | 音量组id。 |
| callback | AsyncCallback
<
[
AudioVolumeGroupManager
](
#audiovolumegroupmanager9
)
>
| 是 | 回调,返回一个音量组实例。 |
| callback | AsyncCallback
<
[AudioVolumeGroupManager](#audiovolumegroupmanager9)
>
| 是 | 回调,返回一个音量组实例。 |
**示例:**
...
...
@@ -1236,7 +1236,7 @@ on(type: 'volumeChange', callback: Callback\<VolumeEvent>): void
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | if input parameter value error
.
|
| 6800101 | if input parameter value error
|
**示例:**
...
...
@@ -1750,7 +1750,7 @@ on(type: 'ringerModeChange', callback: Callback\<AudioRingMode>): void
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | if input parameter value error
.
|
| 6800101 | if input parameter value error
|
**示例:**
...
...
@@ -1889,7 +1889,7 @@ on(type: 'micStateChange', callback: Callback<MicStateChangeEvent>): void
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | if input parameter value error
.
|
| 6800101 | if input parameter value error
|
**示例:**
...
...
@@ -2108,7 +2108,7 @@ on(type: "audioRendererChange", callback: Callback<AudioRendererChangeInfoArr
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | if input parameter value error
.
|
| 6800101 | if input parameter value error
|
**示例:**
...
...
@@ -2157,7 +2157,7 @@ off(type: "audioRendererChange"): void
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | if input parameter value error
.
|
| 6800101 | if input parameter value error
|
**示例:**
...
...
@@ -2181,6 +2181,14 @@ on(type: "audioCapturerChange", callback: Callback<AudioCapturerChangeInfoArr
| type | string | 是 | 事件类型,支持的事件
`'audioCapturerChange'`
:当音频采集器发生更改时触发。 |
| callback | Callback
<
[
AudioCapturerChangeInfoArray
](
#audiocapturerchangeinfoarray9
)
>
| 是 | 回调函数。 |
**错误码:**
以下错误码的详细介绍请参见
[
音频错误码
](
../errorcodes/errorcode-audio.md
)
。
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | if input parameter value error |
**示例:**
```
js
...
...
@@ -2221,6 +2229,14 @@ off(type: "audioCapturerChange"): void;
| -------- | -------- | --- | ------------------------------------------------------------- |
| type | string |是 | 事件类型,支持的事件
`'audioCapturerChange'`
:音频采集器更改事件。 |
**错误码:**
以下错误码的详细介绍请参见
[
音频错误码
](
../errorcodes/errorcode-audio.md
)
。
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | if input parameter value error |
**示例:**
```
js
...
...
@@ -2365,7 +2381,7 @@ on(type: 'deviceChange', deviceFlag: DeviceFlag, callback: Callback<DeviceChange
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | if input parameter value error
.
|
| 6800101 | if input parameter value error
|
**示例:**
...
...
@@ -2399,7 +2415,7 @@ off(type: 'deviceChange', callback?: Callback<DeviceChangeAction\>): void
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | if input parameter value error
.
|
| 6800101 | if input parameter value error
|
**示例:**
...
...
@@ -3804,7 +3820,7 @@ on(type: 'audioInterrupt', callback: Callback\<InterruptEvent>): void
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | if input parameter value error
.
|
| 6800101 | if input parameter value error
|
**示例:**
...
...
@@ -4627,7 +4643,7 @@ audioCapturer.on('stateChange', (state) => {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Tone
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| :------------------------------------------------ | :----- | :----------------------------|
| TONE_TYPE_DIAL_0 | 0 | 键0的DTMF音。 |
| TONE_TYPE_DIAL_1 | 1 | 键1的DTMF音。 |
...
...
@@ -4883,7 +4899,7 @@ tonePlayer.release().then(() => {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Device
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ------------- | ------ | ---------------------------------------------------- |
| SPEAKER | 2 | 扬声器。 |
| BLUETOOTH_SCO | 7 | 蓝牙设备SCO(Synchronous Connection Oriented)连接。 |
...
...
@@ -4897,7 +4913,7 @@ tonePlayer.release().then(() => {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Renderer
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| -------------- | ------ | ------------------ |
| TYPE_ACTIVATED | 0 | 表示触发焦点事件。 |
| TYPE_INTERRUPT | 1 | 表示音频打断事件。 |
...
...
zh-cn/application-dev/reference/errorcodes/errorcode-audio.md
浏览文件 @
405fc817
...
...
@@ -4,7 +4,7 @@
**错误信息**
i
nvalid parameter.
I
nvalid parameter.
**错误描述**
...
...
@@ -22,7 +22,7 @@ invalid parameter.
**错误信息**
allocate memory failed
.
Memory allocation failure
.
**错误描述**
...
...
@@ -42,7 +42,7 @@ allocate memory failed.
**错误信息**
Operation not permit at current
state.
Unsupported
state.
**错误描述**
...
...
@@ -61,7 +61,7 @@ Operation not permit at current state.
**错误信息**
unsupported operation
.
Unsupported parameter value
.
**错误描述**
...
...
@@ -80,7 +80,7 @@ unsupported operation.
**错误信息**
time
out.
Processing time
out.
**错误描述**
...
...
@@ -98,7 +98,7 @@ time out.
**错误信息**
stream number limited
.
Too many audio streams
.
**错误描述**
...
...
@@ -116,7 +116,7 @@ stream number limited.
**错误信息**
s
ystem error.
S
ystem error.
**错误描述**
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录