# 音视频观测器 (/zh-CN/api-reference/rtc/unity/play/mediaplayer/mediaplayer-observer)

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

<a id="toc_mediaplayer_observer"></a>

<a id="api_imediaplayer_registeraudioframeobserver1_imediaplayer"></a>

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

## RegisterAudioFrameObserver [1/2] [#registeraudioframeobserver-12]

注册 PCM 音频帧观测器。

<a id="api_imediaplayer_registeraudioframeobserver1_imediaplayer__prototype"></a>

```csharp
public abstract int RegisterAudioFrameObserver(IAudioPcmFrameSink observer);
```

<a id="api_imediaplayer_registeraudioframeobserver1_imediaplayer__detailed_desc"></a>

你需要在该方法中实现一个 [IAudioPcmFrameSink](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_iaudiopcmframesink) 类，并根据场景需要，注册该类的回调。成功注册音频帧观测器后，SDK 会在捕捉到每个音频帧时，触发你所注册的回调。

<a id="api_imediaplayer_registeraudioframeobserver1_imediaplayer__parameters"></a>

### 参数 [#参数]

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

音频帧观测器，观测每帧音频的接收，详见 [IAudioPcmFrameSink](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_iaudiopcmframesink)。

</Parameter>
</ParameterList>

<a id="api_imediaplayer_registeraudioframeobserver1_imediaplayer__return_values"></a>

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

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

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

- [IMediaPlayer](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imediaplayer)

<a id="api_imediaplayer_registeraudioframeobserver2_imediaplayer"></a>

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

## RegisterAudioFrameObserver [2/2] [#registeraudioframeobserver-22]

注册音频帧观测器。

<a id="api_imediaplayer_registeraudioframeobserver2_imediaplayer__prototype"></a>

```csharp
public abstract int RegisterAudioFrameObserver(IAudioPcmFrameSink observer, RAW_AUDIO_FRAME_OP_MODE_TYPE mode);
```

<a id="api_imediaplayer_registeraudioframeobserver2_imediaplayer__detailed_desc"></a>

<a id="api_imediaplayer_registeraudioframeobserver2_imediaplayer__parameters"></a>

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

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

音频帧观测器，观测每帧音频的接收，详见 [IAudioPcmFrameSink](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_iaudiopcmframesink)。

</Parameter>
<a id="mode"></a>
<Parameter name="mode">

音频帧的使用模式，详见 [RAW_AUDIO_FRAME_OP_MODE_TYPE](/zh-CN/api-reference/rtc/unity/enum-rawaudioframeopmodetype)。

</Parameter>
</ParameterList>

<a id="api_imediaplayer_registeraudioframeobserver2_imediaplayer__return_values"></a>

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

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

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

- [IMediaPlayer](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imediaplayer)

<a id="api_imediaplayer_unregisteraudioframeobserver_imediaplayer"></a>

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

## UnregisterAudioFrameObserver [#unregisteraudioframeobserver]

取消注册音频帧观测器。

<a id="api_imediaplayer_unregisteraudioframeobserver_imediaplayer__prototype"></a>

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

<a id="api_imediaplayer_unregisteraudioframeobserver_imediaplayer__detailed_desc"></a>

<a id="api_imediaplayer_unregisteraudioframeobserver_imediaplayer__return_values"></a>

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

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

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

- [IMediaPlayer](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imediaplayer)

<a id="callback_imediaplayersourceobserver_onaudiovolumeindication_imediaplayersourceobserver"></a>

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

## onAudioVolumeIndication [#onaudiovolumeindication]

媒体播放器音量提示回调。

<a id="callback_imediaplayersourceobserver_onaudiovolumeindication_imediaplayersourceobserver__prototype"></a>

```csharp
public virtual void OnAudioVolumeIndication(int volume) {}
```

<a id="callback_imediaplayersourceobserver_onaudiovolumeindication_imediaplayersourceobserver__detailed_desc"></a>

SDK 每 200 毫秒触发一次该回调，报告媒体播放器当前的音量。

<a id="callback_imediaplayersourceobserver_onaudiovolumeindication_imediaplayersourceobserver__parameters"></a>

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

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

播放器的当前音量，取值范围为 [0,255]。

</Parameter>
</ParameterList>

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

- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imediaplayersourceobserver)

<a id="callback_iaudiopcmframesink_onframe_iaudiopcmframesink"></a>

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

## OnFrame [#onframe]

已获取音频帧回调。

<a id="callback_iaudiopcmframesink_onframe_iaudiopcmframesink__prototype"></a>

```csharp
public virtual bool OnFrame(AudioPcmFrame frame)
        {
            return true;
        }
```

<a id="callback_iaudiopcmframesink_onframe_iaudiopcmframesink__detailed_desc"></a>

注册音频数据观测器后，每次接收到一帧音频帧时，都会触发该回调，报告音频帧信息。

<a id="callback_iaudiopcmframesink_onframe_iaudiopcmframesink__parameters"></a>

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

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

音频帧信息。详见 [AudioPcmFrame](/zh-CN/api-reference/rtc/unity/class-audiopcmframe)。

</Parameter>
</ParameterList>

<a id="callback_iaudiopcmframesink_onframe_iaudiopcmframesink__return_values"></a>

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

无实际含义。

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

- [IAudioPcmFrameSink](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_iaudiopcmframesink)

<a id="callback_imediaplayersourceobserver_onmetadata"></a>

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

## OnMetaData [#onmetadata]

报告已获取媒体附属信息。

<a id="callback_imediaplayersourceobserver_onmetadata__prototype"></a>

```csharp
public virtual void OnMetaData(byte[] data, int length) { }
```

<a id="callback_imediaplayersourceobserver_onmetadata__detailed_desc"></a>

解析媒体附属信息后时，SDK 会触发该回调，报告媒体附属信息的数据类型和具体数据。

<a id="callback_imediaplayersourceobserver_onmetadata__parameters"></a>

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

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

具体数据，用户自定义格式的数据。

</Parameter>
<a id="length"></a>
<Parameter name="length">

数据长度，单位为 byte。

</Parameter>
</ParameterList>

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

- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imediaplayersourceobserver)

<a id="callback_imediaplayersourceobserver_onplaybufferupdated"></a>

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

## OnPlayBufferUpdated [#onplaybufferupdated]

报告当前缓冲数据能播放的时间。

<a id="callback_imediaplayersourceobserver_onplaybufferupdated__prototype"></a>

```csharp
public virtual void OnPlayBufferUpdated(Int64 playCachedBuffer) { }
```

<a id="callback_imediaplayersourceobserver_onplaybufferupdated__detailed_desc"></a>

播放在线媒体资源的过程中，SDK 会每隔 1 秒触发一次该回调，报告当前缓冲的数据能支持的播放时间。

- 当缓冲数据支持的播放时间小于阈值（默认为 0）时，返回 `PLAYER_EVENT_BUFFER_LOW` (6)。
- 当缓冲数据支持的播放时间大于阈值（默认为 0）时，返回 `PLAYER_EVENT_BUFFER_RECOVER` (7)。

<a id="callback_imediaplayersourceobserver_onplaybufferupdated__parameters"></a>

### 参数 [#参数-5]

<ParameterList>
<a id="playcachedbuffer"></a>
<Parameter name="playCachedBuffer">

当前缓冲的数据能支持的播放时间 (毫秒)。

</Parameter>
</ParameterList>

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

- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imediaplayersourceobserver)

<a id="callback_imediaplayersourceobserver_onplayerevent"></a>

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

## OnPlayerEvent [#onplayerevent]

报告播放器的事件。

<a id="callback_imediaplayersourceobserver_onplayerevent__prototype"></a>

```csharp
public virtual void OnPlayerEvent(MEDIA_PLAYER_EVENT eventCode, Int64 elapsedTime, string message) { }
```

<a id="callback_imediaplayersourceobserver_onplayerevent__detailed_desc"></a>

- 调用 [Seek](/zh-CN/api-reference/rtc/unity/play/mediaplayer/mediaplayer-control#api_imediaplayer_seek) 定位播放后，SDK 会触发该回调，报告定位播放的结果。

<a id="callback_imediaplayersourceobserver_onplayerevent__parameters"></a>

### 参数 [#参数-6]

<ParameterList>
<a id="eventcode"></a>
<Parameter name="eventCode">

播放器事件，详见 [MEDIA_PLAYER_EVENT](/zh-CN/api-reference/rtc/unity/enum-mediaplayerevent)。

</Parameter>
<a id="elapsedtime"></a>
<Parameter name="elapsedTime">

发生事件的时间 (毫秒)。

</Parameter>
<a id="message"></a>
<Parameter name="message">

事件的信息。

</Parameter>
</ParameterList>

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

- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imediaplayersourceobserver)

<a id="callback_imediaplayersourceobserver_onplayerinfoupdated"></a>

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

## OnPlayerInfoUpdated [#onplayerinfoupdated]

媒体播放器相关信息发生改变回调。

<a id="callback_imediaplayersourceobserver_onplayerinfoupdated__prototype"></a>

```csharp
public virtual void OnPlayerInfoUpdated(PlayerUpdatedInfo info) { }
```

<a id="callback_imediaplayersourceobserver_onplayerinfoupdated__detailed_desc"></a>

当媒体播放器相关信息发生改变时，SDK 会触发该回调。你可用其进行问题定位和排查。

<a id="callback_imediaplayersourceobserver_onplayerinfoupdated__parameters"></a>

### 参数 [#参数-7]

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

媒体播放器相关信息。详见 [PlayerUpdatedInfo](/zh-CN/api-reference/rtc/unity/class-playerupdatedinfo)。

</Parameter>
</ParameterList>

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

- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imediaplayersourceobserver)

<a id="callback_imediaplayersourceobserver_onplayersourcestatechanged"></a>

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

## OnPlayerSourceStateChanged [#onplayersourcestatechanged]

报告播放器状态改变。

<a id="callback_imediaplayersourceobserver_onplayersourcestatechanged__prototype"></a>

```csharp
public virtual void OnPlayerSourceStateChanged(MEDIA_PLAYER_STATE state, MEDIA_PLAYER_REASON reason)
```

<a id="callback_imediaplayersourceobserver_onplayersourcestatechanged__detailed_desc"></a>

当播放器状态改变时，SDK 会触发该回调，报告新的播放状态。

<a id="callback_imediaplayersourceobserver_onplayersourcestatechanged__parameters"></a>

### 参数 [#参数-8]

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

新的播放状态，详见 [MEDIA_PLAYER_STATE](/zh-CN/api-reference/rtc/unity/enum-mediaplayerstate)。

</Parameter>
<a id="reason"></a>
<Parameter name="reason">

播放器状态改变的原因，详见 [MEDIA_PLAYER_REASON](/zh-CN/api-reference/rtc/unity/enum-mediaplayerreason)。

</Parameter>
</ParameterList>

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

- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imediaplayersourceobserver)

<a id="callback_imediaplayersourceobserver_onplayersrcinfochanged"></a>

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

## OnPlayerSrcInfoChanged [#onplayersrcinfochanged]

媒体资源视频码率变化回调。

<a id="callback_imediaplayersourceobserver_onplayersrcinfochanged__prototype"></a>

```csharp
public virtual void OnPlayerSrcInfoChanged(SrcInfo from, SrcInfo to) {}
```

<a id="callback_imediaplayersourceobserver_onplayersrcinfochanged__detailed_desc"></a>

<a id="callback_imediaplayersourceobserver_onplayersrcinfochanged__parameters"></a>

### 参数 [#参数-9]

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

变化前，媒体资源播放时的视频码率相关信息。详见 [SrcInfo](/zh-CN/api-reference/rtc/unity/class-srcinfo)。

</Parameter>
<a id="to"></a>
<Parameter name="to">

变化后，媒体资源播放时的视频码率相关信息。详见 [SrcInfo](/zh-CN/api-reference/rtc/unity/class-srcinfo)。

</Parameter>
</ParameterList>

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

- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imediaplayersourceobserver)

<a id="callback_imediaplayersourceobserver_onpositionchanged"></a>

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

## OnPositionChanged [#onpositionchanged]

报告当前媒体资源的播放进度。

<a id="callback_imediaplayersourceobserver_onpositionchanged__prototype"></a>

```csharp
public virtual void OnPositionChanged(long positionMs, long timestampMs)
```

<a id="callback_imediaplayersourceobserver_onpositionchanged__detailed_desc"></a>

播放媒体文件时，SDK 每隔 1 秒会自动触发该回调，报告当前播放进度。

<a id="callback_imediaplayersourceobserver_onpositionchanged__parameters"></a>

### 参数 [#参数-10]

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

当前播放进度，单位为 ms。

</Parameter>
<a id="timestampms"></a>
<Parameter name="timestampMs">

当前播放进度的 NTP 时间戳，单位为 ms。

:::note
注： 该参数仅在频道内生效。
:::

</Parameter>
</ParameterList>

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

- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imediaplayersourceobserver)

<a id="callback_imediaplayersourceobserver_onpreloadevent"></a>

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

## OnPreloadEvent [#onpreloadevent]

报告预加载媒体资源的事件。

<a id="callback_imediaplayersourceobserver_onpreloadevent__prototype"></a>

```csharp
public virtual void OnPreloadEvent(string src, PLAYER_PRELOAD_EVENT @event) { }
```

<a id="callback_imediaplayersourceobserver_onpreloadevent__detailed_desc"></a>

<a id="callback_imediaplayersourceobserver_onpreloadevent__parameters"></a>

### 参数 [#参数-11]

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

媒体资源的路径。

</Parameter>
<a id="event"></a>
<Parameter name="@event">

预加载媒体资源时发生的事件。详见 [PLAYER_PRELOAD_EVENT](/zh-CN/api-reference/rtc/unity/enum-playerpreloadevent)。

</Parameter>
</ParameterList>

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

- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imediaplayersourceobserver)

<a id="callback_imediaplayercustomdataprovider_onreaddata"></a>

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

## OnReadData [#onreaddata]

读取媒体资源数据回调。

<a id="callback_imediaplayercustomdataprovider_onreaddata__prototype"></a>

```csharp
public virtual int OnReadData(IntPtr bufferPtr, int bufferSize)
        {
            return 0;
        }
```

<a id="callback_imediaplayercustomdataprovider_onreaddata__detailed_desc"></a>

使用 [OpenWithMediaSource](/zh-CN/api-reference/rtc/unity/play/mediaplayer/mediaplayer-open#api_imediaplayer_openwithmediasource) 打开媒体资源时，SDK 会触发该回调向你请求传入媒体资源数据的 Buffer。

<a id="callback_imediaplayercustomdataprovider_onreaddata__parameters"></a>

### 参数 [#参数-12]

<ParameterList>
<a id="bufferptr"></a>
<Parameter name="bufferPtr">

输入参数，数据 Buffer，单位为字节。请将 SDK 报告的 `bufferSize` 数据写入到此参数中。

</Parameter>
<a id="buffersize"></a>
<Parameter name="bufferSize">

数据 Buffer 的长度，单位为字节。

</Parameter>
</ParameterList>

<a id="callback_imediaplayercustomdataprovider_onreaddata__return_values"></a>

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

- 如果读取数据成功，请在返回值中传入你实际读取的数据长度，单位为字节。
- 如果读取数据失败，请在返回值中传入 0。

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

- [IMediaPlayerCustomDataProvider](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imediaplayercustomdataprovider)