Skip to content

GitLab

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

Page history
Update iOS 升级文档SDK开发指南 authored by lic's avatar lic
Show whitespace changes
Inline Side-by-side
Showing with 92 additions and 85 deletions
iOS-升级文档SDK开发指南.md
View page @ 7657c438
......@@ -9,6 +9,8 @@ PS. 关于Xcode12最低版本支持 iOS 9.0 ，如何联调 iOS 8.0 设备？
注：选择项目中的 Build Settings ，搜索或找到 iOS Deployment Target ，点击 iOS 9.0 在展开的下拉菜单中选择 Other ，在文本框中输入 8.0 即可。
```
## 3.16.1
发布日期：2021.05.27
......@@ -51,6 +53,7 @@ PS. 关于Xcode12最低版本支持 iOS 9.0 ，如何联调 iOS 8.0 设备？
## 3.16.0
发布日期：2021.05.20
......@@ -73,7 +76,7 @@ PS. 关于Xcode12最低版本支持 iOS 9.0 ，如何联调 iOS 8.0 设备？
**RequestDataPlayBack.h 文件 新增API**
```objective-c
```objc
/**
* 3.16.0 new
* @brief 获取全量聊天数据
......@@ -108,7 +111,7 @@ PS. 关于Xcode12最低版本支持 iOS 9.0 ，如何联调 iOS 8.0 设备？
**RequestDataPlayBack.h 文件 API 新增字段**
```objective-c
```objc
/**
* @brief 获取房间信息，主要是要获取直播间模版来类型，根据直播间模版类型来确定界面布局
* 房间信息
......@@ -151,7 +154,7 @@ PS. 关于Xcode12最低版本支持 iOS 9.0 ，如何联调 iOS 8.0 设备？
**RequestData.h RequestDataPlayBack.h API变更**
```objective-c
```objc
/**
* @brief 文档加载状态
* index
......@@ -178,7 +181,7 @@ PS. 关于Xcode12最低版本支持 iOS 9.0 ，如何联调 iOS 8.0 设备？
**RequestData.h RequestDataPlayBack.h OfflinePlayBack.h** 新增api
```objective-c
```objc
/**
* @brief 设置防录屏功能
* @param isEnable YES 开启 NO 关闭(默认)
......@@ -202,7 +205,7 @@ PS. 关于Xcode12最低版本支持 iOS 9.0 ，如何联调 iOS 8.0 设备？
**RequestDataPlayBack.h 新增**
```objective-c
```objc
/**
* @brief 回放打点数据
* @param dotList 打点信息
......@@ -213,7 +216,7 @@ PS. 关于Xcode12最低版本支持 iOS 9.0 ，如何联调 iOS 8.0 设备？
**PlayParameter 新增 HDReplayDotModel**
```objective-c
```objc
/** 打点时间：单位:S */
@property (nonatomic, assign) NSInteger time;
/** 打点描述 */
......@@ -239,6 +242,7 @@ PS. 关于Xcode12最低版本支持 iOS 9.0 ，如何联调 iOS 8.0 设备？
2.Demo优化：修复观看回放切换到直播后可能出现聊天数据未清除问题
## v3.14.0
发布日期：2021.02.18
......@@ -257,7 +261,7 @@ api变更：
**PlayParameter.h** 废弃liveid
```objective-c
```objc
/**
* @brief 直播ID，回放时才用到(已废弃)
*/
......@@ -268,7 +272,7 @@ api变更：
废弃api
```objective-c
```objc
/**
* @brief 房间的音视频线路 (已废弃)
* @param model LineModel 详情
......@@ -298,7 +302,7 @@ api变更：
新增api
```objective-c
```objc
/**
* The New Method (3.14.0)
* @brief 是否开启音频模式
......@@ -390,6 +394,8 @@ api变更：
- (void)changeLine:(NSInteger)index completion:(void (^)(NSDictionary * results))completion;
```
## v3.13.0
发布日期：2021.01.11
......@@ -410,7 +416,7 @@ api变更：
**PlayParameter.h** 新增枚举类型
```objective-c
```objc
/**
* 音视频模式
* PLAY_MODE_TYEP_VIDEO 视频
......@@ -433,7 +439,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
新增 **HDQualityModel** 类
```objective-c
```objc
/** 清晰度 */
@property (nonatomic, copy) NSString * _Nonnull quality;
/** 描述 */
......@@ -442,7 +448,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
**RequestDataPlayBack.h** 废弃api
```objective-c
```objc
/**
* @brief 接收到播放线路 (已废弃)
* 例:videoArray元素个数 2 代表2条线路 changeLineWithPlayParameter传0或1
......@@ -475,7 +481,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
**RequestDataPlayBack.h** 新增api回调
```objective-c
```objc
/**
* The New Method (3.13.0)
* @brief 是否开启音频模式
......@@ -515,7 +521,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
**RequestDataPlayBack.h** 新增api主动调用方法
```objective-c
```objc
/**
* The New Method (3.13.0)
* @brief 切换播放类型
......@@ -564,7 +570,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
**1.更新 “ 收到播放直播状态api ”，恢复成和3.12之前版本保持一致**
```
```objc
/**
* @brief 收到播放直播状态 0.正在直播 1.未开始直播
*/
......@@ -590,7 +596,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
1. 支持抽奖2.0，新增显示抽奖名称、查看中奖用户、中奖信息收集等功能
```
```objc
代理方法（可选）
/**
......@@ -623,7 +629,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
5. 播放器状态新增api
```
```objc
代理方法（可选）
/**
* @brief 播放器初始化完成 (会多次回调)
......@@ -633,7 +639,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
6. 收到直播状态api更改
```
```objc
/**
* @brief 收到播放直播状态 1.正在直播 0.未开始直播
*/
......@@ -645,7 +651,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
已删除
```
```objc
/**
* @brief 切换源，firRoadNum表示一共有几个线路，secRoadKeyArray表示每个线路对应的清晰度
*/
......@@ -660,7 +666,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
新增
```
```objc
代理方法（可选）
/**
......@@ -716,7 +722,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
1.直播打卡支持自定义打卡提示语
```
```objc
/**
* @brief 收到开始打卡
* dic {
......@@ -736,7 +742,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
2.直播新增用户进出直播间消息通知
```
```objc
/**
* @brief 用户进出直播间提示
* @param model RemindModel 详情
......@@ -746,7 +752,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
3.直播SDK新增用户禁言群发消息通知
```
```objc
/**
* @brief 禁言用户提示
* @param model BanChatModel 详情
......@@ -756,7 +762,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
4.在线回放SDK新增播放状态api
```
```objc
/**
* @brief 视频准备播放
* @param dict 数据
......@@ -775,7 +781,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
2.新增视频加载的网络速度(直播、在线回放)
```
```objc
/**
* @brief 视频加载速度
* @param speed 视频加载速度字符串
......@@ -787,7 +793,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
4.SDK新增回放播放器时间API（在线回放，离线回放）
```
```objc
/**
* @brief 播放器时间
* @param currentTime 当前时间
......@@ -798,7 +804,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
5.SDK新增视频播放器状态API（直播，在线回放，离线回放）
```
```objc
/**
* @brief 视频状态改变
* @param state
......@@ -858,7 +864,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
1. 新增直播删除广播;
```
```objc
//代理方法
/**
* @brief 删除广播
......@@ -873,7 +879,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
3. 直播、回放、离线回放 新增 PPT支持切换模式；
```
```objc
//主动调用
/**
* @brief 主动调用方法 用于调整PPT缩放模式
......@@ -920,7 +926,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
1. 新增回放线路切换；
```
```objc
//代理方法
/**
*接收到播放线路 例:int值 2 代表两条 changeLineWithNum传0或1
......@@ -939,7 +945,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
2. 新增跑马灯功能；
```
```objc
/**
* @brief 跑马灯信息,需要开启跑马灯功能且iOS 9.0以上
*/
......@@ -982,7 +988,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
1. 新增聊天禁言删除历史记录；
```
```objc
/**
* @brief 收到聊天禁言并删除聊天记录
* viewerId 禁言用户id,是自己的话别删除聊天历史,其他人需要删除该用户的聊天
......@@ -1004,7 +1010,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
1. 新增获取在线讲师和助教列表方法；
```
```objc
/**
收到老师列表
teachers = (
......@@ -1023,7 +1029,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
2. 新增获取直播间设置方法；
```
```objc
/**
* @brief 房间设置信息
* dic{
......@@ -1041,7 +1047,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
3. demo新增视频截图方法；
```
```objc
//获取视频截图
- (void)thumbnailImageAtCurrentTime {
UIImage *image = [self.requestData.ijkPlayer thumbnailImageAtCurrentTime];
......@@ -1053,7 +1059,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
4. demo新增多个回放切换方法；
```
```objc
/**
切换回放,需要重新配置参数
*/
......@@ -1070,7 +1076,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
1.新增打卡功能
```
```objc
监听方法:
/**
* @brief 收到开始打卡
......@@ -1120,7 +1126,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
2.新增视频状态
```
```objc
/**
* @brief 视频状态
* rseult playing/paused/loading
......@@ -1130,7 +1136,7 @@ typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
3.随堂测
```
```objc
直播观看
/**
* @brief 获取随堂测
......@@ -1188,7 +1194,7 @@ ps:原有获取随堂测方法已删除
1.新增修改文档背景色方法
```
```objc
/**
改变文档背景颜色
......@@ -1230,7 +1236,7 @@ ps:原有获取随堂测方法已删除
2. 新增离线回放接收到文档加载状态
```
```objc
/**
* @brief 文档加载状态(The new method)
* index
......@@ -1247,7 +1253,7 @@ ps:原有获取随堂测方法已删除
1. 接收到文档加载状态
```
```objc
/**
* @brief 文档加载状态(The new method)
* index
......@@ -1260,7 +1266,7 @@ ps:原有获取随堂测方法已删除
2. 接收到随堂测
```
```objc
/**
* @brief 接收到随堂测(The new method)
* rseultDic 随堂测内容
......@@ -1270,7 +1276,7 @@ ps:原有获取随堂测方法已删除
3. 接收到随堂测提交结果
```
```objc
/**
* @brief 随堂测提交结果(The new method)
* rseultDic 提交结果,调用commitPracticeWithPracticeId:(NSString *)practiceId options:(NSArray *)options后执行
......@@ -1280,7 +1286,7 @@ ps:原有获取随堂测方法已删除
4. 接收到随堂测统计结果
```
```objc
/**
* @brief 随堂测统计结果(The new method)
* rseultDic 统计结果,调用getPracticeStatisWithPracticeId:(NSString *)practiceId后执行
......@@ -1290,7 +1296,7 @@ ps:原有获取随堂测方法已删除
5. 接收到随堂测排名结果
```
```objc
/**
* @brief 随堂测排名结果(The new method)
* rseultDic 排名结果,调用getPracticeRankWithPracticeId:(NSString *)practiceId后执行
......@@ -1300,7 +1306,7 @@ ps:原有获取随堂测方法已删除
6. 接收到停止随堂测
```
```objc
/**
* @brief 停止随堂测(The new method)
* rseultDic 结果
......@@ -1310,7 +1316,7 @@ ps:原有获取随堂测方法已删除
7. 接收到关闭随堂测
```
```objc
/**
* @brief 关闭随堂测(The new method)
* rseultDic 结果
......@@ -1320,7 +1326,7 @@ ps:原有获取随堂测方法已删除
8. 接收到视频状态
```
```objc
/**
* @brief 视频状态(The new method)
* rseult playing/paused
......@@ -1330,7 +1336,7 @@ ps:原有获取随堂测方法已删除
9. 主动提交随堂测
```
```objc
/**
* @brief 提交随堂测(The new method)
* @param practiceId 随堂测ID
......@@ -1341,7 +1347,7 @@ ps:原有获取随堂测方法已删除
10. 主动获取随堂测统计信息
```
```objc
/**
* @brief 获取随堂测统计信息(可多次调用)(The new method)
* @param practiceId 随堂测ID
......@@ -1351,7 +1357,7 @@ ps:原有获取随堂测方法已删除
11. 主动获取随堂测排名
```
```objc
/**
* @brief 获取随堂测排名(可多次调用)(The new method)
* @param practiceId 随堂测ID
......@@ -1361,7 +1367,7 @@ ps:原有获取随堂测方法已删除
12. 回放新增文档加载状态
```
```objc
/**
* @brief 文档加载状态(The new method)
* index
......@@ -1378,7 +1384,7 @@ ps:原有获取随堂测方法已删除
1. 获取观看者自身的信息
```
```objc
/**
* @brief 服务器端给自己设置的信息(The new method)
* viewerId 服务器端给自己设置的UserId
......@@ -1390,7 +1396,7 @@ ps:原有获取随堂测方法已删除
2. 聊天审核
```
```objc
/**
* @brief 聊天审核(The new method)
* status 聊天消息的状态 0 显示 1 不不显示
......@@ -1419,7 +1425,7 @@ ps:原有获取随堂测方法已删除
7. SDK新增聊天禁言及解禁回调
```
```objc
/**
* @brief 收到聊天禁言(The new method)
* mode 禁言类型 1：个人禁言 2：全员禁言
......@@ -1444,7 +1450,7 @@ ps:原有获取随堂测方法已删除
1. 视频或者文档大窗
```
```objc
/**
* @brief 视频或者文档大窗(The new method)
* isMain 1为视频为主,0为文档为主"
......@@ -1470,7 +1476,7 @@ ps:原有获取随堂测方法已删除
1. 新增学员踢出类型;
```
```objc
/**
* @brief 收到踢出消息(change)
kick_out_type
......@@ -1482,7 +1488,7 @@ kick_out_type
2. 文档模式新增切换数据源响应事件;
```
```objc
/**
* @brief 客户端关闭摄像头(The new method)
数据源类型 数据源值 数据源类型描述 数据源类型描述值
......@@ -1506,7 +1512,7 @@ source_type 60 source_type_desc 数据源类型：自定义场景
1. 切换当前的文档模式;
```
```objc
/**
* @brief 切换当前的文档模式(The new method)
* 1.切换至跟随模式（默认值）值为0，
......@@ -1517,7 +1523,7 @@ source_type 60 source_type_desc 数据源类型：自定义场景
2. 获取所有文档列表(代理方法);
```
```objc
/**
* @brief 获取所有文档列表(The new method)
*/
......@@ -1526,7 +1532,7 @@ source_type 60 source_type_desc 数据源类型：自定义场景
3. 跳转到指定文档页;
```
```objc
/**
* @brief 跳转到指定文档页(自由模式才生效)(The new method)
* @param docId 文档的docId
......@@ -1537,7 +1543,7 @@ source_type 60 source_type_desc 数据源类型：自定义场景
4. 离线回放CCR文件的解析方法;
```
```objc
/**
* @brief 离线回放CCR文件的解析方法(The new method)
* @param dst 需要进行解析的CCR文件.
......@@ -1561,7 +1567,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
5. 离线回放开始和结束时间;
```
```objc
/**
* @brief 回放的开始时间和结束时间(The new method)
*/
......@@ -1574,7 +1580,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
1. 优化文档展示生命周期;
```
```objc
/**
* 文档视图在直播间未开始直播时不创建
* 文档视图在直播间结束直播时将销毁
......@@ -1583,7 +1589,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
2. 修复demo离线下载iOS 12兼容性问题;
```
```objc
/**
* 修复iOS 12断点续传闪退问题
*/
......@@ -1595,7 +1601,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
1. 新增问卷统计功能；
```
```objc
/**
* @brief 获取问卷统计(The new method)
*/
......@@ -1604,7 +1610,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
2. 新增禁用ppt滚动属性；
```
```objc
/**
* @brief PPT是否允许滚动
*/
......@@ -1625,7 +1631,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
3. 双击ppt事件代理方法
```
```objc
/**
* @brief 双击ppt(The new method)
*/
......@@ -1634,7 +1640,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
4. 新增自定义参数viewercustominfo
```
```objc
/**
* json格式字符串，可选，自定义用户信息，该信息会记录在用户访问记录中，用于统计分析使用（长度不能超过1000个字符，若直播间启用接口验证则该参数无效）如果不需要的话就不要传值
* 格式如下：
......@@ -1645,7 +1651,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
5. 新增文档按直播间设置的模式展示
```
```objc
/**
* @brief PPT适配模式分为四种，
* 1.第一种是全部填充屏幕，可拉伸变形，
......@@ -1658,7 +1664,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
6. 新增回放的开始时间和结束时间
```
```objc
/**
* @brief 回放的开始时间和结束时间(The new method)
*/
......@@ -1667,7 +1673,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
7. 新增直播间封禁和解禁代理
```
```objc
/**
* @brief 直播间被禁(The new method)
*/
......@@ -1683,7 +1689,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
1. 获取直播开始时间和直播时长代理方法
```
```objc
/**
* @brief 获取直播开始时间和直播时长(The new method)
* liveDuration 直播持续时间，单位（s），直播未开始返回-1"
......@@ -1705,7 +1711,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
1.观看直播修改昵称
```
```objc
/**
* @brief 修改昵称(The new method)
* @param nickName 修改后的昵称
......@@ -1722,7 +1728,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
2.获取PPT当前页数和总页数
```
```objc
/**
* @brief 获取ppt当前页数和总页数(The new method)
*
......@@ -1736,7 +1742,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
3.获取最近一条广播
```
```objc
/**
* @brief 观看直播收到最近一条广播(回放和离线回放收到所有广播)(The new method)
* content 广播内容
......@@ -1753,7 +1759,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
2.修复回放频繁拖动进度条引起的崩溃问题；
3.修复频繁切换PPT动画文档和视频窗口位置，导致文档显示不完整问题；
3.修复频繁切换PPT动画文档和视频窗口位置，导致文档显示不完整问题；
## v2.5.1
......@@ -1767,7 +1773,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
1.直播类中增加问卷功能
```
```objc
~~~
PlayForPCVC.m文件中相应的回调方法为:
- (void)questionnaireWithTitle:(NSString *)title url:(NSString *)url;
......@@ -1776,7 +1782,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
2.直播类中增加主动请求问卷功能
```
```objc
~~~
RequestData.h中增加相应的方法，当用户主动调用该方法时，会得到当前问卷的信息
-(void)getPublishingQuestionnaire;
......@@ -1785,7 +1791,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
3.离线回放类中增加改变播放器父窗口的方法
```
```objc
~~~
OfflinePlayBack.h中增加相应的方法
- (void)changePlayerParent:(UIView *) playerParent;
......@@ -1794,7 +1800,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
4.离线回放类中增加改变文档父窗口的方法
```
```objc
~~~
OfflinePlayBack.h中增加相应的方法
- (void)changeDocParent:(UIView *) docParent;
......@@ -1803,7 +1809,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
5.回放类中增加改变播放器父窗口的方法
```
```objc
~~~
RequestDataPlayBack.h中增加相应的方法
- (void)changePlayerParent:(UIView *) playerParent;
......@@ -1812,7 +1818,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
6.回放类中增加改变文档父窗口的方法
```
```objc
~~~
RequestDataPlayBack.h中增加相应的方法
- (void)changeDocParent:(UIView *) docParent;
......@@ -1833,6 +1839,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
1.户禁言后提问的问题，只给当前用户自己展示(禁言后服务端返回的问题id全部为-1)
```objc
~~~
PlayForPCVC.m文件中相应的回调方法为:
- (void)onQuestionDic:(NSDictionary *)questionDic;
......@@ -1844,6 +1851,7 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];
encryptId = [NSString stringWithFormat:@"%@[%@]",encryptId,dateTime];
}
~~~
```
2.增加直播，回放，离线回放的实时画笔功能(接口无变化)
......@@ -1880,4 +1888,3 @@ int zipDec = [_offlinePlayBack DecompressZipWithDec:srcPath dir:destination];