概览--视频直播-火山引擎

文档中心

立即注册

视频直播

请输入

SDK API 参考

概览

方法

方法	说明
setConfig	初始化播放器，用于设置是否开启 SEI 消息、是否开启硬件解码和是否开启本地 DNS 预解析等配置信息。
setObserver	设置播放器回调，用于监听播放器 VeLivePlayer 的播放错误、播放状态、音视频首帧渲染状态和清晰度档位信息等回调事件。
setRenderFillMode	设置播放器画面的填充模式。
setPlayerVolume	设置播放器音量。
isPlaying	检查播放器是否正在播放。
switchResolution	切换播放的清晰度档位。
destroy	停止播放，并销毁播放器。
stop	停止播放，不销毁播放器。
pause	暂停播放。
play	开始/恢复播放。
setPlayStreamData	多路流信息配置。例如，您需要使用 ABR、手动切档和主备流等依赖多路流的功能，可以调用本方法进行配置。
setPlayUrl	设置单个直播播放地址。
setMute	设置是否静音播放。
isMute	获取是否处于静音状态。
setProperty	设置播放器高级配置。高级配置包括离屏渲染设置、缓冲区最大时长、ABR 码率自适应算法类型等，如需了解详细信息，请联系火山引擎技术支持。
setRenderRotation	设置视频顺时针旋转角度。
setRenderMirror	设置视频镜像。
setEnableSuperResolution	设置是否开启超分。您需要联系火山引擎技术支持开通超分功能后才可使用该功能。
startPictureInPicture	启动画中画模式。
stopPictureInPicture	退出画中画模式。
isPictureInPictureSupported	判断当前环境是否支持画中画。
setPictureInPictureListener	设置画中画的监听器。
enablePictureInPicture	启用 iOS 的自动画中画模式（App 切后台时自动开启）。
disablePictureInPicture	关闭 iOS 的自动画中画模式。

回调

方法	说明
onError	播放器错误信息回调，播放器出现错误时，触发回调。
onFirstVideoFrameRender	视频首帧渲染事件回调。视频首帧渲染成功，或播放过程中发生重试，重试后的第一个视频帧渲染成功，均会触发此回调。
onFirstAudioFrameRender	音频首帧渲染事件回调。音频首帧渲染成功，或播放过程中发生重试，重试后的第一个音频帧渲染成功，均会触发此回调。
onStallStart	播放卡顿开始回调。
onStallEnd	播放卡顿结束回调。音频缓冲区达到起播条件且开始播放后，触发此回调。
onVideoRenderStall	视频渲染卡顿回调。视频渲染发生卡顿时，触发此回调。
onAudioRenderStall	音频渲染卡顿回调。音频渲染发生卡顿时，触发此回调。
onResolutionSwitch	清晰度档位变化回调。
onVideoSizeChanged	视频分辨率变化回调。视频大小发生变化时，触发回调。
onReceiveSeiMessage	SEI 信息回调。当播放器 SDK 接收到 SEI 信息时，触发回调。
onMainBackupSwitch	主备流切换回调。
onPlayerStatusUpdate	播放状态发生变化时，触发回调。
onStatistics	播放信息周期性回调。播放器 SDK 会周期性地回调本方法，您可以通过本方法获取当前播放器的播放地址、码率和帧率等信息。
onSnapshotComplete	截图成功回调。当播放器调用 snapshot 截图成功后，会触发此回调。
onRenderVideoFrame	视频帧回调。调用 enableVideoFrameObserver 开启视频帧解析回调后，当播放器成功解码视频帧时，会触发此回调。
onRenderAudioFrame	音频帧回调。调用 enableAudioFrameObserver 开启音频帧解析回调后，当播放器成功解码音频帧时，会触发此回调。
onStreamFailedOpenSuperResolution	超分开启失败。调用 setEnableSuperResolution 开启超分后，当播放器不支持超分开启或者超分处理出错时，会触发此回调。
onStartPictureInPicture	用于监听画中画启动的回调。可以在其中处理 UI 状态更新或埋点逻辑。
onStopPictureInPicture	用于监听画中画退出的回调。当用户手动关闭画中画或应用主动退出时触发。
onClickPictureInPicture	用于监听画中画窗口被点击的回调，适用于响应用户交互。
onError	用于监听画中画发生错误的回调，可用于错误上报或兜底处理。

最近更新时间：2025.05.19 16:05:41

这个页面对您有帮助吗？

有用

无用