Merge pull request #10 from HeraShowFeng/PILCS-13472/v1.0.3

v1.0.3 release

Pod/iphoneos/QNRTPlayerKit.framework.dSYM/Contents/Info.plist

@@ -13,7 +13,7 @@
 		<key>CFBundleSignature</key>
 		<string>????</string>
 		<key>CFBundleShortVersionString</key>
-		<string>1.0.2</string>
+		<string>1.0.3</string>
 		<key>CFBundleVersion</key>
 		<string>1</string>
 	</dict>

Pod/iphoneos/QNRTPlayerKit.framework/Headers/QNRTPlayer.h

@@ -26,6 +26,9 @@ NS_ASSUME_NONNULL_BEGIN
 /*!
  * @abstract SDK 运行过程中发生错误会通过该方法回调。
  *
+ * @param player QNRTPlayer
+ * @param error 错误信息
+ *
  * @discussion 具体错误码的含义可以见 QNRTTypeDefines.h 文件。
  *
  * @since v1.0.0
@@ -37,7 +40,8 @@ NS_ASSUME_NONNULL_BEGIN
  *
  * @param player QNRTPlayer
  * @param playState 播放状态
- * @discussion QNRTPlayStateError 不会通过此回调，会通过 - (void)RTPlayer:(QNRTPlayer *)player didFailWithError:(NSError *)error;回调出来。
+ *
+ * @discussion 状态为 QNRTPlayStateError 时，具体错误信息会通过 - (void)RTPlayer:(QNRTPlayer *)player didFailWithError:(NSError *)error; 回调。
  *
  * @since v1.0.0
  */
@@ -46,6 +50,9 @@ NS_ASSUME_NONNULL_BEGIN
 /*!
  * @abstract 统计信息回调。
  *
+ * @param player QNRTPlayer
+ * @param statistic 统计信息
+ *
  * @discussion 回调的时间间隔由 statisticInterval 参数决定，statisticInterval 默认为 0，即不回调统计信息。
  *
  * @see statisticInterval
@@ -55,7 +62,10 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)RTPlayer:(QNRTPlayer *)player didGetStatistic:(NSDictionary *)statistic;
 
 /*!
- * @abstract 当前流媒体流收到音频轨道。
+ * @abstract 当前流媒体流收到数据轨道的回调。
+ *
+ * @param player QNRTPlayer
+ * @param kind 数据源类型
  *
  * @since v1.0.0
  */
@@ -64,6 +74,9 @@ NS_ASSUME_NONNULL_BEGIN
 /*!
  * @abstract 音视频首帧解码后的回调。
  *
+ * @param player QNRTPlayer
+ * @param kind 数据源类型
+ *
  * @since v1.0.0
  */
 - (void)RTPlayer:(QNRTPlayer *)player firstSourceDidDecode:(QNRTSourceKind )kind;
@@ -109,14 +122,14 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nonatomic, assign) double volume;
 
-/**
+/*!
  * 视频的宽
  *
  * @since v1.0.0
  */
 @property (nonatomic, assign, readonly) CGFloat width;
 
-/**
+/*!
  * 视频的高
  *
  * @since v1.0.0
@@ -139,31 +152,36 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nonatomic, strong) QNRTVideoView *playView;
 
-/**
+/*!
  * 开始播放新的 url
  *
- * @param url 需要播放的 url ，目前支持 webrtc (url 以 webrtc:// 开头) 协议。
+ * @param url 需要播放的 url ，目前支持 webrtc (url 以 webrtc:// 开头) 、WHEP 协议。
  * @param isSupport 当前播放 URL 是否支持 SSL 证书，默认为 NO
  *
  * @since v1.0.0
  */
 - (void)playWithUrl:(NSURL *)url supportHttps:(BOOL)isSupport;
 
-/**
+/*!
  * 停止播放器
  *
  * @since v1.0.0
  */
 - (void)stop;
 
-/**
- * 静音
+/*!
+ * 音频是否静音
+ *
+ * @param mute 静音开关。
  *
  * @since 1.0.0
  */
 - (void)muteAudio:(BOOL)mute;
-/**
- * 停止画面渲染
+
+/*!
+ * 视频是否停止画面渲染
+ *
+ * @param mute 渲染开关。
  *
  * @since 1.0.0
  */
@@ -172,6 +190,8 @@ NS_ASSUME_NONNULL_BEGIN
 /*!
  * @abstract 是否将声音从扬声器输出。
  *
+ * @param speakerOn 扬声器开关。
+ *
  * @discussion 默认值为 NO，传入 YES 时，会强制声音从扬声器输出。
  *
  * @warning 由于系统原因，在某些设备（如 iPhone XS Max、iPhone 8 Plus）上，连接 AirPods 后无法通过

Pod/iphoneos/QNRTPlayerKit.framework/Headers/QNRTPlayerKit.h

@@ -15,7 +15,6 @@ FOUNDATION_EXPORT const unsigned char QNRTPlayerKitVersionString[];
 
 // In this header, you should import all the public headers of your framework using statements like #import <QNRTPlayerKit/PublicHeader.h>
 
-
 #import <QNRTPlayerKit/QNRTTypeDefines.h>
 #import <QNRTPlayerKit/QNRTPlayer.h>
 #import <QNRTPlayerKit/QNRTVideoRender.h>

Pod/iphoneos/QNRTPlayerKit.framework/Headers/QNRTTypeDefines.h

@@ -15,8 +15,7 @@ extern NSString *QNRTErrorDomain;
 
 #pragma mark - RTPlayer Error Code
 
-NS_ERROR_ENUM(QNRTErrorDomain)
-{
+NS_ERROR_ENUM(QNRTErrorDomain) {
     // 服务请求超时，或者域名解析错误等
     QNRTErrorNetworkError                            = 20001,
     // 请求服务鉴权失败
@@ -29,10 +28,12 @@ NS_ERROR_ENUM(QNRTErrorDomain)
     QNRTErrorDescriptionError                        = 20005,
     // 连接异常
     QNRTErrorConnectFailed                           = 20006,
-
 };
 
-///音频播放状态
+/*!
+ @typedef    QNRTPlayState
+ @abstract   定义播放的状态。
+ */
 typedef NS_ENUM(NSUInteger, QNRTPlayState) {
     /*!
      * @abstract 未知状态，只会作为 init 前的初始状态，开始播放之后任何情况下都不会再回到此状态。
@@ -81,7 +82,10 @@ typedef NS_ENUM(NSUInteger, QNRTSourceKind) {
     QNRTSourceKindVideo = 1,
 };
 
-//视频填充模式
+/*!
+ @typedef    QNRTVideoFillModeType
+ @abstract   定义视频填充模式。
+ */
 typedef enum {
     /**
      @brief Stretch to fill the full view, which may distort the image outside of its normal aspect ratio
@@ -99,10 +103,8 @@ typedef enum {
     QNRTVideoFillModePreserveAspectRatioAndFill
 } QNRTVideoFillModeType;
 
-
 extern NSString *QNRTStatisticAudioBitrateKey;
 extern NSString *QNRTStatisticVideoBitrateKey;
 extern NSString *QNRTStatisticVideoFrameRateKey;
 
-
 #endif /* QNRTTypeDefines_h */

Pod/iphoneos/QNRTPlayerKit.framework/Headers/QNRTVideoRender.h

@@ -12,12 +12,14 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface QNRTVideoRender : NSObject
 
-/**
+/*!
  @brief 对应的 sessionId，由 SDK 内部设置
  */
 @property (nonatomic, strong, readonly) NSString *sessionId;
 
-
+/*!
+ @brief 视频渲染视图
+ */
 @property (nonatomic, strong) QNRTVideoView *renderView;
 
 @end

Pod/iphoneos/QNRTPlayerKit.framework/Headers/QNRTVideoView.h

@@ -15,7 +15,8 @@ NS_ASSUME_NONNULL_BEGIN
 /*!
  * @abstract 远端画面的填充方式
  *
- * @discussion 当画面与 QNRTVideoView 的比例不一致时，使用的填充方式。默认使用 QNRTVideoFillModePreserveAspectRatioAndFill。
+ * @discussion 当画面与 QNRTVideoView 的比例不一致时，使用的填充方式。
+ *             默认使用 QNRTVideoFillModePreserveAspectRatioAndFill。
  *
  * @since v1.0.0
  */

Pod/universal/QNRTPlayerKit.framework.dSYM/Contents/Info.plist

@@ -13,7 +13,7 @@
 		<key>CFBundleSignature</key>
 		<string>????</string>
 		<key>CFBundleShortVersionString</key>
-		<string>1.0.2</string>
+		<string>1.0.3</string>
 		<key>CFBundleVersion</key>
 		<string>1</string>
 	</dict>