# 音频频谱 (/zh-CN/api-reference/rtc/cpp-all-platforms/audio/audio-spectrum)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## disableAudioSpectrumMonitor [#disableaudiospectrummonitor]
禁用音频频谱监测。
```cpp
virtual int disableAudioSpectrumMonitor() = 0;
```
调用 [enableAudioSpectrumMonitor](/zh-CN/api-reference/rtc/cpp-all-platforms/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 后,如需关闭音频频谱监测,可调用该方法。
:::note
注: 你可以在加入频道前或加入频道后调用此方法。
:::
### 返回值 [#返回值]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类]
- [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine)
## enableAudioSpectrumMonitor [#enableaudiospectrummonitor]
开启音频频谱监测。
```cpp
virtual int enableAudioSpectrumMonitor(int intervalInMS = 100) = 0;
```
:::note
注: [enableAudioSpectrumMonitor](/zh-CN/api-reference/rtc/cpp-all-platforms/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 方法可以在加入频道前或加入频道后调用。
:::
### 适用场景 [#适用场景]
你可以在加入频道前或加入频道后调用此方法。
### 参数 [#参数]
SDK 触发 [onLocalAudioSpectrum](/zh-CN/api-reference/rtc/cpp-all-platforms/audio/audio-spectrum#callback_iaudiospectrumobserver_onlocalaudiospectrum) 和 [onRemoteAudioSpectrum](/zh-CN/api-reference/rtc/cpp-all-platforms/audio/audio-spectrum#callback_iaudiospectrumobserver_onremoteaudiospectrum) 回调的时间间隔,单位为毫秒(默认值为 100,默认)。该参数值不能小于 10,否则调用该方法会失败。
### 返回值 [#返回值-1]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -2:参数无效。
### 所属接口类 [#所属接口类-1]
- [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine)
## registerAudioSpectrumObserver [#registeraudiospectrumobserver]
注册音频频谱观察器。
```cpp
virtual int registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver * observer) = 0;
```
成功注册音频频谱观察器并调用 [enableAudioSpectrumMonitor](/zh-CN/api-reference/rtc/cpp-all-platforms/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 启用音频频谱监测后,SDK 会根据你设置的时间间隔,触发你在 [IAudioSpectrumObserver](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_iaudiospectrumobserver) 中实现的回调。
:::note
注: 你可以在加入频道前或加入频道后调用此方法。
:::
### 参数 [#参数-1]
音频频谱观察器。详见 [IAudioSpectrumObserver](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_iaudiospectrumobserver)。
### 返回值 [#返回值-2]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-2]
- [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine)
## unregisterAudioSpectrumObserver [#unregisteraudiospectrumobserver]
取消注册音频频谱观察器。
```cpp
virtual int unregisterAudioSpectrumObserver(agora::media::IAudioSpectrumObserver * observer) = 0;
```
调用 [registerAudioSpectrumObserver](/zh-CN/api-reference/rtc/cpp-all-platforms/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 后,如果你想关闭音频频谱监测,可以调用此方法。
:::note
注: 你可以在加入频道前或加入频道后调用此方法。
:::
### 参数 [#参数-2]
音频频谱观察器。详见 [IAudioSpectrumObserver](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_iaudiospectrumobserver)。
### 返回值 [#返回值-3]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-3]
- [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine)
## onLocalAudioSpectrum [#onlocalaudiospectrum]
本地音频频谱数据回调。
```cpp
virtual bool onLocalAudioSpectrum(const AudioSpectrumData& data) = 0;
```
调用 [registerAudioSpectrumObserver](/zh-CN/api-reference/rtc/cpp-all-platforms/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 注册 [IAudioSpectrumObserver](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_iaudiospectrumobserver) 接口并实现 [onLocalAudioSpectrum](/zh-CN/api-reference/rtc/cpp-all-platforms/audio/audio-spectrum#callback_iaudiospectrumobserver_onlocalaudiospectrum) 回调,同时调用 [enableAudioSpectrumMonitor](/zh-CN/api-reference/rtc/cpp-all-platforms/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 启用音频频谱监测后,SDK 会按照设置的时间间隔,在编码前触发该回调,报告本地音频频谱数据。
### 参数 [#参数-3]
本地用户的音频频谱数据。详见 [AudioSpectrumData](/zh-CN/api-reference/rtc/cpp-all-platforms/class-audiospectrumdata)。
### 返回值 [#返回值-4]
- true:接收到频谱数据。
- false:未接收到频谱数据。
### 所属接口类 [#所属接口类-4]
- [IAudioSpectrumObserver](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_iaudiospectrumobserver)
## onRemoteAudioSpectrum [#onremoteaudiospectrum]
远端音频频谱回调。
```cpp
virtual bool onRemoteAudioSpectrum(const UserAudioSpectrumInfo* spectrums, unsigned int spectrumNumber) = 0;
```
成功调用 [registerAudioSpectrumObserver](/zh-CN/api-reference/rtc/cpp-all-platforms/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 实现 [onRemoteAudioSpectrum](/zh-CN/api-reference/rtc/cpp-all-platforms/audio/audio-spectrum#callback_iaudiospectrumobserver_onremoteaudiospectrum) 回调,并调用 [enableAudioSpectrumMonitor](/zh-CN/api-reference/rtc/cpp-all-platforms/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 启用音频频谱监测后,SDK 会按照你设置的时间间隔触发该回调,报告接收到的远端音频数据频谱。
### 触发时机 [#触发时机]
SDK 会按照你设置的时间间隔触发该回调,报告接收到的远端音频数据频谱。
### 参数 [#参数-4]
远端用户的音频频谱信息。数组长度为 SDK 监测到的远端用户数量。如果该数组为 NULL,表示未检测到远端用户的音频频谱。详见 [UserAudioSpectrumInfo](/zh-CN/api-reference/rtc/cpp-all-platforms/class-useraudiospectruminfo)。
远端用户的数量。
### 返回值 [#返回值-5]
- true:接收到频谱数据。
- false:未接收到频谱数据。
### 所属接口类 [#所属接口类-5]
- [IAudioSpectrumObserver](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_iaudiospectrumobserver)