iOS推流SDK开发者使用说明文档

iOS推流SDK开发者使用说明文档1 版本信息2 推流SDK简介及加载流程2.1 SDK目的2.2 IDE版本要求2.3 SDK适用范围2.4 真机 or 模拟器2.5 Info.plist配置要求2.6 工程配置基本要求2.7 配置对象类PushParameters3 网络请求类及代理介绍CCPushUtil:推流工具类,单例类CCPushUtilDelegate:对应的代理3.1.1 登录3.1.2登录对应的代理方法3.1.3 登陆成功以后到退出登陆以前可能会有用户自定义消息的代理方法被触发(定制功能,无定制需求请忽略此代理方法)3.2推流过程中会回调的代理有3.3 推流前的接口以及设置3.4 推流中的接口以及设置3.4.1 停止推流3.4.2 停止推流的代理方法3.4.3 其它3.5 没有推流时可以请求的接口以及设置(此接口和推流无关)3.6 手动录制3.7 聊天的代理(如果不对接聊天功能,请忽略)3.8 获取房间人数以及房间信息的代理方法3.9 聊天调用方法(如果不对接聊天功能,请忽略)3.10 获取房间人数以及房间信息3.11 房间互动功能配置信息(代理方法)HDSInteractionConfigureModel3.12 获取互动组件Token(主动方法)4错误码及错误描述以下错误都会在封装在返回的错误中的(NSError *)error中,为自定义的错误,另外reason:(NSString *)reason会是服务器返回的错误信息4.1 错误类型定义如下4.2 错误类型分类4.2.1 业务错误4.2.2 系统错误5直播流程说明5.1 登录5.2 设置码率,分辨率,帧率,预览页面,前后置摄像头5.3 开始推流(设置声音,闪光灯),设置推流中屏幕不会锁屏。5.4 停止推流5.5 退出登录(不一定退出推流就一定要退出登录,没有必然联系,但是如果退出房间,就一定要退出登录)5.6 音频输入源类型有 普通耳机,蓝牙耳机,麦克风

 

1 版本信息

2 推流SDK简介及加载流程

功能特性:

功能特性描述
前后摄像头切换支持手机前后摄像头切换直播;
自定义码率支持调整直播视频码率;
自定义分辨率支持设置直播画面分辨率;
横竖屏支持手机横屏或竖屏模式直播;
音量设置支持调整麦克风采集音量大小;
帧率设置支持设置直播帧率;
闪光灯开关支持开启闪光灯;
美颜支持磨皮、美白、粉嫩三种美颜特效;
水印支持设置图片水印;
聊天支持主播与观众互动聊天;
获取在线人数支持获取直播间在线人数
支持https协议支持接口https请求
直播带货直播带货

2.1 SDK目的

2.2 IDE版本要求

2.3 SDK适用范围

2.4 真机 or 模拟器

2.5 Info.plist配置要求

2.6 工程配置基本要求

2.7 配置对象类PushParameters

3 网络请求类及代理介绍

CCPushUtil:推流工具类,单例类

CCPushUtilDelegate:对应的代理

3.1.1 登录

3.1.2登录对应的代理方法

3.1.3 登陆成功以后到退出登陆以前可能会有用户自定义消息的代理方法被触发(定制功能,无定制需求请忽略此代理方法)

3.2推流过程中会回调的代理有

3.3 推流前的接口以及设置

3.4 推流中的接口以及设置

3.4.1 停止推流

3.4.2 停止推流的代理方法

3.4.3 其它

3.5 没有推流时可以请求的接口以及设置(此接口和推流无关)

3.6 手动录制

3.7 聊天的代理(如果不对接聊天功能,请忽略)

3.8 获取房间人数以及房间信息的代理方法

3.9 聊天调用方法(如果不对接聊天功能,请忽略)

3.10 获取房间人数以及房间信息

 

3.11 房间互动功能配置信息(代理方法)

方法注释所在类文件
(void)onInteractionConfigure:互动功能配置HDLiveKit/CCPushUtil.h

示例代码

HDSInteractionConfigureModel

参数类型注释所在类文件
isLiveStoreSwitchBOOL直播带货开关 0:关闭 1:开启HDLiveKit/PushParameters.h

 

3.12 获取互动组件Token(主动方法)

方法注释所在类文件
(void)getInteractionToken: token:获取互动组件 tokenHDLiveKit/CCPushUtil.h

示例代码

 

 

4错误码及错误描述

以下错误都会在封装在返回的错误中的(NSError *)error中,为自定义的错误,另外reason:(NSString *)reason会是服务器返回的错误信息

4.1 错误类型定义如下

4.2 错误类型分类

4.2.1 业务错误

4.2.2 系统错误

5直播流程说明

5.1 登录

5.2 设置码率,分辨率,帧率,预览页面,前后置摄像头

5.3 开始推流(设置声音,闪光灯),设置推流中屏幕不会锁屏。

5.4 停止推流

5.5 退出登录(不一定退出推流就一定要退出登录,没有必然联系,但是如果退出房间,就一定要退出登录)

5.6 音频输入源类型有 普通耳机,蓝牙耳机,麦克风

 

 

 

 

 

 

 

 

 

#创盛视联数码科技(北京)有限公司