升级迁移
更新时间:2025-03-21 14:06:01
一、1.x 升级至 2.x
1.1 模块重命名
需要将 watchCore.subtitles 全部改成 watchCore.subtitle
1.2 Api 变更
聊天室模块(chat)拆分出表情模块(emotion),需要更改原本对应的 api,具体如下
watchCore.chat.getEmotionFaceDomList => watchCore.emotion.getEmotionFaceDomList
watchCore.chat.getEmotionFaceClickTarget => watchCore.emotion.getEmotionFaceClickTarget
watchCore.chat.getEmotionImages => watchCore.emotion.getEmotionImages
同时,拆分表情模块后,需要外部手动调用 watchCore.emotion.setupEmotionParser 来加载表情解析器
提问模块获取聊天历史的 api 也做了变化
watchCore.ask.getAskHistory => watchCore.ask.getAskHistoryByUserId
1.3 Api 废弃
以下的 api 在 1.x 和 0.x 版本虽然废弃,但还保留功能,但 2.x 已将对应的功能移除,请更改推荐变更的方法
watchCore.ask.sendQuestion => watchCore.ask.sendAskSpeak
watchCore.chat.getOnlineUserList => watchCore.chat.getOnlineUserListNew
watchCore.chat.setChatMsgReplayPlaybackTarget => watchCore.playback.setCurrentPlaybackTarget
另外,还有部分身份认证 api 在 2.0 版本废弃,后续也不再支持,如需使用用户系统,请联系保利威技术人员,接入统一授权 SDK
watchCore.identity.checkIdentityWxAuthwatchCore.identity.checkIdentityInfoLogin
1.4 业务影响
需要注意,2.0 版本增加了卡片推送重放,且默认开启,但会影响 currentPlaybackTarget.chatReplayEnabled 判断。如果您直接在 V1 版本配套的 UI 层升级,请改成 currentPlaybackTarget.chatMsgReplayEnabled
1.5 CDN 外链引入变更
1.x 外链引入时,需要使用以下的引入方式
<!-- 通过1.x版本号引入 -->
<script src="https://websdk.videocc.net/live-watch-sdk/{version}/lib/polyv-live-watch.umd.js"></script>
2.x 外链引入时,则需要使用以下的引入方式
<!-- 通过2.x版本号引入 -->
<script src="https://websdk.videocc.net/live-watch-sdk/{version}/lib/polyv-live-watch-sdk.umd.js"></script>
1.6 配套项目升级指南
- 如果您用的是 直播观看页开源项目 v1.11.0,那可以参考这条开源项目仓库里的这条 ui-1.x-with-sdk-2.x 分支 ,该分支提供了
开源项目 v1.11.0接入逻辑层SDK v2.0.0的示例,能够正常运行。但不再使用保利威用户体系 - 如果您用的是更早之前的开源项目版本,请先升级至
v1.11.0
