Update Doc.

nickarora · Sep 11, 2019 · 50def88 · 50def88
1 parent 3557e13
commit 50def88
Show file tree

Hide file tree

Showing 8 changed files with 302 additions and 118 deletions.
diff --git a/SGPlayer/Classes/Core/SGOption/SGDecoderOptions.h b/SGPlayer/Classes/Core/SGOption/SGDecoderOptions.h
@@ -10,33 +10,51 @@
 
 @interface SGDecoderOptions : NSObject <NSCopying>
 
-/**
- *
+/*!
+ @property options
+ @abstract
+    The options for avformat_open_input.
+    Default is nil.
  */
 @property (nonatomic, copy) NSDictionary *options;
 
-/**
- *
+/*!
+ @property threadsAuto
+ @abstract
+    The option for avformat_open_input.
+    Default is YES.
  */
 @property (nonatomic) BOOL threadsAuto;
 
-/**
- *
+/*!
+ @property refcountedFrames
+ @abstract
+    The option for avformat_open_input.
+    Default is YES.
  */
 @property (nonatomic) BOOL refcountedFrames;
 
-/**
- *
+/*!
+ @property hardwareDecodeH264
+ @abstract
+    Indicates whether hardware decoding is enabled for H264.
+    Default is YES.
  */
 @property (nonatomic) BOOL hardwareDecodeH264;
 
-/**
- *
+/*!
+ @property hardwareDecodeH265
+ @abstract
+    Indicates whether hardware decoding is enabled for H265.
+    Default is YES.
  */
 @property (nonatomic) BOOL hardwareDecodeH265;
 
-/**
- *
+/*!
+ @property preferredPixelFormat
+ @abstract
+    Indicates the default hardware decoding output format.
+    Default is kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange.
  */
 @property (nonatomic) OSType preferredPixelFormat;
 

diff --git a/SGPlayer/Classes/Core/SGOption/SGDemuxerOptions.h b/SGPlayer/Classes/Core/SGOption/SGDemuxerOptions.h
@@ -10,8 +10,14 @@
 
 @interface SGDemuxerOptions : NSObject <NSCopying>
 
-/**
- *
+/*!
+ @property options
+ @abstract
+    The options for avformat_open_input.
+    Default:
+        @{@"reconnect" : @(1),
+          @"user-agent" : @"SGPlayer",
+          @"timeout" : @(20 * 1000 * 1000)}
  */
 @property (nonatomic, copy) NSDictionary *options;
 

diff --git a/SGPlayer/Classes/Core/SGOption/SGOptions.h b/SGPlayer/Classes/Core/SGOption/SGOptions.h
@@ -13,23 +13,31 @@
 
 @interface SGOptions : NSObject <NSCopying>
 
-/**
- *
+/*!
+ @method sharedOptions
+ @abstract
+    Globally shared configuration options.
  */
 + (instancetype)sharedOptions;
 
-/**
- *
+/*!
+ @property demuxer
+ @abstract
+    The options for demuxer.
  */
 @property (nonatomic, strong) SGDemuxerOptions *demuxer;
 
-/**
- *
+/*!
+ @property decoder
+ @abstract
+    The options for decoder.
  */
 @property (nonatomic, strong) SGDecoderOptions *decoder;
 
-/**
- *
+/*!
+ @property processor
+ @abstract
+    The options for processor.
  */
 @property (nonatomic, strong) SGProcessorOptions *processor;
 

diff --git a/SGPlayer/Classes/Core/SGOption/SGProcessorOptions.h b/SGPlayer/Classes/Core/SGOption/SGProcessorOptions.h
@@ -10,13 +10,19 @@
 
 @interface SGProcessorOptions : NSObject <NSCopying>
 
-/**
- *
+/*!
+ @property audioClass
+ @abstract
+    The audio frame processor class.
+    Default is SGAudioProcessor.
  */
 @property (nonatomic, copy) Class audioClass;
 
-/**
- *
+/*!
+ @property videoClass
+ @abstract
+    The video frame processor class.
+    Default is SGVideoProcessor.
  */
 @property (nonatomic, copy) Class videoClass;
 

diff --git a/SGPlayer/Classes/Core/SGRenderer/SGAudioRenderer.h b/SGPlayer/Classes/Core/SGRenderer/SGAudioRenderer.h
@@ -10,8 +10,10 @@
 
 @interface SGAudioRenderer : NSObject
 
-/**
- *
+/*!
+ @property volume
+ @abstract
+    Indicates the current audio volume.
  */
 @property (nonatomic) Float64 volume;
 

diff --git a/SGPlayer/Classes/Core/SGRenderer/SGVideoRenderer.h b/SGPlayer/Classes/Core/SGRenderer/SGVideoRenderer.h
@@ -26,38 +26,74 @@ typedef NS_ENUM(NSUInteger, SGScalingMode) {
 
 @interface SGVideoRenderer : NSObject
 
-/**
- *  Main thread only.
+/*!
+ @property view
+ @abstract
+    Indicates the view that displays content.
+ 
+ @discussion
+    Main thread only.
  */
 @property (nonatomic, strong) SGPLFView *view;
 
-/**
- *  Main thread only.
+/*!
+ @property viewport
+ @abstract
+    Indicates the current vr viewport.
+ 
+ @discussion
+    Main thread only.
  */
 @property (nonatomic, strong, readonly) SGVRViewport *viewport;
 
-/**
- *  Main thread only.
+/*!
+ @property frameOutput
+ @abstract
+    Capture the video frame that will be rendered.
+ 
+ @discussion
+    Main thread only.
  */
 @property (nonatomic, copy) void (^frameOutput)(SGVideoFrame *frame);
 
-/**
- *  Main thread only.
+/*!
+ @property preferredFramesPerSecond
+ @abstract
+    Indicates how many frames are rendered in one second.
+    Default is 30.
+ 
+ @discussion
+    Main thread only.
  */
 @property (nonatomic) NSInteger preferredFramesPerSecond;
 
-/**
- *  Main thread only.
+/*!
+ @property scalingMode
+ @abstract
+    Indicates current scaling mode.
+ 
+ @discussion
+    Main thread only.
  */
 @property (nonatomic) SGScalingMode scalingMode;
 
-/**
- *  Main thread only.
+/*!
+ @property displayMode
+ @abstract
+    Indicates current display mode.
+ 
+ @discussion
+    Main thread only.
  */
 @property (nonatomic) SGDisplayMode displayMode;
 
-/**
- *  Main thread only.
+/*!
+ @method currentImage
+ @abstract
+    Generate a screenshot of the current view.
+ 
+ @discussion
+    Main thread only.
  */
 - (SGPLFImage *)currentImage;
 

diff --git a/SGPlayer/Classes/Core/SGSession/SGPlayerItem.h b/SGPlayer/Classes/Core/SGSession/SGPlayerItem.h
@@ -16,48 +16,66 @@
 + (instancetype)new NS_UNAVAILABLE;
 - (instancetype)init NS_UNAVAILABLE;
 
-/**
- *
+/*!
+ @method initWithAsset:
+ @abstract
+    Initializes an SGPlayerItem with an SGAsset.
  */
 - (instancetype)initWithAsset:(SGAsset *)asset;
 
-/**
- *
+/*!
+ @property error
+ @abstract
+    If the loading item failed, this describes the error that caused the failure.
  */
 @property (nonatomic, copy, readonly) NSError *error;
 
-/**
- *
+/*!
+ @property tracks
+ @abstract
+    Provides array of SGPlayerItem tracks.
  */
 @property (nonatomic, copy, readonly) NSArray<SGTrack *> *tracks;
 
-/**
- *
+/*!
+ @property duration
+ @abstract
+    Indicates the metadata of the item.
  */
 @property (nonatomic, copy, readonly) NSDictionary *metadata;
 
-/**
- *
+/*!
+ @property duration
+ @abstract
+    Indicates the duration of the item.
  */
 @property (nonatomic, readonly) CMTime duration;
 
-/**
- *
+/*!
+ @property duration
+ @abstract
+    Indicates the audioSelection of the item.
  */
 @property (nonatomic, copy, readonly) SGTrackSelection *audioSelection;
 
-/**
- *
+/*!
+ @method setAudioSelection:action:
+ @abstract
+    Select specific audio tracks.
  */
 - (void)setAudioSelection:(SGTrackSelection *)audioSelection action:(SGTrackSelectionAction)action;
 
-/**
- *
+/*!
+ @property duration
+ @abstract
+    Indicates the videoSelection of the item.
  */
 @property (nonatomic, copy, readonly) SGTrackSelection *videoSelection;
 
-/**
- *
+/*!
+ @method setVideoSelection:action:
+ @abstract
+    Select specific video tracks.
  */
 - (void)setVideoSelection:(SGTrackSelection *)videoSelection action:(SGTrackSelectionAction)action;