English
Log In
You can then view all documents
内容输出/内容输出对接文档/内容输出接入_iOS动态库/集成文档
集成文档
Last updated 2022-11-21 17:45:51

集成文档

内容合作SDK以下简称LCDSDK,旨在把字节系的优质内容生态和算法能力输出给B端合作伙伴。

注:除以下通用配置之外,其他接入部分可以参考静态库的接入指南接入

iOS 14适配

  • 穿山甲请使用3.6.1.5及以上版本
  • RangersAppLog请使用5.6.6及以上版本
  • 适配过程请参考:穿山甲平台iOS 14适配

1. 运行环境支持

  • 支持系统 iOS 9.X 及以上;
  • SDK编译环境 Xcode 11及以上版本;
  • 支持架构: x86-64, i386, armv7, armv7s, arm64

2. 参数申请

若之前已接入字节其他SDK,可复用参数,并将之前使用的appid提供给穿山甲的技术支持同学进行配置; 若之前未接入,直接使用平台上生成的applog appid即可

3. 工程配置

内容合作SDK需要依赖以下七个库,请保证这些依赖库都正常接入,否则会出现接入失败的情况。

  • LCDSDK (LCDSDK.framework + LCDSDK.bundle 两个文件)
  • RangersAppLog SDK (仅支持cocoapods方式集成)
  • 穿山甲SDK(BUAdSDK.framework + BUCNAuxiliary.framework + BUFoundation.framework + BUAdSDK.bundle 四个文件)
  • RangersAPM SDK (仅支持cocoapods方式集成)

3.1 集成方式

建议使用CocoaPods的方式集成,会减少很多不必要的配置,接入成本最低。

3.1.1 CocoaPods方式接入

第一步:在工程的podfile中添加代码:

第二步:运行 pod install 命令安装SDK

运行 pod install 不会自动更新 repo,如果下载的不是最新版,可使用 pod install —repo-update 更新或先运行 pod repo update。

3.2 引入配置文件

无论是通过 Pod 方式还是手动将SDK引入工程之后,都需要配置。

image.png

在内容输出->内容管理模块找到需要接入短视频SDK的应用,点击"下载SDK参数配置",然后将SDK配置文件(例如 sdk_setting_file.json)拖拽到app工程内,并勾选[Copy items if needed]

确保Copy Bundle Resources中有对应的json配置文件

4. 初始化SDK

​ 请尽可能早的调用初始化方法,以便LCDSDK完成必要的初始化操作。

​ 初始化注册完成会返回注册成功失败的回调,触发回调最长超时时间为3s,一般情况下都会成功,如果收到失败回调,请重新初始化一次,否则会导致SDK的功能无法使用。注意不要造成一直重复循环初始化。

​ 建议在冷启动主线程中完成初始化注册。

​ ⚠️⚠️⚠️⚠️⚠️注意

​ 为了视频的播放体验,必须在AppDelegate的applicationDidBecomeActive:和applicationWillResignActive:中调用开始渲染和停止渲染方法(这两个方法不耗时)。不做这一步可能带来未知的黑屏或者crash。

​ 详细使用方法请参考samples下的AppDelegate。

5. 其他初始化接口

​ LCDSDK提供初始化类LCDManager,包含获取SDK的版本号和初始化注册的功能。

​ 初始化需要的LCDConfig类中有几个必传参数,传入上面申请的参数即可。注意:必传参数设置不对或者为空,都会导致SDK无法正常运行。

​ 值得注意的是customApplog属性。LCDSDK依赖AppLog完成日志上报,如果您的应用本身使用了AppLog并完成了初始化,这个属性请设置为YES,以免LCDSDK内部再次初始化AppLog对您的日志上报造成影响。如果您的应用本身不使用AppLog,您同样可以选择自己初始化或者由LCDSDK来帮您完成初始化。


Contents
Contact us