English
Log In
You can then view all documents
成长工具/内容输出/内容SDK/常见问题&排查指南/短剧功能配置
短剧功能配置
Last updated 2025-03-20 10:55:34

1.聚合页

功能配置项

示例

Android

iOS

「换一换」功能

Android实现

iOS实现

禁止开启换一换(默认展示):DJXWidgetDramaHomeParams#showChangeBtn

暂不支持


「标题栏+返回按钮」显隐


  • 是否展示标题栏(默认展示):DJXWidgetDramaHomeParams#showPageTitle
  • 是否展示返回按钮(默认展示):不展示标题栏时不生效DJXWidgetDramaHomeParams#showBackBtn
  • 是否展示标题栏(默认展示):由返回按钮和标题栏共同控制
    • 是否展示返回按钮:DJXPlayletConfig#isShowNavigationItemBackButton
    • 是否展示标题:DJXPlayletConfig#isShowNavigationItemTitle

置顶短剧


置顶短剧(可多个):DJXWidgetDramaHomeParams#topDramaId

置顶短剧(可多个):DJXPlayletAggregatePageVCConfig#topSkitIds

顶部偏移量

聚合页顶部偏移量:DJXWidgetDramaHomeParams#setTopOffset

聚合页顶部偏移量:DJXPlayletAggregatePageVCConfig#marginTop

自定义聚合页(搜索/分类)

SDK封装的聚合页不支持调整,开发者可以根据提供的接口自定义短剧聚合页,详细请参考>>>

SDK封装的聚合页不支持调整,开发者可以根据提供的接口自定义短剧聚合页,详细请参考>>>

2. 滑滑流

功能配置项

示例

Android

iOS

「短剧顶部信息」配置


Android实现

iOS实现


  1. 滑滑流频道设置
    1. 滑滑流频道(默认显示推荐频道):DJXWidgetDrawParams#drawChannelType
      1. 推荐:DJXWidgetDrawParams.DRAW_CHANNEL_TYPE_RECOMMEND
      2. 剧场:DJXWidgetDrawParams.DRAW_CHANNEL_TYPE_THEATER
      3. 推荐+剧场:DJXWidgetDrawParams.DRAW_CHANNEL_TYPE_RECOMMEND_THEATER
    2. 隐藏频道名称(展示一个频道才生效,如推荐+剧场两个频道不生效):DJXWidgetDrawParams#hideChannelName
    3. 频道名称(只有当个性化推荐开关关闭时才生效):DJXWidgetDrawParams#customCategory
    4. 设置标题栏间距
  1. 左上角返回按钮显隐(默认显示):DJXWidgetDrawParams#hideClose
  1. 滑滑流频道设置
    1. 滑滑流频道(默认全部展示): DJXDrawVideoVCConfig#drawVCTabOptions
      1. 推荐:DJXDrawVideoVCTabOptions_playlet_feed
      2. 剧场:DJXDrawVideoVCTabOptions_theater
      3. 推荐+剧场(可切换的两个tab):DJXDrawVideoVCTabOptions_playlet_feed | DJXDrawVideoVCTabOptions_theater
    2. 隐藏频道名称(仅有一个tab时这个开关才生效,如同时设置展示推荐和剧场页两个频道不生效):DJXDrawVideoVCConfig#shouldHideTabBarView
    3. 设置滑滑流频道名称(只有当个性化推荐开关关闭时生效):DJXDrawVideoVCConfig#recommandTabName
      1. recommandTabName只有在首次初始化时赋值会生效,运行后无法修改(当前iOS SDK存在bug关闭推荐也无法修改title)
      2. 关闭个性化推荐开关:[DJXManager setPersonalizationRecommendation:NO]
  1. 左上角关闭按钮显隐(默认不展示):DJXDrawVideoVCConfig#showCloseButton

置顶短剧

  1. 置顶短剧:DJXWidgetDrawParams#topDramaId
  1. 置顶短剧:DJXDrawVideoVCConfig#topSkitId

「短剧底部信息」配置

  1. 隐藏底部信息(默认显示):
    1. 底部标题信息:DJXWidgetDrawParams#hideDramaInfo
    2. 下一集入口:DJXWidgetDrawParams#hideDramaEnter
  1. 设置标题栏间距
  1. 播放进度条
    1. 修改进度条样式:DJXWidgetDrawParams#progressBarStyle
    2. 不支持隐藏进度条
  1. 隐藏底部跳转区域(标题+下一集入口):DJXDrawVideoVCConfig#hiddenPlayletEnterView
  1. 播放进度条
    1. 修改进度条样式(进度条样式目前只有深色与浅色两种):DJXDrawVideoVCConfig#progressBarStyle
    2. 进度条距离底部边距(外流:滑滑流、 内流:播放详情页)
    3. 不支持隐藏进度条


「点赞+收藏」按钮显隐

  1. 点赞按钮隐藏:DJXWidgetDrawParams#hideLikeButton
  2. 禁止双击点赞:DJXWidgetDrawParams#hideDoubleClickLike
  3. 收藏按钮隐藏:DJXWidgetDrawParams#hideFavorButton
  1. 点赞按钮隐藏:DJXDrawVideoVCConfig#hideLikeIcon
  2. 禁止双击点赞:DJXDrawVideoVCConfig#disableDoubleClickLike
  3. 收藏按钮隐藏:DJXDrawVideoVCConfig#hideCollectIcon

添加自定义View

  1. 自定义view(会随着短剧滑动而滑动):DJXWidgetDrawParams#listener(IDJXDramaListener),实现createCustomView方法并返回自定义view
  1. 自定义view(会随着短剧滑动而滑动):签署DJXDrawVideoCellAddSubviewDelegate协议,调用DJXWidgetDrawParams#drawVideoCellAddSubviewDelegate,实现以下方法返回自定义view

特别注意:自定义滑滑流cell和自定义详情页cell是两个不同的delegate,若从滑滑流跳转到的详情页的情况下

  • SDK广告:可以将滑滑流的drawVideoCellAddSubviewDelegate与详情页的customViewDelegate一同签署实现。
  • 自定义广告:在自行初始化详情页时,为其签署customViewDelegate并实现,滑滑流签署则会无效

添加Draw广告

/

滑滑流不支持,详情页支持(详见详情页插入draw广告)

滑滑流不支持,详情页支持(详见详情页插入draw广告)

添加底部Banner

  1. 插入banner广告:实现DJXDramaDetailConfig.adCustomProvider()
    1. getDrawBoxAdBannerView返回开发者自行请求的banner广告view
  1. 插入banner广告:签署DJXDrawVideoViewControllerBannerDelegate协议,调用DJXWidgetDrawParams#bannerDelegate,实现drawVideoVCBottomBannerView方法返回Banner视图(设置banner时只需要配置宽高即可)

需要注意,详情页与滑滑流的自定义banner所用的delegate是不同的,详见详情页banner使用方法。

设置起播水位

/

  1. 设置起播进度(参数单位为毫秒,如20000->20s):IDJXWidget#seekTo


  1. 设置起播进度(参数单位为毫秒,如20000->20s):DJXDrawVideoViewController#seekVideoToMSeconds

额外注意:seekVideoToMSeconds方法目前iOS SDK存在bug,无法生效,会在下个版本进行修复。

播放器回调


/

  1. 播放器回调:调用DJXWidgetDrawParams#listener实现播放器回调,视频播放回调中开发者可以获取到短剧内容,开发者可根据此回调返回内容进行自定义UI的绘制工作。

播放器回调

播放器回调返回的短剧内容

  1. 播放器回调:签署DJXPlayletPlayerProtocol协议,调用playconfig#playerDelegate,实现播放器回调,视频播放回调中开发者可以获取到短剧内容,开发者可根据此回调返回内容进行自定义UI的绘制工作。

播放器回调

播放器回调返回的短剧内容

特别注意:

  • SDK广告:如果是从滑滑流进入并且签署了该协议,那么滑滑流和详情页都会由这个回调返回数据,注意区分。
  • 自定义广告:详情页需要再度签署代理才会获取到回调,与详情页的回调相互独立。

3. 播放详情页

功能配置项

示例

Android

iOS

选集面板

  1. 打开默认选集面板:IDJXWidget#openDramaGallery
  1. 自定义选集面板:开发者需要通过自定义view实现,点击具体item后调用setCurrentDramaIndex跳转到指定集数
  1. 打开默认选集面板:DJXDrawVideoViewController#chooseEpisode
  1. 自定义选集面板:开发者需要通过自定义view实现,点击具体item后调用setCurrentPlayletEpisode跳转到指定集数

详情页「更多」配置




Android实现


  1. 打开更多弹窗(包括举报等功能):IDJXWidget#openMoreDialog
  1. 隐藏更多按钮:IDJXWidget#hideMore
  1. 自定义「更多-举报页」DJXDramaDetailConfig#setCustomReport
  1. 打开更多弹窗(包括举报等功能):目前未暴露相关接口
  2. 隐藏更多按钮(仅在详情页会生效):DJXPlayletConfig#hideMoreButton
  1. 自定义「更多-举报页」:暂不支持



「详情页view」显隐

  1. 返回按钮显隐DJXDramaDetailConfig#hideBack
  1. 顶部信息(集数)显隐DJXDramaDetailConfig#hideTopInfo
  1. 底部信息显隐DJXDramaDetailConfig#hideBottomInfo
  1. SDK封装解锁弹窗隐藏(隐藏后直接看广告或在start自定义解锁弹窗):DJXDramaDetailConfig#hideRewardDialog
  1. 返回按钮显隐:DJXPlayletConfig#hideBackButton
  1. 顶部信息(集数)显隐:DJXPlayletConfig#hideTopInfo
  1. 底部信息显隐:DJXPlayletConfig#hideBottomInfo
  1. SDK封装解锁弹窗隐藏(隐藏后直接看广告或在start开始解锁链自定义解锁弹窗):DJXPlayletConfig#hideRewardDialog

「点赞+收藏」按钮显隐

  1. 点赞按钮显隐:DJXDramaDetailConfig#hideLikeButton
  2. 收藏按钮显隐:DJXDramaDetailConfig#hideFavorButton
  3. 禁止双击点赞:DJXDramaDetailConfig#hideDoubleClick
  1. 点赞按钮显隐:DJXPlayletConfig#hideLikeIcon
  2. 收藏按钮显隐:DJXPlayletConfig#hideCollectIcon
  3. 禁止双击点赞DJXPlayletConfig#disableDoubleClickLike

「详情页view」调整间距


  1. 短剧底部信息(标题文案、进度条、选集面板)距离底部边距DJXWidgetDrawParams#setBottomOffset
  1. 短剧来源(改编小说)提示文案顶部间距:DJXDramaDetailConfig#setScriptTipsTopMargin
  1. 短剧顶部信息(标题、返回按钮、更多按钮)距离顶部距离:DJXDramaDetailConfig#setTopOffset
  1. 备案号下边距调整:DJXDramaDetailConfig#setIcpTipsBottomMargin
  1. 短剧底部信息(标题文案、进度条、选集面板)距离底部边距:暂不支持调整
  2. 短剧来源上边距:DJXPlayletConfig#fromTopMargin
  1. 短剧顶部信息(标题、返回按钮、更多按钮)距离顶部距离:暂不支持调整
  2. 备案号下边距调整:暂不支持调整

无限下滑

(一部剧播完会播下一部剧)

/


  1. 无限下滑(默认开启):DJXDramaDetailConfig#infiniteScrollEnabled
  1. 无限下滑(默认开启):DJXPlayletConfig#closeInfiniteScroll

添加自定义View

  1. 自定义view(会随着短剧滑动而滑动):DJXWidgetDrawParams#listener(IDJXDramaListener),实现createCustomView方法返回自定义view
  1. 添加全局view(盖在详情页上面,不会随着短剧滑动而滑动):开发者直接在播放详情页自行调整布局即可
  1. 自定义view(会随着短剧滑动而滑动):签署DJXPlayletDetailCellDelegate协议,调用DJXWidgetDrawParams#customViewDelegate,实现以下方法自定义view

特别注意:

  • SDK广告:可以将滑滑流的drawVideoCellAddSubviewDelegate与详情页的customViewDelegate一同签署实现
  • 自定义广告:需要在自行初始化详情页时,为其签署customViewDelegate并实现,滑滑流签署则会无效

添加Draw广告

插入draw


插入banner


Android实现


  1. 插入draw广告(效果为滑动视频时,会在指定的index处划出全屏的广告):实现DJXDramaDetailConfig.adCustomProvider()
    1. getDetailDrawAdPositions:插入位置:支持开发者透传位置数组,数组值表示随后插入一条广告(如2则在2之后插入一条)
    2. getDetailAdDrawView:返回开发者自行请求的draw广告view


  1. 插入draw广告(效果为滑动视频时,会在指定的index处划出全屏的广告):签署DJXShortplayDetailDrawAdDelegate协议
    1. playletConfig.customDrawAdViewDelegate = self; 返回开发者自行请求的draw广告view
    2. playletConfig.customAdIndex = self.customAdIndex; 标识在第几集后面插入自定义Draw广告

添加底部Banner

  1. 插入banner广告:JXDramaDetailConfig.adCustomProvider()
    1. getDetailAdBannerView返回开发者自行请求的banner广告view


  1. 插入banner广告:通过签署DJXDrawVideoViewControllerBannerDelegate协议,调用playletConfig.interfaceDelegate ,实现playletDetailBottomBanner方法并返回Banner视图(设置banner时只需要配置宽高即可)

滑滑流与详情页的banner使用的不是一个delegate

滑滑流底部banner需要签署bannerDelegate

详情页的底部banner需要签署interfaceDelegate

设置起播水位



  1. 设置起播进度(参数单位为毫秒,如20000->20s):IDJXWidget#seekTo使用同滑滑流页面。
    1. 详情页面设置起播时间,需要拿到详情页实例,如直接创建的详情页实例,则可直接使用,如创建的滑滑流实例页面,需要配置为“自定义广告”,实现setEnterDelegate自行创建并获取详情页实例。
  1. 设置起播进度(参数单位为毫秒,如20000->20s):DJXDrawVideoViewController#seekVideoToMSeconds
    1. 额外注意:seekVideoToMSeconds方法目前iOS SDK存在bug,无法生效,会在下个版本进行修复。使用同滑滑流页面。
    2. 详情页面想要设置起播时间,需要拿到详情页实例,如直接创建的详情页实例可直接使用,如创建的滑滑流实例页面,需要配置为“自定义广告”,实现clickEnterView自行创建并获取详情页实例。

播放器回调


同滑滑流页面

同滑滑流页面

4. 隐私开关

功能配置项

Android

iOS

备案号

备案号:

  1. 聚合页和滑滑流出只有备案号的短剧内容:V2600+初始化时设置isOnlyICPNumber为true

特别注意:若同时接入了短剧和短故事djxholder和novholder都要设置isOnlyIcpnumber接口,否则会存在覆盖不生效的问题

  1. 通过接口请求短剧信息:可以通过icpNumber判断是否有备案号返回
复制

青少年模式


青少年模式(默认不开启):在SDK初始化注册的时候设置isTeenagerMode

特别注意:关闭不返回短剧内容

复制

青少年模式(默认不开启):在SDK初始化注册的时候签署authorityDelegate协议,然后在当前协议页面返回对应的开关值即可

特别注意:关闭不返回短剧内容

复制

设备号获取开关

Androidid和oaid开关:如下说明

更多开关请参考:https://www.csjplatform.com/supportcenter/28147

复制

idfa开关:在SDK初始化注册的时候签署authorityDelegate协议,然后在当前协议页面返回对应的开关值即可

更多开关请参考https://www.csjplatform.com/supportcenter/28165#o7wynw7gucg0

复制

个性化推荐

个性化开关:关闭个性化后就不走推荐算法了

个性化开关:关闭个性化后就不走推荐算法了

5. 登录与退出登录

如果未调用登录接口(Android、iOS),观看记录是和设备绑定的,如果调用登录,观看记录是和开发者传的用户uid绑定的

特别声明:退出登录仅删除本地存储的用户浏览记录,用户绑定其他内容需开发者自行处理。

6. 常见接口


android

ios

注释

收藏状态

DJXDrama#isfavor


DJXPlayletInfoModel#favorite_state

android和iOS同一个账户 收藏列表不一致?

因为ios和Android在用户侧是同一个app,但是在平台上是两个不同的app,应用ID也不一样,相关请求平台无法识别,即使同一个用户账号在双端的收藏列表是不会同步的。

用户想自定义收藏与点赞等功能,需隐藏原先点赞收藏,自定义view并自行维护逻辑。

长按倍速

https://www.csjplatform.com/supportcenter/28478

https://www.csjplatform.com/supportcenter/28478


解锁状态

IDJXService#getEpisodesStatus

DJXPlayletManager#requestPlayletDetailsUnlockInfo


短剧分类

IDJXService#requestDramaCategoryList

DJXPlayletManager#requestCategoryPlayletLisWithCategory


搜索


IDJXService#searchDrama

DJXPlayletManager#requestCategoryPlayletLisWithSearchWord

目前不支持分页查询,page和count没有用,且page需要传<= 1 的值,否则会返回空

短剧等级

DJXDrama#levelLabel

DJXPlayletInfoModel#level_label


暂无获取短剧热度接口,开发者可以根据短剧对象获取短剧等级标签(1:S级、2:A级、3:B级),将高潜短剧靠前展示

播放进度


Android:设置播放监听litener,监听onDurationChange自行记录播放进度

iOS:签署DJXPlayletPlayerProtocol协议,监听drawVideo自行记录播放进度

7. 错误码

错误码

错误说明

04010

传入的时间戳不在前后一小时内,需确认是否有手动修改设备时间

04023

"sha1不匹配",确认报名和签名md5和穿山甲平台的是否一致,如果是测试环境,debug和release环境可以使用同一个签名

04005

未查到短剧,短剧已下线,开发者需实时请求短剧信息

04013

用户不可绑定过多设备,一个用户只能绑定8个设备


Contents
Contact us