// // WindPlayerController.h // WindPlayer // // Copyright (c) 2016年 任子丰 ( http://github.com/renzifeng ) // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN // THE SOFTWARE. #import #import #import #import #import #import #import #import #import NS_ASSUME_NONNULL_BEGIN @interface WindPlayerController : NSObject /// The video contrainerView in normal model. @property (nonatomic, strong) UIView *containerView; /// The currentPlayerManager must conform `WindPlayerMediaPlayback` protocol. @property (nonatomic, strong) id currentPlayerManager; /// The custom controlView must conform `WindPlayerMediaControl` protocol. @property (nonatomic, strong) UIView *controlView; /// The notification manager class. @property (nonatomic, strong, readonly) WindPlayerNotification *notification; /// The container view type. @property (nonatomic, assign, readonly) WindPlayerContainerType containerType; /// The player's small container view. @property (nonatomic, strong, readonly) WindFloatView *smallFloatView; /// Whether the small window is displayed. @property (nonatomic, assign, readonly) BOOL isSmallFloatViewShow; /*! @method playerWithPlayerManager:containerView: @abstract Create an WindPlayerController that plays a single audiovisual item. @param playerManager must conform `WindPlayerMediaPlayback` protocol. @param containerView to see the video frames must set the contrainerView. @result An instance of WindPlayerController. */ + (instancetype)playerWithPlayerManager:(id)playerManager containerView:(UIView *)containerView; /*! @method initWithPlayerManager:containerView: @abstract Create an WindPlayerController that plays a single audiovisual item. @param playerManager must conform `WindPlayerMediaPlayback` protocol. @param containerView to see the video frames must set the contrainerView. @result An instance of WindPlayerController. */ - (instancetype)initWithPlayerManager:(id)playerManager containerView:(UIView *)containerView; /*! @method playerWithScrollView:playerManager:containerViewTag: @abstract Create an WindPlayerController that plays a single audiovisual item. Use in `UITableView` or `UICollectionView`. @param scrollView is `tableView` or `collectionView`. @param playerManager must conform `WindPlayerMediaPlayback` protocol. @param containerViewTag to see the video at scrollView must set the contrainerViewTag. @result An instance of WindPlayerController. */ + (instancetype)playerWithScrollView:(UIScrollView *)scrollView playerManager:(id)playerManager containerViewTag:(NSInteger)containerViewTag; /*! @method initWithScrollView:playerManager:containerViewTag: @abstract Create an WindPlayerController that plays a single audiovisual item. Use in `UITableView` or `UICollectionView`. @param scrollView is `tableView` or `collectionView`. @param playerManager must conform `WindPlayerMediaPlayback` protocol. @param containerViewTag to see the video at scrollView must set the contrainerViewTag. @result An instance of WindPlayerController. */ - (instancetype)initWithScrollView:(UIScrollView *)scrollView playerManager:(id)playerManager containerViewTag:(NSInteger)containerViewTag; /*! @method playerWithScrollView:playerManager:containerView: @abstract Create an WindPlayerController that plays a single audiovisual item. Use in `UIScrollView`. @param playerManager must conform `WindPlayerMediaPlayback` protocol. @param containerView to see the video at the scrollView. @result An instance of WindPlayerController. */ + (instancetype)playerWithScrollView:(UIScrollView *)scrollView playerManager:(id)playerManager containerView:(UIView *)containerView; /*! @method initWithScrollView:playerManager:containerView: @abstract Create an WindPlayerController that plays a single audiovisual item. Use in `UIScrollView`. @param playerManager must conform `WindPlayerMediaPlayback` protocol. @param containerView to see the video at the scrollView. @result An instance of WindPlayerController. */ - (instancetype)initWithScrollView:(UIScrollView *)scrollView playerManager:(id)playerManager containerView:(UIView *)containerView; @end @interface WindPlayerController (WindPlayerTimeControl) /// The player current play time. @property (nonatomic, readonly) NSTimeInterval currentTime; /// The player total time. @property (nonatomic, readonly) NSTimeInterval totalTime; /// The player buffer time. @property (nonatomic, readonly) NSTimeInterval bufferTime; /// The player progress, 0...1 @property (nonatomic, readonly) float progress; /// The player bufferProgress, 0...1 @property (nonatomic, readonly) float bufferProgress; /** Use this method to seek to a specified time for the current player and to be notified when the seek operation is complete. @param time seek time. @param completionHandler completion handler. */ - (void)seekToTime:(NSTimeInterval)time completionHandler:(void (^ __nullable)(BOOL finished))completionHandler; @end @interface WindPlayerController (WindPlayerPlaybackControl) /// Resume playback record.default is NO. /// Memory storage playback records. @property (nonatomic, assign) BOOL resumePlayRecord; /// 0...1.0 /// Only affects audio volume for the device instance and not for the player. /// You can change device volume or player volume as needed,change the player volume you can conform the `WindPlayerMediaPlayback` protocol. @property (nonatomic) float volume; /// The device muted. /// Only affects audio muting for the device instance and not for the player. /// You can change device mute or player mute as needed,change the player mute you can conform the `WindPlayerMediaPlayback` protocol. @property (nonatomic, getter=isMuted) BOOL muted; // 0...1.0, where 1.0 is maximum brightness. Only supported by main screen. @property (nonatomic) float brightness; /// The play asset URL. @property (nonatomic) NSURL *assetURL; /// If tableView or collectionView has only one section , use `assetURLs`. /// If tableView or collectionView has more sections , use `sectionAssetURLs`. /// Set this you can use `playTheNext` `playThePrevious` `playTheIndex:` method. @property (nonatomic, copy, nullable) NSArray *assetURLs; /// The currently playing index,limited to one-dimensional arrays. @property (nonatomic) NSInteger currentPlayIndex; /// is the last asset URL in `assetURLs`. @property (nonatomic, readonly) BOOL isLastAssetURL; /// is the first asset URL in `assetURLs`. @property (nonatomic, readonly) BOOL isFirstAssetURL; /// If Yes, player will be called pause method When Received `UIApplicationWillResignActiveNotification` notification. /// default is YES. @property (nonatomic) BOOL pauseWhenAppResignActive; /// When the player is playing, it is paused by some event,not by user click to pause. /// For example, when the player is playing, application goes into the background or pushed to another viewController @property (nonatomic, getter=isPauseByEvent) BOOL pauseByEvent; /// The current player controller is disappear, not dealloc @property (nonatomic, getter=isViewControllerDisappear) BOOL viewControllerDisappear; /// You can custom the AVAudioSession, /// default is NO. @property (nonatomic, assign) BOOL customAudioSession; /// default is NO. @property (nonatomic, assign) BOOL followSysMute; /// The block invoked when the player is Prepare to play. @property (nonatomic, copy, nullable) void(^playerPrepareToPlay)(id asset, NSURL *assetURL); /// The block invoked when the player is Ready to play. @property (nonatomic, copy, nullable) void(^playerReadyToPlay)(id asset, NSURL *assetURL); /// The block invoked when the player play progress changed. @property (nonatomic, copy, nullable) void(^playerPlayTimeChanged)(id asset, NSTimeInterval currentTime, NSTimeInterval duration); /// The block invoked when the player play buffer changed. @property (nonatomic, copy, nullable) void(^playerBufferTimeChanged)(id asset, NSTimeInterval bufferTime); /// The block invoked when the player playback state changed. @property (nonatomic, copy, nullable) void(^playerPlayStateChanged)(id asset, WindPlayerPlaybackState playState); /// The block invoked when the player load state changed. @property (nonatomic, copy, nullable) void(^playerLoadStateChanged)(id asset, WindPlayerLoadState loadState); /// The block invoked when the player play failed. @property (nonatomic, copy, nullable) void(^playerPlayFailed)(id asset, id error); /// The block invoked when the player play end. @property (nonatomic, copy, nullable) void(^playerDidToEnd)(id asset); // The block invoked when video size changed. @property (nonatomic, copy, nullable) void(^presentationSizeChanged)(id asset, CGSize size); /** Play the next url ,while the `assetURLs` is not NULL. */ - (void)playTheNext; /** Play the previous url ,while the `assetURLs` is not NULL. */ - (void)playThePrevious; /** Play the index of url ,while the `assetURLs` is not NULL. @param index play the index. */ - (void)playTheIndex:(NSInteger)index; /** Player stop and playerView remove from super view,remove other notification. */ - (void)stop; /*! @method replaceCurrentPlayerManager: @abstract Replaces the player's current playeranager with the specified player item. @param manager must conform `WindPlayerMediaPlayback` protocol @discussion The playerManager that will become the player's current playeranager. */ - (void)replaceCurrentPlayerManager:(id)manager; /** Add video to cell. */ - (void)addPlayerViewToCell; /** Add video to container view. */ - (void)addPlayerViewToContainerView:(UIView *)containerView; /** Add to small float view. */ - (void)addPlayerViewToSmallFloatView; /** Stop the current playing video and remove the playerView. */ - (void)stopCurrentPlayingView; /** stop the current playing video on cell. */ - (void)stopCurrentPlayingCell; @end @interface WindPlayerController (WindPlayerOrientationRotation) @property (nonatomic, readonly) WindOrientationObserver *orientationObserver; /// Whether automatic screen rotation is supported. /// The value is NO. /// This property is used for the return value of UIViewController `shouldAutorotate` method. @property (nonatomic, readonly) BOOL shouldAutorotate; /// Whether allow the video orientation rotate. /// default is YES. @property (nonatomic) BOOL allowOrentitaionRotation; /// When WindFullScreenMode is WindFullScreenModeLandscape the orientation is LandscapeLeft or LandscapeRight, this value is YES. /// When WindFullScreenMode is WindFullScreenModePortrait, while the player fullSceen this value is YES. @property (nonatomic, readonly) BOOL isFullScreen; /// when call the `stop` method, exit the fullScreen model, default is YES. @property (nonatomic, assign) BOOL exitFullScreenWhenStop; /// Lock the screen orientation. @property (nonatomic, getter=isLockedScreen) BOOL lockedScreen; /// The current orientation of the player. /// Default is UIInterfaceOrientationPortrait. @property (nonatomic, readonly) UIInterfaceOrientation currentOrientation; /// The block invoked When player will rotate. @property (nonatomic, copy, nullable) void(^orientationWillChange)(WindPlayerController *player, BOOL isFullScreen); /// The block invoked when player rotated. @property (nonatomic, copy, nullable) void(^orientationDidChanged)(WindPlayerController *player, BOOL isFullScreen); /// default is UIStatusBarStyleLightContent. @property (nonatomic, assign) UIStatusBarStyle fullScreenStatusBarStyle; /// defalut is UIStatusBarAnimationSlide. @property (nonatomic, assign) UIStatusBarAnimation fullScreenStatusBarAnimation; /// The fullscreen statusbar hidden. @property (nonatomic, getter=isStatusBarHidden) BOOL statusBarHidden; /** Add the device orientation observer. */ - (void)addDeviceOrientationObserver; /** Remove the device orientation observer. */ - (void)removeDeviceOrientationObserver; /** Enter the fullScreen while the WindFullScreenMode is WindFullScreenModeLandscape. @param orientation is UIInterfaceOrientation. @param animated is animated. */ - (void)rotateToOrientation:(UIInterfaceOrientation)orientation animated:(BOOL)animated; /** Enter the fullScreen while the WindFullScreenMode is WindFullScreenModeLandscape. @param orientation is UIInterfaceOrientation. @param animated is animated. @param completion rotating completed callback. */ - (void)rotateToOrientation:(UIInterfaceOrientation)orientation animated:(BOOL)animated completion:(void(^ __nullable)(void))completion; /** Enter the fullScreen while the WindFullScreenMode is WindFullScreenModePortrait. @param fullScreen is fullscreen. @param animated is animated. @param completion rotating completed callback. */ - (void)enterPortraitFullScreen:(BOOL)fullScreen animated:(BOOL)animated completion:(void(^ __nullable)(void))completion; /** Enter the fullScreen while the WindFullScreenMode is WindFullScreenModePortrait. @param fullScreen is fullscreen. @param animated is animated. */ - (void)enterPortraitFullScreen:(BOOL)fullScreen animated:(BOOL)animated; /** FullScreen mode is determined by WindFullScreenMode. @param fullScreen is fullscreen. @param animated is animated. @param completion rotating completed callback. */ - (void)enterFullScreen:(BOOL)fullScreen animated:(BOOL)animated completion:(void(^ __nullable)(void))completion; /** FullScreen mode is determined by WindFullScreenMode. @param fullScreen is fullscreen. @param animated is animated. */ - (void)enterFullScreen:(BOOL)fullScreen animated:(BOOL)animated; @end @interface WindPlayerController (WindPlayerViewGesture) /// An instance of WindPlayerGestureControl. @property (nonatomic, readonly) WindPlayerGestureControl *gestureControl; /// The gesture types that the player not support. @property (nonatomic, assign) WindPlayerDisableGestureTypes disableGestureTypes; /// The pan gesture moving direction that the player not support. @property (nonatomic) WindPlayerDisablePanMovingDirection disablePanMovingDirection; @end @interface WindPlayerController (WindPlayerScrollView) /// The scroll view is `tableView` or `collectionView`. @property (nonatomic, readonly, nullable) UIScrollView *scrollView; /// The scrollView player should auto player, default is YES. @property (nonatomic) BOOL shouldAutoPlay; /// WWAN network auto play, only support in scrollView mode when the `shouldAutoPlay` is YES, default is NO. @property (nonatomic, getter=isWWANAutoPlay) BOOL WWANAutoPlay; /// The indexPath is playing. @property (nonatomic, readonly, nullable) NSIndexPath *playingIndexPath; /// The indexPath should be play while scrolling. @property (nonatomic, readonly, nullable) NSIndexPath *shouldPlayIndexPath; /// The view tag that the player display in scrollView. @property (nonatomic, readonly) NSInteger containerViewTag; /// The current playing cell stop playing when the cell has out off the screen，defalut is YES. @property (nonatomic) BOOL stopWhileNotVisible; /** The current player scroll slides off the screen percent. the property used when the `stopWhileNotVisible` is YES, stop the current playing player. the property used when the `stopWhileNotVisible` is NO, the current playing player add to small container view. The range is 0.0~1.0, defalut is 0.5. 0.0 is the player will disappear. 1.0 is the player did disappear. */ @property (nonatomic) CGFloat playerDisapperaPercent; /** The current player scroll to the screen percent to play the video. The range is 0.0~1.0, defalut is 0.0. 0.0 is the player will appear. 1.0 is the player did appear. */ @property (nonatomic) CGFloat playerApperaPercent; /// If tableView or collectionView has more sections, use `sectionAssetURLs`. @property (nonatomic, copy, nullable) NSArray *>*sectionAssetURLs; /// The block invoked When the player appearing. @property (nonatomic, copy, nullable) void(^wind_playerAppearingInScrollView)(NSIndexPath *indexPath, CGFloat playerApperaPercent); /// The block invoked When the player disappearing. @property (nonatomic, copy, nullable) void(^wind_playerDisappearingInScrollView)(NSIndexPath *indexPath, CGFloat playerDisapperaPercent); /// The block invoked When the player will appeared. @property (nonatomic, copy, nullable) void(^wind_playerWillAppearInScrollView)(NSIndexPath *indexPath); /// The block invoked When the player did appeared. @property (nonatomic, copy, nullable) void(^wind_playerDidAppearInScrollView)(NSIndexPath *indexPath); /// The block invoked When the player will disappear. @property (nonatomic, copy, nullable) void(^wind_playerWillDisappearInScrollView)(NSIndexPath *indexPath); /// The block invoked When the player did disappeared. @property (nonatomic, copy, nullable) void(^wind_playerDidDisappearInScrollView)(NSIndexPath *indexPath); /// The block invoked When the player should play. @property (nonatomic, copy, nullable) void(^wind_playerShouldPlayInScrollView)(NSIndexPath *indexPath); /// The block invoked When the player did stop scroll. @property (nonatomic, copy, nullable) void(^wind_scrollViewDidEndScrollingCallback)(NSIndexPath *indexPath); /// Filter the cell that should be played when the scroll is stopped (to play when the scroll is stopped). - (void)wind_filterShouldPlayCellWhileScrolled:(void (^ __nullable)(NSIndexPath *indexPath))handler; /// Filter the cell that should be played while scrolling (you can use this to filter the highlighted cell). - (void)wind_filterShouldPlayCellWhileScrolling:(void (^ __nullable)(NSIndexPath *indexPath))handler; /** Play the indexPath of url without scroll postion, while the `assetURLs` or `sectionAssetURLs` is not NULL. @param indexPath Play the indexPath of url. */ - (void)playTheIndexPath:(NSIndexPath *)indexPath; /** Play the indexPath of url, while the `assetURLs` or `sectionAssetURLs` is not NULL. @param indexPath Play the indexPath of url. @param scrollPosition scroll position. @param animated scroll animation. */ - (void)playTheIndexPath:(NSIndexPath *)indexPath scrollPosition:(WindPlayerScrollViewScrollPosition)scrollPosition animated:(BOOL)animated; /** Play the indexPath of url with scroll postion, while the `assetURLs` or `sectionAssetURLs` is not NULL. @param indexPath Play the indexPath of url. @param scrollPosition scroll position. @param animated scroll animation. @param completionHandler Scroll completion callback. */ - (void)playTheIndexPath:(NSIndexPath *)indexPath scrollPosition:(WindPlayerScrollViewScrollPosition)scrollPosition animated:(BOOL)animated completionHandler:(void (^ __nullable)(void))completionHandler; /** Play the indexPath of url with scroll postion. @param indexPath Play the indexPath of url @param assetURL The player URL. */ - (void)playTheIndexPath:(NSIndexPath *)indexPath assetURL:(NSURL *)assetURL; /** Play the indexPath of url with scroll postion. @param indexPath Play the indexPath of url @param assetURL The player URL. @param scrollPosition scroll position. @param animated scroll animation. */ - (void)playTheIndexPath:(NSIndexPath *)indexPath assetURL:(NSURL *)assetURL scrollPosition:(WindPlayerScrollViewScrollPosition)scrollPosition animated:(BOOL)animated; /** Play the indexPath of url with scroll postion. @param indexPath Play the indexPath of url @param assetURL The player URL. @param scrollPosition scroll position. @param animated scroll animation. @param completionHandler Scroll completion callback. */ - (void)playTheIndexPath:(NSIndexPath *)indexPath assetURL:(NSURL *)assetURL scrollPosition:(WindPlayerScrollViewScrollPosition)scrollPosition animated:(BOOL)animated completionHandler:(void (^ __nullable)(void))completionHandler; @end @interface WindPlayerController (WindPlayerDeprecated) /** Add the playerView to cell. */ - (void)updateScrollViewPlayerToCell __attribute__((deprecated("use `addPlayerViewToCell:` instead."))); /** Add the playerView to containerView. @param containerView The playerView containerView. */ - (void)updateNoramlPlayerWithContainerView:(UIView *)containerView __attribute__((deprecated("use `addPlayerViewToContainerView:` instead."))); /** Play the indexPath of url ,while the `assetURLs` or `sectionAssetURLs` is not NULL. @param indexPath Play the indexPath of url @param scrollToTop Scroll the current cell to top with animations. */ - (void)playTheIndexPath:(NSIndexPath *)indexPath scrollToTop:(BOOL)scrollToTop __attribute__((deprecated("use `playTheIndexPath:scrollPosition:animated:` instead."))); /** Play the indexPath of url with scroll postion. @param indexPath Play the indexPath of url @param assetURL The player URL. @param scrollToTop Scroll the current cell to top with animations. */ - (void)playTheIndexPath:(NSIndexPath *)indexPath assetURL:(NSURL *)assetURL scrollToTop:(BOOL)scrollToTop __attribute__((deprecated("use `playTheIndexPath:assetURL:scrollPosition:animated:` instead."))); /** Play the indexPath of url ,while the `assetURLs` or `sectionAssetURLs` is not NULL. @param indexPath Play the indexPath of url @param scrollToTop scroll the current cell to top with animations. @param completionHandler Scroll completion callback. */ - (void)playTheIndexPath:(NSIndexPath *)indexPath scrollToTop:(BOOL)scrollToTop completionHandler:(void (^ __nullable)(void))completionHandler __attribute__((deprecated("use `playTheIndexPath:scrollPosition:animated:completionHandler:` instead."))); /** Enter the fullScreen while the WindFullScreenMode is WindFullScreenModeLandscape. @param orientation UIInterfaceOrientation @param animated is animated. @param completion rotating completed callback. */ - (void)enterLandscapeFullScreen:(UIInterfaceOrientation)orientation animated:(BOOL)animated completion:(void(^ __nullable)(void))completion __attribute__((deprecated("use `rotateToOrientation:animated:completion:` instead."))); /** Enter the fullScreen while the WindFullScreenMode is WindFullScreenModeLandscape. @param orientation UIInterfaceOrientation @param animated is animated. */ - (void)enterLandscapeFullScreen:(UIInterfaceOrientation)orientation animated:(BOOL)animated __attribute__((deprecated("use `rotateToOrientation:animated:` instead."))); /** Add to the keyWindow. */ - (void)addPlayerViewToKeyWindow __attribute__((deprecated("use `addPlayerViewToSmallFloatView` instead.")));; @end NS_ASSUME_NONNULL_END