中文
登录
后可查看全部文档
成长工具/内容输出/内容输出对接文档/内容输出接入_iOS静态库/短剧/短剧
短剧
最近更新 2023-08-15 14:29:36


短剧接入

短剧可以提供给用户竖版短视频场景下的看剧体验。接入方式分为封装形式和接口形式,封装形式包含了聚合页和广告部分,由聚合页来完成变现;接口形式提供给开发者短剧列表接口和播放功能,变现部分由开发者实现。

如果开发者的APP没接过小视频,请参考接入指南 平台接入文档,实现小视频SDK初始化等功能,然后再实现短剧产品的功能

1. 封装方式接入

该功能封装了短剧聚合页,开发者只需接入聚合页控制器,就可以在自己app的点击式入口,tab入口等任意地方接入短剧内容,商业变现在聚合页和播放页内部完成。

1.1 接口

1.1.1 接口说明

LCDPlayletAggregatePageViewController

  • LCDPlayletAggregatePageViewController用来初始化聚合页,LCDPlayletAggregatePageVCConfig为初始化参数
  • isShowNavigationItemBackButton和isShowNavigationItemTitle控制导航栏返回按钮的元素是否展示
  • topSkitId用来控制热门推荐的栏目中的第一个剧展示哪部(4600版本废弃)
  • freeEpisodesCount和unlockEpisodesCountUsingAD控制初始解锁的剧集和每次看广告解锁的集数(4600版本废弃)
  • 4600版本删除三个delegate和一些可选参数,放到新增的playletConfig方法中
复制

1.1.2. 代码示例

复制

1.2. 回调

1.2.1 回调说明

播放器回调 LCDPlayletPlayerProtocol
  • 播放器回调中会返回短剧播放器的各个阶段,开发者根据播放状态进行相应的逻辑处理
  • LCDPlayletConfig会携带当前播放的剧集信息
复制


广告回调 LCDPlayletAdvertProtocol
  • 广告回调中会返回广告的各个阶段,开发者根据广告的状态进行相应的逻辑处理
  • LCDAdTrackEvent会携带当前播放的广告信息
复制

2. 接口方式接入

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

2.1 接口

2.1.1 接口说明

LCDPlayletManager
  • interfaceDelegate为广告行为回调,playerDelegate为播放器回调,adDelegate为广告回调
  • shareInstance为LCDPlayletManager的单例对象
  • 短剧全部列表 requestAllPlayletList变更为requestAllPlayletListWithOrder方法,增加order参数,支持正序/倒序获取
复制



LCDPlayletConfig
  • infoModel为短剧信息对象,通过接口获取的playletList为此对象
  • episode为集数,用来控制跳转到短剧的第几集
  • fromTopMargin为可选参数,fromTopMargin用来控制右上角来源信息的上边距,防止遮挡
  • playletMode表示接入模式,此参数影响后续网络请求
  • skitId表示短剧的id,用来跳转一部剧的播放页
  • 其他可选参数详见下方说明
复制
LCDPlayletInfoModel
  • requestAllPlayletList和requestPlayletListWithPlayletId接口返回的列表中为此类型对象
  • LCDPlayletInfoModel里面包含的关于各个短剧的信息
复制

2.1.2 代码示例

  • requestAll:无需多余参数,请求全量的短剧列表,返回数组中类型为LCDPlayletInfoConfig
  • requestWithList:需要传入需要请求的短剧id数组,请求传入id的短剧信息
  • enterPlayer:进入一个播放页,需要构建一个LCDPlayletConfig对象,episode为进入的集数,infoModel为上述两个接口中返回的短剧信息对象LCDPlayletInfoConfig
复制

2.2 回调

2.2.1 回调说明

播放器回调 LCDPlayletPlayerProtocol
  • 播放器回调中会返回短剧播放器的各个阶段,开发者根据播放状态进行相应的逻辑处理
  • LCDPlayletConfig会携带当前播放的剧集信息
复制
广告回调 LCDPlayletInterfaceProtocol
  • 此回调为开发者通过接口接入,需要处理广告时的必要回调
  • 每一集播放前会通过isNeedBlock接口查询接入方能否播放该集,return NO则继续播放,return YES则会触发下一个回调
  • showAdIfNeeded在上一个回调return NO时调用,开发者可以在此回调中处理广告行为,处理结束时调用completeHandler通知sdk,play参数控制是否继续播放
  • 【4600版本新增】LCDPlayletInterfaceProtocol回调,在接口模式下,点击混排或聚合页时需要跳转时回调
  • 【4600版本新增】LCDPlayletAdvertProtocol回调,在封装模式下,激励视频结果和跳过的回调
复制
短剧详情页配置 LCDPlayletDetailCellDelegate(4902新增)
  • 此回调为开发者通过接口接入,支持开发者在短剧详情页自定义View
复制

2.2.2 回调示例

广告回调

复制

3. 短剧混排

3.1 接口

3.1.1 接口说明

使用小视频的接入方式,LCDDrawVideoViewController类来构造一个控制器,短剧混排也区分为接口形式接入和封装形式接入,接入方式playletMode来区分,LCDPlayletModeOptions_Interface为接口形式,LCDPlayletModeOptions_Package为封装形式。

3.1.2 代码示例

复制
复制


3.2 回调

3.2.1 回调说明

与上面短剧回调相同,接口形式遵守LCDPlayletPlayerProtocol和LCDPlayletAdvertProtocol协议;封装形式遵守LCDPlayletPlayerProtocol和LCDPlayletInterfaceProtocol协议;通过LCDPlayletManager设置对应的delegate

3.2.2 回调示例

复制

4. 短剧卡片

创建卡片LCDPlayletCard,卡片的配置LCDPlayletCardConfig,以及相应的回调LCDPlayletCardDelegate

从卡片进入短剧需要传入LCDPlayletConfig的两个参数entranceTypegroupId

复制

附录

通用接口配置

建议回传用户信息,方便后续内容分发和优化策略下发

复制



本篇目录
联系我们