# 音频频谱 (/zh-CN/api-reference/rtc/ios/audio/audio-spectrum)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<a id="toc_audio_spectrum"></a>

<a id="api_irtcengine_disableaudiospectrummonitor"></a>

<a id="ariaid-title2"></a>

## disableAudioSpectrumMonitor [#disableaudiospectrummonitor]

禁用音频频谱监测。

<a id="api_irtcengine_disableaudiospectrummonitor__prototype"></a>

```objc
- (int)disableAudioSpectrumMonitor NS_SWIFT_NAME(disableAudioSpectrumMonitor());
```

<a id="api_irtcengine_disableaudiospectrummonitor__detailed_desc"></a>

如果你已调用 [enableAudioSpectrumMonitor:](/zh-CN/api-reference/rtc/ios/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 方法启用音频频谱监测，可以调用此方法禁用该功能。

:::note
注： 你可以在加入频道前或后调用此方法。
:::

<a id="api_irtcengine_disableaudiospectrummonitor__return_values"></a>

### 返回值 [#返回值]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类]

- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_irtcengine)

<a id="api_irtcengine_enableaudiospectrummonitor"></a>

<a id="ariaid-title3"></a>

## enableAudioSpectrumMonitor: [#enableaudiospectrummonitor]

开启音频频谱监测。

<a id="api_irtcengine_enableaudiospectrummonitor__prototype"></a>

```objc
- (int)enableAudioSpectrumMonitor:(int)intervalInMS NS_SWIFT_NAME(enableAudioSpectrumMonitor(_:));
```

<a id="api_irtcengine_enableaudiospectrummonitor__detailed_desc"></a>

如果你希望获取本地或远端用户的音频频谱数据，可以注册音频频谱观察器并调用该方法。

:::note
注： 你可以在加入频道前或加入频道后调用该方法。
:::

<a id="api_irtcengine_enableaudiospectrummonitor__scenario"></a>

### 适用场景 [#适用场景]

你可以在加入频道前或加入频道后调用此方法。

<a id="api_irtcengine_enableaudiospectrummonitor__parameters"></a>

### 参数 [#参数]

<ParameterList>
<a id="intervalinms"></a>
<Parameter name="intervalInMS">

SDK 触发 [onLocalAudioSpectrum:](/zh-CN/api-reference/rtc/ios/audio/audio-spectrum#callback_iaudiospectrumobserver_onlocalaudiospectrum) 和 [onRemoteAudioSpectrum:](/zh-CN/api-reference/rtc/ios/audio/audio-spectrum#callback_iaudiospectrumobserver_onremoteaudiospectrum) 回调的时间间隔（单位为毫秒，默认值为 100）。该参数不能小于 10，否则调用该方法会失败。

</Parameter>
</ParameterList>

<a id="api_irtcengine_enableaudiospectrummonitor__return_values"></a>

### 返回值 [#返回值-1]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

  - -2：参数无效。

### 所属接口类 [#所属接口类-1]

- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_irtcengine)

<a id="api_irtcengine_registeraudiospectrumobserver"></a>

<a id="ariaid-title4"></a>

## registerAudioSpectrumDelegate: [#registeraudiospectrumdelegate]

注册音频频谱观察者。

<a id="api_irtcengine_registeraudiospectrumobserver__prototype"></a>

```objc
- (int)registerAudioSpectrumDelegate:(id<AgoraAudioSpectrumDelegate> _Nullable )delegate NS_SWIFT_NAME(registerAudioSpectrumDelegate(_:));
```

<a id="api_irtcengine_registeraudiospectrumobserver__detailed_desc"></a>

成功注册音频频谱观察者并调用 [enableAudioSpectrumMonitor:](/zh-CN/api-reference/rtc/ios/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 启用音频频谱监测后，SDK 会根据你设置的时间间隔，触发你在 [AgoraAudioSpectrumDelegate](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_iaudiospectrumobserver) 中实现的回调。

:::note
注： 你可以在加入频道前或加入频道后调用此方法。
:::

<a id="api_irtcengine_registeraudiospectrumobserver__parameters"></a>

### 参数 [#参数-1]

<ParameterList>
<a id="delegate"></a>
<Parameter name="delegate">

音频频谱观察者。详见 [AgoraAudioSpectrumDelegate](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_iaudiospectrumobserver)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_registeraudiospectrumobserver__return_values"></a>

### 返回值 [#返回值-2]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-2]

- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_irtcengine)

<a id="api_irtcengine_unregisteraudiospectrumobserver"></a>

<a id="ariaid-title5"></a>

## unregisterAudioSpectrumDelegate: [#unregisteraudiospectrumdelegate]

取消注册音频频谱观察者。

<a id="api_irtcengine_unregisteraudiospectrumobserver__prototype"></a>

```objc
- (int)unregisterAudioSpectrumDelegate:(id<AgoraAudioSpectrumDelegate> _Nullable)delegate NS_SWIFT_NAME(unregisterAudioSpectrumDelegate(_:));
```

<a id="api_irtcengine_unregisteraudiospectrumobserver__detailed_desc"></a>

如果你已调用 [registerAudioSpectrumDelegate:](/zh-CN/api-reference/rtc/ios/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 方法注册了音频频谱观察者，想要关闭音频频谱监测时，可以调用该方法。

:::note
注： 你可以在加入频道前或加入频道后调用此方法。
:::

<a id="api_irtcengine_unregisteraudiospectrumobserver__parameters"></a>

### 参数 [#参数-2]

<ParameterList>
<a id="delegate-1"></a>
<Parameter name="delegate">

音频频谱观察者。详见 [AgoraAudioSpectrumDelegate](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_iaudiospectrumobserver)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_unregisteraudiospectrumobserver__return_values"></a>

### 返回值 [#返回值-3]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-3]

- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_irtcengine)

<a id="callback_iaudiospectrumobserver_onlocalaudiospectrum"></a>

<a id="ariaid-title6"></a>

## onLocalAudioSpectrum: [#onlocalaudiospectrum]

获取本地音频频谱数据。

<a id="callback_iaudiospectrumobserver_onlocalaudiospectrum__prototype"></a>

```objc
- (BOOL)onLocalAudioSpectrum:(NSArray<NSNumber *> * _Nullable)audioSpectrumData NS_SWIFT_NAME(onLocalAudioSpectrum(_:));
```

<a id="callback_iaudiospectrumobserver_onlocalaudiospectrum__detailed_desc"></a>

成功调用 [registerAudioSpectrumDelegate:](/zh-CN/api-reference/rtc/ios/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 实现 [AgoraAudioSpectrumDelegate](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_iaudiospectrumobserver) 中的 [onLocalAudioSpectrum:](/zh-CN/api-reference/rtc/ios/audio/audio-spectrum#callback_iaudiospectrumobserver_onlocalaudiospectrum) 回调，并调用 [enableAudioSpectrumMonitor:](/zh-CN/api-reference/rtc/ios/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 启用音频频谱监测后，SDK 会按照你设置的时间间隔触发该回调，在编码前报告接收到的远端音频数据频谱。

<a id="callback_iaudiospectrumobserver_onlocalaudiospectrum__parameters"></a>

### 参数 [#参数-3]

<ParameterList>
<a id="audiospectrumdata"></a>
<Parameter name="audioSpectrumData">

本地用户的音频频谱数据。声网将音频频率划分为 256 个频率域，并通过该参数报告每个频率域的能量值。每个能量值的取值范围为 [-300, 1]，单位为 dBFS。

</Parameter>
</ParameterList>

<a id="callback_iaudiospectrumobserver_onlocalaudiospectrum__return_values"></a>

### 返回值 [#返回值-4]

- YES：接收到音频频谱数据。
- NO：未接收到音频频谱数据。

### 所属接口类 [#所属接口类-4]

- [AgoraAudioSpectrumDelegate](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_iaudiospectrumobserver)

<a id="callback_iaudiospectrumobserver_onremoteaudiospectrum"></a>

<a id="ariaid-title7"></a>

## onRemoteAudioSpectrum: [#onremoteaudiospectrum]

获取远端音频频谱信息回调。

<a id="callback_iaudiospectrumobserver_onremoteaudiospectrum__prototype"></a>

```objc
- (BOOL)onRemoteAudioSpectrum:(NSArray<AgoraAudioSpectrumInfo *> * _Nullable)AudioSpectrumInfo NS_SWIFT_NAME(onRemoteAudioSpectrum(_:));
```

<a id="callback_iaudiospectrumobserver_onremoteaudiospectrum__detailed_desc"></a>

你调用 [registerAudioSpectrumDelegate:](/zh-CN/api-reference/rtc/ios/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 注册 [AgoraAudioSpectrumDelegate](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_iaudiospectrumobserver) 协议并实现 [onRemoteAudioSpectrum:](/zh-CN/api-reference/rtc/ios/audio/audio-spectrum#callback_iaudiospectrumobserver_onremoteaudiospectrum) 回调，同时调用 [enableAudioSpectrumMonitor:](/zh-CN/api-reference/rtc/ios/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 启用音频频谱监测后，该回调会按照设置的时间间隔触发，用于报告接收到的远端音频频谱数据。

<a id="callback_iaudiospectrumobserver_onremoteaudiospectrum__timing"></a>

### 触发时机 [#触发时机]

该回调在接收到远端音频频谱数据时被触发。

<a id="callback_iaudiospectrumobserver_onremoteaudiospectrum__parameters"></a>

### 参数 [#参数-4]

<ParameterList>
<a id="audiospectruminfo"></a>
<Parameter name="AudioSpectrumInfo">

远端用户的音频频谱信息。数组的数量为 SDK 监测到的远端用户数量。若该数组为 nil，表示未检测到远端用户的音频频谱。详见 [AgoraAudioSpectrumInfo](/zh-CN/api-reference/rtc/ios/class-useraudiospectruminfo)。

</Parameter>
</ParameterList>

<a id="callback_iaudiospectrumobserver_onremoteaudiospectrum__return_values"></a>

### 返回值 [#返回值-5]

- YES：已接收到频谱数据。
- NO：未接收到频谱数据。

### 所属接口类 [#所属接口类-5]

- [AgoraAudioSpectrumDelegate](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_iaudiospectrumobserver)