English
Log In
You can then view all documents
成长工具/内容输出/内容输出对接文档/内容输出接入_Android /短剧/短剧
短剧
Last updated 2023-08-15 14:29:21

短剧接入

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

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

1. 封装方式接入

1.1 加载聚合页Fragment

接入方可以调用DPSdk.factory().createDramaHome(DPWidgetDramaHomeParams.obtain())来获取fragment,将获取到的聚合页fragment放入到自己app中即可。

接口说明
1.1.1 获取组件工厂
复制
1.1.2 创建组件
复制
1.1.3 组件IDPWidget说明
复制
1.1.4 短剧详情页配置 DPDramaDetialConfig
复制
1.1.5 举报页自定义 IReportEnterDelegate(4601新增)
复制
1.1.6 组件参数DPWidgetDramaHomeParams说明
复制
1.1.7 聚合页监听器 IDPDramaHomeListener(4601新增)
复制
1.1.8 短剧埋点结构 DPDramaLog(4700新增)
复制


1.1.9 监听器IDPDramaListener说明

参考2.2..5

1.1.10 监听器IDPAdListener说明

参考2.2.6

2. 接口方式接入(参考DramaApiActivity和DramaApiDetailActivity)

demo入口 底部集合Tab -> 多媒体入口 -> 短剧 -> Api

2.1 获取短剧详情

  • 请求短剧详情

调用DPSdk.factory().requestAllDrama(page, count, callback)批量获取所有短剧详情

调用DPSdk.factory().requestDrama(dramaIds, callback)通过指定短剧id获取对应短剧详情

复制
  • 短剧详情数据接口说明:
复制

2.2 加载播放页Fragment

接入方可以调用DPSdk.factory().createDramaDetail(DPWidgetDramaDetailParams)来获取fragment,将获取到的聚合页fragment放入到自己app中即可。

接口说明
2.2.1 获取组件工厂
复制
2.2.2 创建组件
复制
2.2.3 组件IDPWidget说明
复制
2.2.4 组件参数DPWidgetDramaDetailParams说明
复制
2.2.5 监听器IDPDramaListener说明

短剧播放详情新增无限下滑功能,播放至短剧最后一集时继续上拉会切换新的短剧,并通过onDramaSwitch回调通知开发者(接口接入必须实现该回调)

复制
2.2.6 监听器IDPAdListener说明
复制

2.3 使用说明

开发者需要在短剧上实现自己的激励视频广告时,需要按照以下步骤进行设置:

  • 创建短剧Fragment
  • 实现IDPDramaListener.isNeedBlock回调判断是否需要解锁才能观看,如果需要阻塞视频播放,并返回true
  • 实现IDPDramaListener.showAdIfNeeded回调,实现广告展示逻辑,在广告奖励发放时,调用callback.onDramaRewardArrived进行短剧播放

3. 短剧混排接入(参考 DrawDramaActivity

3.1 获取短剧历史记录

复制

3.2 接口说明

3.2.1 创建组件

复制

3.2.2 组件参数 DPWidgetDrawParams 说明

复制

3.2.3 短剧配置 DPDramaDetailConfig 说明

设置短剧详情页模式,设置为非封装模式时必须实现IDramaDetailEnterDelegate

复制

3.2.4 短剧自建详情页启动接口 IDramaDetailEnterDelegate 说明  

开发者希望「短剧混排流」跳转「自建短剧详情页」时必须实现

复制

3.2.5 监听器IDPDrawListener

非短剧详情播放页的沉浸式流的监听回调

内流短剧详情页的回调通过IDPDramaListener回调,其余沉浸式场景回调通过IDPDrawListener回传给开发者

复制

3.2.6 监听器IDPDramaListener说明

同2.2.1.5短剧播放详情页的监听回调

3.2.7 监听器IDPAdListener说明

同2.2.1.6

3.3 代码示例

  DrawDramaActivity#initDrawWidget()

复制

4. 短剧卡片接入

获取短剧卡片接口

复制

4.1短剧卡片参数 DPWidgetDramaCardParams

复制

4.2 View 组件能力接口 IDPElement (4601新增)

复制


Contents
Contact us