988      微信

iOS 推流SDK使用说明__SDK文档及下载_API及SDK_视频直播-阿里云

文档说明：本文档面向所有使用该SDK的开发人员、测试人员以及对此感兴趣的用户，要求读者具有一定的iOS开发能力

1. 简介

iOS推流SDK是在iOS平台上使用的软件开发工具包(Soft Development Kit)，为iOS开发者提供简单易用的接口，帮助开发者实现iOS平台上的推流应用开发。

1.1 功能说明

1. 方便快捷、低门槛实现媒体推流功能。用户无须关心内部实现细节，只需要自定义界面既可以实现专业级的推流应用。

2. 推流支持格式：rtmp

3. 编码目前为硬编

1.2 安装包说明

推流器SDK的完整下载包中包含test、lib、doc等

1. test：主要存放了调用SDK的示例工程，可以帮助用户了解如何使用该SDK

2. lib：推流器SDK开发包,包含推流器framework文件,需要在您的工程中进行引用

3. doc：存放SDK相关接入文档。

1.3 推流器性能

1. 目前推流SDK推流采用的是硬编。

2. 推流采用librtmp推流

3. DK的大小：使用SDK库安装之后的程序大小在1M左右。即为你的程序增 加1M左右的大小。

1.4 注意事项

1. 推流器SDK目前只支持单实例。不能够同时开2个推流实例，同时只能存在一个实例，需要另开实例的时候，需要关闭之前存在的实例。

2. 操作系统版本要求iOS8.0以上。

2. 使用说明

2.1 开发环境配置

1. 需要准备iOS的运行环境(Xcode8.0以上版本,iOS SDK8.0以上版本), 以及硬件CPU支持ARMv7、ARMv7s或ARM64的iOS设备。

2.2、开通直播

详情参见 直播快速开始 流程

2.3、SDK下载

iOS 推流SDK开发包（2016-11-09）

2.4、SDK集成

拖拽sdk文件夹到自己的Xcode项目中。

勾选 Copy items if needed，点击 Finish。

打开项目的 app target，在 Build Phases 中的 Link Binary With Libraries添加以下依赖库。

2.5 iOS10适配说明

由于iOS10.0对于iOS设备权限获取的方式不同于之前的版本，因此特别说明.

推流SDK需要获取iOS设备的摄像头和麦克风权限，需要在开发项目的plist文件中添加如下权限配置

 Privacy - Camera Usage Description 
 Privacy - Microphone Usage Description

3. SDK使用指南

3.1 开发环境配置

1. 需要准备Xcode运行环境，以及硬件配置iOS8.0以上的苹果手持设备。

2. 权限开通，在阿里云上申请推流SDK开发权限

3.2 开发步骤

在需要直播功能的控制器头部导入#import <AlivcLiveVideo/AlivcLiveVideo.h>，并设置代理AlivcLiveSessionDelegate使用用媒体推流器SDK的调用顺序为

1. 调用[[AlivcLiveSession alloc] initWithConfiguration:configuration]创建session类

2. 调用alivcLiveVideoStartPreview开启预览

3. 调用alivcLiveVideoConnectServer开始推流

4. 调用alivcLiveVideoDisconnectServer停止推流

5. 调用alivcLiveVideoStopPreview停止预览

6. session = nil 销毁直播session

3.3 Demo示例

在 SDK 中提供了 Demo,此 Demo 是用推流 SDK 开发了一个完整的推流器, 用户可以参考 Demo 进行推流的开发。

下面给出了部分重要的 Demo 中调用 SDK 的代码。

一． 设置直播参数

1.初始化config配置类

AlivcLConfiguration *configuration = [[AlivcLConfiguration alloc] init];

2. 设置推流地址

configuration.url = pushUrl;

3. 设置最大码率

configuration.videoMaxBitRate = 1500 * 1000; 

4. 设置当前视频码率

configuration.videoBitRate = 600 * 1000;

5. 设置最小码率

configuration.videoMinBitRate = 400 * 1000;

6. 设置音频码率

configuration.audioBitRate = 64 * 1000;

7. 设置直播分辨率

configuration.videoSize = CGSizeMake(360, 640);

8. 设置横屏or竖屏

configuration.screenOrientation = AlivcLiveScreenVertical;

9. 设置帧率

configuration.fps = 20; 

10. 设置摄像头采集质量

configuration.preset = AVCaptureSessionPresetiFrame1280x720;

11. 设置前置摄像头或后置摄像头

configuration.position = AVCaptureDevicePositionFront;

12.设置水印图片

configuration.waterMaskImage = [UIImage imageNamed:@"watermask"];

13.设置水印位置

configuration.waterMaskLocation = 1;

14.设置水印相对x边框距离

configuration.waterMaskMarginX = 10;

15.设置水印相对y边框距离

configuration.waterMaskMarginY = 10;

16.设置重连超时时长

configuration.reconnectTimeout = 5;

二. 创建直播session

1. 初始化liveSession类

_liveSession = [[AlivcLiveSession alloc] initWithConfiguration:configuration];

2. 设置session代理

_liveSession.delegate = self;

3. 开启直播预览

[_liveSession alivcLiveVideoStartPreview];

4. 开启直播

[_liveSession alivcLiveVideoConnectServer];

5. 获取直播预览视图，可将获取的直播视图添加到当前控制器上，实现直播预览功能。

[_liveSession previewView]

6.停止预览

[_liveSession alivcLiveVideoStopPreview];

注意：停止预览后将liveSession置为nil

7.关闭直播

[_liveSession alivcLiveVideoDisconnectServer];

8.设置闪光灯模式

_liveSession.torchMode = AVCaptureTorchModeOn//关闭AVCaptureTorchModeOff;

9.开启美颜

[_liveSession setEnableSkin:YES];

10.缩放

[_liveSession alivcLiveVideoZoomCamera:1.0f];

11.聚焦

[_liveSession alivcLiveVideoFocusAtAdjustedPoint:percentPoint autoFocus:YES];

12.调试信息

AlivcLDebugInfo *i = [_liveSession dumpDebugInfo];

三、直播功能的相关代理方法

@Required

1.直播出错的代理方法

-(void)alivcLiveVideoLiveSession:(AlivcLiveSession *)session error:(NSError *)error;

2.网速较慢时的代理方法

-(void)alivcLiveVideoLiveSessionNetworkSlow:
(AlivcLiveSession *)session;

@optional

1.音频初始化失败

-(void)alivcLiveVideoLiveSession:(AlivcLiveSession *)session OpenAudioError:(NSError *)error；

2.视频初始化失败

-(void)alivcLiveVideoLiveSession:(AlivcLiveSession *)session OpenVideoError:(NSError *)error；

3.音频编码器初始化失败

-(void)alivcLiveVideoLiveSession:(AlivcLiveSession *)session EncodeAudioError:(NSError *)error；

4.视频编码器初始化失败

-(void)alivcLiveVideoLiveSession:(AlivcLiveSession *)session EncodeVideoError:(NSError *)error；

5. 音频设备获取成功

- (void)alivcLiveVideoOpenAudioSuccess:(AlivcLiveSession *)session;        

6.视频设备获取成功

- (void)alivcLiveVideoOpenVideoSuccess:(AlivcLiveSession *)session;    

7.推流连接成功

- (void)alivcLiveVideoLiveSessionConnectSuccess:(AlivcLiveSession *)session;

8.码率变化

-(void)alivcLiveVideoLiveSession:(AlivcLiveSession *)session bitrateStatusChange:(ALIVC_LIVE_BITRATE_STATUS)bitrateStatus;

9.重连超时

- (void)alivcLiveVideoReconnectTimeout:(AlivcLiveSession *)session

4. 接口说明

4.1 AlivcLiveSession

类名：AlivcLiveSession

功能：推流器接口类，提供推流控制

成员：

各成员具体使用：

/*!
 *  当前版本号
 *
 *  @return 版本号
 */
+ (NSString *)alivcLiveVideoVersion;
/*!
 *  init
 *
 *  @param configuration 配置
 *
 *  @return AlivcLiveSession
 */
- (instancetype)initWithConfiguration:(AlivcLConfiguration *)configuration;
/*!
 *  预览View
 *
 *  @return 预览View
 */
- (UIView *)previewView;
/*!
 *  开始
 */
- (void)alivcLiveVideoStartPreview;
/*!
 *  停止
 */
- (void)alivcLiveVideoStopPreview;
/*!
 *  转换摄像头
 */
- (void)alivcLiveVideoRotateCamera;
/*!
 *  对焦
 *
 *  @param point     位置
 *  @param autoFocus 是否自动对焦
 */
- (void)alivcLiveVideoFocusAtAdjustedPoint:(CGPoint)point autoFocus:(BOOL)autoFocus;
/*!
 *  缩放
 *
 *  @param zoom 缩放倍数
 */
- (void)alivcLiveVideoZoomCamera:(CGFloat)zoom;
/*!
 *  更新live配置，可以更新码率和帧率，但是只能在connectServer之前调用
 *
 *  @param block 配置
 */
- (void)alivcLiveVideoUpdateConfiguration:(void(^)(AlivcLConfiguration *configuration))block;
/*!
 *  推流连接
 */
- (void)alivcLiveVideoConnectServer;
/*!
 *  推流断开连接
 */
- (void)alivcLiveVideoDisconnectServer;
/*!
 *  调试信息
 *
 *  @return 调试信息
 */
- (AlivcLDebugInfo *)dumpDebugInfo;
/*!
 *  当前码率
 *
 *  @return 码率
 */
- (NSInteger)alivcLiveVideoBitRate;

4.2 delegate监听回调