iOS-升级文档SDK开发指南.md

@@ -9,6 +9,172 @@ PS. 关于Xcode12最低版本支持 iOS 9.0 ，如何联调 iOS 8.0 设备？
 注：选择项目中的 Build Settings ，搜索或找到 iOS Deployment Target ，点击 iOS 9.0 在展开的下拉菜单中选择 Other ，在文本框中输入 8.0 即可。
 ```
 
+## v3.13.0
+
+发布日期：2021.01.11
+
+1.直播demo支持后进入用户查看问卷
+
+2.直播demo新增视频清晰度
+
+3.在线回放demo及SDK新增切换视频清晰度
+
+4.在线回放、直播demo新增切换线路
+
+5.在线回放、直播demo新增只听音频功能
+
+6.直播demo播放器、弹幕样式优化
+
+7.api变更
+
+**PlayParameter.h** 新增枚举类型
+
+```objective-c
+/**
+ *  音视频模式
+ *  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,//无音频线路
+};
+```
+
+新增 **HDQualityModel** 类
+
+```objective-c
+/** 清晰度 */
+@property (nonatomic, copy)   NSString                * _Nonnull quality;
+/** 描述 */
+@property (nonatomic, copy)   NSString                * _Nonnull desc;
+```
+
+**RequestDataPlayBack.h** 废弃api 
+
+```objective-c
+/**
+ *    @brief    接收到播放线路 (已废弃)
+ *    例:videoArray元素个数 2 代表2条线路 changeLineWithPlayParameter传0或1
+ *
+ *    废弃版本    3.13.0
+ *    兼容版本    2021年10月08日之后将不再维护
+ *    新方法     清晰度回调 - (void)HDReceivedVideoQuality:(NSDictionary *)dict;
+ *              线路回调  - (void)HDReceivedVideoAudioLines:(NSDictionary *)dict;
+ *
+ */
+-(void)numberOfReceivedLinesWithVideo:(NSArray *)videoArray audio:(NSArray *)audioArray;
+/**
+ *  @brief 切换线路 (已废弃)
+ *  param
+ *       disableVideo  视频传no,音频传yes(账号开启音频模式下才可以传yes)
+ *       lineNum 线路 例:-(void)numberOfReceivedLinesWithVideo:(NSArray *)videoArray audio:(NSArray *)audioArray;中videoArray元素个数为2 则传0或1
+ *  results:
+    success 0 切换成功 -1切换失败 -2 切换频繁
+    currentIndex 当前播放线路
+ *
+ *    废弃版本    3.13.0
+ *    兼容版本    2021年10月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)changeLineWithPlayParameter:(PlayParameter *)param completion:(void (^)(NSDictionary * results))completion;
+```
+
+**RequestDataPlayBack.h** 新增api回调 
+
+```objective-c
+/**
+ *    The New Method (3.13.0)
+ *    @brief    是否开启音频模式
+ *    @param    hasAudio   HAVE_AUDIO_LINE_TURE 有音频 HAVE_AUDIO_LINE_FALSE 无音频
+ *
+ *    触发回调条件 1.初始化SDK登录成功后
+ */
+- (void)HDAudioMode:(HAVE_AUDIO_LINE)hasAudio;
+/**
+ *    The New Method (3.13.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.13.0)
+ *    @brief    房间包含的音视频线路 (会多次回调)
+ *    @param    dict   线路数据
+ *    线路数据   key(包含的键值)             type(数据类型)             description(描述)
+ *              lineList(线路列表)         array                     @[@"line1",@"line2"]
+ *              indexNum(当前线路下标)      integer                   0
+ *
+ *    触发回调条件 1.初始化SDK登录成功后
+ *               2.主动调用切换清晰度方法
+ *               3.主动调用切换线路方法
+ *               4.主动调用切换音视频模式回调
+ */
+- (void)HDReceivedVideoAudioLines:(NSDictionary *)dict;
+```
+
+**RequestDataPlayBack.h** 新增api主动调用方法
+
+```objective-c
+/**
+ *    The New Method (3.13.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.13.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.13.0)
+ *    @brief    切换线路
+ *    @param    index   选择线路下标
+ *    @param    completion 切换结果
+ *              { success 0 切换成功 -1切换失败 -2 切换频繁
+ *                reason 错误原因 }
+ *
+ *    切换线路回调方法 - (void)HDReceivedVideoAudioLines:(NSDictionary *)dict;
+ */
+- (void)changeLine:(NSInteger)index completion:(void (^)(NSDictionary * results))completion;
+```
+
 
 
 ## v3.12.2