播放信息获取

  • React Native

更新时间不可用

getAudioBufferDelay

获取播放媒体文件时的音频缓冲延迟。

TypeScript
abstract getAudioBufferDelay(): number;

参数

参数名描述
delayMs

输出参数,表示播放媒体文件时的音频缓冲延迟,单位为毫秒。

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

返回值

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

所属接口类

getDuration

获取媒体文件总时长。

TypeScript
abstract getDuration(): number;

返回值

媒体文件总时长(毫秒)。

所属接口类

getMediaPlayerId

获取播放器 ID。

TypeScript
abstract getMediaPlayerId(): number;

返回值

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

所属接口类

getMute

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

TypeScript
abstract getMute(): boolean;

返回值

  • true:当前播放的媒体文件为静音。
  • false:当前播放的媒体文件没有静音。

所属接口类

getPlayoutVolume

获取当前本地播放音量。

TypeScript
abstract getPlayoutVolume(): number;

返回值

返回当前本地播放音量,取值范围从 0 到 100:

  • 0: 无声。
  • 100: (默认)媒体文件的原始播放音量。

所属接口类

getPlayPosition

获取当前播放进度。

TypeScript
abstract getPlayPosition(): number;

返回值

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

所属接口类

getPlaySrc

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

TypeScript
abstract getPlaySrc(): string;

返回值

播放的媒体资源的路径。

所属接口类

getPublishSignalVolume

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

TypeScript
abstract getPublishSignalVolume(): number;

返回值

  • ≥ 0: 播放文件的远端播放音量。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

getState

获取播放器当前状态。

TypeScript
abstract getState(): MediaPlayerState;

返回值

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

所属接口类

getStreamCount

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

TypeScript
abstract getStreamCount(): number;

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

返回值

  • 方法调用成功,返回该媒体文件中媒体流的数量。
  • < 0: 方法调用失败,详见 MediaPlayerReason。

所属接口类

getStreamInfo

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

TypeScript
abstract getStreamInfo(index: number): PlayerStreamInfo;

调用时机

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

参数

参数名描述
index

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

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

返回值

  • 方法调用成功,返回媒体流信息,详见 PlayerStreamInfo。
  • 方法调用失败,返回 null。

所属接口类

onPlayerPlaybackStats

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

TypeScript
onPlayerPlaybackStats?(stats: PlayerPlaybackStats): void;

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

参数

参数名描述
stats

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

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

所属接口类