# 音视频观测器 (/zh-CN/api-reference/rtc/unreal-cpp/play/mediaplayer/mediaplayer-observer)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## registerAudioFrameObserver [1/2] [#registeraudioframeobserver-12]
注册 PCM 音频帧观测器。
```cpp
virtual int registerAudioFrameObserver(media::IAudioPcmFrameSink* observer) = 0;
```
### 详情 [#详情]
你需要在该方法中实现一个 [IAudioPcmFrameSink](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_iaudiopcmframesink) 类,并根据场景需要,注册该类的回调。成功注册音频帧观测器后,SDK 会在捕捉到每个音频帧时,触发你所注册的回调。
### 参数 [#参数]
音频帧观测器,观测每帧音频的接收,详见 [IAudioPcmFrameSink](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_iaudiopcmframesink)。
### 返回值 [#返回值]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类]
- [IMediaPlayer](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayer)
## registerAudioFrameObserver [2/2] [#registeraudioframeobserver-22]
注册音频帧观测器。
```cpp
virtual int registerAudioFrameObserver(media::IAudioPcmFrameSink* observer,
RAW_AUDIO_FRAME_OP_MODE_TYPE mode) = 0;
```
### 参数 [#参数-1]
音频帧观测器,观测每帧音频的接收,详见 [IAudioPcmFrameSink](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_iaudiopcmframesink)。
音频帧的使用模式,详见 [RAW_AUDIO_FRAME_OP_MODE_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-rawaudioframeopmodetype)。
### 返回值 [#返回值-1]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-1]
- [IMediaPlayer](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayer)
## registerPlayerSourceObserver [#registerplayersourceobserver]
注册一个播放观测器。
```cpp
virtual int registerPlayerSourceObserver(IMediaPlayerSourceObserver* observer) = 0;
```
### 调用时机 [#调用时机]
加入频道前后均可调用。
### 调用限制 [#调用限制]
无。
### 参数 [#参数-2]
播放观测器,报告播放中的事件,详见 [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayersourceobserver)。
### 返回值 [#返回值-2]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-2]
- [IMediaPlayer](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayer)
## registerVideoFrameObserver [#registervideoframeobserver]
注册视频帧观测器。
```cpp
virtual int registerVideoFrameObserver(media::base::IVideoFrameObserver* observer) = 0;
```
### 详情 [#详情-1]
你需要在该方法中实现一个 [IVideoFrameObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideoframeobserver) 类,并根据场景需要,注册该类的回调。成功注册视频帧观测器后,SDK 会在捕捉到每个视频帧时,触发你所注册的回调。
### 参数 [#参数-3]
视频帧观测器,观测每帧视频的接收。详见 [IVideoFrameObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideoframeobserver)。
### 返回值 [#返回值-3]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-3]
- [IMediaPlayer](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayer)
## unregisterAudioFrameObserver [#unregisteraudioframeobserver]
取消注册音频帧观测器。
```cpp
virtual int unregisterAudioFrameObserver(media::IAudioPcmFrameSink* observer) = 0;
```
### 参数 [#参数-4]
音频帧观测器,详见 [IAudioPcmFrameSink](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_iaudiopcmframesink)。
### 返回值 [#返回值-4]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-4]
- [IMediaPlayer](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayer)
## unregisterPlayerSourceObserver [#unregisterplayersourceobserver]
取消注册播放观测器。
```cpp
virtual int unregisterPlayerSourceObserver(IMediaPlayerSourceObserver* observer) = 0;
```
### 参数 [#参数-5]
播放观测器,报告播放中的事件,详见 [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayersourceobserver)。
### 返回值 [#返回值-5]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-5]
- [IMediaPlayer](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayer)
## unregisterVideoFrameObserver [#unregistervideoframeobserver]
取消注册视频帧观测器。
```cpp
virtual int unregisterVideoFrameObserver(agora::media::base::IVideoFrameObserver* observer) = 0;
```
### 参数 [#参数-6]
视频帧观测器,观测每帧视频的接收,详见 [IVideoFrameObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideoframeobserver)。
### 返回值 [#返回值-6]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-6]
- [IMediaPlayer](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayer)
## onAudioVolumeIndication [#onaudiovolumeindication]
媒体播放器音量提示回调。
```cpp
virtual void onAudioVolumeIndication(int volume) = 0;
```
### 详情 [#详情-2]
SDK 每 200 毫秒触发一次该回调,报告媒体播放器当前的音量。
### 参数 [#参数-7]
播放器的当前音量,取值范围为 [0,255]。
### 所属接口类 [#所属接口类-7]
- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayersourceobserver)
## onFrame [#onframe]
已获取音频帧回调。
```cpp
virtual void onFrame(agora::media::base::AudioPcmFrame* frame) = 0;
```
### 详情 [#详情-3]
注册音频数据观测器后,每次接收到一帧音频帧时,都会触发该回调,报告音频帧信息。
### 参数 [#参数-8]
音频帧信息。详见 [AudioPcmFrame](/zh-CN/api-reference/rtc/unreal-cpp/class-audiopcmframe)。
### 所属接口类 [#所属接口类-8]
- [IAudioPcmFrameSink](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_iaudiopcmframesink)
## onMetaData [#onmetadata]
报告已获取媒体附属信息。
```cpp
virtual void onMetaData(const void* data, int length) = 0;
```
### 详情 [#详情-4]
解析媒体附属信息后时,SDK 会触发该回调,报告媒体附属信息的数据类型和具体数据。
### 参数 [#参数-9]
具体数据,用户自定义格式的数据。
数据长度,单位为 byte。
### 所属接口类 [#所属接口类-9]
- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayersourceobserver)
## onPlayBufferUpdated [#onplaybufferupdated]
报告当前缓冲数据能播放的时间。
```cpp
virtual void onPlayBufferUpdated(int64_t playCachedBuffer) = 0;
```
### 详情 [#详情-5]
播放在线媒体资源的过程中,SDK 会每隔 1 秒触发一次该回调,报告当前缓冲的数据能支持的播放时间。
- 当缓冲数据支持的播放时间小于阈值(默认为 0)时,返回 PLAYER_EVENT_BUFFER_LOW (6)。
- 当缓冲数据支持的播放时间大于阈值(默认为 0)时,返回 PLAYER_EVENT_BUFFER_RECOVER (7)。
### 参数 [#参数-10]
当前缓冲的数据能支持的播放时间 (毫秒)。
### 所属接口类 [#所属接口类-10]
- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayersourceobserver)
## onPlayerEvent [#onplayerevent]
报告播放器的事件。
```cpp
virtual void onPlayerEvent(media::base::MEDIA_PLAYER_EVENT eventCode, int64_t elapsedTime, const char* message) = 0;
```
### 详情 [#详情-6]
- 调用 [seek](/zh-CN/api-reference/rtc/unreal-cpp/play/mediaplayer/mediaplayer-control#api_imediaplayer_seek) 定位播放后,SDK 会触发该回调,报告定位播放的结果。
### 参数 [#参数-11]
播放器事件,详见 [MEDIA_PLAYER_EVENT](/zh-CN/api-reference/rtc/unreal-cpp/enum-mediaplayerevent)。
发生事件的时间 (毫秒)。
事件的信息。
### 所属接口类 [#所属接口类-11]
- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayersourceobserver)
## onPlayerInfoUpdated [#onplayerinfoupdated]
媒体播放器相关信息发生改变回调。
```cpp
virtual void onPlayerInfoUpdated(const media::base::PlayerUpdatedInfo& info) = 0;
```
### 详情 [#详情-7]
当媒体播放器相关信息发生改变时,SDK 会触发该回调。你可用其进行问题定位和排查。
### 参数 [#参数-12]
媒体播放器相关信息。详见 [PlayerUpdatedInfo](/zh-CN/api-reference/rtc/unreal-cpp/class-playerupdatedinfo)。
### 所属接口类 [#所属接口类-12]
- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayersourceobserver)
## onPlayerSourceStateChanged [#onplayersourcestatechanged]
报告播放器状态改变。
```cpp
virtual void onPlayerSourceStateChanged(media::base::MEDIA_PLAYER_STATE state,
media::base::MEDIA_PLAYER_REASON reason) = 0;
```
### 详情 [#详情-8]
当播放器状态改变时,SDK 会触发该回调,报告新的播放状态。
### 参数 [#参数-13]
新的播放状态,详见 [MEDIA_PLAYER_STATE](/zh-CN/api-reference/rtc/unreal-cpp/enum-mediaplayerstate)。
播放器状态改变的原因,详见 [MEDIA_PLAYER_REASON](/zh-CN/api-reference/rtc/unreal-cpp/enum-mediaplayerreason)。
### 所属接口类 [#所属接口类-13]
- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayersourceobserver)
## onPlayerSrcInfoChanged [#onplayersrcinfochanged]
媒体资源视频码率变化回调。
```cpp
virtual void onPlayerSrcInfoChanged(const media::base::SrcInfo& from, const media::base::SrcInfo& to) = 0;
```
### 参数 [#参数-14]
变化前,媒体资源播放时的视频码率相关信息。详见 [SrcInfo](/zh-CN/api-reference/rtc/unreal-cpp/class-srcinfo)。
变化后,媒体资源播放时的视频码率相关信息。详见 [SrcInfo](/zh-CN/api-reference/rtc/unreal-cpp/class-srcinfo)。
### 所属接口类 [#所属接口类-14]
- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayersourceobserver)
## onPositionChanged [#onpositionchanged]
报告当前媒体资源的播放进度。
```cpp
virtual void onPositionChanged(int64_t positionMs, int64_t timestampMs) = 0;
```
### 详情 [#详情-9]
播放媒体文件时,SDK 每隔 1 秒会自动触发该回调,报告当前播放进度。
### 参数 [#参数-15]
当前播放进度,单位为 ms。
当前播放进度的 NTP 时间戳,单位为 ms。
### 所属接口类 [#所属接口类-15]
- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayersourceobserver)
## onPreloadEvent [#onpreloadevent]
报告预加载媒体资源的事件。
```cpp
virtual void onPreloadEvent(const char* src, media::base::PLAYER_PRELOAD_EVENT event) = 0;
```
### 参数 [#参数-16]
媒体资源的路径。
预加载媒体资源时发生的事件。详见 [PLAYER_PRELOAD_EVENT](/zh-CN/api-reference/rtc/unreal-cpp/enum-playerpreloadevent)。
### 所属接口类 [#所属接口类-16]
- [IMediaPlayerSourceObserver](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayersourceobserver)
## onReadData [#onreaddata]
读取媒体资源数据回调。
```cpp
virtual int onReadData(unsigned char *buffer, int bufferSize) = 0;
```
### 详情 [#详情-10]
使用 [openWithMediaSource](/zh-CN/api-reference/rtc/unreal-cpp/play/mediaplayer/mediaplayer-open#api_imediaplayer_openwithmediasource) 打开媒体资源时,SDK 会触发该回调向你请求传入媒体资源数据的 Buffer。
### 参数 [#参数-17]
输入参数,数据 Buffer,单位为字节。请将 SDK 报告的 bufferSize 数据写入到此参数中。
数据 Buffer 的长度,单位为字节。
### 返回值 [#返回值-7]
- 如果读取数据成功,请在返回值中传入你实际读取的数据长度,单位为字节。
- 如果读取数据失败,请在返回值中传入 0。
### 所属接口类 [#所属接口类-17]
- [IMediaPlayerCustomDataProvider](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_imediaplayercustomdataprovider)