# 音视频观测器 (/zh-CN/api-reference/rtc/unreal-blueprint/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_irtcengine_getmediaplayersourceobserver"></a>

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

## GetMediaPlayerSourceObserver [#getmediaplayersourceobserver]

获取事件处理器。

<a id="api_irtcengine_getmediaplayersourceobserver__prototype"></a>

```cpp
UFUNCTION(BlueprintPure, Category = "Agora|IRtcEngine")
UAgoraBPuIMediaPlayerSourceObserver* GetMediaPlayerSourceObserver();
```

<a id="api_irtcengine_getmediaplayersourceobserver__detailed_desc"></a>

调用该方法获取事件处理器后，你可以调用 [AddBlueprintCallbackExecutor](/zh-CN/api-reference/rtc/unreal-blueprint/play/mediaplayer/mediaplayer-observer#api_imediaplayer_addblueprintcallbackexecutor) 绑定对应的回调执行器。

<a id="api_irtcengine_getmediaplayersourceobserver__timing"></a>

### 调用时机 [#调用时机]

调用 [GetAgoraRtcEngine](/zh-CN/api-reference/rtc/unreal-blueprint/initialize#api_createagorartcengine) 后。

<a id="api_irtcengine_getmediaplayersourceobserver__restriction"></a>

### 调用限制 [#调用限制]

无。

<a id="api_irtcengine_getmediaplayersourceobserver__return_values"></a>

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

返回一个指向 `UAgoraBPuIMediaPlayerSourceObserver` 事件处理器的指针。

<a id="api_imediaplayer_addblueprintcallbackexecutor"></a>

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

## AddBlueprintCallbackExecutor [#addblueprintcallbackexecutor]

添加一个蓝图回调执行器。

<a id="api_imediaplayer_addblueprintcallbackexecutor__prototype"></a>

```cpp
UFUNCTION(BlueprintCallable, Category = "Agora|Event")
void AddBlueprintCallbackExecutor(UAgoraBPuIMediaPlayerSourceObserverCBExecutor* Executor);
```

<a id="api_imediaplayer_addblueprintcallbackexecutor__detailed_desc"></a>

获取事件处理器后，你可以调用该方法绑定回调执行器，用于执行 [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unreal-blueprint/rtc-interface-class#class_imediaplayersourceobserver) 接口类下的相关回调。

<a id="api_imediaplayer_addblueprintcallbackexecutor__timing"></a>

### 调用时机 [#调用时机-1]

调用 [GetMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unreal-blueprint/play/mediaplayer/mediaplayer-observer#api_irtcengine_getmediaplayersourceobserver) 获取事件处理器后。

<a id="api_imediaplayer_addblueprintcallbackexecutor__restriction"></a>

### 调用限制 [#调用限制-1]

无。

<a id="api_imediaplayer_addblueprintcallbackexecutor__parameters"></a>

### 参数 [#参数]

<ParameterList>
<a id="executor"></a>
<Parameter name="Executor">

指向 `UAgoraBPuIMediaPlayerSourceObserverCBExecutor` 类型的指针，用于执行 IMediaPlayerSourceObserver 接口类下的回调逻辑。

</Parameter>
</ParameterList>

<a id="callback_imediaplayersourceobserver_onaudiovolumeindication"></a>

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

## OnAudioVolumeIndication [#onaudiovolumeindication]

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

<a id="callback_imediaplayersourceobserver_onaudiovolumeindication__prototype"></a>

```cpp
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
void OnAudioVolumeIndication(int volume);
```

<a id="callback_imediaplayersourceobserver_onaudiovolumeindication__detailed_desc"></a>

### 详情 [#详情]

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

<a id="callback_imediaplayersourceobserver_onaudiovolumeindication__parameters"></a>

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

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

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

</Parameter>
</ParameterList>

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

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

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

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

## OnMetaData [#onmetadata]

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

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

```cpp
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
	void OnMetaData(const FString& Data);
```

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

### 详情 [#详情-1]

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

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

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

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

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

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

数据长度，单位为 byte。

</Parameter>
</ParameterList>

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

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

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

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

## OnPlayBufferUpdated [#onplaybufferupdated]

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

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

```cpp
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
	void OnPlayBufferUpdated(int64 playCachedBuffer);
```

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

### 详情 [#详情-2]

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

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

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

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

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

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

</Parameter>
</ParameterList>

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

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

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

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

## OnPlayerEvent [#onplayerevent]

报告播放器的事件。

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

```cpp
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
	void OnPlayerEvent(EMEDIA_PLAYER_EVENT eventCode, int64 elapsedTime, const FString& message);
```

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

### 详情 [#详情-3]

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

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

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

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

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

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

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

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

事件的信息。

</Parameter>
</ParameterList>

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

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

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

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

## OnPlayerInfoUpdated [#onplayerinfoupdated]

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

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

```cpp
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
	void OnPlayerInfoUpdated(const FPlayerUpdatedInfo& info);
```

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

### 详情 [#详情-4]

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

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

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

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

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

</Parameter>
</ParameterList>

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

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

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

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

## OnPlayerSourceStateChanged [#onplayersourcestatechanged]

报告播放器状态改变。

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

```cpp
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
	void OnPlayerSourceStateChanged(EMEDIA_PLAYER_STATE state, FENUMWRAP_MEDIA_PLAYER_REASON ec);
```

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

### 详情 [#详情-5]

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

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

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

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

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

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

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

</Parameter>
</ParameterList>

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

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

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

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

## OnPlayerSrcInfoChanged [#onplayersrcinfochanged]

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

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

```cpp
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
	void OnPlayerSrcInfoChanged(const FSrcInfo& from, const FSrcInfo& to);
```

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

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

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

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

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

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

</Parameter>
</ParameterList>

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

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

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

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

## OnPositionChanged [#onpositionchanged]

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

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

```cpp
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
	void OnPositionChanged(int64 position_ms, int64 timestampMs);
```

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

### 详情 [#详情-6]

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

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

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

<ParameterList>
<a id="positionms"></a>
<Parameter name="positionMs">

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

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

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

</Parameter>
</ParameterList>

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

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

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

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

## OnPreloadEvent [#onpreloadevent]

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

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

```cpp
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
	void OnPreloadEvent(const FString& src, EPLAYER_PRELOAD_EVENT event);
```

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

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

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

媒体资源的路径。

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

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

</Parameter>
</ParameterList>

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

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