• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Interface (AudioSpatializationManager)
2<!--Kit: Audio Kit-->
3<!--Subsystem: Multimedia-->
4<!--Owner: @songshenke-->
5<!--Designer: @caixuejiang; @hao-liangfei; @zhanganxiang-->
6<!--Tester: @Filger-->
7<!--Adviser: @zengyawen-->
8
9> **说明:**
10>
11> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
12> - 本Interface首批接口从API version 18开始支持。
13
14空间音频管理。
15
16在使用AudioSpatializationManager的接口之前,需先通过[getSpatializationManager](arkts-apis-audio-AudioManager.md#getspatializationmanager18)获取AudioSpatializationManager实例。
17
18## 导入模块
19
20```ts
21import { audio } from '@kit.AudioKit';
22```
23
24## isSpatializationEnabledForCurrentDevice<sup>18+</sup>
25
26isSpatializationEnabledForCurrentDevice(): boolean
27
28获取当前设备空间音频渲染是否开启。同步返回结果。
29
30**系统能力:** SystemCapability.Multimedia.Audio.Spatialization
31
32**返回值:**
33
34| 类型                   | 说明                                                         |
35| ---------------------- | ------------------------------------------------------------ |
36| boolean | 当前设备空间音频渲染是否开启。true表示开启,false表示未开启。 |
37
38**示例:**
39
40```ts
41import { audio } from '@kit.AudioKit';
42
43let isSpatializationEnabledForCurrentDevice: boolean = audioSpatializationManager.isSpatializationEnabledForCurrentDevice();
44console.info(`AudioSpatializationManager isSpatializationEnabledForCurrentDevice: ${isSpatializationEnabledForCurrentDevice}`);
45```
46
47## on('spatializationEnabledChangeForCurrentDevice')<sup>18+</sup>
48
49on(type: 'spatializationEnabledChangeForCurrentDevice', callback: Callback<boolean\>): void
50
51监听当前设备空间音频渲染开关状态变化事件。使用callback异步回调。
52
53**系统能力:** SystemCapability.Multimedia.Audio.Spatialization
54
55**参数:**
56
57| 参数名   | 类型                                                 | 必填 | 说明                                           |
58| :------- | :--------------------------------------------------- | :--- |:---------------------------------------------|
59| type     | string | 是   | 事件回调类型,支持的事件为'spatializationEnabledChangeForCurrentDevice',当空间音频渲染开关状态变化时,触发该事件。 |
60| callback | Callback<boolean\> | 是   | 回调函数。返回true表示打开空间音频渲染状态;返回false表示关闭空间音频渲染状态。   |
61
62**错误码:**
63
64以下错误码的详细介绍请参见[Audio错误码](errorcode-audio.md)。
65
66| 错误码ID | 错误信息 |
67| ------- | --------------------------------------------|
68| 6800101 | Parameter verification failed. |
69
70**示例:**
71
72```ts
73import { audio } from '@kit.AudioKit';
74
75audioSpatializationManager.on('spatializationEnabledChangeForCurrentDevice', (isSpatializationEnabledForCurrentDevice: boolean) => {
76  console.info(`isSpatializationEnabledForCurrentDevice: ${isSpatializationEnabledForCurrentDevice}`);
77});
78```
79
80## off('spatializationEnabledChangeForCurrentDevice')<sup>18+</sup>
81
82off(type: 'spatializationEnabledChangeForCurrentDevice', callback?: Callback<boolean\>): void
83
84取消监听当前设备空间音频渲染开关状态变化事件。使用callback异步回调。
85
86**系统能力:** SystemCapability.Multimedia.Audio.Spatialization
87
88**参数:**
89
90| 参数名   | 类型                                                | 必填 | 说明                                       |
91| -------- | --------------------------------------------------- | ---- | ------------------------------------------ |
92| type     | string | 是   | 事件回调类型,支持的事件为'spatializationEnabledChangeForCurrentDevice',当取消订阅当前设备空间音频渲染开关状态变化事件时,触发该事件。 |
93| callback | Callback<boolean\> | 否   | 回调函数。返回true表示打开空间音频渲染状态;返回false表示关闭空间音频渲染状态。   |
94
95**错误码:**
96
97以下错误码的详细介绍请参见[Audio错误码](errorcode-audio.md)。
98
99| 错误码ID | 错误信息 |
100| ------- | --------------------------------------------|
101| 6800101 | Parameter verification failed. |
102
103**示例:**
104
105```ts
106import { audio } from '@kit.AudioKit';
107audioSpatializationManager.off('spatializationEnabledChangeForCurrentDevice');
108```
109