Added -playerViewPreferredInitialLoadingView:

I've added this feature because sometimes it takes a lot of time before YouTube iframe player become ready, especially in bad connection situations. During that time users are not notified the view is actually loading or not. This can be handy. Perhaps I should add a code to remove self.initialLoadingView when -webView:didFailLoadWithError: as well to prevent the loading view from being displayed forever.
youtube · Dec 14, 2015 · dd01965 · dd01965
1 parent 324ffc3
commit dd01965
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 1 deletion.
diff --git a/Classes/YTPlayerView.h b/Classes/YTPlayerView.h
@@ -110,6 +110,25 @@ typedef NS_ENUM(NSInteger, YTPlayerError) {
  */
 - (nonnull UIColor *)playerViewPreferredWebViewBackgroundColor:(nonnull YTPlayerView *)playerView;
 
+/**
+ * Callback invoked when initially loading the YouTube iframe to the webview to display a custom
+ * loading view while the player view is not ready. This loading view will be dismissed just before
+ * -playerViewDidBecomeReady: callback is invoked. The loading view will be automatically resized
+ * to cover the entire player view.
+ *
+ * The default implementation does not display any custom loading views so the player will display
+ * a blank view with a background color of (-playerViewPreferredWebViewBackgroundColor:).
+ * 
+ * Note that the custom loading view WILL NOT be displayed after iframe is loaded. It will be 
+ * handled by YouTube iframe API. This callback is just intended to tell users the view is actually
+ * doing something while iframe is being loaded, which will take some time if users are in poor networks.
+ *
+ * @param playerView The YTPlayerView instance where the error has occurred.
+ * @return A view object that will be displayed while YouTube iframe API is being loaded. 
+ * Pass nil to display no custom loading view. Default implementation returns nil.
+ */
+- (nullable UIView *)playerViewPreferredInitialLoadingView:(nonnull YTPlayerView *)playerView;
+
 @end
 
 /**

diff --git a/Classes/YTPlayerView.m b/Classes/YTPlayerView.m
@@ -62,7 +62,8 @@
 
 @interface YTPlayerView()
 
-@property(nonatomic, strong) NSURL *originURL;
+@property (nonatomic, strong) NSURL *originURL;
+@property (nonatomic, weak) UIView *initialLoadingView;
 
 @end
 
@@ -533,6 +534,9 @@ - (void)notifyDelegateOfYouTubeCallbackUrl: (NSURL *) url {
  }
 
  if ([action isEqual:kYTPlayerCallbackOnReady]) {
+ if (self.initialLoadingView) {
+ [self.initialLoadingView removeFromSuperview];
+ }
  if ([self.delegate respondsToSelector:@selector(playerViewDidBecomeReady:)]) {
  [self.delegate playerViewDidBecomeReady:self];
  }
@@ -727,6 +731,17 @@ - (BOOL)loadWithPlayerParams:(NSDictionary *)additionalPlayerParams {
  [self.webView setDelegate:self];
  self.webView.allowsInlineMediaPlayback = YES;
  self.webView.mediaPlaybackRequiresUserAction = NO;
+
+ if ([self.delegate respondsToSelector:@selector(playerViewPreferredInitialLoadingView:)]) {
+ UIView *initialLoadingView = [self.delegate playerViewPreferredInitialLoadingView:self];
+ if (initialLoadingView) {
+ initialLoadingView.frame = self.bounds;
+ initialLoadingView.autoresizingMask = UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleHeight;
+ [self addSubview:initialLoadingView];
+ self.initialLoadingView = initialLoadingView;
+ }
+ }
+
  return YES;
 }