播放信息获取

  • Unreal C++

更新时间不可用

getDuration

获取媒体文件总时长。

C++
virtual int getDuration(int64_t& duration) = 0;

参数

参数名描述
duration

输出参数。媒体文件总时长(毫秒)。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

getMediaPlayerId

获取播放器 ID。

C++
virtual int getMediaPlayerId() const = 0;

返回值

  • 方法调用成功,返回播放器 ID。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

getMute

获取当前播放的媒体文件是否静音。

C++
virtual int getMute(bool& mute) = 0;

参数

参数名描述
mute

输出参数。静音状态:

  • true: 媒体文件已静音。
  • false: 媒体文件未静音。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

getPlayoutVolume

获取当前本地播放音量。

C++
virtual int getPlayoutVolume(int& volume) = 0;

参数

参数名描述
volume

输出参数。本地播放音量,取值范围从 0 到 100:

  • 0: 无声。
  • 100: (默认)媒体文件的原始播放音量。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

getPlayPosition

获取当前播放进度。

C++
virtual int getPlayPosition(int64_t& pos) = 0;

参数

参数名描述
pos

媒体资源文件当前的播放位置,单位为毫秒。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 方法调用成功,返回当前播放进度(毫秒)。
  • < 0: 方法调用失败,详见 MEDIA_PLAYER_REASON。

所属接口类

getPlaySrc

获取播放的媒体资源的路径。

C++
virtual const char* getPlaySrc() = 0;

返回值

播放的媒体资源的路径。

所属接口类

getPublishSignalVolume

获取远端用户听到的音量。

C++
virtual int getPublishSignalVolume(int& volume) = 0;

参数

参数名描述
volume

输出参数。播放文件的远端播放音量。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

getState

获取播放器当前状态。

C++
virtual media::base::MEDIA_PLAYER_STATE getState() = 0;

返回值

播放器当前状态,详见 MEDIA_PLAYER_STATE。

所属接口类

getStreamCount

获取当前媒体文件中媒体流的数量。

C++
virtual int getStreamCount(int64_t& count) = 0;

详情

注意: 请在 open 后并收到 onPlayerSourceStateChanged 回调报告播放状态为 PLAYER_STATE_OPEN_COMPLETED 后再调用该方法。

参数

参数名描述
count

输出参数。当前媒体文件中媒体流的数量。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

所属接口类

getStreamInfo

通过媒体流的索引值获取媒体流信息。

C++
virtual int getStreamInfo(int64_t index, media::base::PlayerStreamInfo* info) = 0;

调用时机

你需要在 getStreamCount 后调用该方法。

调用限制

无。

参数

参数名描述
index

媒体流索引值。该参数需小于 getStreamCount 的 count 参数。

info

输出参数。媒体流的所有信息,详见 PlayerStreamInfo。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

onPlayerPlaybackStats

报告当前播放的媒体资源的相关信息。

C++
virtual void onPlayerPlaybackStats(const media::base::PlayerPlaybackStats& stats) {
    (void)stats;
  }

详情

当媒体资源开始播放后,SDK 会每秒触发一次该回调,报告媒体资源的相关信息。

参数

参数名描述
stats

媒体资源的相关信息,详见 PlayerPlaybackStats。

表格内容超出当前宽度,可横向滚动查看更多列。

所属接口类