Merge pull request #75 from HeraShowFeng/v5.2.4_release

release v5.2.4
pili-engineering · Aug 22, 2023 · 41ceb6f · 41ceb6f
2 parents 1dccb3e + b57a976
commit 41ceb6f
Show file tree

Hide file tree

Showing 65 changed files with 901 additions and 138 deletions.
diff --git a/APIDiffs/api-diffs-5.2.4.md b/APIDiffs/api-diffs-5.2.4.md
@@ -0,0 +1,54 @@
+# QNRTCKit 5.2.3 to 5.2.4 API Differences
+
+## General Headers
+
+```
+QNRTCConfiguration.h
+```
+- *Added* property `@property (nonatomic, assign, readonly) int reconnectionTimeout;`
+- *Added* property `@property (nonatomic, assign, readonly) QNVideoEncoderType encoderType;`
+- *Added* method `- (instancetype)initWithPolicy:(QNRTCPolicy)policy audioScene:(QNAudioScene)audioScene reconnectionTimeout:(int)reconnectionTimeout;`
+- *Added* method `- (instancetype)initWithPolicy:(QNRTCPolicy)policy audioScene:(QNAudioScene)audioScene reconnectionTimeout:(int)reconnectionTimeout encoderType:(QNVideoEncoderType)encoderType;`
+
+```
+QNVideoEncoderConfig.h
+```
+- *Added* property `@property (nonatomic, assign, readonly) QNVideoFormatPreset formatPreset;`
+- *Added* method `- (instancetype)initWithPreference:(QNDegradationPreference)preference
+ formatPreset:(QNVideoFormatPreset)formatPreset;` 
+
+```
+QNLocalVideoTrackStats.h
+```
+- *Added* property `@property (nonatomic, assign, readonly) NSUInteger uplinkFrameWidth;`
+- *Added* property `@property (nonatomic, assign, readonly) NSUInteger uplinkFrameHeight;`
+- *Added* property `@property (nonatomic, assign, readonly) NSUInteger captureFrameRate;`
+- *Added* property `@property (nonatomic, assign, readonly) NSUInteger captureFrameWidth;`
+- *Added* property `@property (nonatomic, assign, readonly) NSUInteger captureFrameHeight;`
+- *Added* property `@property (nonatomic, assign, readonly) NSUInteger targetFrameRate;`
+- *Added* property `@property (nonatomic, assign, readonly) NSUInteger targetFrameWidth;`
+- *Added* property `@property (nonatomic, assign, readonly) NSUInteger targetFrameHeight;`
+
+```
+QNRemoteVideoTrackStats.h
+```
+- *Added* property `@property (nonatomic, assign, readonly) NSUInteger uplinkFrameWidth;`
+- *Added* property `@property (nonatomic, assign, readonly) NSUInteger uplinkFrameHeight;`
+
+```
+QNAudioEffectMixer.h
+```
+- *Deprecated* method `- (void)audioEffectMixer:(QNAudioEffectMixer *)audioEffectMixer didFailWithError:(NSError *)error;`
+- *Added* method `- (void)audioEffect:(QNAudioEffect *)audioEffect didFailed:(int)effectID error:(NSError *)error;`
+- *Added* nethod `- (void)audioEffect:(QNAudioEffect *)audioEffect didFinished:(int)effectID;`
+
+```
+QNTypeDefines
+```
+- *Added* `QNDegradationDefault`
+- *Added* `QNVideoEncoderType`
+- *Added* `QNVideoFormatPreset`
+- *Added* `QNRTCErrorStreamNotExistError`
+- *Added* `QNRTCErrorServerUnavailable`
+- *Added* `QNRTCErrorOperationTimeoutError`
+- *Added* `QNRTCErrorLiveStreamingClosedError`
diff --git a/Pod/iphoneos/QNRTCKit.framework.dSYM/Contents/Info.plist b/Pod/iphoneos/QNRTCKit.framework.dSYM/Contents/Info.plist
@@ -13,7 +13,7 @@
  <key>CFBundleSignature</key>
  <string>????</string>
  <key>CFBundleShortVersionString</key>
- <string>5.2.3</string>
+ <string>5.2.4</string>
  <key>CFBundleVersion</key>
  <string>1</string>
  </dict>

diff --git a/Pod/iphoneos/QNRTCKit.framework.dSYM/Contents/Resources/DWARF/QNRTCKit b/Pod/iphoneos/QNRTCKit.framework.dSYM/Contents/Resources/DWARF/QNRTCKit
diff --git a/Pod/iphoneos/QNRTCKit.framework/Headers/QNAudioEffectMixer.h b/Pod/iphoneos/QNRTCKit.framework/Headers/QNAudioEffectMixer.h
@@ -94,18 +94,31 @@ NS_ASSUME_NONNULL_BEGIN
  *
  * @since v5.1.0
  */
-- (void)audioEffectMixer:(QNAudioEffectMixer *)audioEffectMixer didFailWithError:(NSError *)error;
+- (void)audioEffectMixer:(QNAudioEffectMixer *)audioEffectMixer didFailWithError:(NSError *)error __deprecated_msg("Method deprecated in v5.2.4. Use `- (void)audioEffect:(QNAudioEffect *)audioEffect didFailed:(int)effectID error:(NSError *)error`");
+
+/*!
+ * @abstract 某音效混音发生错误的回调
+ *
+ * @param audioEffect 音效实例
+ *
+ * @param effectID 音效唯一标识符
+ *
+ * @param error 错误
+ *
+ * @since v5.2.4
+ */
+- (void)audioEffect:(QNAudioEffect *)audioEffect didFailed:(int)effectID error:(NSError *)error;
 
 /*!
  * @abstract 音效混音某音效播放完成的回调
  *
- * @param audioEffectMixer 音效混音实例
+ * @param audioEffect 音效实例
  *
  * @param effectID 音效唯一标识符
  *
- * @since v5.1.0
+ * @since v5.2.4
  */
-- (void)audioEffectMixer:(QNAudioEffectMixer *)audioEffectMixer didFinished:(int)effectID;
+- (void)audioEffect:(QNAudioEffect *)audioEffect didFinished:(int)effectID;
 @end
 
 @interface QNAudioEffectMixer : NSObject

diff --git a/Pod/iphoneos/QNRTCKit.framework/Headers/QNLocalVideoTrackStats.h b/Pod/iphoneos/QNRTCKit.framework/Headers/QNLocalVideoTrackStats.h
@@ -58,6 +58,78 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nonatomic, assign, readonly) double uplinkLostRate;
 
+/*!
+ * @abstract 本地视频上行视频帧宽度
+ *
+ * @discussion 本地编码输出的视频宽度
+ *
+ * @since v5.2.4
+ */
+@property (nonatomic, assign, readonly) NSUInteger uplinkFrameWidth;
+
+/*!
+ * @abstract 本地视频上行视频帧高度
+ *
+ * @discussion 本地编码输出的视频高度
+ *
+ * @since v5.2.4
+ */
+@property (nonatomic, assign, readonly) NSUInteger uplinkFrameHeight;
+
+/*!
+ * @abstract 采集视频帧率
+ *
+ * @discussion 本地实际采集到的视频帧率
+ *
+ * @since v5.2.4
+ */
+@property (nonatomic, assign, readonly) NSUInteger captureFrameRate;
+
+/*!
+ * @abstract 采集视频帧宽度
+ *
+ * @discussion 本地采集视频帧宽度
+ *
+ * @since v5.2.4
+ */
+@property (nonatomic, assign, readonly) NSUInteger captureFrameWidth;
+
+/*!
+ * @abstract 采集视频帧宽高度
+ *
+ * @discussion 本地采集视频帧宽高度
+ *
+ * @since v5.2.4
+ */
+@property (nonatomic, assign, readonly) NSUInteger captureFrameHeight;
+
+/*!
+ * @abstract 目标视频帧率
+ *
+ * @discussion 期望的视频帧率
+ *
+ * @since v5.2.4
+ */
+@property (nonatomic, assign, readonly) NSUInteger targetFrameRate;
+
+/*!
+ * @abstract 目标视频帧宽度
+ *
+ * @discussion 期望的视频帧宽度
+ *
+ * @since v5.2.4
+ */
+@property (nonatomic, assign, readonly) NSUInteger targetFrameWidth;
+
+/*!
+ * @abstract 目标视频帧高度
+ *
+ * @discussion 期望的视频帧高度
+ *
+ * @since v5.2.4
+ */
+@property (nonatomic, assign, readonly) NSUInteger targetFrameHeight;
+
 @end
 
 NS_ASSUME_NONNULL_END
diff --git a/Pod/iphoneos/QNRTCKit.framework/Headers/QNRTCConfiguration.h b/Pod/iphoneos/QNRTCKit.framework/Headers/QNRTCConfiguration.h
@@ -51,6 +51,22 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nonatomic, assign, readonly) QNAudioScene audioScene;
 
+/*!
+ * @abstract SDK 与七牛服务器由于网络原因断开后，内部尝试重连的超时时间，单位： ms，默认 30s
+ *
+ * @warning 建议在重连超时收到 QNRTCErrorNetworkTimeout 后做新的业务处理
+ *
+ * @since v5.2.4
+ */
+@property (nonatomic, assign, readonly) int reconnectionTimeout;
+/*!
+ * @abstract 设置编码器类型，默认使用 QNVideoEncoderToolboxH264
+ *
+ *
+ * @since v5.2.4
+ */
+@property (nonatomic, assign, readonly) QNVideoEncoderType encoderType;
+
 /*!
  * @abstract 用默认参数生成一个对象
  *
@@ -87,6 +103,29 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (instancetype)initWithPolicy:(QNRTCPolicy)policy audioScene:(QNAudioScene)audioScene;
 
+
+/*!
+ * @abstract 用指定的 policy 、audioScene 、reconnectionTimeout 生成一个对象
+ *
+ * @param policy 用指定的连接方式
+ * @param audioScene 场景
+ * @param reconnectionTimeout 重连超时间单位（ms）
+ * @since v5.2.4
+ */
+- (instancetype)initWithPolicy:(QNRTCPolicy)policy audioScene:(QNAudioScene)audioScene reconnectionTimeout:(int)reconnectionTimeout;
+
+/*!
+ * @abstract 用指定的 policy 、audioScene 、reconnectionTimeout 、encoderType生成一个对象
+ *
+ * @param policy 用指定的连接方式
+ * @param audioScene 场景
+ * @param reconnectionTimeout 重连超时间单位（ms）
+ * @param encoderType 视频编码类型
+ * @since v5.2.4
+ */
+- (instancetype)initWithPolicy:(QNRTCPolicy)policy audioScene:(QNAudioScene)audioScene reconnectionTimeout:(int)reconnectionTimeout encoderType:(QNVideoEncoderType)encoderType;
+
+
 @end
 
 NS_ASSUME_NONNULL_END
diff --git a/Pod/iphoneos/QNRTCKit.framework/Headers/QNRTCLogConfiguration.h b/Pod/iphoneos/QNRTCKit.framework/Headers/QNRTCLogConfiguration.h
@@ -29,7 +29,7 @@ NS_ASSUME_NONNULL_BEGIN
 /*!
  * @abstract 文件最大 size
  *
- * @discussion 默认为 3MB，传 0 则代表不需要写日志
+ * @discussion 默认为 3MB，传 0 则代表不需要写日志，自定义文件大小范围为 256kb ~ 10MB
  */
 @property (nonatomic, assign) long maxSizeInBytes;
 

diff --git a/Pod/iphoneos/QNRTCKit.framework/Headers/QNRemoteVideoTrackStats.h b/Pod/iphoneos/QNRTCKit.framework/Headers/QNRemoteVideoTrackStats.h
@@ -67,6 +67,24 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nonatomic, assign, readonly) double uplinkLostRate;
 
+/*!
+ * @abstract 远端视频上行视频帧宽度
+ *
+ * @discussion 远端用户编码输出的视频宽度
+ *
+ * @since v5.2.4
+ */
+@property (nonatomic, assign, readonly) NSUInteger uplinkFrameWidth;
+
+/*!
+ * @abstract 远端视频上行视频帧高度
+ *
+ * @discussion 远端用户编码输出的视频高度
+ *
+ * @since v5.2.4
+ */
+@property (nonatomic, assign, readonly) NSUInteger uplinkFrameHeight;
+
 @end
 
 NS_ASSUME_NONNULL_END