音视频观测器

  • HarmonyOS

更新时间不可用

registerPlayerObserver

注册一个播放观测器。

TypeScript
public abstract registerPlayerObserver(playerObserver:IMediaPlayerObserver);

调用时机

加入频道前后均可调用。

调用限制

无。

参数

参数名描述
playerObserver

播放观测器,报告播放中的事件,详见 IMediaPlayerObserver。

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

返回值

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

unRegisterPlayerObserver

取消注册播放观测器。

TypeScript
public abstract unRegisterPlayerObserver();

参数

参数名描述
playerObserver

播放观测器,报告播放中的事件,详见 IMediaPlayerObserver。

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

返回值

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

onAudioVolumeIndication

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

TypeScript
onAudioVolumeIndication?:(volume:number) => void

详情

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

参数

参数名描述
volume

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

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

所属接口类

onMetaData

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

TypeScript
onMetaData?:(type:Constants.MediaPlayerMetadataType,data:ArrayBuffer) => void

详情

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

参数

参数名描述
type

媒体附属信息数据类型,详见 MediaPlayerMetadataType。

data

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

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

所属接口类

onPlayBufferUpdated

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

TypeScript
onPlayBufferUpdated?:(playCachedBuffer:number) => void

详情

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

  • 当缓冲数据支持的播放时间小于阈值(默认为 0)时,返回 BUFFER_LOW (6)。
  • 当缓冲数据支持的播放时间大于阈值(默认为 0)时,返回 BUFFER_RECOVER (7)。

参数

参数名描述
playCachedBuffer

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

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

所属接口类

onPlayerEvent

报告播放器的事件。

TypeScript
onPlayerEvent?:(eventCode:Constants.MediaPlayerEvent,elapsedTime:number,message:string) => void

详情

  • 调用 seek 定位播放后,SDK 会触发该回调,报告定位播放的结果。

参数

参数名描述
eventCode

播放器事件,详见 MediaPlayerEvent。

elapsedTime

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

message

事件的信息。

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

所属接口类

onPlayerInfoUpdated

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

TypeScript
onPlayerInfoUpdated?:(info:PlayerUpdatedInfo) => void

详情

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

参数

参数名描述
info

媒体播放器相关信息。详见 PlayerUpdatedInfo。

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

所属接口类

onPlayerStateChanged

报告播放器状态改变。

TypeScript
onPlayerStateChanged?:(state:Constants.MediaPlayerState,reason:Constants.MediaPlayerReason) => void

详情

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

参数

参数名描述
state

新的播放状态,详见 MediaPlayerState。

reason

播放器状态改变的原因,详见 MediaPlayerReason。

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

所属接口类

onPlayerSrcInfoChanged

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

TypeScript
onPlayerSrcInfoChanged?:(from:SrcInfo,to:SrcInfo) => void

参数

参数名描述
from

变化前,媒体资源播放时的视频码率相关信息。详见 SrcInfo。

to

变化后,媒体资源播放时的视频码率相关信息。详见 SrcInfo。

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

所属接口类

onPositionChanged

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

TypeScript
onPositionChanged?:(positionMs:number,timestampMs:number) => void

详情

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

参数

参数名描述
positionMs

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

timestampMs

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

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

所属接口类

onPreloadEvent

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

TypeScript
onPreloadEvent?:(src:string,event:Constants.MediaPlayerPreloadEvent) => void

参数

参数名描述
event

预加载媒体资源时发生的事件。详见 MediaPlayerPreloadEvent。

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

所属接口类