new ASVideoPlayerNodeDelegate methods. comments in header

AsyncDisplayKit/ASVideoPlayerNode.h

@@ -39,6 +39,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 @end
 
+#pragma mark - ASVideoPlayerNodeDelegate -
 @protocol ASVideoPlayerNodeDelegate <NSObject>
 @optional
 /**
@@ -46,16 +47,66 @@ NS_ASSUME_NONNULL_BEGIN
  * @param videoPlayer
  */
 - (NSArray *)videoPlayerNodeNeededControls:(ASVideoPlayerNode*)videoPlayer;
+
+/**
+ * @abstract Delegate method invoked in layoutSpecThatFits:
+ * @param videoPlayer
+ * @param controls - Dictionary of controls which are used in videoPlayer; Dictionary keys are ASVideoPlayerNodeControlType
+ * @param constrainedSize - ASSizeRange for ASVideoPlayerNode
+ * @discussion - Developer can layout whole ASVideoPlayerNode as he wants. ASVideoNode is locked and it can't be changed
+ */
+- (ASLayoutSpec *)videoPlayerNodeLayoutSpec:(ASVideoPlayerNode *)videoPlayer
+                                forControls:(NSDictionary *)controls
+                         forConstrainedSize:(ASSizeRange)constrainedSize;
+
+#pragma mark Text delegate methods
+/**
+ * @abstract Delegate method invoked before creating ASVideoPlayerNodeControlTypeElapsedText and ASVideoPlayerNodeControlTypeDurationText
+ * @param videoPlayer
+ * @param timeLabelType
+ */
 - (NSDictionary *)videoPlayerNodeTimeLabelAttributes:(ASVideoPlayerNode *)videoPlayerNode timeLabelType:(ASVideoPlayerNodeControlType)timeLabelType;
 
-#pragma mark - Scrubber delegate methods
+#pragma mark Scrubber delegate methods
 - (UIColor *)videoPlayerNodeScrubberMaximumTrackTint:(ASVideoPlayerNode *)videoPlayer;
 - (UIColor *)videoPlayerNodeScrubberMinimumTrackTint:(ASVideoPlayerNode *)videoPlayer;
 - (UIColor *)videoPlayerNodeScrubberThumbTint:(ASVideoPlayerNode *)videoPlayer;
 - (UIImage *)videoPlayerNodeScrubberThumbImage:(ASVideoPlayerNode *)videoPlayer;
-- (ASLayoutSpec *)videoPlayerNodeLayoutSpec:(ASVideoPlayerNode *)videoPlayer
-                                forControls:(NSDictionary *)controls
-                         forConstrainedSize:(ASSizeRange)constrainedSize;
+
+
+#pragma mark ASVideoNodeDelegate proxy methods
+/**
+ * @abstract Delegate method invoked when ASVideoNode playback time is updated.
+ * @param videoPlayerNode The video node that was tapped.
+ * @param second current playback time.
+ */
+- (void)videoPlayerNode:(ASVideoPlayerNode *)videoPlayer didPlayToTime:(CMTime)time;
+
+/**
+ * @abstract Delegate method invoked when ASVideoNode changes state.
+ * @param videoPlayerNode The ASVideoPlayerNode whose ASVideoNode is changing state.
+ * @param state ASVideoNode state before this change.
+ * @param toSate ASVideoNode new state.
+ * @discussion This method is called after each state change
+ */
+- (void)videoPlayerNode:(ASVideoPlayerNode *)videoPlayer willChangeVideoNodeState:(ASVideoNodePlayerState)state toVideoNodeState:(ASVideoNodePlayerState)toSate;
+
+/**
+ * @abstract Delegate method is invoked when ASVideoNode decides to change state.
+ * @param videoPlayerNode The ASVideoPlayerNode whose ASVideoNode is changing state.
+ * @param state ASVideoNode that is going to be set.
+ * @discussion Delegate method invoked when player changes it's state to
+ * ASVideoNodePlayerStatePlaying or ASVideoNodePlayerStatePaused
+ * and asks delegate if state change is valid
+ */
+- (BOOL)videoPlayerNode:(ASVideoPlayerNode*)videoPlayer shouldChangeVideoNodeStateTo:(ASVideoNodePlayerState)state;
+
+/**
+ * @abstract Delegate method invoked when the ASVideoNode has played to its end time.
+ * @param videoPlayerNode The video node has played to its end time.
+ */
+- (void)videoPlayerNodePlaybackDidFinish:(ASVideoPlayerNode *)videoPlayer;
+
 @end
 NS_ASSUME_NONNULL_END
 #endif