保利威文档中心

帮助中心

播放器模块

更新时间:2026-07-17 15:16:39

播放器模块(player) 主要负责播放器相关的 Api。

一、Api 方法概览

Api 方法 说明
getPlayerInfo 获取播放器信息
setupPlayer 创建播放器
supportLiveTimeShift 是否支持直播时移
supportTimeAxisMark 是否支持时间轴标记
supportLowLatency 是否支持无延迟观看
play 恢复视频播放
freezePlay 冻结视频播放
pause 暂停视频播放
stop 停止拉流
supportRefresh 是否支持刷新
refresh 刷新直播流
setVolume 设置视频音量
getCurrentVolume 获取视频音量
addBarrage 添加弹幕
setBarrageShow 设置弹幕显示状态
supportBarrageSpeed 是否支持弹幕速度切换
setBarrageSpeed 切换弹幕速度
supportBarrageSize 是否支持弹幕字号切换
setBarrageSize 切换弹幕字号
supportBarrageLocation 是否支持弹幕位置切换
getBarrageLocationSetting 获取弹幕位置信息
setBarrageLocation 切换弹幕位置
supportBarrageAlpha 是否支持弹幕透明度切换
setBarrageAlpha 切换弹幕透明度
resizeBarrage 更新弹幕显示区域
getLineCount 获取线路总数
changeLine 切换线路
getCurrentLine 获取当前线路
changeSubtitleSkinShow 改变实时字幕播放器的开关展示
getQualityLevels 获取可选的清晰度级别
changeQualityLevel 切换清晰度级别
getCurrentQualityLevel 获取播放器清晰度级别
getRateList 获取可选的倍速列表
changeRate 切换倍速
getCurrentRate 获取播放器倍速
getCurrentTime 获取回放播放时间
getDurationTime 获取回放播放总时长
seekVideo 设置播放进度
supportPlaybackVideo 是否支持回放视频
getAutoChangePlaybackEnabled 是否能自动切回放
changePlayback 切换回放
getPlayerSetting 获取播放器设置
getPlayerLogoSetting 获取播放器 logo 设置
getPlayerWarmUpSetting 获取播放器暖场设置信息
setPlayerReplaySubtitleSelectConfig 更新播放器回放字幕选择组件的文案和显示状态
setGestureDirection 设置手势 seek 方向
destroyPlayer 销毁播放器
getPIPEnabled 获取"是否开启画中画功能"
getPIPForIOSEnabled 获取"是否开启IOS系统画中画功能"
getPcPIPEnabled 获取"PC端是否开启小窗播放功能"
supportPictureInPicture 当前播放器是否支持画中画
getPictureInPictureStatus 获取画中画状态
enterPictureInPicture 进入画中画
leavePictureInPicture 退出画中画
togglePictureInPicture 切换画中画
switchDetectionByInfo 执行缓冲监测切换线路/清晰度
getLiveStreamCaptureUrl 获取直播截图地址
getPlayerAdvertLinkData 获取播放器广告链接数据
exitWebPageFullScreen 退出网页全屏, 仅点播播放器移动端和直播播放器移动端支持
requestFullscreen 进入系统全屏
exitFullscreen 退出系统全屏
toggleFullscreen 切换系统全屏
getFullscreenStatus 获取系统全屏状态
supportFullscreen 当前播放器是否支持系统全屏

二、Event 事件概览

Event 事件 说明
PlayerEvents.PlayerInfoChange 播放器信息修改事件
PlayerEvents.PlayerWarmUpSettingChange 播放器暖场信息更新
PlayerEvents.PlayerConfigLoaded 播放器配置信息加载成功
PlayerEvents.PlayerInited 播放器初始化完毕
PlayerEvents.PlayerScriptLoaded 播放器脚本加载完成
PlayerEvents.PlayerPlaying 播放器播放事件
PlayerEvents.PlayerPause 播放器暂停事件
PlayerEvents.VolumeChange 音量改变
PlayerEvents.LineChange 线路切换
PlayerEvents.QualityLevelChange 清晰度级别切换
PlayerEvents.RateChange 倍速修改
PlayerEvents.BarrageStatusChange 播放器弹幕改变
PlayerEvents.BarrageSettingClick 调起弹幕设置弹窗
PlayerEvents.TimeUpdate 播放时间改变
PlayerEvents.PlaybackOver 回放播放结束
PlayerEvents.HistoryPlay 回放续播事件
PlayerEvents.LowLatencyError 无延迟播放异常
PlayerEvents.ToggleFullScreen 切换播放器全屏
PlayerEvents.PlayerMarqueeError 防录屏跑马灯异常
PlayerEvents.PlayerTimeAxisMarkListChange 播放器打点信息改变
PlayerEvents.PlayerHighlightsBtnClicked 播放器"精彩看点"按钮点击事件
PlayerEvents.PlayerSubtitleSwitched 播放器"实时字幕"切换按钮切换
PlayerEvents.PlayerUIControlDisplay 播放器 UI 控制栏显隐事件
PlayerEvents.PlayerLoading 移动端播放器Loading显示隐藏事件
PlayerEvents.PlayerUIReplaySubtitleChecked 回放字幕开启和关闭指定的字幕
PlayerEvents.PlayerUIReplaySubtitleSelectBtnClick 移动端播放器点击字幕的选择器时触发
PlayerEvents.PlayerSetupPanelSkinInit 移动端播放器设置面板皮肤初始化事件
PlayerEvents.PlayerHeadAdClicked 移动端播放器头部广告点击事件
PlayerEvents.PlayerStopAdClicked 移动端播放器暂停广告点击事件
PlayerEvents.PlayerStatisticsInfo 移动端播放器统计信息
PlayerEvents.PlayerInnerTimeUpdate 播放器内部时间更新事件
PlayerEvents.PlayerSetupPanelChange 移动端播放器设置面板改变事件
PlayerEvents.PlayerLoadingDetectionUpdate 播放缓冲状态监测更新事件
PlayerEvents.PlayerFullscreenChange 播放器全屏状态改变事件
PlayerEvents.GuideStreamVideoSizeChange 导播台推流分辨率调整事件
PlayerEvents.VodPlayerServerError 点播播放器server error事件
PlayerEvents.LivePlayerError 直播播放器s2j_onPlayerError事件
PlayerEvents.EnterPictureInPicture 进入画中画
PlayerEvents.LeavePictureInPicture 退出画中画
联系客服,在线咨询