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

```csharp
public abstract int DisableAudioSpectrumMonitor();
```

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

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

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

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

```csharp
public abstract int EnableAudioSpectrumMonitor(int intervalInMS = 100);
```

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

如果你想获取本地或远端用户的音频频谱数据，请注册音频频谱观测器并开启音频频谱监测。

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

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

### 参数 [#参数]

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

SDK 触发 [OnLocalAudioSpectrum](/zh-CN/api-reference/rtc/unity/audio/audio-spectrum#callback_iaudiospectrumobserver_onlocalaudiospectrum) 和 [OnRemoteAudioSpectrum](/zh-CN/api-reference/rtc/unity/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]

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

```csharp
public abstract int RegisterAudioSpectrumObserver(IAudioSpectrumObserver observer);
```

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

成功注册音频频谱观测器并调用 [EnableAudioSpectrumMonitor](/zh-CN/api-reference/rtc/unity/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 开启音频频谱监测后，SDK 会按照你设置的时间间隔报告你在 [IAudioSpectrumObserver](/zh-CN/api-reference/rtc/unity/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/unity/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]

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

```csharp
public abstract int UnregisterAudioSpectrumObserver();
```

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

调用 [RegisterAudioSpectrumObserver](/zh-CN/api-reference/rtc/unity/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 后，如果你想取消注册音频频谱观测器，请调用该方法。

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

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

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

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

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

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

```csharp
public virtual bool OnLocalAudioSpectrum(AudioSpectrumData data)
        {
            return true;
        }
```

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

成功调用 [RegisterAudioSpectrumObserver](/zh-CN/api-reference/rtc/unity/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 实现 [IAudioSpectrumObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_iaudiospectrumobserver) 中的 [OnLocalAudioSpectrum](/zh-CN/api-reference/rtc/unity/audio/audio-spectrum#callback_iaudiospectrumobserver_onlocalaudiospectrum) 回调并调用 [EnableAudioSpectrumMonitor](/zh-CN/api-reference/rtc/unity/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 开启音频频谱监测后，SDK 会按照你设置的时间间隔触发该回调，报告编码前的本地音频数据的频谱。

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

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

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

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

</Parameter>
</ParameterList>

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

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

是否接收频谱数据：

- true: 接收。
- false: 不接收。

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

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

```csharp
public virtual bool OnRemoteAudioSpectrum(UserAudioSpectrumInfo[] spectrums, uint spectrumNumber)
        {
            return true;
        }
```

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

成功调用 [RegisterAudioSpectrumObserver](/zh-CN/api-reference/rtc/unity/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) 实现 [IAudioSpectrumObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_iaudiospectrumobserver) 中的 [OnRemoteAudioSpectrum](/zh-CN/api-reference/rtc/unity/audio/audio-spectrum#callback_iaudiospectrumobserver_onremoteaudiospectrum) 回调并调用 [EnableAudioSpectrumMonitor](/zh-CN/api-reference/rtc/unity/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) 开启音频频谱监测后，SDK 会按照你设置的时间间隔触发该回调，报告接收到的远端音频数据的频谱。

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

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

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

远端用户的音频频谱信息，详见 [UserAudioSpectrumInfo](/zh-CN/api-reference/rtc/unity/class-useraudiospectruminfo)。 数组数量等于 SDK 监测到的远端用户数量，数组为空表示没有监测到远端用户的音频频谱。

</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/unity/rtc-interface-class#class_iaudiospectrumobserver)