Skip to content

GitLab

iOS 直播回放SDK开发指南 · Changes

Page history
Updated iOS 直播回放SDK开发指南 (markdown) authored by Clark-new's avatar Clark-new
Hide whitespace changes
Inline Side-by-side
Showing with 690 additions and 507 deletions
iOS-直播回放SDK开发指南.md
View page @ 8aa7fc5c
## 1.概述
Live_iOS_Play_SDK 是一个适用于iOS平台的直播SDK，使用此SDK可以与CC视频云服务进行对接，在iOS端使用CC视频的直播回放功能,本SDK只针对iOS手机播放端。 # 1.概述
### 1.1 功能特性 ## 1.1 阅读对象
| 功能 | 描述 |
| :----------- | :------------------- |
| 回放视频 | 观看直播回放视频 |
| 文档展示 | 观看直播时展示的文档 |
| 问答 | 观看直播时的问答 |
| 历史聊天数据 | 观看历史聊天数据 |
| 房间信息 | 观看直播间信息 |
### 1.2 阅读对象
本文档为技术文档，需要阅读者： 本文档为技术文档，需要阅读者：
* 具备基本的iOS开发能力
* 准备接入CC视频的直播回放SDK相关功能
* 对CC云直播产品使用方法有基础的了解，[使用帮助地址](http://doc.bokecc.com/live/manual/introduction/)
- 具备基本的iOS开发能力
- 准备接入CC视频的直播SDK相关功能
- 对CC云直播产品使用方法有基础的了解，[使用帮助地址](https://doc.bokecc.com/live/)
## 1.2 功能特性
| 功能 | 描述 |
| -------- | ---------------------- |
| 直播视频 | 观看直播视频 |
| 视频倍速 | 观看直播回放倍速播放 |
| 文档展示 | 能够观看当前直播文档 |
| 聊天 | 所有直播时的聊天 |
| 简介 | 支持对直播间的信息展示 |
| 广播 | 支持历史全体消息 |
| 问答 | 支持历史问答 |
# 2.开发准备
## 2.1 开发环境
## 2.开发准备 - Xcode : Xcode 开发IDE
- Version 10.0 及以上
## 2.2 SDK配置
### 2.2.1 CocoaPods集成
**已安装CocoaPods**
### 2.1 开发环境
* Xcode : Xcode 开发IDE
### 2.2 错误码及错误描述
``` ```
(1). 业务错误 如果是有连麦的SDK:
pod 'CCLivePlaySDK', '~> 3.8.0'
如果是无连麦的SDK:
pod 'CCLivePlaySDK', :podspec => 'https://raw.githubusercontent.com/CCVideo/Live_iOS_Play_SDK/3.8.0/CCLivePlaySDK.podspec'
typedef NS_ENUM(NSInteger, ERROR_SERVICE_TYPE) { 注:3.8.0为版本号,修改为自己想要的版本号即可
```
ERROR_ROOM_STATE = 1001,//@"直播间状态不可用，可能没有开始推流" **未安装CocoaPods**
ERROR_USELESS_INFO = 1002,//@"没有获取到有用的视频信息" 1. 安装CocoaPods
ERROR_PASSWORD = 1003,//@"密码错误" 打开终端：>_
1、查看当前Ruby版本
}; ```
ruby -v
```
(2). 系统错误 2、升级Ruby环境，首先需要安装rvm（第一步要下载一些东西等两分钟左右）
typedef NS_ENUM(NSInteger, ERROR_SYSTEM_TYPE) { ```
curl -L get.rvm.io | bash -s stable
source ~/.bashrc
source ~/.bash_profile
```
ERROR_RETURNDATA = 1004,//@"返回内容格式错误" 3、查看rvm版本
ERROR_PARAMETER = 1005,//@"可能是参数错误" ```
rvm -v
显示如下(或者是其他版本)
rvm 1.29.3 (latest) by Michal Papis, Piotr Kuczynski, Wayne E. Seguin [https://rvm.io]
```
ERROR_NETWORK = 1006,//@"网络错误" 4、列出ruby可安装的版本信息
}; ```
rvm list known
显示如下
# MRI Rubies
[ruby-]1.8.6[-p420]
[ruby-]1.8.7[-head] # security released on head
[ruby-]1.9.1[-p431]
[ruby-]1.9.2[-p330]
[ruby-]1.9.3[-p551]
[ruby-]2.0.0[-p648]
[ruby-]2.1[.10]
[ruby-]2.2[.10]
[ruby-]2.3[.7]
[ruby-]2.4[.4]
[ruby-]2.5[.1] // 重点在这里 重点在这里 重点在这里
[ruby-]2.6[.0-preview2] // 测试版
ruby-head
.....
```
``` 5、安装一个ruby版本
```
rvm install 2.5.1
// 注意:安装过程中需要两次按下 Enter 键, 第二次按下后需要输入电脑访问密码(不可见,只管输入就行);
// 如果你电脑没有安装Xcode和Command Line Tools for Xcode以及Homebrew 会自动下载安装,建议提前安装这三者.
这里很多小伙伴会遇到错误，大部分是因为没有安装Homebrew造成，所以所以所以要提前安装比较好
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```
6、设置为默认版本
```
rvm use 2.5.1 --default
```
7、更换源
```
sudo gem update --system
gem sources --remove https://rubygems.org/
gem sources --add https://gems.ruby-china.com/
```
8、为了验证你的Ruby镜像是并且仅是ruby-china，执行以下命令查看
**日志工具类** ```
(1) 单例模式 gem sources -l
如果是以下结果说明正确，如果有其他的请自行百度解决
*** CURRENT SOURCES ***
https://gems.ruby-china.com/
```
9、这时候才正式开始安装CocoaPods
```
sudo gem install -n /usr/local/bin cocoapods
```
10、如果安装了多个Xcode使用下面的命令选择（一般需要选择最近的Xcode版本）
```
sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer
```
11、安装本地库
```
pod setup
```
12、执行以上命令后
```
Setting up CocoaPods master repo
$ /usr/bin/git clone https://github.com/CocoaPods/Specs.git master --progress
Cloning into 'master'...
remote: Counting objects: 1879515, done.
remote: Compressing objects: 100% (321/321), done.
Receiving objects: 21% (404525/1879515), 73.70 MiB | 22.00 KiB/
然后就是漫长的等待，当然,网络好的情况下会更快
```
2. 在Podfile文件中添加
```
如果是有连麦的SDK:
pod 'CCLivePlaySDK', '~> 3.8.0'
如果是无连麦的SDK:
pod 'CCLivePlaySDK', '~> 3.8.0', :podspec => 'https://raw.githubusercontent.com/CCVideo/Live_iOS_Play_SDK/master/CCLivePlaySDK.podspec'
```
3. 在终端中执行
```
pod install
```
**ps:目前CocoaPods集成仅支持3.8.0及以后的版本,旧版本暂不支持CocoaPods集成**
### 2.2.2 手动集成
1.将SDK文件夹内的所有文件拖到项目中
``` ```
/** command + b 编译，如果报错" file '...xxx/IJKMediaFramework.framework/IJKMediaFramework' for architecture arm64 "
解决方案：
Targets -> Build Settings -> 搜索 "Enable Bitcode" 设置为 "NO"
```
2.command + r 运行
- @brief 获取单例对象 ```
*/ 如果报错" dyld: Library not loaded: @rpath/XXX.framework "
解决方案：
Targets -> Build Phases ->
点击左上角 "+" 按钮 ->
选择 "New Copy Files Phase" ->
点击新添加的 Copy Files 前面的下拉箭头 ->
Destination 选择 "Frameworks" ->
点击当前目录下的 "+" 将SDK包含的.framework 包添加即可
```
- (instancetype)sharedInstance;
/** ## 2.3 日志存储
- @brief 是否需要存储日志信息到文件中，最好在AppDelegate类里面调用，这样就适用于全局日 在AppDelegate.m文件导入头文件
- 志的存储，当然中途调用也可以，从调用后开始应用之后的日志存储逻辑
*/
-(void)isNeedToSaveLog:(BOOL)needsave;
/** ```
#import "CCSDK/SaveLogUtil.h"
```
- @brief 存储日志的信息 在启动方法中添加日志存储
- action相当于key，也可以理解为存储的事件名称
- logStr相当于value，也可以理解为存储的日志信息字符串
*/
-(void)saveLog:(NSString *)logStr action:(NSString *)action;
```
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
/**
* @brief 是否存储日志
*/
[[SaveLogUtil sharedInstance]isNeedToSaveLog:YES];
return YES;
}
``` ```
## 2.4 错误码
服务错误类型
(2) 示例应用及说明 ```
ERROR_SERVICE_TYPE
ERROR_ROOM_STATE = 1001 直播间状态不可用，可能没有开始推流
ERROR_USELESS_INFO = 1002 没有获取到有用的视频信息
ERROR_PASSWORD = 1003 密码错误
```
系统错误类型
在CCSDK中相关的信息已经做了日志打印的相关处理操作，但是在demo中也添加了几句话，用户也可以自定义添加自己需要的日志，用于记录或者调试都可以。 ```
ERROR_SYSTEM_TYPE
ERROR_RETURNDATA = 1004 返回内容格式错误
ERROR_PARAMETER = 1005 直播间信息填写错误
ERROR_NETWORK = 1006 网络异常
ERROR_LOGINDATA = 1007 登录
ERROR_PLAYERURL = 1008 视频播放地址
ERROR_QUESTIONLIST = 1009 问卷列表
ERROR_STATISTICAL = 1010 问卷统计
ERROR_DOCLIST = 1011 文档列表
ERROR_HISTORY = 1012 历史信息
PRACTICE_LIST = 1013 随堂测试
PRACTICECOMMIT = 1014 提交随堂测试
PRACTICESTATIS = 1015 获取随堂测统计
PRACTICERANK = 1016 获取随堂测排名
ERROR_SOCKET = 1017 socket加载失败
ERROR_PUNCH = 1018 获取打卡信息失败
ERROR_PUNCHCOMMIT = 1019 获取打卡提交结果失败
ERROR_DRMURL = 1020 获取加密地址失败
```
注意： # 3.快速集成
1) SDK中设置的日志存储目录为：NSHomeDirectory()/Library/CCLog/ ，存储文件名为yyyy-MM-dd.log ## 3.1 配置参数
2) SDK中如果开启了日志存储以后，日志只存不删，需要使用者按照自己的逻辑进行删除 3.1.1 调用方法
```
/**
* @brief 登录房间
* @param parameter 配置参数信息
* 必填参数 userId //用户ID
* 必填参数 roomId //房间ID
* 必填参数 liveid //直播ID，回放时才用到
* 必填参数 viewerName //用户名称
* 必填参数 token //房间密码
* (已弃用!) security //是否使用https
*
- (id)initLoginWithParameter:(PlayParameter *)parameter;
/**
* @brief 进入房间，并请求画图聊天数据并播放视频（可以不登陆，直接从此接口进入直播间）
* @param parameter 配置参数信息
* 必填参数 userId; //用户ID
* 必填参数 roomId; //房间ID
* 必填参数 liveid; //直播ID，回放时才用到
* 必填参数 viewerName; //用户名称
* 必填参数 token; //房间密码
* 必填参数 docParent; //文档父类窗口
* 必填参数 docFrame; //文档区域
* 必填参数 playerParent; //视频父类窗口
* 必填参数 playerFrame; //视频区域
* (已弃用!) security //是否使用https
* 必填参数 pauseInBackGround; //后台是否继续播放，注意：如果开启后台播放需要打开 xcode->Capabilities->Background Modes->on->Audio,AirPlay,and Picture in Picture
* 必填参数 defaultColor; //ppt默认底色，不写默认为白色
* 必填参数 PPTScalingMode; //PPT适配方式 PPT适配模式分为四种，1.一种是全部填充屏幕，可拉伸变形，2.第二种是等比缩放，横向或竖向贴住边缘，另一方向可以留黑边，3.第三种是等比缩放，横向或竖向贴住边缘，另一方向出边界，裁剪PPT，不可以留黑边，4.根据直播间文档显示模式的返回值进行设置(推荐)(The New Method)
* 必填参数 scalingMode; //屏幕适配方式
*/
- (id)initWithParameter:(PlayParameter *)parameter;
``` ```
1. 在AppDelegate.m中添加了 代理方法
[[SaveLogUtil sharedInstance]isNeedToSaveLog:YES];
表示设置为记录日志log
2. 在PlayForPCVC.m中添加了
[[SaveLogUtil sharedInstance] saveLog:@"" action:@"视频加载成功或开始播放，多次调用，不必关心"];
表示视频加载成功或开始播放
3. PlayBackVC.m中添加了
[[SaveLogUtil sharedInstance] saveLog:@"" action:@"视频加载成功或开始播放，多次调用，不必关心"];
表示视频加载成功或开始播放
``` ```
/**
* @brief 请求回放地址成功
*/
-(void)requestSucceed;
/**
* @brief 请求回放地址失败
*/
-(void)requestFailed:(NSError *)error reason:(NSString *)reason;
/**
* @brief 登录成功
*/
- (void)loginSucceedPlayBack;
/**
* @brief 登录失败
*/
-(void)loginFailed:(NSError *)error reason:(NSString *)reason;
```
3.1.2 集成
## 3.快速集成 导入头文件
首先，需要下载最新版本的SDK，下载地址为：[Live_iOS_Play_SDK](https://github.com/CCVideo/Live_iOS_Play_SDK) ```
集成前需要知道的事情: #import "CCSDK/RequestDataPlayBack.h"//SDK
1. 工程分三个部分：一个有连麦功能（Demo-观看端有连麦），体积较大，一个无连麦功能（Demo-观看端无连麦），体积较小，第三个部分是离线下载回放（Demo-离线下载），其中离线下载回放中的CCSDK用有连麦的库和无连麦的库都可以，示例中用的无连麦的库(体积较小) ```
2. （重要）本SDK只支持真机，不支持模拟器
3. （重要）本SDK只支持iOS8.0及以上版本，iOS7.x版本不支持
4. （重要）当使用有连麦工程时，分为音视频连麦和音频连麦两种连麦，有连麦的demo中没有以页面体现两种连麦的按钮，当选中简介时，连麦为音视频连麦，当选中 文档，聊天或问答任意一个时，连麦为音频连麦，代码使中用_isAudioVideo加以区分，当_isAudioVideo==YES;时为音视频连麦，当_isAudioVideo==NO;时为音频连麦
### 3.1 导入framework
三个工程SDK目录都在工程目录下的CCSDK文件夹中，文件夹中的所有文件都属于SDK部分，应全部应用(注意不要遗漏socketio.html文件)
### 3.2 Demo 声明变量
1. Demo-观看端有连麦实现了基本的播放，在线回放逻辑，可以直接运行
2. Demo-观看端无连麦实现了基本的播放，在线回放逻辑，可以直接运行，除无连麦外，功能同上
3. Demo-离线下载实现了基本的离线下载和离线回放逻辑，可以直接运行（其中的CCSDK用4，5两个工程中的任意一个CCSDK文件夹即可）
### 3.3 配置依赖库 ```
@property (nonatomic,strong)RequestData * requestDataPlayBack;//sdk
```
在项目/General/Linked framework and libraries 中不要忘记添加对用的依赖 配置参数:PlayParameter的属性如下
**基础配置类PlayParameter**
``` ```
/**
* @brief 用户ID
*/
@property(nonatomic, copy)NSString *userId;//用户ID @property(nonatomic, copy)NSString *userId;//用户ID
/**
* @brief 房间ID
*/
@property(nonatomic, copy)NSString *roomId;//房间ID @property(nonatomic, copy)NSString *roomId;//房间ID
/**
* @brief 用户名称
*/
@property(nonatomic, copy)NSString *viewerName;//用户名称 @property(nonatomic, copy)NSString *viewerName;//用户名称
/**
* @brief 房间密码
*/
@property(nonatomic, copy)NSString *token;//房间密码 @property(nonatomic, copy)NSString *token;//房间密码
@property(nonatomic, copy)NSString *liveId;//回放ID，回放时才用到 /**
* @brief 直播ID，回放时才用到
*/
@property(nonatomic, copy)NSString *liveId;//直播ID，回放时才用到
/**
* @brief 回放ID
*/
@property(nonatomic, copy)NSString *recordId;//回放ID @property(nonatomic, copy)NSString *recordId;//回放ID
/**
* @brief 用户自定义参数，需和后台协商，没有定制传@""
*/
@property(nonatomic, copy)NSString *viewerCustomua;//用户自定义参数，需和后台协商，没有定制传@"" @property(nonatomic, copy)NSString *viewerCustomua;//用户自定义参数，需和后台协商，没有定制传@""
@property(nonatomic, copy)NSString *destination;//下载文件解压到的目录路径(离线下载相关) /**
* json格式字符串，可选，自定义用户信息，该信息会记录在用户访问记录中，用于统计分析使用（长度不能超过1000个字符，若直播间启用接口验证则该参数无效）如果不需要的话就不要传值
* 格式如下：
* viewercustominfo: '{"exportInfos": [ {"key": "城市", "value": "北京"}, {"key": "姓名", "value": "哈哈"}]}'
*/
@property(nonatomic, copy)NSString *viewercustominfo;
/**
* @brief 文档父类窗口
*/
@property(nonatomic,strong)UIView *docParent;//文档父类窗口 @property(nonatomic,strong)UIView *docParent;//文档父类窗口
/**
* @brief 文档区域
*/
@property(nonatomic,assign)CGRect docFrame;//文档区域 @property(nonatomic,assign)CGRect docFrame;//文档区域
/**
* @brief 视频父类窗口
*/
@property(nonatomic,strong)UIView *playerParent;//视频父类窗口 @property(nonatomic,strong)UIView *playerParent;//视频父类窗口
/**
* @brief 视频区域
*/
@property(nonatomic,assign)CGRect playerFrame;//视频区域 @property(nonatomic,assign)CGRect playerFrame;//视频区域
@property(nonatomic,assign)BOOL security;//是否使用https，静态库暂时只能使用http协议 /**
/* * @brief
* 0:IJKMPMovieScalingModeNone * 0:IJKMPMovieScalingModeNone
* 1:IJKMPMovieScalingModeAspectFit * 1:IJKMPMovieScalingModeAspectFit
* 2:IJKMPMovieScalingModeAspectFill * 2:IJKMPMovieScalingModeAspectFill
* 3:IJKMPMovieScalingModeFill * 3:IJKMPMovieScalingModeFill
*/ */
@property(assign, nonatomic)NSInteger scalingMode;//屏幕适配方式，含义见上面 @property(assign, nonatomic)NSInteger scalingMode;//屏幕适配方式，含义见上面
@property(nonatomic,strong)UIColor *defaultColor;//ppt默认底色，不设置(nil)默认为白色 /**
* @brief ppt默认底色，不写默认为白色
*/
@property(nonatomic,strong)UIColor *defaultColor;//ppt默认底色，不写默认为白色
/**
* @brief /后台是否继续播放，注意：如果开启后台播放需要打开 xcode->Capabilities->Background Modes->on->Audio,AirPlay,and Picture in Picture
*/
@property(nonatomic,assign)BOOL pauseInBackGround;//后台是否继续播放，注意：如果开启后台播放需要打开 xcode->Capabilities->Background Modes->on->Audio,AirPlay,and Picture in Picture @property(nonatomic,assign)BOOL pauseInBackGround;//后台是否继续播放，注意：如果开启后台播放需要打开 xcode->Capabilities->Background Modes->on->Audio,AirPlay,and Picture in Picture
/* /**
* PPT适配模式分为三种， * @brief PPT适配模式分为四种，
* 1.一种是全部填充屏幕，可拉伸变形， * 1.一种是全部填充屏幕，可拉伸变形，
* 2.第二种是等比缩放，横向或竖向贴住边缘，另一方向可以留黑边， * 2.第二种是等比缩放，横向或竖向贴住边缘，另一方向可以留黑边，
* 3.第三种是等比缩放，横向或竖向贴住边缘，另一方向出边界，裁剪PPT，不可以留黑边 * 3.第三种是等比缩放，横向或竖向贴住边缘，另一方向出边界，裁剪PPT，不可以留黑边
*/ * 4.根据直播间文档显示模式的返回值进行设置(推荐)
*/
@property(assign, nonatomic)NSInteger PPTScalingMode;//PPT适配方式，含义见上面 @property(assign, nonatomic)NSInteger PPTScalingMode;//PPT适配方式，含义见上面
``` /**
* @brief PPT是否允许滚动
*/
@property(nonatomic, assign)BOOL pptInteractionEnabled;
/**
### 3.4 登录直播间 * @brief 设置当前的文档模式，
**可以登录也可以不登录,本文档是按照需要登录设计的,如不需登录请跳过3.4** * 1.切换至跟随模式（默认值）值为0，
* 2.切换至自由模式；值为1，
*/
@property(assign, nonatomic)NSInteger DocModeType;//设置当前的文档模式
```
开始配置
首先导入头文件
``` ```
#import "CCSDK/CCLiveUtil.h" 第一步:实例化参数类
#import "CCSDK/RequestDataPlayBack.h" PlayParameter *parameter = [[PlayParameter alloc] init];
//配置PlayParameter里面的属性,如userId,roomId等!
第二步实例化RequestData类
_requestDataPlayBack = [[RequestDataPlayBack alloc] initWithParameter:parameter];
_requestDataPlayBack.delegate = self;
第三步添加代理
_requestDataPlayBack.delegate = self;
``` ```
配置参数
添加代理
``` ```
//更多参数请查看PlayParameter 属性 @interface 您的控制器 ()<RequestDataPlayBackDelegate>
PlayParameter *parameter = [[PlayParameter alloc] init];
parameter.userId = @"用户ID";
parameter.roomId = @"房间ID";
parameter.liveId = @"直播ID，回放时才用到";
parameter.recordId = @"回放ID";
parameter.viewerName = @"用户名称";
parameter.token = @"房间密码";
parameter.security = @"是否使用https，静态库暂时只能使用http协议";
parameter.pauseInBackGround = YES;后台是否继续播放
_requestDataPlayBack = [[RequestDataPlayBack alloc] initWithParameter:parameter];
_requestDataPlayBack.delegate = self;;//需要实现RequestDataPlayBackDelegate代理方法
``` ```
实现代理方法
实现代理
``` ```
#pragma mark - RequestDataPlayBackDelegate
/** /**
* @brief 请求成功 * @brief 请求回放地址成功
*/ */
-(void)requestSucceed { -(void)requestSucceed;
// NSLog(@"请求成功！");
}
/** /**
* @brief 登录请求失败 * @brief 请求回放地址失败
*/ */
-(void)requestFailed:(NSError *)error reason:(NSString *)reason { -(void)requestFailed:(NSError *)error reason:(NSString *)reason;
NSString *message = nil;
if (reason == nil) {
message = [error localizedDescription];
} else {
message = reason;
}
}
```
### 3.5 开启视频直播回放
跳转到直播回放页面,配置观看直播回放同样需要导入头文件
```
#import "CCSDK/CCLiveUtil.h"
#import "CCSDK/RequestDataPlayBack.h"
```
配置参数,和登录时配置的参数差不多,很多参数都是登录传过来的
```
PlayParameter *parameter = [[PlayParameter alloc] init];
parameter.userId = @"用户ID";
parameter.roomId = @"房间ID";
parameter.liveId = @"直播ID，回放时才用到";
parameter.recordId = @"回放ID";
parameter.viewerName = @"用户名称";
parameter.token = @"房间密码";
parameter.playerParent = self.videoView;//视频父类窗口
parameter.playerFrame = _videoRect//视频区域;
parameter.security = NO;
parameter.pauseInBackGround = YES;
parameter.defaultColor = [UIColor whiteColor];
parameter.scalingMode = 1;
_requestDataPlayBack = [[RequestDataPlayBack alloc] initWithParameter:parameter];
_requestDataPlayBack.delegate = self;
``` ```
### 3.6 文档观看
PlayParameter增加两个属性
```
@property(nonatomic,strong)UIView *docParent;//文档父类窗口
@property(nonatomic,assign)CGRect docFrame;//文档区域
```
## 4. 功能使用
### 4.1 RequestDataPlayBack回放请求类介绍
#### 4.1.1 在回放PlayBackViewController.m中主要调用此类来和此SDK交互
#### 4.1.2 RequestDataPlayBack中的成员变量 **至此您的项目已经可以运行了,并且已经集成好了视频基本功能;如果不需要文档功能则不配置文档相关属性即可,另外添加文档功能写一个定时器在视频开始播放时调用下面的方法即可**
``` ```
@property (weak,nonatomic) id<RequestDataPlayBackDelegate> delegate;//代理 /**
* @brief time：从直播开始到现在的秒数，SDK会在画板上绘画出来相应的图形
*/
- (void)continueFromTheTime:(NSInteger)time;
```
@property (retain, atomic) id<IJKMediaPlayback> ijkPlayer;//播放器
```
播放器倍速，直播和回放都可以用，一般只用于回放 ## 3.2 观看回放
ijkPlayer.playbackRate = 1.5; 设置播放器以1.5倍速播放，其他倍速同理，可快可慢 3.2.1 代理方法(可选)
float speed = ijkPlayer.playbackRate; 获取当前播放器的播放速度，并赋值给speed变量
#### 4.1.3 RequestDataPlayBack中的成员方法
``` ```
/** /**
* @brief 登录房间 * @brief 加载视频失败
* @param parameter 配置参数信息 */
* 必填参数 userId - (void)playback_loadVideoFail;
* 必填参数 roomId
* 必填参数 liveid
* 必填参数 viewerName
* 必填参数 token
* 必填参数 security
*/
- (id)initLoginWithParameter:(PlayParameter *)parameter;
/** /**
* @brief 进入房间，并请求画图聊天数据并播放视频（可以不登陆，直接从此接口进入直播间） * @brief 回放的开始时间和结束时间
* @param parameter 配置参数信息 * @param dic {endTime //结束时间
* 必填参数 userId; startTime //开始时间 }
* 必填参数 roomId; */
* 必填参数 liveid; -(void)liveInfo:(NSDictionary *)dic;
* 必填参数 viewerName;
* 必填参数 token;
* 必填参数 docParent;
* 必填参数 docFrame;
* 必填参数 playerParent;
* 必填参数 playerFrame;
* 必填参数 security;
* 必填参数 pauseInBackGround;
* 必填参数 defaultColor;
* 必填参数 PPTScalingMode;
* 必填参数 scalingMode;
*/
- (id)initWithParameter:(PlayParameter *)parameter;
/** /**
* @brief 销毁文档和视频，清除视频和文档的时候需要调用,推出播放页面的时候也需要调用 * @brief 视频状态
*/ * rseult playing/paused/loading
- (void)requestCancel; */
-(void)videoStateChangeWithString:(NSString *) result;
/** /**
* @brief time：从直播开始到现在的秒数，SDK会在画板上绘画出来相应的图形 * @brief 跑马灯
*/ * @param dic action [{ //事件
- (void)continueFromTheTime:(NSInteger)time; duration //执行时间
end { //结束位置
alpha //透明度
xpos //x坐标
ypos //y坐标 },
start { //开始位置
alpha //透明度
xpos //x坐标
ypos //y坐标}]
image { //包含图片
height //图片高度
image_url //地址
width //图片宽度}
loop //循环次数 -1 无限循环
text { //文字信息
color //文字颜色
content //文字内容
font_size //字体大小}
type //当前类型 text 文本 image 图片
*/
-(void)receivedMarqueeInfo:(NSDictionary *)dic;
/** /**
* @brief 获取文档区域内白板或者文档本身的宽高比，返回值即为宽高比，做屏幕适配用 *接收到播放线路 例:int值 2 代表两条 changeLineWithNum传0或1
*/ */
- (CGFloat)getDocAspectRatio; -(void)numberOfReceivedLines:(NSInteger)linesCount;
```
/** 3.2.2 主动方法(可选)
* @brief 改变文档区域大小,主要用在文档生成后改变文档窗口的frame
*/
- (void)changeDocFrame:(CGRect) docFrame;
```
/** /**
* @brief 改变播放器frame * @brief 销毁文档和视频，清除视频和文档的时候需要调用,推出播放页面的时候也需要调用
*/ */
- (void)requestCancel;
/**
* @brief 改变播放器frame
*/
- (void)changePlayerFrame:(CGRect) playerFrame; - (void)changePlayerFrame:(CGRect) playerFrame;
/** /**
* @brief 播放器暂停 * @brief 改变播放器父窗口
*/ */
- (void)changePlayerParent:(UIView *) playerParent;
/**
* @brief 播放器暂停
*/
- (void)pausePlayer; - (void)pausePlayer;
/** /**
* @brief 播放器播放 * @brief 播放器播放
*/ */
- (void)startPlayer; - (void)startPlayer;
/** /**
* @brief 播放器关闭 * @brief 播放器关闭
*/ */
- (void)shutdownPlayer; - (void)shutdownPlayer;
/** /**
* @brief 播放器停止 * @brief 播放器停止
*/ */
- (void)stopPlayer; - (void)stopPlayer;
/** /**
* @brief 从头播放 * @brief 从头重新播放
*/ */
- (void)replayPlayer; - (void)replayPlayer;
/** /**
* @brief 播放器是否播放 * @brief 播放器是否播放
*/ */
- (BOOL)isPlaying; - (BOOL)isPlaying;
/**
/* * @brief 播放器当前播放时间
* @brief 播放器当前播放时间 */
*/
- (NSTimeInterval)currentPlaybackTime; - (NSTimeInterval)currentPlaybackTime;
/**
/* * @brief 设置播放器当前播放时间（用于拖拽进度条时掉用的）
* @brief 设置播放器当前播放时间（用于拖拽进度条时掉用的） */
*/
- (void)setCurrentPlaybackTime:(NSTimeInterval)time; - (void)setCurrentPlaybackTime:(NSTimeInterval)time;
/**
/* * @brief 回放视频总时长
* @brief 回放视频总时长 */
*/
- (NSTimeInterval)playerDuration; - (NSTimeInterval)playerDuration;
/** /**
* @brief 设置后台是否可播放 * @brief 设置后台是否可播放
*/ */
- (void)setpauseInBackGround:(BOOL)pauseInBackGround; - (void)setpauseInBackGround:(BOOL)pauseInBackGround;
/**
* @brief 改变文档背景颜色
@param hexColor 字符串,传颜色的HEXColor 如:#000000
*/
- (void)changeDocWebColor:(NSString *)hexColor;
/**
* @brief 获取随堂测信息
*/
-(void)getPracticeInformation;
/**
* @brief 切换线路
* index 传入numberOfReceivedLines的返回值 如:返回2 则传0或1
* results:
success 0 切换成功 -1切换品失败 -2 切换频繁
currentIndex 当前播放线路
*/
- (void)changeLineWithNum:(NSInteger)index completion:(void (^)(NSDictionary * results))completion;
``` ```
### 4.2 事件监听 ## 3.3 文档功能
事件监听只需要实现对应的代理方法即可
#### 4.2.1 获取文档内白板或者文档本身的宽高 3.3.1 代理方法(可选)
``` ```
/** /**
* @brief 获取文档内白板或者文档本身的宽高，来进行屏幕适配用的 * @brief 获取文档内白板或者文档本身的宽高，来进行屏幕适配用的
*/ */
- (void)getDocAspectRatioOfWidth:(CGFloat)width height:(CGFloat)height; - (void)getDocAspectRatioOfWidth:(CGFloat)width height:(CGFloat)height;
```
#### 4.2.2 历史提问&回答
```
/** /**
* @brief 收到本房间的历史提问&回答 * @brief 获取ppt当前页数和总页数(The new method)
*/ *
- (void)onParserQuestionArr:(NSArray *)questionArr onParserAnswerArr:(NSArray *)answerArr; * 回调当前翻页的页数信息
``` * 白板docTotalPage一直为0, pageNum从1开始
#### 4.2.3 历史聊天数据 * 其他文档docTotalPage为正常页数,pageNum从0开始
``` * @param dictionary 翻页信息
* dictionary :{docId 文档ID
* docName 文档名
* docTotalPage 文档总页数
* pageNum 文档页码}
*/
- (void)onPageChange:(NSDictionary *) dictionary;
/** /**
* @brief 解析本房间的历史聊天数据 * @brief 回放翻页数据列表
*/ * @param array[{ docName //文档名
-(void)onParserChat:(NSArray *)arr; pageTitle //页标题
``` time //时间
#### 4.2.4 请求回放地址成功 url //地址 }]
``` */
- (void)pageChangeList:(NSMutableArray *)array;
/** /**
* @brief 请求回放地址成功 * @brief 双击ppt
*/ */
-(void)requestSucceed; - (void)doubleCllickPPTView;
```
#### 4.2.5 请求回放地址失败
```
/** /**
* @brief 请求回放地址失败 * @brief 文档加载状态(The new method)
*/ * index
-(void)requestFailed:(NSError *)error reason:(NSString *)reason; * 0 文档组件初始化完成
* 1 动画文档加载完成
* 2 非动画文档加载完成
*/
- (void)docLoadCompleteWithIndex:(NSInteger)index;
``` ```
#### 4.2.6 登录成功
3.3.2 主动方法(可选)
``` ```
/** /**
* @brief 登录成功 * @brief time：从直播开始到现在的秒数，SDK会在画板上绘画出来相应的图形
*/ */
- (void)loginSucceedPlayBack; - (void)continueFromTheTime:(NSInteger)time;
```
#### 4.2.7 登录失败
```
/** /**
* @brief 登录失败 * @brief 获取文档区域内白板或者文档本身的宽高比，返回值即为宽高比，做屏幕适配用
*/ */
-(void)loginFailed:(NSError *)error reason:(NSString *)reason; - (CGFloat)getDocAspectRatio;
```
#### 4.2.8 获取房间信息
```
/** /**
* @brief 获取房间信息，主要是要获取直播间模版来类型，根据直播间模版类型来确定界面布局 * @brief 改变文档区域大小,主要用在文档生成后改变文档窗口的frame
* 房间简介：dic[@"desc"]; */
* 房间名称：dic[@"name"]; - (void)changeDocFrame:(CGRect) docFrame;
* 房间模版类型：[dic[@"templateType"] integerValue];
* 模版类型为1: 聊天互动： 无 直播文档： 无 直播问答： 无
* 模版类型为2: 聊天互动： 有 直播文档： 无 直播问答： 有
* 模版类型为3: 聊天互动： 有 直播文档： 无 直播问答： 无
* 模版类型为4: 聊天互动： 有 直播文档： 有 直播问答： 无
* 模版类型为5: 聊天互动： 有 直播文档： 有 直播问答： 有
* 模版类型为6: 聊天互动： 无 直播文档： 无 直播问答： 有
*/
-(void)roomInfo:(NSDictionary *)dic;
```
#### 4.2.9 加载视频失败
```
/*
* 加载视频失败
*/
- (void)playback_loadVideoFail;
```
#### 4.2.10 回放翻页数据列表
```
/*
* 回放翻页数据列表
* docName 文档名称
* url 文档url
* pageTitle 页面标题
* time 翻页时间
*/
- (void)pageChangeList:(NSMutableArray *)array;
```
#### 4.2.11 获取PPT当前页数和总页数
```
/** /**
* @brief 获取ppt当前页数和总页数(The new method) * @brief 改变文档父窗口
* */
* 回调当前翻页的页数信息 <br/> - (void)changeDocParent:(UIView *) docParent;
* 白板docTotalPage一直为0, pageNum从1开始<br/>
* 其他文档docTotalPage为正常页数,pageNum从0开始<br/>
* @param dictionary 翻页信息
*/
- (void)onPageChange:(NSDictionary *) dictionary;
``` ```
#### 4.2.12 获取历史广播
## 3.4 房间信息
代理方法(可选)
``` ```
/** /**
* @brief 收到历史广播(The new method) * @brief 获取房间信息，主要是要获取直播间模版来类型，根据直播间模版类型来确定界面布局
* content 广播内容 * 房间信息
* time 发布时间(单位:秒) * baseRecordInfo = {
*/ description = "简介";
- (void)broadcastHistory_msg:(NSArray *)History_msg; title = "标题";
``` };
####4.2.13 回放的开始时间和结束时间 * 房间模版类型：[dic[@"templateType"] integerValue];
``` * 模版类型为1: 聊天互动： 无 直播文档： 无 直播问答： 无
* 模版类型为2: 聊天互动： 有 直播文档： 无 直播问答： 有
* 模版类型为3: 聊天互动： 有 直播文档： 无 直播问答： 无
* 模版类型为4: 聊天互动： 有 直播文档： 有 直播问答： 无
* 模版类型为5: 聊天互动： 有 直播文档： 有 直播问答： 有
* 模版类型为6: 聊天互动： 无 直播文档： 无 直播问答： 有
*/
-(void)roomInfo:(NSDictionary *)dic;
/** /**
* @brief 回放的开始时间和结束时间(The new method) * @brief 服务器端给自己设置的信息(The new method)
*/ * viewerId 服务器端给自己设置的UserId
-(void)liveInfo:(NSDictionary *)dic; * groupId 分组id
``` * name 用户名
### 4.3.播放器监听 */
**添加播放器监听事件（监听播放状态改变）** -(void)setMyViewerInfo:(NSDictionary *) infoDic;
```
1. 播放器的监听事件有以下几种
1. IJKMPMoviePlayerLoadStateDidChangeNotification 视频加载视频状态发生改变
（1）IJKMPMovieLoadStateStalled 正在加载
（2）IJKMPMovieLoadStatePlayable 可以播放
（3）IJKMPMovieLoadStatePlaythroughOK 已经缓存完成,如果设置了自动播放,这时会自动播放
2. IJKMPMoviePlayerPlaybackStateDidChangeNotification 视频播放状态发生改变
（1）IJKMPMoviePlaybackStateStopped 播放停止
（2）IJKMPMoviePlaybackStatePlaying 播放
（3）IJKMPMoviePlaybackStatePaused 暂停
（4）IJKMPMoviePlaybackStateInterrupted 打断（停止，中断）
（5）IJKMPMoviePlaybackStateSeekingForward 向前拖动
（6）IJKMPMoviePlaybackStateSeekingBackward 向后拖动
3. IJKMPMoviePlayerPlaybackDidFinishReasonUserInfoKey 视频播放终止播放原因
4. IJKMPMoviePlayerPlaybackDidFinishNotification 视频终止播放
5. IJKMPMovieNaturalSizeAvailableNotification 视频开始播放时，用这个可以监听到视频的分辨率
6. IJKMPMoviePlayerPlaybackDidFinishReasonUserInfoKey 视频播放完成(有可能是加载失败，也有可能是播放结束)
7. IJKMPMoviePlayerPlaybackDidFinishNotification 视频播放完成(有可能是加载失败，也有可能是播放结束)
```
### 4.4 接收数据格式介绍
1 收到提问&回答(RequestDataDelegate和RequestDataPlayBackDelegate 中代理方法)
```
RequestDataDelegate中代理名称如下：
- (void)onQuestionArr:(NSArray *)questionArr onAnswerArr:(NSArray *)answerArr;
RequestDataPlayBackDelegate中代理名称如下：
- (void)onParserQuestionArr:(NSArray *)questionArr onParserAnswerArr:(NSArray *)answerArr;
``` ```
2 提问格式，数组
``` ## 3.5 聊天功能
(
{ 代理方法(可选)
content = question;//问题内容
encryptId = 2264AF619DD010E9;//问题ID
id = 342854;//提问ID，此ID和上面的encryptId无差别，都是提问的唯一标志，且和下面的回答id是一对多对应，一个问题可以有多条回答信息
isPublish = 1;//问题是否发布
questionUserAvatar = "";//头像
questionUserId = 00d30351184d4cbdb0fcbadd9a55ba1c;//提问问题的用户的用户id
questionUserName = qwer;//提问问题用户的用户名
time = 69006;//提问问题时间点（毫秒）
triggerTime = "2017-11-21 13:50:19";//具体时间点
}
)
```
3 收到提问(RequestDataDelegate中代理方法)
```
- (void)onQuestionDic:(NSDictionary *)questionDic;
{
action = question;
time = 0;//新的提问和回答时间全部为0，历史的提问和回答才有正确时间
value = {
content = question;
id = BC2D248818827729;//如果该用户被禁言后，该用户发出问题的id都为-1，并且该问题只会发送给该用户，不会发送给其他用户
triggerTime = "2017-11-21 14:02:54";
userAvatar = "";
userId = 9c408a9761d74cb9b64587b2776c5327;
userName = qwer;
};
}
注：提问者角色默认为学生
```
4 收到回答(RequestDataDelegate中代理方法)
```
- (void)onAnswerDic:(NSDictionary *)answerDic;
{
action = answer;
time = 0;//新的提问和回答时间全部为0，历史的提问和回答才有正确时间
value = {
content = answer;
isPrivate = 0;
questionId = BC2D248818827729;
questionUserId = 9c408a9761d74cb9b64587b2776c5327;
triggerTime = "2017-11-21 14:04:17";
userAvatar = "";
userId = 4c70191006d54d549e43ccff4bc1bfd1;
userName = admin;
userRole = publisher;
};
}
```
5 收到30条历史聊天数据信息(RequestDataDelegate中代理方法)
```
- (void)onChatLog:(NSArray *)chatLogArr;
(
{
content = message;//聊天内容
time = 68996;//聊天时间（毫秒）
userAvatar = "";//聊天者头像
userCustomMark = "";//个性化信息
userId = 00d30351184d4cbdb0fcbadd9a55ba1c;//聊天者id
userName = qwer;//聊天者用户名
userRole = student;//聊天者用户角色
}
)
```
6 收到学生发送的公聊信息(RequestDataDelegate中代理方法)
``` ```
- (void)onPublicChatMessage:(NSDictionary *)dic; /**
{ * @brief 解析本房间的历史聊天数据
msg = chat;//内容 * @param chatArr [{ chatId //聊天ID
time = "14:10:16";//时间 content //聊天内容
useravatar = "";//头像 groupId //聊天组ID
usercustommark = "";//个性化信息 time //时间
userid = 9c408a9761d74cb9b64587b2776c5327;//用户id userId //用户ID
username = qwer;//用户名 userName //用户名
userrole = student;//用户角色 userRole //用户角色}]
} */
-(void)onParserChat:(NSArray *)arr;
``` ```
7 收到学生禁言消息(RequestDataDelegate中代理方法)
```
(void)onSilenceUserChatMessage:(NSDictionary *)message;
{
msg = asdfghj; ## 3.6 问答功能
time = "14:13:53"; 代理方法(可选)
useravatar = ""; ```
/**
* @brief 收到历史提问&回答
* @param questionArr [{content //问答内容
encryptId //加密ID
groupId //分组ID
isPublish //1 发布的问答 0 未发布的问答
questionUserId //问答用户ID
questionUserName //问答用户名
time //问答时间
triggerTime //问答具体时间}]
* @param answerArr [{answerUserId //回复用户ID
answerUserName //回复名
answerUserRole //回复角色（主讲、助教）
content //回复内容
encryptId //加密ID
groupId //分组ID
isPrivate //1 私聊回复 0 公共回复
time = 135; //回复时间
triggerTime //回复具体时间}]
*/
- (void)onParserQuestionArr:(NSArray *)questionArr onParserAnswerArr:(NSArray *)answerArr;
```
usercustommark = "";
userid = 9c408a9761d74cb9b64587b2776c5327;
username = qwer; ## 3.7 广播功能
userrole = student; 代理方法(可选)
} ```
/**
* @brief 收到本房间历史广播(The new method)
* content 广播内容
* time 发布时间(单位:秒)
*/
- (void)broadcastHistory_msg:(NSArray *)array;
``` ```
8 收到学生私聊(RequestDataDelegate中代理方法) ## 3.8 随堂测
代理方法(可选)
```
/**
* @brief 接收到随堂测(The new method)
* rseultDic 随堂测内容
resultDic {isExist //1 随堂考存在 0随堂考不存在
practice {id //随堂考主键ID
isAnswered //false 未回答过 true 回答过
options = ({ id //选项主键ID
index //选项序号})
publishTime //发布时间
status //发布状态 1开启 0关闭
type //题目类型 0判断 1单选 2多选}
serverTime //分发时间}
*
*/
-(void)receivePracticeWithDic:(NSDictionary *) resultDic;
``` ```
(void)OnPrivateChat:(NSDictionary *)dic;
{ # 4.常见问题
fromuseravatar = ""; ## 4.1 旋转屏错误
fromuserid = 9c408a9761d74cb9b64587b2776c5327; 常用的旋转屏方式
fromusername = qwer; 第一个方法决定是否支持多方向旋转屏，如果返回NO则后面的两个方法都不会再被调用，而且只会支持默认的UIInterfaceOrientationMaskPortrait方向；
fromuserrole = student; 第二个方法直接返回支持的旋转方向，该方法在iPad上的默认返回值是UIInterfaceOrientationMaskAll，iPhone上的默认返回值是UIInterfaceOrientationMaskAllButUpsideDown，官方文档有说明
usercustommark = ""; 第三个方法返回最优先显示的屏幕方向，比如同时支持Portrait和Landscape方向，但想优先显示Landscape方向，那软件启动的时候就会先显示Landscape，在手机切换旋转方向的时候仍然可以在Portrait和Landscape之间切换
msg = chat; HD云直播的页面跳转均是采用模态形式跳转
time = "14:11:32"; ```
- (void)presentViewController:(UIViewController *)viewControllerToPresent animated: (BOOL)flag completion:(void (^ __nullable)(void))completion NS_AVAILABLE_IOS(5_0);
```
touserid = 00d30351184d4cbdb0fcbadd9a55ba1c; 在每个控制器或者基类控制器设置旋转选项
}
``` ```
#pragma mark - 屏幕旋转
- (BOOL)shouldAutorotate{
return NO;//该旋转的页面自己变量控制
}
- (UIInterfaceOrientation)preferredInterfaceOrientationForPresentation
{
return UIInterfaceOrientationPortrait;
}
- (UIInterfaceOrientationMask)supportedInterfaceOrientations
{
return UIInterfaceOrientationMaskPortrait;
}
```
9 聊天信息数组(RequestDataPlayBackDelegate中代理方法) ## 4.2 Swift实现代理错误
``` ```
-(void)onParserChat:(NSArray *)chatArr; //初始化
let parameter = PlayParameter.init()
/**
*配置各种参数
*/
//守护代理
guard let player = requestDataPlayBack else {
return}
player.delegate = self
```
( ## 4.3 查看手机日志
{ 首先: 在AppDelegate中写如下代码(仅限CCSDK);
content = aaa;//聊天内容 ```
[[SaveLogUtil sharedInstance]isNeedToSaveLog:YES];
```
time = 27;//聊天的时间点 第一步:选择Windows下面的Devices and Simulators
userAvatar = "";//聊天用户头像 第二步:点击Devices and Simulators 会出现手机信息以及测试的INSTALLED APPS, 点击设置(齿轮图标) 会出现三个选项, 选择Download Container...
userCustomMark = "";//个性化信息 第三步: 点击Download Container... 下载并保存日志文件,打开文件找到XXLog文件里面就是相关的打印日志
userId = 00942719153943a4a847d8c9278f030d;//聊天用户id 第四步:这里可以看到相关的请求信息和打印日志, 也可以判断错误原因
userName = admin;//聊天用户名 ## 4.4 编译失败和打包上架打包失败
userRole = publisher;//聊天用户角色 错误大意为
}
)
``` ```
Failed to verify bitcode in xxxxx
error: Bundle only contains bitcode-marker /var/folders/s5/lnk362pd4cs0lmtn_43ppjzw0000gn/T/XcodeDistPipeline.2TS/Root/Payload/268YK.appxxxxxxxxxx (armv7)
```
解决办法:
## 5.API查询 第一步: xcode -> file -> Workspace Settings
Doc目录打开index.html文件 第二步: Shared Workspace Settings:
## 6.Q&A 第三步:Build System -> Legacy Build System
### 6.1如发现 dyld: Library not loaded: @rpath/CCPush.framework/CCPush
Referenced from: /var/containers/Bundle/Application/3CC41924-7F22-48FC-AAD1-7C2C089EF749/demo.app/demo
Reason: image not found问题
将报错的类库添加进入
General -> Embedded Binaries 和 General -> Linked Frameworks and Libraries 两处即可