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