又拍云 iOS 推拉流 SDK 使用说明

阅读对象

本文档面向 iOS 移动视频直播应用开发者。

SDK 概述

此 SDK 实现了视频直播和播放两部分功能。开发者可以在应用内集成此 SDK 来快速实现视频推流（直播）和拉流（播放）功能。

支持 ARMv7，ARM64，x86_64 架构

注意: SDK 依赖于 FFMPEG 3.0 , 不建议用户自行再添加 FFMPEG 库 , 如有特殊需求, 请联系我们

推流端功能特性

集成音频和视频采集模块 AVCaptureSession
音频编码：AAC
视频编码：H.264
支持音频，视频硬件编码
推流协议：RTMP
支持前后置摄像头切换
支持闪光灯开关
支持目标码率设置
支持拍摄帧频设置
支持美颜滤镜
支持横屏拍摄

播放端功能特性

支持视频格式：HLS, RTMP, FLV，mp4 等直播或点播视频格式，支持 HLS 多种分辨率切换
低延时直播体验，配合又拍云推流 SDK 及 CDN 分发, 可以达到全程直播稳定在 2-3 秒延时
支持设置窗口大小和全屏设置
支持音量调节，静音设置
支持亮度调整
支持缓冲大小设置，缓冲进度回调
支持自动音画同步调整

SDK下载

Demo 下载: https://github.com/upyun/ios-live-sdk

SDK使用说明

运行环境和兼容性

UPLiveSDK.framework 支持 iOS 8 及以上系统版本；

安装使用说明

安装方法：直接将 UPLiveSDK.framework 拖拽到目标工程目录;

使用: 详见 DEMO 工程

工程设置：

Enable bitcode： NO

Framework Search Paths : 添加 $(PROJECT_DIR), 并设置为 recursive

工程依赖：

AVFoundation.framework

QuartzCore.framework

OpenGLES.framework

AudioToolbox.framework

VideoToolbox.framework

Accelerate.framework

libbz2.1.0.tbd

libiconv.tbd

libz.tbd

推流 SDK 使用示例 UPAVCapturer

使用拍摄和推流功能 UPAVCapturer 需要引入头文件 #import <UPLiveSDK/UPAVCapturer.h>

UPAVCapturer 为单例模式。

注: 也可以单独使用 SDK 的推流器 UPAVStreamer , 采集模块自定义, 如视频采集可利用 GPUImageVideoCamera 。

1.设置视频预览视图:

   UIViewContentMode previewContentMode = UIViewContentModeScaleAspectFit;
   self.videoPreview = [[UPAVCapturer sharedInstance] previewWithFrame:CGRectMake(0, 0, width, height) 
   contentMode:previewContentMode];
   self.videoPreview.backgroundColor = [UIColor blackColor];
   [self.view insertSubview:self.videoPreview atIndex:0];

2.设置推流地址

	
	NSString *rtmpPushUrl = @"rtmp://host/liveapp/streamid";
	
	[UPAVCapturer sharedInstance].outStreamPath = rtmpPushUrl;

3.开启和关闭


	//开启视频采集并推流到 rtmpPushUrl

	[[UPAVCapturer sharedInstance] start];

	//关闭视频采集，停止推流

	[[UPAVCapturer sharedInstance] stop];

4.摄像头切换接口, 闪光灯设置接口


    [[UPAVCapturer sharedInstance] changeCamera];//切换前后摄像头

    

    [UPAVCapturer sharedInstance].camaraTorchOn ＝ YES;//设置闪光灯开关

5.码率设置接口

可以根据网络情况适当调整码率：


    [UPAVCapturer sharedInstance].bitrate = 400000;//默认值 600000 bps

6.推流状态回调

如果在直播过程发生异常，可以通过 UPAVCapturerDelegate 捕捉错误信息，并且关闭拍摄推流。


//采集状态
- (void)UPAVCapturer:(UPAVCapturer *)capturer capturerStatusDidChange:(UPAVCapturerStatus)capturerStatus {
    switch (capturerStatus) {
        case UPAVCapturerStatusStopped: {
        // 拍摄停止
        }
            break;
        case UPAVCapturerStatusLiving: {
        // 拍摄中
        }
            break;
        case UPAVCapturerStatusError: {
         // 拍摄错误
        }
            break;
        default:
            break;
    }
}

//错误捕捉
- (void)UPAVCapturer:(UPAVCapturer *)capturer capturerError:(NSError *)error {
    if (error) {
        NSString *s = [NSString stringWithFormat:@"%@", error];
        [self errorAlert:s];
    }
    //需要关闭直播
}

//推流状态
- (void)UPAVCapturer:(UPAVCapturer *)capturer pushStreamStatusDidChange:(UPPushAVStreamStatus)streamStatus {
    
    switch (streamStatus) {
        case UPPushAVStreamStatusClosed:
            //连接关闭
            break;
        case UPPushAVStreamStatusConnecting:
            //连接中
            break;
        case UPPushAVStreamStatusReady:
            //连接成功
            break;
        case UPPushAVStreamStatusPushing:
            //推流中
            break;
        case UPPushAVStreamStatusError: {
            //推流错误
        }
            break;
        default:
            break;
    }
}

7.其他参数设置


	//选择拍摄分辨率，默认 640 X 480
	[UPAVCapturer sharedInstance].capturerPresetLevel = _settings.level;
	
	//选择前后置摄像头，默认使用后置摄像头
	[UPAVCapturer sharedInstance].camaraPosition = _settings.camaraPosition;
	
	//选择横竖屏拍摄方式，默认竖屏拍摄
	[UPAVCapturer sharedInstance].videoOrientation = _settings.videoOrientation;
	
	//推流是否自动开始，如果设置为 NO 只拍摄不推流。
	[UPAVCapturer sharedInstance].streamingOnOff = _settings.streamingOnOff;
	
	//美颜滤镜是否开启，默认开启
	[UPAVCapturer sharedInstance].filter = _settings.filter;
	
	//设置美颜滤镜，详见 demo 中代码示例
    _fliter = [BeautifyFilter new];
    [UPAVCapturer sharedInstance].videoFiler = _fliter;

	//闪光灯开关
	[UPAVCapturer sharedInstance].camaraTorchOn = _settings.camaraTorchOn;
	
	//设置拍摄帧频，默认值 24 fps
	[UPAVCapturer sharedInstance].fps = _settings.fps;

拉流 SDK 使用示例 UPAVPlayer

使用 UPAVPlayer 需要引入头文件 #import <UPLiveSDK/UPAVPlayer.h>

UPAVPlayer 使用接口类似 AVFoundation 的 AVPlayer 。

完整的使用代码请参考 demo 工程。

1.设置播放地址


    //初始化播放器，设置播放地址
    _player = [[UPAVPlayer alloc] initWithURL:@"rtmp://live.hkstv.hk.lxdns.com/live/hks"];

    //设置播放器画面尺寸
    [_player setFrame:[UIScreen mainScreen].bounds];
    
    //将播放器画面添加到 UIview上展示
    [self.view insertSubview:_player.playView atIndex:0];

2.视频流基本信息


- (void)UPAVPlayer:(id)player streamInfoDidReceive:(UPAVPlayerStreamInfo *)streamInfo {
    NSLog(@"视频信息-- %@ ", streamInfo.descriptionInfo);
    if (streamInfo.canPause && streamInfo.canSeek) {
        _playProgressSlider.maximumValue = streamInfo.duration;
        NSLog(@"streamInfo.duration %f", streamInfo.duration);
    } else {
        _playProgressSlider.enabled = NO;
    }
}

3.播放状态回调

- (void)UPAVPlayer:(id)player playerStatusDidChange:(UPAVPlayerStatus)playerStatus {
    
    switch (playerStatus) {
        case UPAVPlayerStatusIdle:{
            // 未进行播放
        }
            break;
            
        case UPAVPlayerStatusPause:{
            //播放暂停
        }
            break;
            
        case UPAVPlayerStatusPlaying_buffering:{
            //播放缓冲中
        }
            break;
        case UPAVPlayerStatusPlaying:{
            //正在播放
        }
            break;
        case UPAVPlayerStatusFailed:{
            //播放失败
        }
            break;
        default:
            break;
    }
}

4.缓冲进度回调


- (void)UPAVPlayer:(id)player bufferingProgressDidChange:(float)progress {
    self.bufferingProgressLabel.text = [NSString stringWithFormat:@"%.0f %%", (progress * 100)];
}

5.播放进度回调


- (void)UPAVPlayer:(id)player displayPositionDidChange:(float)position {
    _playProgressSlider.value = position;
    self.timelabel.text = [NSString stringWithFormat:@"%.0f / %.0f", position, _player.streamInfo.duration];
}

6.音量设置

@property (nonatomic) CGFloat volume;

7.画面亮度


@property (nonatomic) CGFloat bright;

8.静音设置


@property (nonatomic) BOOL mute;

9.播放错误捕捉


- (void)UPAVPlayer:(id)player playerError:(NSError *)error {
    NSLog(@"播放错误 %@", error);
}

10.连接、播放、暂停、停止、seek

- (void)connect;//连接文件或视频流。
- (void)play;//开始播放。如果流文件未连接会自动连接视频流。
- (void)pause;//暂停播放。直播流无法暂停。
- (void)stop;//停止播放且关闭视频流。
- (void)seekToTime:(CGFloat)position;//seek 到固定播放点。直播流无法 seek。

UPYUN 直播平台自主配置流程

1.注册新建又拍云账号

注册地址

2.进行账户认证

账户认证

3.创建服务

创建服务

填写服务名称，简称 bucket

资源获取方式选择自主源站

加速域名和回源地址如有则填写，如无可以任意编辑结构合法内容，如域名为 a.com，回源 IP 为 1.1.1.1

创建好服务后如需进行直播功能测试和加速，会有对应的服务人员与您联系，您将需求按如下格式整理好发送给服务人员，我们会尽快为您提供测试服务

格式如下

账户名：xxxxx

服务名称：bucket 名

app 名：如 show/* show 代表应用名称，* 代表目录后可以为 stream id

拉流需要支持的格式：rtmp 或 http-flv 或 hls (三个至少选其中一个)

对外服务的推流域名：xxx.com （如无可不填写）

对外服务的拉流域名：xxx.com （如无可不填写）

4.推拉流地址格式以及 token 加密规则

推流地址：rtmp://bucket.v0.upaiyun.com/show/abc

拉流地址：rtmp 协议 rtmp://bucket.b0.upaiyun.com/show/abc , http+flv http://bucket.b0.upaiyun.com/show/abc.flv , hls http://bucket.b0.upaiyun.com/show/abc.m3u8

Token 防盗链加密规则

Token 防盗链可设置签名过期时间来控制文件的访问时限

url格式：

推流地址：rtmp://bucket.v0.upaiyun.com/show/abc?_upt=abcdefgh137000060

拉流地址：http://bucket.b0.upaiyun.com/show/abc.flv?_upt=abcdefgh137000060

签名方式说明

签名：_upt = MD5( token密匙 + etime + URI) {中间 8 位} + etime

加密后格式如下 _upt=abcdefgh1370000600

参数：

token 密钥：用户所填的密钥(一个 bucket 对应一个密钥)

etime ：过期时间，必须是 UNIX TIME 格式，如： 1378092990

URI ：请求地址（不包含?及后面的 Query String），如： /live/abc

正确例子:

密钥 : password

etime : 1462513671

URI : /live/streamhz

密钥 + etime + URI 拼接结果 : password1462513671/live/streamhz

md5 之后： cd07624363efbcc102e772c2e270e811

取中间 8 位加 etime ：bcc102e71462513671

最后 url ： url

由 SDK 生成 TOKEN


/* 生成推流 token
 例如推流地址：rtmp://bucket.v0.upaiyun.com/live/abc?_upt=abcdefgh1370000600
 其中：
 bucket 为 bucket name；
 live 为 appName；
 abc 为 streamName；
 abcdefgh1370000600 为推流token 可以用此方法计算生成。
 */
+ (NSString *)tokenWithKey:(NSString *)key //空间密钥
                    bucket:(NSString *)bucket //空间名
                expiration:(int)expiration //token 过期时间
           applicationName:(NSString *)appName //应用名，比如示例推流地址中的 live
                streamName:(NSString *)streamName; //流名， 比如示例推流地址中的 abc

版本历史

1.0.1 基本的直播推流器和播放器；

播放器支持 rtmp, hls, flv;
推流器支持 rtmp 推流。

1.0.2 性能优化，添加美颜滤镜

推流添加美颜滤镜；
缩小 framework 打包体积；
修复播放器清晰度 bug；
修复播放器开始播放花屏 bug；
修改播放器卡顿重新连接逻辑；
播放器秒开优化。

1.0.3 点播支持

播放器点播，支持暂停和 seek 功能；
播放器播放、连接逻辑分离，支持异步预连接和缓冲；
播放器状态 delegate 方式回调；
推流器解决 iPhone 6s 音频采集引起相关的 bug；
推流器横屏拍摄及屏幕旋转适配 demo。

1.0.4 分析统计，拆分 UPAVStreamer

播放器添加播放质量分析统计功能；
播放器添加帧频，码率等信息接口及 demo 展示；
SDK 内部删除 GPUImage 依赖，美颜滤镜功能通过协议接口暴露；
推流器拆分暴露 UPAVStreamer，方便自由组织实现采集，处理，编码，推流等直播各个环节；
推流器 UPAVCapturer 状态回调改为代理方式，且细分推流状态和拍摄状态；
推流器添加拍摄帧频，推流帧频，码率，丢帧等信息接口及 demo 展示；
推流过程支持背景音乐不被打断及修复 AVAudioSession 相关bug；

反馈与建议

邮箱：livesdk@upai.com

QQ: 3392887145

phoenixZZZ/ios-live-sdk