中文
登录
后可查看全部文档
成长工具/短剧SDK/短剧SDK接入iOS/获取短剧信息(接口)
获取短剧信息(接口)
最近更新 2024-05-31 11:30:18


简介

该接口会返回短剧列表信息,进入到播放页后,每次播放前都会有回调获取播放权限,由开发者决定是否完成变现行为后,继续短剧的播放。

注意:短剧内容库是持续实时更新的,不定期会有短剧上新或下线,为了保证更好的使用效果,开发者应实时请求接口获取短剧信息,不要自行存储短剧封面、分类等内容,再做页面渲染。否则可能会出现某部短剧页面渲染了,但实际该短剧已下线无法播放的情况,影响用户体验。

如果您自行渲染页面,可参考以下方式做产品设计: 人工在服务端配置聚合页/列表页的短剧排序。在页面加载时,实时请求接口拉取物料进行页面渲染;如拉取失败,则不展示该短剧,顺位展示下个短剧。避免因短剧下线影响线上展示/播放。

一、接口

1、接口说明

1.1 DJXPlayletManager

  • shareInstance为DJXPlayletManager的单例对象
  • DJXPlayletConfig为进入播放页的参数,进入播放页后需要切集可以使用setCurrentPlayletEpisode方法,详情页的配置及监听回调请参考短剧SDK->短剧播放页配置模块,包括 ① 短剧详情页配置参数DJXPlayletConfig;② 广告回调 DJXPlayletAdvertProtocol、播放器回调DJXPlayletPlayerProtocol;③ 激励解锁交互回调 DJXPlayletInterfaceProtocol等说明
复制

1.2 DJXPlayletInfoModel

  • requestAllPlayletList和requestPlayletListWithPlayletId接口返回的列表中为此类型对象
  • DJXPlayletInfoModel里面包含的关于各个短剧的信息
复制

二、最佳实践

  • requestAll:无需多余参数,请求全量的短剧列表,返回数组中类型为DJXPlayletInfoModel
  • requestWithList:需要传入需要请求的短剧id数组,请求传入id的短剧信息

详情页的配置及监听回调请参考短剧SDK->短剧播放页配置模块,包括 ① 短剧详情页配置参数DJXPlayletConfig;② 广告回调 DJXPlayletAdvertProtocol、播放器回调DJXPlayletPlayerProtocol;③ 激励解锁交互回调 DJXPlayletInterfaceProtocol等说明

复制


本篇目录
联系我们