Skip to content

GitLab

iOS 升级文档SDK开发指南 · Changes

Page history
update authored by lic's avatar lic
Hide whitespace changes
Inline Side-by-side
Showing with 230 additions and 0 deletions
iOS-升级文档SDK开发指南.md
View page @ bf8d0a2f
......@@ -12,6 +12,236 @@ PS. 关于Xcode12最低版本支持 iOS 9.0 ，如何联调 iOS 8.0 设备？
## 4.7.0
发布日期：2022.11.25
1.新增直播、在线回放文档重试功能
2.新增直播低延迟与多人连麦解耦
3.新增抽奖老虎机样式
4.新增红包雨自定义封面
5.新增隐私协议
6.适配iOS16
7.修复其他已知问题
8.优化Demo层UI
### ‼️ 本地集成 ‘必须’ 的准备 : 替换 CCBundle 资源文件，替换 HDBaseUtils 库，替换 CCSDK 库
‼️ **PS: 红包雨自定义封面改动详情见《云直播红包雨功能接入文档》**
| 文件名称 | 路径 |
| ----------- | ------------------------------------------------------------ |
| CCBundle | 压缩包 --> SDK 文件夹 --> Live_iOS_Play_SDK 文件夹 --> 选择 CCBundle.bundle 资源文件进行替换 |
| HDBaseUtils | 压缩包 --> SDK 文件夹 --> HDBaseUtils 文件夹 --> 选择 HDBaseUtils.framework 库文件进行替换 |
| CCSDK | 压缩包 --> SDK 文件夹 --> Live_iOS_Play_SDK 文件夹 --> 选择 CCSDK.framework 库文件进行替换 |
### 直播 RequestData.h
#### API变更：文档加载状态
| 方法 | 说明 |
| ------------------------------- | ------------ |
| (void)docLoadCompleteWithIndex: | 文档加载状态 |
示例代码
```objc
/**
* @brief 文档加载状态
* index
* 0 文档组件加载成功
* 1 动态文档翻页成功
* 2 非动画文档(白板 图片)文档翻页完成
* 3 文档组件加载失败
* 4 静态文档翻页失败
* 5 动态文档翻页失败
* 6 画板翻页失败
* 7 极速动画翻页加载成功
* 8 极速动画翻页加载失败
* 9 文档组件重载失败
* 10 静态文档翻页超时
* 11 动态文档动画执行成功
* 12 动态文档动画执行超时
* 13 动态文档加载成功
* 14 动态文档加载失败
*/
- (void)docLoadCompleteWithIndex:(NSInteger)index;
```
#### 文档状态说明及操作
| 参数 | 说明 | 操作 |
| ---- | ------------------------------------------------------------ | -------- |
| 0 | 文档组件加载成功 | 无 |
| 1 | 动态文档翻页成功 | 无 |
| 2 | 非动画文档(白板 图片)文档翻页完成 | 无 |
| 3 | 文档组件加载失败（SDK内部已做重试逻辑，但仍失败需要退出重新进入房间） | 退出重进 |
| 4 | 静态文档翻页失败（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
| 5 | 动态文档翻页失败（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
| 6 | 画板翻页失败（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
| 7 | 极速动画翻页加载成功 | 无 |
| 8 | 极速动画翻页加载失败（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
| 9 | 文档组件重载失败（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
| 10 | 静态文档翻页超时（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
| 11 | 动态文档动画执行成功 | 无 |
| 12 | 动态文档动画执行超时（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
| 13 | 动态文档加载成功 | 无 |
| 14 | 动态文档加载失败（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
### 新增API：重载翻页
| 方法 | 说明 |
| ----------------------- | -------- |
| (void)reloadPageChange: | 重载翻页 |
示例代码
```objc
/// 重载翻页
/// @param closure 操作回调
- (void)reloadPageChange:(void (^)(BOOL result, NSString *message))closure {
if (result == NO) {
// 重载翻页操作失败，错误信息 message
}
}
```
### 在线回放 RequestDataPlayBack.h
#### API变更：文档加载状态
| 方法 | 说明 |
| ------------------------------- | ------------ |
| (void)docLoadCompleteWithIndex: | 文档加载状态 |
示例代码
```objc
/**
* @brief 文档加载状态
* index
* 0 文档组件加载成功
* 1 动态文档翻页成功
* 2 非动画文档(白板 图片)文档翻页完成
* 3 文档组件加载失败
* 4 静态文档翻页失败
* 5 动态文档翻页失败
* 6 画板翻页失败
* 7 极速动画翻页加载成功
* 8 极速动画翻页加载失败
* 9 文档组件重载失败
* 10 静态文档翻页超时
* 11 动态文档动画执行成功
* 12 动态文档动画执行超时
* 13 动态文档加载成功
* 14 动态文档加载失败
*/
- (void)docLoadCompleteWithIndex:(NSInteger)index;
```
#### 文档状态说明及操作
| 参数 | 说明 | 操作 |
| ---- | ------------------------------------------------------------ | -------- |
| 0 | 文档组件加载成功 | 无 |
| 1 | 动态文档翻页成功 | 无 |
| 2 | 非动画文档(白板 图片)文档翻页完成 | 无 |
| 3 | 文档组件加载失败（SDK内部已做重试逻辑，但仍失败需要退出重新进入房间） | 退出重进 |
| 4 | 静态文档翻页失败（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
| 5 | 动态文档翻页失败（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
| 6 | 画板翻页失败（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
| 7 | 极速动画翻页加载成功 | 无 |
| 8 | 极速动画翻页加载失败（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
| 9 | 文档组件重载失败（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
| 10 | 静态文档翻页超时（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
| 11 | 动态文档动画执行成功 | 无 |
| 12 | 动态文档动画执行超时（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
| 13 | 动态文档加载成功 | 无 |
| 14 | 动态文档加载失败（展示文档刷新按钮，用户可手动出发文档重载） | 重载翻页 |
### 新增API：重载数据获取失败（代理）
| 方法 | 说明 |
| --------------------- | ---------------------------------------------------------- |
| (void)onPageDataError | 翻页数据获取失败，请使用 "-(void)reloadPageData;" 重新获取 |
示例代码
```objc
/// 翻页数据获取失败，请使用 "-(void)reloadPageData;" 重新获取
- (void)onPageDataError;
```
### 新增API：重载翻页数据（主动）
| 方法 | 说明 |
| -------------------- | ------------ |
| (void)reloadPageData | 重载翻页数据 |
示例代码
```objc
/// 重载翻页数据
- (void)reloadPageData;
```
#### 新增API：重载翻页（主动）
| 方法 | 说明 |
| ---------------------- | -------- |
| (void)reloadPageChange | 重载翻页 |
示例代码
```objc
/// 重载翻页
- (void)reloadPageChange;
```
### PlayParameter.h 类中修改 NewLotteryMessageModel 类 infos 字段增加参数
| 参数 | 是否必须 | 注释 |
| ------------ | --------------------- | ---------------------------------------------------- |
| onlineUsers | (NSArray 必须) | 参与抽奖名单 例:@[@{@"avar":@"头像",@"name":用户名}] |
| prizeNum | (NSInteger 必须) | 奖品个数 |
| onlineNumber | (NSInteger 必须) | 参与在线人数 |
| lotteryType | (NSInteger 必须) | 抽奖类型 0:普通抽奖 1:老虎机抽奖 |
示例代码
```objc
/**
* 抽奖信息 infos
* infos 包含的字段: 注:字段对应的值可能为空
* lotteryStatus (NSInteger 必须) 抽奖状态: 0抽奖创建成功， 1抽奖取消成功， 2抽奖已完成， 3抽奖异常结束
* lotteryId (NSString 必须) 抽奖ID
* collectTemplate (NSArray 必须) 用户信息模板 例:@[@{@"index":index序号,@"title":提示,@"tips":@"提示"}]
* isWinner (BOOL 必须) 是否中奖
* ownUserInfo (NSDictionary 必须) 中奖者信息 例:@{@"userAvatar":头像,@"userName":用户名,@"userId":用户id,@"prizeCode":中奖码}
* prize (NSDictionary 必须) 奖品信息 例:@{@"name":奖品名字}
* userInfos (NSArray 必须) 中奖名单 例:@[@{@"userAvatar":头像,@"userName":用户名,@"userId":用户id,@"prizeCode":中奖码}]
* onlineUsers (NSArray 必须) 参与抽奖名单 例:@[@{@"avar":@"头像",@"name":用户名}]
* prizeNum (NSInteger 必须) 奖品个数
* onlineNumber (NSInteger 必须) 参与在线人数
* lotteryType (NSInteger 必须) 抽奖类型 0:普通抽奖 1:老虎机抽奖
*/
@property (nonnull, strong) NSDictionary *infos;
```
## 4.5.0
发布日期：2022.08.01
......