PLVideoStreamingConfiguration.h
7.06 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
//
// PLVideoStreamingConfiguration.h
// PLCameraStreamingKit
//
// Created on 15/8/4.
// Copyright (c) 2015年 Pili Engineering. All rights reserved.
//
#import <Foundation/Foundation.h>
#import <CoreGraphics/CoreGraphics.h>
#import "PLTypeDefines.h"
/*!
@class PLVideoStreamingConfiguration
@abstract 视频编码和推流相关的配置。
@discussion 当你不明白每个具体参数是什么含义前，你可以使用 defaultConfiguration 或者通过指定分辨率和推流质量生成一个 config.
在设定一个参数时，请务必明白其含义，并且知道其可能造成的影响，随意的设定可能引起编码器设定失败。
@since v1.0.0
*/
@interface PLVideoStreamingConfiguration : NSObject <NSCopying>
/*!
@property videoProfileLevel
@abstract H.264 编码时使用的 Profile Level。
@discussion 默认情况下使用 AVVideoProfileLevelH264Baseline31，如果对于视频编码有额外的需求并且知晓该参数带来的影响可以自行更改。
@warning 当你不清楚该参数更改对分辨率要求，码率等影响时，请不要随意更改。
@since v1.0.0
*/
@property (nonatomic, copy) NSString *videoProfileLevel;
/*!
@property videoSize
@abstract 编码时的视频分辨率。
@discussion 需要注意的是，这个参数影响的是视频编码时的分辨率，而非摄像头采集到数据的预览大小，传递给编码器的图像尺寸与此尺寸不同时，会按照 AVVideoScalingModeResizeAspectFill
对图像做剪切，从而确保图像不会出现压缩的现象。
@since v1.0.0
*/
@property (nonatomic, assign) CGSize videoSize;
/*!
@property expectedSourceVideoFrameRate
@abstract 预期视频的帧率。
@discussion 预期视频的编码帧率，这个数值对编码器的来说并不是直接限定了 fps, 而是给编码器一个预期的视频帧率，最终编码的视频帧率，是由实际输入的数据决定的。
@since v1.2.0
*/
@property (nonatomic, assign) NSUInteger expectedSourceVideoFrameRate;
/*!
@property videoMaxKeyframeInterval
@abstract 视频编码关键帧最大间隔（GOP）。
@discussion h.264 编码时，两个关键帧之间间隔的最多的帧数，一般为 fps 的两倍或者三倍。
@since v1.0.0
*/
@property (nonatomic, assign) NSUInteger videoMaxKeyframeInterval;
/*!
@property averageVideoBitRate
@abstract 平均视频编码码率。
@discussion 单位为 bps(Bits per Second)。该参数的视频编码实际过程中，并不是恒定的数值，所以只能设定平均视频编码码率。
@since v1.2.0
*/
@property (nonatomic, assign) NSUInteger averageVideoBitRate;
/*!
@property videoEncoderType
@abstract H.264 编码器类型
@discussion 默认采用 PLH264EncoderType_AVFoundation 编码方式，在 iOS 8 及以上的系统可采用 PLH264EncoderType_VideoToolbox。
@since v2.1.4
*/
@property (nonatomic, assign) PLH264EncoderType videoEncoderType;
/*!
@method defaultConfiguration
@abstract 生成一个默认的视频编码推流配置对象。
@discussion 该方法每次都会生成一个新的配置，这不是单例方法。默认情况下，对应的参数为分辨率 (320, 480), video quality PLStreamingQualityMedium1
@see configurationWithVideoQuality:
@see initWithVideoSize:expectedSourceVideoFrameRate:videoMaxKeyframeInterval:averageVideoBitRate:videoProfileLevel:
@since v1.0.0
*/
+ (instancetype)defaultConfiguration;
/*!
@method configurationWithVideoQuality:
@abstract 指定自定义分辨率和推流质量生成一个配置。
@param quality 编码质量
@discussion 该方法每次都会生成一个新的配置，这不是单例方法。
@see initWithVideoSize:expectedSourceVideoFrameRate:videoMaxKeyframeInterval:averageVideoBitRate:videoProfileLevel:
@since v1.0.0
*/
+ (instancetype)configurationWithVideoQuality:(NSString *)quality;
/*!
@method initWithVideoSize:expectedSourceVideoFrameRate:videoMaxKeyframeInterval:averageVideoBitRate:videoProfileLevel:videoEncoderType:
@abstract 初始化一个 PLVideoStreamingConfiguration 对象。
@param videoSize 编码分辨率
@param expectedSourceVideoFrameRate 预期采集源视频码率
@param videoMaxKeyframeInterval 视频最大关键帧间隔
@param averageVideoBitRate 平均视频码率
@param videoProfileLevel H.264 编码时的 profile level
@param videoEncoderType H.264 编码所采用的编码器
@warning 如果指定的参数不合理，在 -validate 时失败，会抛出异常。
@discussion 由于 VideoToolbox 编码只在 iOS 8 及以上系统版本支持，若 videoEncoderType 采用 PLH264EncoderType_VideoToolbox，在 iOS 8 以下的系统会自动回退采用 AVFoundation 编码。**若需使用 App Extension 推流，建议使用 PLH264EncoderType_AVFoundation 编码器，设备兼容性更高**。
@see defaultConfiguration
@see configurationWithVideoSize:videoQuality:
@since v2.1.4
*/
- (instancetype)initWithVideoSize:(CGSize)videoSize
expectedSourceVideoFrameRate:(NSUInteger)expectedSourceVideoFrameRate
videoMaxKeyframeInterval:(NSUInteger)videoMaxKeyframeInterval
averageVideoBitRate:(NSUInteger)averageVideoBitRate
videoProfileLevel:(NSString *)videoProfileLevel
videoEncoderType:(PLH264EncoderType)videoEncoderType NS_DESIGNATED_INITIALIZER;
/*!
DEPRECATED: Use initWithVideoSize:expectedSourceVideoFrameRate:videoMaxKeyframeInterval:averageVideoBitRate:videoProfileLevel:videoEncoderType:
@method initWithVideoSize:expectedSourceVideoFrameRate:videoMaxKeyframeInterval:averageVideoBitRate:videoProfileLevel:
@abstract 初始化一个 PLVideoStreamingConfiguration 对象。
@param videoSize 编码分辨率
@param expectedSourceVideoFrameRate 预期采集源视频码率
@param videoMaxKeyframeInterval 视频最大关键帧间隔
@param averageVideoBitRate 平均视频码率
@param videoProfileLevel H.264 编码时的 profile level
@warning 如果指定的参数不合理，在 -validate 时失败，会抛出异常。
@see defaultConfiguration
@see configurationWithVideoSize:videoQuality:
@since v1.2.0
*/
- (instancetype)initWithVideoSize:(CGSize)videoSize
expectedSourceVideoFrameRate:(NSUInteger)expectedSourceVideoFrameRate
videoMaxKeyframeInterval:(NSUInteger)videoMaxKeyframeInterval
averageVideoBitRate:(NSUInteger)averageVideoBitRate
videoProfileLevel:(NSString *)videoProfileLevel DEPRECATED_ATTRIBUTE;
/*!
@method validate
@abstract 校验 PLVideoStreamingConfiguration 是否有设置会导致编码失败，如果有，该方法会抛出异常。
@since v1.0.0
*/
- (BOOL)validate;
@end