# 音频频谱 (/zh-CN/api-reference/rtc/macos/audio/audio-spectrum)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## disableAudioSpectrumMonitor [#disableaudiospectrummonitor]
禁用音频频谱监测。
```objc
- (int)disableAudioSpectrumMonitor NS_SWIFT_NAME(disableAudioSpectrumMonitor());
```
如果你已调用 [enableAudioSpectrumMonitor:](/zh-CN/api-reference/rtc/macos/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 方法启用音频频谱监测,可以调用此方法禁用该功能。
:::note
注: 你可以在加入频道前或后调用此方法。
:::
### 返回值 [#返回值]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类]
- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine)
## enableAudioSpectrumMonitor: [#enableaudiospectrummonitor]
开启音频频谱监测。
```objc
- (int)enableAudioSpectrumMonitor:(int)intervalInMS NS_SWIFT_NAME(enableAudioSpectrumMonitor(_:));
```
如果你希望获取本地或远端用户的音频频谱数据,可以注册音频频谱观察器并调用该方法。
:::note
注: 你可以在加入频道前或加入频道后调用该方法。
:::
### 适用场景 [#适用场景]
你可以在加入频道前或加入频道后调用此方法。
### 参数 [#参数]
SDK 触发 [onLocalAudioSpectrum:](/zh-CN/api-reference/rtc/macos/audio/audio-spectrum#callback_iaudiospectrumobserver_onlocalaudiospectrum) 和 [onRemoteAudioSpectrum:](/zh-CN/api-reference/rtc/macos/audio/audio-spectrum#callback_iaudiospectrumobserver_onremoteaudiospectrum) 回调的时间间隔(单位为毫秒,默认值为 100)。该参数不能小于 10,否则调用该方法会失败。
### 返回值 [#返回值-1]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -2:参数无效。
### 所属接口类 [#所属接口类-1]
- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine)
## registerAudioSpectrumDelegate: [#registeraudiospectrumdelegate]
注册音频频谱观察者。
```objc
- (int)registerAudioSpectrumDelegate:(id _Nullable )delegate NS_SWIFT_NAME(registerAudioSpectrumDelegate(_:));
```
成功注册音频频谱观察者并调用 [enableAudioSpectrumMonitor:](/zh-CN/api-reference/rtc/macos/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 启用音频频谱监测后,SDK 会根据你设置的时间间隔,触发你在 [AgoraAudioSpectrumDelegate](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_iaudiospectrumobserver) 中实现的回调。
:::note
注: 你可以在加入频道前或加入频道后调用此方法。
:::
### 参数 [#参数-1]
音频频谱观察者。详见 [AgoraAudioSpectrumDelegate](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_iaudiospectrumobserver)。
### 返回值 [#返回值-2]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-2]
- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine)
## unregisterAudioSpectrumDelegate: [#unregisteraudiospectrumdelegate]
取消注册音频频谱观察者。
```objc
- (int)unregisterAudioSpectrumDelegate:(id _Nullable)delegate NS_SWIFT_NAME(unregisterAudioSpectrumDelegate(_:));
```
如果你已调用 [registerAudioSpectrumDelegate:](/zh-CN/api-reference/rtc/macos/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 方法注册了音频频谱观察者,想要关闭音频频谱监测时,可以调用该方法。
:::note
注: 你可以在加入频道前或加入频道后调用此方法。
:::
### 参数 [#参数-2]
音频频谱观察者。详见 [AgoraAudioSpectrumDelegate](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_iaudiospectrumobserver)。
### 返回值 [#返回值-3]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-3]
- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine)
## onLocalAudioSpectrum: [#onlocalaudiospectrum]
获取本地音频频谱数据。
```objc
- (BOOL)onLocalAudioSpectrum:(NSArray * _Nullable)audioSpectrumData NS_SWIFT_NAME(onLocalAudioSpectrum(_:));
```
成功调用 [registerAudioSpectrumDelegate:](/zh-CN/api-reference/rtc/macos/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 实现 [AgoraAudioSpectrumDelegate](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_iaudiospectrumobserver) 中的 [onLocalAudioSpectrum:](/zh-CN/api-reference/rtc/macos/audio/audio-spectrum#callback_iaudiospectrumobserver_onlocalaudiospectrum) 回调,并调用 [enableAudioSpectrumMonitor:](/zh-CN/api-reference/rtc/macos/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 启用音频频谱监测后,SDK 会按照你设置的时间间隔触发该回调,在编码前报告接收到的远端音频数据频谱。
### 参数 [#参数-3]
本地用户的音频频谱数据。声网将音频频率划分为 256 个频率域,并通过该参数报告每个频率域的能量值。每个能量值的取值范围为 [-300, 1],单位为 dBFS。
### 返回值 [#返回值-4]
- YES:接收到音频频谱数据。
- NO:未接收到音频频谱数据。
### 所属接口类 [#所属接口类-4]
- [AgoraAudioSpectrumDelegate](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_iaudiospectrumobserver)
## onRemoteAudioSpectrum: [#onremoteaudiospectrum]
获取远端音频频谱信息回调。
```objc
- (BOOL)onRemoteAudioSpectrum:(NSArray * _Nullable)AudioSpectrumInfo NS_SWIFT_NAME(onRemoteAudioSpectrum(_:));
```
你调用 [registerAudioSpectrumDelegate:](/zh-CN/api-reference/rtc/macos/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 注册 [AgoraAudioSpectrumDelegate](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_iaudiospectrumobserver) 协议并实现 [onRemoteAudioSpectrum:](/zh-CN/api-reference/rtc/macos/audio/audio-spectrum#callback_iaudiospectrumobserver_onremoteaudiospectrum) 回调,同时调用 [enableAudioSpectrumMonitor:](/zh-CN/api-reference/rtc/macos/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 启用音频频谱监测后,该回调会按照设置的时间间隔触发,用于报告接收到的远端音频频谱数据。
### 触发时机 [#触发时机]
该回调在接收到远端音频频谱数据时被触发。
### 参数 [#参数-4]
远端用户的音频频谱信息。数组的数量为 SDK 监测到的远端用户数量。若该数组为 nil,表示未检测到远端用户的音频频谱。详见 [AgoraAudioSpectrumInfo](/zh-CN/api-reference/rtc/macos/class-useraudiospectruminfo)。
### 返回值 [#返回值-5]
- YES:已接收到频谱数据。
- NO:未接收到频谱数据。
### 所属接口类 [#所属接口类-5]
- [AgoraAudioSpectrumDelegate](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_iaudiospectrumobserver)