Skip to content

GitLab

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

Page history
4.11.0 authored by lic's avatar lic
Hide whitespace changes
Inline Side-by-side
Showing with 165 additions and 28 deletions
iOS-直播回放SDK开发指南.md
View page @ 17d46d39
......@@ -49,15 +49,19 @@
**必须 ** 需在 Podfile 文件中添加以下代码（最新）
```shell
pod 'CCLivePlaySDK', '4.9.0'
# 基础SDK
pod 'CCLivePlaySDK', '4.11.0'
pod 'HDVideoClass_BSDK', '6.25.0'
pod 'HDSSZip'
pod 'HDSCocoaLumberjack', '4.9.0'
pod 'AgoraRtcEngine_iOS', '3.7.2'
pod 'HDSAliyunPlayer', '4.9.0'
pod 'HDSAliyunPlayer'
pod 'HDStreamLib'
pod 'HDSCocoaLumberjack'
pod 'HDSSZip'
pod 'HDSVRMediaFramework' // 小于 4.11.0 版本不用添加
```
**可选**（互动组件）
```shell
......@@ -360,6 +364,52 @@ Destination 选择 "Frameworks" ->
ERROR_DRMURL = 1020 获取加密地址失败
```
#### 在线回放登陆错误 Code 码
| 错误码 | 描述 | 备注 |
| -------- | ---------------------------------------------------- | ------------------------------ |
| 10000000 | 请求参数不正确，请检查后重试。 | |
| 20270008 | 您的Token不存在，请重新登录。 | |
| 10000001 | 系统出现异常，请稍后再试。 | |
| 20200002 | 您的账户已过期，请联系客服处理。 | |
| 10000034 | 您还未登录，请先登录后再试。 | |
| 10000005 | 该回放不存在或已被删除，请检查后重试。 | |
| 10000007 | 该直播不存在或已被删除，请检查后重试。 | |
| 10000006 | 该直播间不存在或已被删除，请检查后重试。 | |
| 20290005 | 请求参数错误，请检查后重试。 | |
| 20270000 | api登录调用失败，请检查网络连接后重试。 | |
| 20270011 | api登录调用超时，请检查网络连接后重试。 | |
| 20270002 | 名称或密码错误，请检查后重试。 | |
| 20270001 | 请求参数错误，请检查后重试。 | |
| 20270003 | 登录失败，请联系管理员添加你至白名单 | |
| 20270004 | 该视频不属于当前账户，请联系客服。 | |
| 20270005 | 该视频不可用，请联系客服。 | |
| 20270006 | 获取播放地址失败，请检查网络连接后重试。 | |
| 20270010 | 获取打点信息失败，请联系客服。 | |
| 20270007 | 该播放地址不存在或已被删除，请联系客服。 | |
| 20290009 | 不合法的产品线，请联系客服。 | |
| 20270012 | 手机号验证失败，请检查输入后重试。 | |
| 20270013 | 登记观看失败，请联系客服。 | |
| 20270014 | 手机号验证失败，请检查输入后重试。 | |
| 20270015 | 发送短信失败，请稍后再试。 | |
| 20270016 | 该直播间未开启直播转回放功能，请联系客服。 | |
| 20270017 | 回放直播间与登录直播间不符，请联系客服。 | |
| 20270018 | 批量获取视频信息失败，请联系客服。 | |
| 20270019 | 视频信息错误，请联系客服。 | |
| 20270020 | 该极速回放视频没有内容，请联系客服。 | |
| 20290015 | 企微绑定已失效，请重新绑定。 | |
| 20290016 | 非法的企微绑定关系，请重新绑定。 | |
| 20290017 | 该企微用户未在当前直播间下被授权，请联系管理员授权。 | |
| 20290001 | - | 接口验证返回 message，直接展示 |
# 3.快速集成
## 3.1 配置参数
......@@ -370,17 +420,32 @@ Destination 选择 "Frameworks" ->
/**
* @brief 登录房间
* @param parameter 配置参数信息
* 必填参数 userId //用户ID
* 必填参数 roomId //房间ID
* 必填参数 viewerName //用户名称
* 必填参数 token //房间密码
* 必填参数 userId
* 必填参数 roomId
* 必填参数 viewerName
* 必填参数 token
* 非必填参数 security
*
* new ==> // Succed Delegate
* new ==> - (void)loginSucceedPlayback;
*
* new ==> // Failed Delegate
* new ==> - (void)onLoginPlaybackFailed:(NSUInteger)code message:(NSString *_Nullable)message;
*/
- (id)initLoginWithParameter:(PlayParameter *)parameter;
/// 初始化SDK
/// @param parameter 参数
/// @param succed 初始化成功回调
/// @param player 播放视图回调
/// @param failed 初始化失败回调
///
/// new ==> // Succed Delegate
/// new ==> - (void)onRequestLoginPlaybackSucced;
///
/// new ==> // Failed Delegate
/// new ==> - (void)onRequstLoginPlaybackFailed:(NSUInteger)code message:(NSString * _Nullable)message;
///
- (id)initSDKWithParameter:(PlayParameter *)parameter
succed:(initSuccedClosure)succed
player:(HDSPlayerViewClosure)player
......@@ -436,6 +501,13 @@ Destination 选择 "Frameworks" ->
/// @param succed 初始化成功回调
/// @param player 播放视图回调
/// @param failed 初始化失败回调
///
/// new ==> // Succed Delegate
/// new ==> - (void)onRequestLoginPlaybackSucced;
///
/// new ==> // Failed Delegate
/// new ==> - (void)onRequstLoginPlaybackFailed:(NSUInteger)code message:(NSString * _Nullable)message;
///
- (id)initSDKWithParameter:(PlayParameter *)parameter
succed:(initSuccedClosure)succed
player:(HDSPlayerViewClosure)player
......@@ -471,22 +543,26 @@ _requestDataPlayBack = [[RequestDataPlayBack alloc] initSDKWithParameter:paramet
代理方法
```objc
/**
* @brief 媒体准备完成
*/
- (void)mediaPrepared;
/**
* @brief 请求回放地址失败
*/
-(void)requestFailed:(NSError *)error reason:(NSString *)reason;
// MARK: - 初始化SDK登陆 代理
/// 4.10.0 new
/// 请求登陆成功
- (void)onRequestLoginPlaybackSucced;
/// 4.10.0 new
/// 请求登陆失败
/// @param code code值
/// @param message 错误信息
- (void)onRequstLoginPlaybackFailed:(NSUInteger)code message:(NSString * _Nullable)message;
// MARK: - 仅登陆 代理
/**
* @brief 登录成功
*/
- (void)loginSucceedPlayBack;
/**
* @brief 登录失败
*/
-(void)loginFailed:(NSError *)error reason:(NSString *)reason;
/// 4.10.0 new 登陆失败错误回调（仅登陆方法响应代理）
/// @param code code值
/// @param message 错误信息
- (void)onLoginPlaybackFailed:(NSUInteger)code message:(NSString *_Nullable)message;
```
......@@ -582,6 +658,9 @@ _requestDataPlayBack = [[RequestDataPlayBack alloc] initSDKWithParameter:paramet
*/
@property(assign, nonatomic)NSInteger DocModeType;//设置当前的文档模式
// 4.10.0 new
// 主次验证标识 "1"：次验证 "0"：默认主验证 （非必需 可为空）
@property (nonatomic, copy) NSString *secondaryVerify;
```
新增 **HDQualityModel** 类 （切换线路清晰度）
......@@ -685,6 +764,13 @@ typedef NS_ENUM(NSUInteger, PlaybackCoreType) {
/// @param succed 初始化成功回调
/// @param player 播放视图回调
/// @param failed 初始化失败回调
///
/// new ==> // Succed Delegate
/// new ==> - (void)onRequestLoginPlaybackSucced;
///
/// new ==> // Failed Delegate
/// new ==> - (void)onRequstLoginPlaybackFailed:(NSUInteger)code message:(NSString * _Nullable)message;
///
- (id)initSDKWithParameter:(PlayParameter *)parameter
succed:(initSuccedClosure)succed
player:(HDSPlayerViewClosure)player
......@@ -716,14 +802,15 @@ typedef NS_ENUM(NSUInteger, PlaybackCoreType) {
实现代理
```objc
/**
* @brief 媒体准备完成
*/
- (void)mediaPrepared;
/**
* @brief 请求回放地址失败
*/
-(void)requestFailed:(NSError *)error reason:(NSString *)reason;
/// 4.10.0 new
/// 请求登陆成功
- (void)onRequestLoginPlaybackSucced;
/// 4.10.0 new
/// 请求登陆失败
/// @param code code值
/// @param message 错误信息
- (void)onRequstLoginPlaybackFailed:(NSUInteger)code message:(NSString * _Nullable)message;
```
代理方法 （可选）
......@@ -1463,6 +1550,56 @@ typedef NS_ENUM(NSUInteger, HDSMediaFinishReason) {
## 3.14 房间配置信息
房间配置项
| 方法 | 说明 |
| ---------------------- | ---------- |
| (void)onRoomConfigure: | 房间配置项 |
示例代码
```objc
/// 4.11.0 new 房间配置项
/// @param configure 配置信息
/// PS:VR开关、自定义表情开关、房间图标
- (void)onRoomConfigure:(HDSRoomConfigureModel * _Nonnull)configure;
```
#### PlayParameter 新增类
参数
| 参数 | 说明 |
| ----------------- | -------------------------------------------------------- |
| VRSwitch | VR开关 NO 关闭， YES 开启 |
| QPSwitch | 问答支持发送图片开关 NO 关闭， YES 开启 |
| customEmojiSwitch | 自定义表情开关 NO 关闭， YES 开启 |
| roomIcon | 房间图标 |
示例代码
```objc
@interface HDSRoomConfigureModel : NSObject
/// VR开关 NO 关闭， YES 开启
@property (nonatomic, assign) BOOL VRSwitch;
/// 问答支持发送图片开关 NO 关闭， YES 开启
@property (nonatomic, assign) BOOL QPSwitch;
/// 自定义表情开关 NO 关闭， YES 开启
@property (nonatomic, assign) BOOL customEmojiSwitch;
/// 房间图标
@property (nonatomic, copy) NSString * _Nullable roomIcon;
@end
```
......