# 音频频谱 (/zh-CN/api-reference/rtc/android/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>

```java
public abstract int disableAudioSpectrumMonitor();
```

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

调用 [enableAudioSpectrumMonitor](/zh-CN/api-reference/rtc/android/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)了解详情和解决建议。

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

- [RtcEngine](/zh-CN/api-reference/rtc/android/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>

```java
public abstract int enableAudioSpectrumMonitor(int intervalInMS);
```

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

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

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

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

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

<a id="api_irtcengine_enableaudiospectrummonitor__related"></a>

### 相关回调 [#相关回调]

[onLocalAudioSpectrum](/zh-CN/api-reference/rtc/android/audio/audio-spectrum#callback_iaudiospectrumobserver_onlocalaudiospectrum) 和 [onRemoteAudioSpectrum](/zh-CN/api-reference/rtc/android/audio/audio-spectrum#callback_iaudiospectrumobserver_onremoteaudiospectrum) 回调。

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

### 参数 [#参数]

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

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

</Parameter>
</ParameterList>

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

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

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

  - -2：参数无效。

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

- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)

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

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

## registerAudioSpectrumObserver [#registeraudiospectrumobserver]

注册音频频谱观察器。

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

```java
public abstract int registerAudioSpectrumObserver(IAudioSpectrumObserver observer);
```

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

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

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

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

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

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

音频频谱观察器。详见 [IAudioSpectrumObserver](/zh-CN/api-reference/rtc/android/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]

- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)

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

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

## unRegisterAudioSpectrumObserver [#unregisteraudiospectrumobserver]

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

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

```java
public abstract int unRegisterAudioSpectrumObserver(IAudioSpectrumObserver observer);
```

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

调用 [registerAudioSpectrumObserver](/zh-CN/api-reference/rtc/android/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 后，如果你希望关闭音频频谱监测，可以调用此方法。

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

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

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

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

音频频谱观察器，详见 [IAudioSpectrumObserver](/zh-CN/api-reference/rtc/android/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]

- [RtcEngine](/zh-CN/api-reference/rtc/android/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>

```java
@CalledByNative boolean onLocalAudioSpectrum(AudioSpectrumInfo data);
```

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

在成功调用 [registerAudioSpectrumObserver](/zh-CN/api-reference/rtc/android/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 实现 [onLocalAudioSpectrum](/zh-CN/api-reference/rtc/android/audio/audio-spectrum#callback_iaudiospectrumobserver_onlocalaudiospectrum) 回调，并调用 [enableAudioSpectrumMonitor](/zh-CN/api-reference/rtc/android/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 启用音频频谱监测后，SDK 会按照你设置的时间间隔，在编码前触发该回调报告本地用户的音频频谱数据。

<a id="callback_iaudiospectrumobserver_onlocalaudiospectrum__timing"></a>

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

该回调在启用音频频谱监测并设置时间间隔后，由 SDK 按照设置的时间间隔在编码前触发。

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

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

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

本地用户的音频频谱数据。详见 [AudioSpectrumInfo](/zh-CN/api-reference/rtc/android/class-audiospectrumdata)。

</Parameter>
</ParameterList>

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

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

是否接收到频谱数据：

- true：已接收到频谱数据。
- false：未接收到频谱数据。

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

- [IAudioSpectrumObserver](/zh-CN/api-reference/rtc/android/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>

```java
boolean onRemoteAudioSpectrum(UserAudioSpectrumInfo[] userAudioSpectrumInfos, int spectrumNumber);
```

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

成功调用 [registerAudioSpectrumObserver](/zh-CN/api-reference/rtc/android/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 并调用 [enableAudioSpectrumMonitor](/zh-CN/api-reference/rtc/android/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 启用音频频谱监测后，SDK 会按照你设置的时间间隔触发该回调。

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

### 触发时机 [#触发时机-1]

该回调在成功调用 [registerAudioSpectrumObserver](/zh-CN/api-reference/rtc/android/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 并启用音频频谱监测后，根据设置的时间间隔被触发。

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

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

<ParameterList>
<a id="useraudiospectruminfos"></a>
<Parameter name="userAudioSpectrumInfos">

远端用户的音频频谱信息。数组长度为 SDK 监测到的远端用户数量。如果该数组为 `null`，表示未检测到远端用户的音频频谱。详见 [UserAudioSpectrumInfo](/zh-CN/api-reference/rtc/android/class-useraudiospectruminfo)。

</Parameter>
<a id="spectrumnumber"></a>
<Parameter name="spectrumNumber">

远端用户的数量。

</Parameter>
</ParameterList>

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

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

- true：接收到频谱数据。
- false：未接收到频谱数据。

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

- [IAudioSpectrumObserver](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_iaudiospectrumobserver)