中文
登录
后可查看全部文档
成长工具/小视频SDK/小视频SDK对接文档/小视频SDK接入_Android /集成文档
集成文档
最近更新 2024-06-06 18:40:45

一、SDK接入

1、依赖说明

1.1 安卓sdk依赖

小视频SDK支持安卓版本:21~29

依赖安卓内部库:support-v4,建议版本:24以上

依赖安卓内部库:recyclerview-v7,建议版本:24以上

如果接入小视频3100、3200版本需要依赖安卓内部库:constraint-layout,指定版本:1.1.2,具体方式如下(androidx和support根据具体使用环境使用其中一个即可):

复制

1.2 外部库依赖

小视频SDK需要依赖两个外部库:

  1. RangersAppLog:日志上报(通过Maven接入小视频SDK时会自动引入,开发者无需手动引入),赋能370x及异常版本SDK内部已处理相关逻辑,开发者不需要特殊处理;
  2. 穿山甲SDK:商业化变现(具体接入详见官方接入文档),① 穿山甲广告SDK需要开发者参考平台接入文档进行手动接入;② 小视频SDK依赖穿山甲SDK中的广告功能进行变现,两者是独立的两个SDK

注: 如果您已经通过其他途径接入过这两个库无需重复申请和接入。

重要:

请自查是否单独申请过火山引擎平台的appid/单独接入过applog,若其他业务侧生成的appid和穿山甲侧不同,开发者可以自行处理applog相关逻辑;

② 若开发者有接入穿山甲赋能输出其他方向,需确保其初始化时机早于小视频SDK,否则会导致小视频SDK不能正常工作&媒体自己的埋点失效

使用 Applog.init(Context, InitConfig) 初始化 applog

③ 若开发者没有以上两种使用场景,即只接入小视频SDK,则不需要单独初始化applog强烈建议自行接入applog的媒体升级到3901及以上版本具体详见下面的1.3初始化SDK;


1.3 so库说明

小视频SDK内置点播相关的so库,只支持armeabi-v7a架构和arm64-v8a架构。

1.4 混淆说明

如果您接入了类似ResGuard的资源混淆框架,需要将对应sdk版本Demo中的keep_res_xxxx.txt中的资源都加入到这类框架的白名单中(xxxx为对应的赋能版本号),当前最新版本的keep_res.txt如下

keep_res_3700.txtkeep_res_3700.txt
1.06 KB

2、集成SDK

目前支持自动集成和手动集成两种方式,如果您使用Gradle编译,建议您使用自动接入方式配置库文件。

2.1 自动集成

打开project级别的build.gradle,添加如下两个仓库

复制

在app module的build.gradle文件的dependencies中添加:

复制

在Application的Module中添加命令依赖gradle脚本:

复制

AndroidManifest.xml配置:在app module的AndroidManifest.xml文件中添加:

复制

3、初始化SDK

重要1:小视频2600版本开始,新客户接入时需要从穿山甲平台获取配置文件,在成长工具->小视频->接入管理模块找到对应的应用,点击「下载SDK参数配置」,然后将JSON配置文件拷贝到项目的assets文件夹下。

重要2:开发者需要自行接入并初始化穿山甲SDK,并在穿山甲SDK初始化完成回调中初始化小视频SDK。一定要注意初始化顺序:

① 在穿山甲广告SDK初始化成功的回调中(InitCallback.success)初始化小视频SDK;

初始化成功的回调:穿山甲 5600 以下版本在 TTAdSdk.init() 方法中,5600 及以上版本在 TTAdSdk.start() 方法中

② 其他聚合 SDK 需自行判断穿山甲SDK初始化完成状态,在初始化成功后再初始化小视频SDK

复制

4、启动SDK服务

在用户同意隐私权限后,使用SDK具体场景(如创建沉浸式小视频),必须先调用init接口,然后调用start接口,并在start结果成功回调之后才能使用具体的场景功能启动,建议在较早的时间启动Sdk

方式如下:

复制

建议在创建具体业务前判断小视频SDK启动状态,如下(可参考demo具体使用方式)

复制

启动监听器用来监听SDK服务是否启动成功

  • isSuccess=true表示启动服务成功
  • 启动服务失败时,可以再次调用启动服务接口(建议最多不要超过3次)
复制

5、初始化配置参数说明

5.1 DPSdkConfig参数说明

复制

5.2 IDPPrivacyController参数说明

隐私信息控制开关

复制

5.3 IDPToastController参数说明

复制

5.4 DPUpdate说明(个性化开关)

复制

5.5 文章详情列表字体大小样式说明

复制

5.6 其他配置说明

  1. 建议在接入调试时打开setDebug(true),流媒体SDK会尽力帮您检查参数是否缺失,并给出toast提示
  2. 在使用小视频SDK时尽量保证已获取到权限:文件读写权限、read_phone权限
  3. 混淆配置已经打入aar中,不需要做额外处理
  4. so库支持的架构是armeabi-v7a和armeabi-v8a两种

二、SDK错误码

错误码

说明

-1

sdk默认值

-2

sdk数据解析异常

0

成功

1

access_token验证失败

22

缺少必要参数

26

接口请求过于频繁

999

未知错误

8000

小视频定制频道异常


三、常见问题

Q:接入版本号小于等于0911,开发者需自行添加混淆,否则影响日志上报。其他版本不需要添加 混淆规则:

复制

Q:系统自带fragment(android.app.Fragment)支持,要求版本不低于1.9.0.0

Q:使用androidx报错:Caused by: java.lang.ClassNotFoundException: Didn’t find class “androidx.swiperefreshlayout.widget.CircularProgressDrawable”,开发者在app级别的build.gradle下添加依赖

复制



本篇目录
联系我们