You need to enable JavaScript to run this app.
导航
回调
最近更新时间:2025.05.19 17:59:35首次发布时间:2024.08.02 17:34:00
复制全文
我的收藏
有用
有用
无用
无用

VeLivePlayerObserver

类型:interface

播放器事件回调。

onError

播放器错误信息回调,播放器出现错误时,触发回调。

类型

((player: VeLivePlayer, error: VeLivePlayerError) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

error
VeLivePlayerError

错误信息,详情请参见 VeLivePlayerError

onFirstVideoFrameRender

视频首帧渲染事件回调。视频首帧渲染成功,或播放过程中发生重试,重试后的第一个视频帧渲染成功,均会触发此回调。

类型

((player: VeLivePlayer, isFirstFrame: boolean) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

isFirstFrame
boolean

渲染成功的是否为视频首帧。

  • true:视频首帧;
  • false:重试后第一个视频帧。

onFirstAudioFrameRender

音频首帧渲染事件回调。音频首帧渲染成功,或播放过程中发生重试,重试后的第一个音频帧渲染成功,均会触发此回调。

类型

((player: VeLivePlayer, isFirstFrame: boolean) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

isFirstFrame
boolean

渲染成功的是否为音频首帧。

  • true:音频首帧;
  • false:重试后第一个音频帧。

onStallStart

播放卡顿开始回调。

类型

((player: VeLivePlayer) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

onStallEnd

播放卡顿结束回调。音频缓冲区达到起播条件且开始播放后,触发此回调。

类型

((player: VeLivePlayer) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

onVideoRenderStall

视频渲染卡顿回调。视频渲染发生卡顿时,触发此回调。

类型

((player: VeLivePlayer, stallTime: number) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

stallTime
number

视频渲染卡顿时长,单位为 ms。

onAudioRenderStall

音频渲染卡顿回调。音频渲染发生卡顿时,触发此回调。

类型

((player: VeLivePlayer, stallTime: number) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

stallTime
number

音频渲染卡顿时长,单位为 ms。

onResolutionSwitch

清晰度档位变化回调。

类型

((player: VeLivePlayer, resolution: VeLivePlayerResolution, error: VeLivePlayerError, reason: VeLivePlayerResolutionSwitchReason) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

resolution
VeLivePlayerResolution

切换后的清晰度档位,详情请参见 VeLivePlayerResolution

error
VeLivePlayerError

切换清晰度档位时,是否发生错误,详情请参见 VeLivePlayerError

reason
VeLivePlayerResolutionSwitchReason

清晰度档位切换的原因,详情请参见 VeLivePlayerResolutionSwitchReason

onVideoSizeChanged

视频分辨率变化回调。视频大小发生变化时,触发回调。

类型

((player: VeLivePlayer, width: number, height: number) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

width
number

变化后的视频宽度,单位为 px。

height
number

变化后的视频高度,单位为 px。

onReceiveSeiMessage

SEI 信息回调。当播放器 SDK 接收到 SEI 信息时,触发回调。

类型

((player: VeLivePlayer, message: string) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

message
string

SEI 信息。

onMainBackupSwitch

主备流切换回调。

类型

((player: VeLivePlayer, streamType: VeLivePlayerStreamType, error: VeLivePlayerError) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

streamType
VeLivePlayerStreamType

切换后的流类型为主路流或备路流,详情请参见 VeLivePlayerStreamType

error
VeLivePlayerError

触发主备流切换的原因,详情请参见 VeLivePlayerError

onPlayerStatusUpdate

播放状态发生变化时,触发回调。

类型

((player: VeLivePlayer, status: VeLivePlayerStatus) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

status
VeLivePlayerStatus

当前播放器的状态,详情请参见 VeLivePlayerStatus

onStatistics

播放信息周期性回调。播放器 SDK 会周期性地回调本方法,您可以通过本方法获取当前播放器的播放地址、码率和帧率等信息。

类型

((player: VeLivePlayer, statistics: VeLivePlayerStatistics) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

statistics
VeLivePlayerStatistics

播放器周期性回调的统计信息,详情请参见 VeLivePlayerStatistics

onSnapshotComplete

截图成功回调。当播放器调用 snapshot 截图成功后,会触发此回调。

类型

((player: VeLivePlayer, bitmap: any) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

bitmap
any

截图的 Bitmap 对象。

onRenderVideoFrame

视频帧回调。调用 enableVideoFrameObserver 开启视频帧解析回调后,当播放器成功解码视频帧时,会触发此回调。

注意

如果自定义渲染使用纹理格式,建议在视频帧回调线程中执行渲染操作。

类型

((player: VeLivePlayer, videoFrame: VeLivePlayerVideoFrame) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

videoFrame
VeLivePlayerVideoFrame

视频帧数据,包含像素格式、封装格式、视频宽高等信息,详情请参见 VeLivePlayerVideoFrame

onRenderAudioFrame

音频帧回调。调用 enableAudioFrameObserver 开启音频帧解析回调后,当播放器成功解码音频帧时,会触发此回调。

注意

回调的音频帧数据为 float32 格式,大端字节序存储。

类型

((player: VeLivePlayer, audioFrame: VeLivePlayerAudioFrame) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

audioFrame
VeLivePlayerAudioFrame

音频数据,详情请参见 VeLivePlayerAudioFrame

onStreamFailedOpenSuperResolution

超分开启失败。调用 setEnableSuperResolution 开启超分后,当播放器不支持超分开启或者超分处理出错时,会触发此回调。

类型

((player: VeLivePlayer, error: VeLivePlayerError) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
player

触发该事件回调的播放器对象。

error
VeLivePlayerError

超分开启失败原因,错误码请参见 VeLivePlayerErrorCode

PictureInPictureManagerListener

类型:interface

画中画相关事件的监听器,用于接收画中画状态的变化通知。

onStartPictureInPicture

用于监听画中画启动的回调。可以在其中处理 UI 状态更新或埋点逻辑。

类型

(() => void) | undefined

onStopPictureInPicture

用于监听画中画退出的回调。当用户手动关闭画中画或应用主动退出时触发。

类型

(() => void) | undefined

onClickPictureInPicture(Android)

用于监听画中画窗口被点击的回调,适用于响应用户交互。

类型

(() => void) | undefined

onError

用于监听画中画发生错误的回调,可用于错误上报或兜底处理。

类型

((code: number, extraData: any) => void) | undefined

参数

名称
类型
是否必选
默认值
说明
code
number

错误码。

  • 0:成功
  • 1:不支持
  • 2:参数错误
  • 3:画中画已开启

extraData
any

额外的错误信息数据,用于辅助调试或日志上报。