播放信息获取
- Unreal Blueprint
更新时间不可用
GetDuration
获取媒体文件总时长。
UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetDuration(int64& duration);参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
GetMediaPlayerId
获取播放器 ID。
UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetMediaPlayerId();返回值
- 方法调用成功，返回播放器 ID。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
GetMute
获取当前播放的媒体文件是否静音。
UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetMute(bool & muted);参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
GetPlayoutVolume
获取当前本地播放音量。
UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetPlayoutVolume(int & volume);参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
GetPlayPosition
获取当前播放进度。
UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetPlayPosition(int64& pos);参数
返回值
- 方法调用成功，返回当前播放进度（毫秒）。
- < 0: 方法调用失败，详见 FENUMWRAP_MEDIA_PLAYER_REASON。
所属接口类
GetPlaySrc
获取播放的媒体资源的路径。
UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
FString GetPlaySrc();返回值
播放的媒体资源的路径。
所属接口类
GetPublishSignalVolume
获取远端用户听到的音量。
UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetPublishSignalVolume(int & volume);参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
GetState
获取播放器当前状态。
UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
EMEDIA_PLAYER_STATE GetState();返回值
播放器当前状态，详见 EMEDIA_PLAYER_STATE。
所属接口类
GetStreamCount
获取当前媒体文件中媒体流的数量。
UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetStreamCount(int64& count);详情
注意： 请在 Open 后并收到 OnPlayerSourceStateChanged 回调报告播放状态为 PLAYER_STATE_OPEN_COMPLETED 后再调用该方法。
参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败，详见 FENUMWRAP_MEDIA_PLAYER_REASON。
所属接口类
GetStreamInfo
通过媒体流的索引值获取媒体流信息。
UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetStreamInfo(int64 index, FPlayerStreamInfo& info);调用时机
你需要在 GetStreamCount 后调用该方法。
调用限制
无。
参数
| 参数名 | 描述 |
|---|---|
index | 媒体流索引值。该参数需小于 GetStreamCount 的 count 参数。 |
info | 输出参数。媒体流的所有信息，详见 FPlayerStreamInfo。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
OnPlayerPlaybackStats
报告当前播放的媒体资源的相关信息。
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
void OnPlayerPlaybackStats(const FPlayerPlaybackStats& stats);详情
当媒体资源开始播放后，SDK 会每秒触发一次该回调，报告媒体资源的相关信息。
参数
| 参数名 | 描述 |
|---|---|
stats | 媒体资源的相关信息，详见 FPlayerPlaybackStats。 |