Skip to content

GitLab

iOS 直播观看SDK开发指南 · Changes

Page history
Update iOS 直播观看SDK开发指南 authored by lic's avatar lic
Hide whitespace changes
Inline Side-by-side
Showing with 202 additions and 56 deletions
iOS-直播观看SDK开发指南.md
View page @ 9dfa4348
......@@ -237,7 +237,7 @@ Destination 选择 "Frameworks" ->
在启动方法中添加日志存储
```
```objective-c
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
/**
* @brief 是否存储日志
......@@ -346,7 +346,7 @@ done
3.1.1 调用方法
```
```objective-c
/**
* @brief 登录房间
* @param parameter 配置参数信息
......@@ -386,7 +386,7 @@ done
代理方法
```
```objective-c
/**
* @brief 登录成功
*/
......@@ -412,19 +412,19 @@ done
导入头文件
```
```objective-c
#import "CCSDK/RequestData.h"//SDK
```
声明变量
```
```objective-c
@property (nonatomic,strong)RequestData * requestData;//sdk
```
配置参数:PlayParameter的属性如下
```
```objective-c
/**
* @brief 用户ID
*/
......@@ -442,9 +442,9 @@ done
*/
@property(nonatomic, copy)NSString *token;//房间密码
/**
* @brief 直播ID，回放时才用到
* @brief 直播ID，回放时才用到(已废弃)
*/
@property(nonatomic, copy)NSString *liveId;//直播ID，回放时才用到
@property(nonatomic, copy)NSString *liveId;//直播ID，回放时才用到(已废弃)
/**
* @brief 回放ID
*/
......@@ -585,7 +585,7 @@ typedef NS_ENUM(NSUInteger, HDMovieFinishReason) {
新增 RemindModel 类 （用户进出直播间代理模型类）
```
```objective-c
/**
* 用户进出通知
* HDUSER_IN_REMIND 进入直播间
......@@ -618,7 +618,7 @@ typedef NS_ENUM(NSUInteger, HDUSER_REMIND) {
新增 BanChatModel 类（用户禁言群发消息通知模型类）
```
```objective-c
/** 用户id */
@property (nonatomic, copy) NSString *userId;
/** 昵称 */
......@@ -633,7 +633,7 @@ typedef NS_ENUM(NSUInteger, HDUSER_REMIND) {
新增 NewLotteryMessageModel 类 （抽奖2.0 该功能需要单独开启）
```
```objective-c
/**
* 抽奖2.0 抽奖消息类别
* NEW_LOTTERY_NULL 无抽奖
......@@ -668,9 +668,9 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
@property (nonnull, strong) NSDictionary *infos;
```
新增 LineModel 类 （切换线路清晰度类）
新增 LineModel 类 （切换线路清晰度类）（已废弃）
```
```objective-c
/** 清晰度 0-原画；200-流畅；300-标清； */
@property (nonatomic, copy) NSArray * _Nonnull quality;
/** 视频线路数 */
......@@ -679,6 +679,38 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
@property (nonatomic, assign) NSInteger audioLine;
```
新增 **HDQualityModel** 类 （切换线路清晰度）
```objective-c
/** 清晰度 */
@property (nonatomic, copy) NSString * _Nonnull quality;
/** 描述 */
@property (nonatomic, copy) NSString * _Nonnull desc;
```
新增枚举类型
```objc
/**
* 音视频模式
* PLAY_MODE_TYEP_VIDEO 视频
* PLAY_MODE_TYEP_AUDIO 音频
*/
typedef NS_ENUM(NSUInteger, PLAY_MODE_TYEP) {
PLAY_MODE_TYEP_VIDEO,//视频
PLAY_MODE_TYEP_AUDIO,//音频
};
/**
* 是否有音频线路
* HAVE_AUDIO_LINE_TURE 有音频线路
* HAVE_AUDIO_LINE_FALSE 无音频线路
*/
typedef NS_ENUM(NSUInteger, HAVE_AUDIO_LINE) {
HAVE_AUDIO_LINE_TURE,//有音频线路
HAVE_AUDIO_LINE_FALSE,//无音频线路
};
```
开始配置
......@@ -701,7 +733,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
实现代理
```
```objective-c
/**
* @brief 请求成功
*/
......@@ -726,7 +758,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
3.2.1 代理方法(可选)
```
```objective-c
/**
* @brief 主讲开始推流
*/
......@@ -818,7 +850,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
3.2.2 主动方法(可选)
```
```objective-c
/**
* @brief 改变播放器frame
*/
......@@ -874,7 +906,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
3.3.1 代理方法(可选)
```
```objective-c
/**
* @brief 获取文档内白板或者文档本身的宽高，来进行屏幕适配用的
*/
......@@ -932,7 +964,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
3.3.2 主动方法(可选)
```
```objective-c
/**
* @brief 获取文档区域内白板或者文档本身的宽高比，返回值即为宽高比，做屏幕适配用
*/
......@@ -1002,7 +1034,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
代理方法(可选)
```
```objective-c
/**
* @brief 获取房间信息，主要是要获取直播间模版来类型，根据直播间模版类型来确定界面布局
* 房间简介：dic[@"desc"];
......@@ -1045,7 +1077,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
代理方法(可选)
```
```objective-c
/**
* @brief 历史聊天数据 (会多次回调)
* @param chatLogArr [{ chatId //聊天ID
......@@ -1129,7 +1161,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
主动方法(可选)
```
```objective-c
/**
* @brief 发送公聊信息
* @param message 发送的消息内容
......@@ -1153,7 +1185,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
代理方法(可选)
```
```objective-c
/**
* @brief 收到提问，用户观看时和主讲的互动问答信息
* @param questionDic { groupId //分组ID
......@@ -1204,7 +1236,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
主动方法(可选)
```
```objective-c
/**
* @brief 提问
* @param message 提问内容
......@@ -1218,7 +1250,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
代理方法(可选)
```
```objective-c
/**
* @brief 本房间为允许连麦的房间，会回调此方法，在此方法中主要设置UI的逻辑，
* 在断开推流,登录进入直播间和改变房间是否允许连麦状态的时候，都会回调此方法
......@@ -1252,7 +1284,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
主动方法(可选)
```
```objective-c
/**
* @brief 设置远程连麦窗口的大小，连麦成功后调用才生效，连麦不成功调用不生效
*/
......@@ -1291,27 +1323,110 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
代理方法(可选)
```
```objective-c
/**
* @brief 房间的音视频线路
* @brief 房间的音视频线路 (已废弃)
* @param model LineModel 详情
*
* 废弃版本 3.14.0
* 兼容版本 2021年11月08日之后将不再维护
* 新方法 清晰度回调 - (void)HDReceivedVideoQuality:(NSDictionary *)dict;
* 线路回调 - (void)HDReceivedVideoAudioLines:(NSDictionary *)dict;
*/
- (void)HDReceivedVideoAudioLinesWithModel:(LineModel *)model;
/**
* The New Method (3.14.0)
* @brief 是否开启音频模式
* @param hasAudio HAVE_AUDIO_LINE_TURE 有音频 HAVE_AUDIO_LINE_FALSE 无音频
*
* 触发回调条件 1.初始化SDK登录成功后
*/
- (void)HDAudioMode:(HAVE_AUDIO_LINE)hasAudio;
/**
* The New Method (3.14.0)
* @brief 房间所包含的清晰度 (会多次回调)
* @param dict 清晰度数据
* 清晰度数据 key(包含的键值) type(数据类型) description(描述)
* qualityList(清晰度列表) array @[HDQualityModel(清晰度详情),HDQualityModel(清晰度详情)]
* currentQuality(当前清晰度) object HDQualityModel(清晰度详情)
*
* 触发回调条件 1.初始化SDK登录成功后
* 2.主动调用切换清晰度方法
* 3.主动调用切换视频模式回调
*/
- (void)HDReceivedVideoQuality:(NSDictionary *)dict;
/**
* The New Method (3.14.0)
* @brief 房间包含的音视频线路 (会多次回调)
* @param dict 线路数据
* 线路数据 key(包含的键值) type(数据类型) description(描述)
* lineList(线路列表) array @[@"line1",@"line2"]
* indexNum(当前线路下标) integer 0
*
* 触发回调条件 1.初始化SDK登录成功后
* 2.主动调用切换清晰度方法
* 3.主动调用切换线路方法
* 4.主动调用切换音视频模式回调
*/
- (void)HDReceivedVideoAudioLines:(NSDictionary *)dict;
```
主动方法(可选)
```
```objective-c
/**
* @brief 切换线路 监听HDReceivedVideoAudioLinesWithModel代理获取线路/清晰度等信息
* @brief 切换线路 监听HDReceivedVideoAudioLinesWithModel代理获取线路/清晰度等信息 (已废弃)
* @param quality 清晰度 0-原画；200-流畅；300-标清；音频传空字符串
* @param stream 线路 从0开始,如两条线路则传0或1
* results { //切换结果
* success 0 切换成功 -1切换失败 -2 切换频繁
* reason 错误原因
* }
* 废弃版本 3.14.0
* 兼容版本 2021年11月08日之后将不再维护
* 新方法 切换播放器类型 - (void)changePlayMode:(PLAY_MODE_TYEP)mode;
* 切换清晰度 - (void)changeQuality:(NSString *)quality completion:(void (^)(NSDictionary * results))completion;
* 切换线路 - (void)changeLine:(NSInteger)index completion:(void (^)(NSDictionary * results))completion;
*/
- (void)changeLineWithQuality:(NSString *)quality Stream:(NSInteger)stream completion:(void (^)(NSDictionary * results))completion;
/**
* The New Method (3.14.0)
* @brief 切换播放类型
* @param mode PLAY_MODE_TYEP_VIDEO 视频模式(默认)
* PLAY_MODE_TYEP_AUDIO 音频模式(当前回放包含音频线路)
* @param completion 切换结果
* { success 0 切换成功 -1切换失败 -2 切换频繁
* reason 错误原因 }
*
* 切换播放器类型 切换为音频,回调 - (void)HDReceivedVideoAudioLines:(NSDictionary *)dict;
* 切换为视频,回调 - (void)HDReceivedVideoQuality:(NSDictionary *)dict;
* - (void)HDReceivedVideoAudioLines:(NSDictionary *)dict;
*
*/
- (void)changePlayMode:(PLAY_MODE_TYEP)mode completion:(void (^)(NSDictionary * results))completion;
/**
* The New Method (3.14.0)
* @brief 切换清晰度
* @param quality 清晰度
* @param completion 切换结果
* { success 0 切换成功 -1切换失败 -2 切换频繁
* reason 错误原因 }
*
* 切换清晰度回调 - (void)HDReceivedVideoQuality:(NSDictionary *)dict;
* - (void)HDReceivedVideoAudioLines:(NSDictionary *)dict;
*/
- (void)changeQuality:(NSString *)quality completion:(void (^)(NSDictionary * results))completion;
/**
* The New Method (3.14.0)
* @brief 切换线路
* @param index 选择线路下标
* @param completion 切换结果
* { success 0 切换成功 -1切换失败 -2 切换频繁
* reason 错误原因 }
*
* 切换线路回调方法 - (void)HDReceivedVideoAudioLines:(NSDictionary *)dict;
*/
- (void)changeLine:(NSInteger)index completion:(void (^)(NSDictionary * results))completion;
```
......@@ -1320,7 +1435,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
代理方法(可选)
```
```objective-c
/**
* @brief 开始答题
*/
......@@ -1379,7 +1494,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
主动方法(可选)
```
```objective-c
/**
* @brief 答单选题
*/
......@@ -1397,7 +1512,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
代理方法(可选)
```
```objective-c
/**
* @brief 发布问卷
*/
......@@ -1436,7 +1551,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
主动方法(可选)
```
```objective-c
/**
* @brief 提交问卷结果
* @param dic{subjectsAnswer[{selectedOptionId //选中选项ID
......@@ -1455,7 +1570,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
代理方法(可选)
```
```objective-c
/**
* @brief 接收到发送的广播
* @param dic {content //广播内容
......@@ -1491,7 +1606,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
代理方法(可选)
```
```objective-c
/**
* @brief 开始签到
*/
......@@ -1500,7 +1615,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
主动方法(可选)
```
```objective-c
/**
* @brief 签到
*/
......@@ -1523,7 +1638,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
代理方法(可选)
```
```objective-c
/**
* @brief 开始抽奖
*/
......@@ -1545,7 +1660,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
代理方法(可选)
```
```objective-c
/**
* @brief 修改昵称
*/
......@@ -1554,7 +1669,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
主动方法(可选)
```
```objective-c
/**
* @brief 修改昵称
* @param nickName 修改后的昵称
......@@ -1568,7 +1683,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
代理方法(可选)
```
```objective-c
/**
* @brief 收到在线人数
*/
......@@ -1589,7 +1704,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
主动放法(可选)
```
```objective-c
/**
* @brief 获取在线房间人数，当登录成功后即可调用此接口，登录不成功或者退出登录后就不可以调用了，如果要求实时性比较强的话，可以写一个定时器，不断调用此接口，几秒钟发一次就可以，然后在代理回调函数中，处理返回的数据,15秒响应一次
*/
......@@ -1606,7 +1721,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
代理方法(可选)
```
```objective-c
/**
* @brief 接收到随堂测
* rseultDic 随堂测内容
......@@ -1708,7 +1823,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
主动方法(可选)
```
```objective-c
/**
* @brief 提交随堂测
* @param practiceId 随堂测ID
......@@ -1736,7 +1851,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
代理方法(可选)
```
```objective-c
/**
* @brief 公告
*/
......@@ -1753,7 +1868,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
代理方法(可选)
```
```objective-c
/**
* @brief 跑马灯
* @param dic action [{ //事件
......@@ -1784,7 +1899,7 @@ typedef NS_ENUM(NSUInteger, NEW_LOTTERY) {
播放器状态类型
```
```objective-c
/**
* 视频播放状态
* HDMoviePlaybackStateStopped 播放停止
......@@ -1820,7 +1935,7 @@ typedef NS_ENUM(NSUInteger, HDMovieLoadState) {
代理方法（可选）
```
```objective-c
/**
* @brief 视频状态改变
* @param state
......@@ -1851,7 +1966,7 @@ typedef NS_ENUM(NSUInteger, HDMovieLoadState) {
代理方法（可选）
```
```objective-c
/**
* @brief 视频加载速度
* @param speed 视频加载速度字符串
......@@ -1863,7 +1978,7 @@ typedef NS_ENUM(NSUInteger, HDMovieLoadState) {
代理方法（可选）
```
```objective-c
/**
* @brief 用户进出直播间提示
* @param model RemindModel 详情
......@@ -1877,7 +1992,7 @@ typedef NS_ENUM(NSUInteger, HDMovieLoadState) {
代理方法（可选）
```
```objective-c
/**
* @brief 抽奖2.0 抽奖信息回调 (该功能需要单独开启)
* @param model NewLotteryMessageModel 详情
......@@ -1887,7 +2002,7 @@ typedef NS_ENUM(NSUInteger, HDMovieLoadState) {
主动方法 （可选）
```
```objective-c
/**
* @brief 抽奖2.0 查询抽奖状态
*/
......@@ -1918,13 +2033,13 @@ typedef NS_ENUM(NSUInteger, HDMovieLoadState) {
HD云直播的页面跳转均是采用模态形式跳转
```
```objective-c
- (void)presentViewController:(UIViewController *)viewControllerToPresent animated: (BOOL)flag completion:(void (^ __nullable)(void))completion NS_AVAILABLE_IOS(5_0);
```
在每个控制器或者基类控制器设置旋转选项
```
```objective-c
#pragma mark - 屏幕旋转
- (BOOL)shouldAutorotate{
return NO;//该旋转的页面自己变量控制
......@@ -1943,7 +2058,7 @@ HD云直播的页面跳转均是采用模态形式跳转
## 4.2 Swift实现代理错误
```
```swift
//初始化
let parameter = PlayParameter.init()
/**
......@@ -1959,7 +2074,7 @@ player.delegate = self
首先: 在AppDelegate中写如下代码(仅限CCSDK);
```
```objective-c
[[SaveLogUtil sharedInstance]isNeedToSaveLog:YES];
```
......@@ -1992,7 +2107,7 @@ error: Bundle only contains bitcode-marker /var/folders/s5/lnk362pd4cs0lmtn_43pp
主动提交问卷这个方法参数格式
```
```objective-c
-(void)commitQuestionnaire:(NSDictionary *)dic
```
......@@ -2018,3 +2133,33 @@ error: Bundle only contains bitcode-marker /var/folders/s5/lnk362pd4cs0lmtn_43pp
}
```
## 4.6 关于api回调所在线程问题
```objective-c
/**
* @brief 文档加载状态（会在子线程回调）
* index
* 0 文档组件初始化完成
* 1 动画文档加载完成
* 2 非动画文档加载完成
* 3文档组件加载失败
* 4文档图片加载失败
* 5文档动画加载失败
* 6画板加载失败
*/
- (void)docLoadCompleteWithIndex:(NSInteger)index;
```
```objective-c
/**
* @brief 获取ppt当前页数和总页数 (会多次回调) （会在子线程回调）
*
* 回调当前翻页的页数信息
* 白板docTotalPage一直为0, pageNum从1开始
* 其他文档docTotalPage为正常页数,pageNum从0开始
* @param dictionary 翻页信息
*/
- (void)onPageChange:(NSDictionary *) dictionary;
```
PS：直播、在线回放只有上述api会在子线程回调，其余的api均在主线程进行回调。
\ No newline at end of file