disable autoplay, rename adStarted to onAdsLoaded, ensure ads are preloading

Author: aleccolville

README.md

@@ -73,7 +73,7 @@ import { BrightcoveIMAPlayer } from "react-native-brightcove-ima-player";
 | adVideoLoadTimeout     | number   | Set the amount of milliseconds for video to load. Default is `3000`                 |                              |
 | playbackRate           | number   | Set playback speed scale. Default is `1`                                            |                              |
 | disableDefaultControl  | boolean  | Disable default player control. Set `true` when you implement own video controller. |                              |
-| adStarted              | Function | Indicates the IMA ad has started                                                    |                              |
+| onAdsLoaded           | Function | Indicates the IMA ads manager has loaded                                             |                              |
 | onReady                | Function | Indicates the video can be played back                                              |                              |
 | onPlay                 | Function | Indicates the video playback starts                                                 |                              |
 | onPause                | Function | Indicates the video is paused                                                       |                              |

android/constants.gradle

@@ -1,7 +1,7 @@
 project.ext {
-    BRIGHTCOVE_VERSION = '6.18.6'
-    PLAY_SERVICES_VERSION = '20.3.0'
-    GOOGLE_IMA_SDK_VERSION = '3.21.1'
-    ANDROIDX_LEGACY_SUPPORT_V4 = '1.0.0'
-    ANDROIDX_MEDIA = '1.1.0'
+  BRIGHTCOVE_VERSION = '6.18.6'
+  PLAY_SERVICES_VERSION = '20.3.0'
+  GOOGLE_IMA_SDK_VERSION = '3.21.1'
+  ANDROIDX_LEGACY_SUPPORT_V4 = '1.0.0'
+  ANDROIDX_MEDIA = '1.1.0'
 }

android/src/main/java/com/matejdr/brightcoveimaplayer/BrightcoveIMAPlayerView.java

@@ -38,6 +38,7 @@
 import com.google.ads.interactivemedia.v3.api.AdsRequest;
 import com.google.ads.interactivemedia.v3.api.ImaSdkFactory;
 import com.google.ads.interactivemedia.v3.api.ImaSdkSettings;
+import com.google.ads.interactivemedia.v3.api.AdsRenderingSettings;
 import com.google.android.exoplayer2.ExoPlayer;
 import com.google.android.exoplayer2.PlaybackParameters;
 import com.google.android.exoplayer2.trackselection.DefaultTrackSelector;
@@ -60,7 +61,7 @@ public class BrightcoveIMAPlayerView extends RelativeLayout implements Lifecycle
   private String policyKey;
   private String accountId;
   private String videoId;
-  private boolean autoPlay = true;
+  private boolean autoPlay = false;
   private boolean playing = false;
   private boolean adsPlaying = false;
   private boolean inViewPort = true;
@@ -107,14 +108,6 @@ private void setup() {
     // Use a procedural abstraction to setup the Google IMA SDK via the plugin.
     setupGoogleIMA();
 
-    eventEmitter.on(EventType.AD_STARTED, new EventListener() {
-      @Override
-      public void processEvent(Event e) {
-        WritableMap event = Arguments.createMap();
-        ReactContext reactContext = (ReactContext) BrightcoveIMAPlayerView.this.getContext();
-        reactContext.getJSModule(RCTEventEmitter.class).receiveEvent(BrightcoveIMAPlayerView.this.getId(), BrightcoveIMAPlayerViewManager.AD_STARTED, event);
-      }
-    });
     eventEmitter.on(EventType.VIDEO_SIZE_KNOWN, new EventListener() {
       @Override
       public void processEvent(Event e) {
@@ -392,9 +385,9 @@ public void onError(@NonNull List<CatalogError> errors) {
   private void playVideo(Video video) {
     BrightcoveIMAPlayerView.this.brightcoveVideoView.clear();
     BrightcoveIMAPlayerView.this.brightcoveVideoView.add(video);
-    if (BrightcoveIMAPlayerView.this.autoPlay) {
-      BrightcoveIMAPlayerView.this.brightcoveVideoView.start();
-    }
+    // if (BrightcoveIMAPlayerView.this.autoPlay) {
+    //   BrightcoveIMAPlayerView.this.brightcoveVideoView.start();
+    // }
   }
 
   private void fixVideoLayout() {
@@ -427,6 +420,12 @@ private void setupAdMarkers(BaseVideoView videoView) {
         int markerTime = cuepoint < 0 ? brightcoveSeekBar.getMax() : (int) (cuepoint * DateUtils.SECOND_IN_MILLIS);
         mediaController.getBrightcoveSeekBar().addMarker(markerTime);
       }
+
+      // fire off ADS_LOADED event
+      WritableMap adEvent = Arguments.createMap();
+      ReactContext reactContext = (ReactContext) BrightcoveIMAPlayerView.this.getContext();
+      reactContext.getJSModule(RCTEventEmitter.class).receiveEvent(BrightcoveIMAPlayerView.this.getId(), BrightcoveIMAPlayerViewManager.EVENT_ADS_LOADED, adEvent);
+
     });
     videoView.setMediaController(mediaController);
   }
@@ -452,6 +451,13 @@ private void setupGoogleIMA() {
     eventEmitter.on(EventType.AD_BREAK_COMPLETED, event -> {
       adsPlaying = false;
     });
+    // checks ad progress and pauses if out of view
+    // fixes the elusive play then scroll away before pre-roll starts bug
+    eventEmitter.on(EventType.AD_PROGRESS, event -> {
+      if (!inViewPort) {
+        this.pause();
+      }
+    });
 
     // Set up a listener for initializing AdsRequests. 
     eventEmitter.on(GoogleIMAEventType.ADS_REQUEST_FOR_VIDEO, event -> {
@@ -477,11 +483,17 @@ private void setupGoogleIMA() {
       imaSdkSettings.setPpid(settings.getString("publisherProvidedID"));
     }
 
+    AdsRenderingSettings adsRenderingSettings =
+    ImaSdkFactory.getInstance().createAdsRenderingSettings();
+    // preload ads
+    adsRenderingSettings.setEnablePreloading(true);
+
     // Create the Brightcove IMA Plugin and pass in the event
     // emitter so that the plugin can integrate with the SDK.
     googleIMAComponent = new GoogleIMAComponent.Builder(this.brightcoveVideoView, eventEmitter)
       .setUseAdRules(true)
       .setLoadVideoTimeout(adVideoLoadTimeout)
+      .setAdsRenderingSettings(adsRenderingSettings)
       .setImaSdkSettings(imaSdkSettings)
       .build();
   }

android/src/main/java/com/matejdr/brightcoveimaplayer/BrightcoveIMAPlayerViewManager.java

@@ -23,7 +23,7 @@ public class BrightcoveIMAPlayerViewManager extends SimpleViewManager<Brightcove
   public static final int COMMAND_STOP_PLAYBACK = 4;
   public static final int COMMAND_TOGGLE_FULLSCREEN = 5;
   public static final int COMMAND_TOGGLE_IN_VIEW_PORT = 6;
-  public static final String AD_STARTED = "ad_started";
+  public static final String EVENT_ADS_LOADED = "ads_loaded";
   public static final String EVENT_READY = "ready";
   public static final String EVENT_PLAY = "play";
   public static final String EVENT_PAUSE = "pause";
@@ -167,7 +167,7 @@ public void receiveCommand(BrightcoveIMAPlayerView view, int commandType, @Nulla
   public @Nullable
   Map<String, Object> getExportedCustomDirectEventTypeConstants() {
     Map<String, Object> map = new HashMap<>();
-    map.put(AD_STARTED, (Object) MapBuilder.of("registrationName", "onAdStarted"));
+    map.put(EVENT_ADS_LOADED, (Object) MapBuilder.of("registrationName", "onAdsLoaded"));
     map.put(EVENT_READY, (Object) MapBuilder.of("registrationName", "onReady"));
     map.put(EVENT_PLAY, (Object) MapBuilder.of("registrationName", "onPlay"));
     map.put(EVENT_PAUSE, (Object) MapBuilder.of("registrationName", "onPause"));

ios/BrightcoveIMAPlayerView.h

@@ -38,7 +38,7 @@
 @property (nonatomic, copy) NSString *videoId;
 @property (nonatomic, copy) NSString *accountId;
 @property (nonatomic, copy) NSString *policyKey;
-@property (nonatomic, copy) RCTDirectEventBlock onAdStarted;
+@property (nonatomic, copy) RCTDirectEventBlock onAdsLoaded;
 @property (nonatomic, copy) RCTDirectEventBlock onReady;
 @property (nonatomic, copy) RCTDirectEventBlock onPlay;
 @property (nonatomic, copy) RCTDirectEventBlock onPause;

ios/BrightcoveIMAPlayerView.m

@@ -60,11 +60,14 @@ - (void)setupWithSettings:(NSDictionary*)settings {
         imaSettings.ppid = kViewControllerIMAPublisherID;
     }
     imaSettings.language = kViewControllerIMALanguage;
+    imaSettings.autoPlayAdBreaks = NO;
 
     IMAAdsRenderingSettings *renderSettings = [[IMAAdsRenderingSettings alloc] init];
     renderSettings.linkOpenerPresentingController = RCTPresentedViewController();
     renderSettings.linkOpenerDelegate = self;
+    renderSettings.enablePreloading = YES; // default is yes anyway
 
+    // Timeout (in seconds) when loading a video ad media file. If loading takes longer than this timeout, the ad playback is canceled and the next ad in the pod plays, if available. Use -1 for the default of 8 seconds.
     if (_targetAdVideoLoadTimeout == 0) {
         renderSettings.loadVideoTimeout = 3.;
     } else {
@@ -96,7 +99,7 @@ - (void)setupWithSettings:(NSDictionary*)settings {
     [[AVAudioSession sharedInstance] setCategory:AVAudioSessionCategoryPlayback error:&error];
 
     BOOL autoAdvance = [settings objectForKey:@"autoAdvance"] != nil ? [[settings objectForKey:@"autoAdvance"] boolValue] : NO;
-    BOOL autoPlay = [settings objectForKey:@"autoPlay"] != nil ? [[settings objectForKey:@"autoPlay"] boolValue] : YES;
+    BOOL autoPlay = NO; //[settings objectForKey:@"autoPlay"] != nil ? [[settings objectForKey:@"autoPlay"] boolValue] : YES;
     BOOL allowsExternalPlayback = [settings objectForKey:@"allowsExternalPlayback"] != nil ? [[settings objectForKey:@"allowsExternalPlayback"] boolValue] : YES;
 
     _playbackController.autoAdvance = autoAdvance;
@@ -238,6 +241,8 @@ -(void) toggleInViewPort:(BOOL)inViewPort {
         _inViewPort = YES;
     } else {
         _inViewPort = NO;
+        [self.playbackController pauseAd];
+        [self.playbackController pause];
     }
 }
 
@@ -254,8 +259,9 @@ -(void) play {
     if (self.playbackController) {
         if (_adsPlaying) {
             [self.playbackController resumeAd];
-            [self.playbackController pause];
+            //[self.playbackController pause];
         } else {
+            // if ad hasnt started, this will kick it off
             [self.playbackController play];
         }
     }
@@ -291,6 +297,8 @@ - (void)handleAppStateDidChange:(NSNotification *)notification
 #pragma mark - BCOVPlaybackControllerBasicDelegate methods
 
 - (void)playbackController:(id<BCOVPlaybackController>)controller playbackSession:(id<BCOVPlaybackSession>)session didReceiveLifecycleEvent:(BCOVPlaybackSessionLifecycleEvent *)lifecycleEvent {
+    
+    // NSLog(@"BC - DEBUG eventType: %@", lifecycleEvent.eventType);
 
     if (lifecycleEvent.eventType == kBCOVPlaybackSessionLifecycleEventPlaybackBufferEmpty ||
         lifecycleEvent.eventType == kBCOVPlaybackSessionLifecycleEventFail ||
@@ -333,20 +341,26 @@ - (void)playbackController:(id<BCOVPlaybackController>)controller playbackSessio
             self.onPause(@{});
         }
     } else if (lifecycleEvent.eventType == kBCOVIMALifecycleEventAdsLoaderLoaded) {
-        if (self.onAdStarted) {
-            self.onAdStarted(@{});
+        if (self.onAdsLoaded) {
+            self.onAdsLoaded(@{});
         }
     } else if (lifecycleEvent.eventType == kBCOVPlaybackSessionLifecycleEventAdProgress) {
         // catches scroll away before ads start bug
         if (!_inViewPort) {
             [self.playbackController pauseAd];
+            [self.playbackController pause];
         }
-    } else if (lifecycleEvent.eventType == kBCOVIMALifecycleEventAdsManagerDidReceiveAdEvent) {
+    }
+    
+    if (lifecycleEvent.eventType == kBCOVIMALifecycleEventAdsManagerDidReceiveAdEvent) {
         IMAAdEvent *adEvent = lifecycleEvent.properties[@"adEvent"];
+        
+        // NSLog(@"BC - DEBUG adEvent: %ld %@", adEvent.type, adEvent.typeString);
 
         switch (adEvent.type)
         {
             case kIMAAdEvent_LOADED:
+                _adsPlaying = YES;
                 break;
             case kIMAAdEvent_PAUSE:
                 break;
@@ -417,35 +431,35 @@ -(void)playerView:(BCOVPUIPlayerView *)playerView didTransitionToScreenMode:(BCO
 #pragma mark - BCOVPlaybackControllerAdsDelegate methods
 
 - (void)playbackController:(id<BCOVPlaybackController>)controller playbackSession:(id<BCOVPlaybackSession>)session didEnterAdSequence:(BCOVAdSequence *)adSequence {
-    if (!_inViewPort && _adsPlaying) {
+    if (!_inViewPort) {
         [self.playbackController pauseAd];
     }
-    [self.playbackController pause];
+//    [self.playbackController pause];
 }
 
 - (void)playbackController:(id<BCOVPlaybackController>)controller playbackSession:(id<BCOVPlaybackSession>)session didExitAdSequence:(BCOVAdSequence *)adSequence {
-    if (_inViewPort) {
-        [self.playbackController play];
-    }
+//    if (_inViewPort) {
+//        [self.playbackController play];
+//    }
 }
 
 - (void)playbackController:(id<BCOVPlaybackController>)controller playbackSession:(id<BCOVPlaybackSession>)session didEnterAd:(BCOVAd *)ad {
-    if (!_inViewPort && _adsPlaying) {
-        [self.playbackController pauseAd];
-    }
-    [self.playbackController pause];
+//    if (!_inViewPort) {
+//        [self.playbackController pauseAd];
+//    }
+//    [self.playbackController pause];
 }
 
 - (void)playbackController:(id<BCOVPlaybackController>)controller playbackSession:(id<BCOVPlaybackSession>)session didExitAd:(BCOVAd *)ad {
-    if (_inViewPort) {
-        [self.playbackController play];
-    }
+//    if (_inViewPort) {
+//        [self.playbackController play];
+//    }
 }
 
 - (void)playbackController:(id<BCOVPlaybackController>)controller playbackSession:(id<BCOVPlaybackSession>)session ad:(BCOVAd *)ad didProgressTo:(NSTimeInterval)progress {
-    if (_playing) {
-        [self.playbackController pause];
-    }
+//    if (_playing) {
+//        [self.playbackController pause];
+//    }
 }
 
 #pragma mark - IMAPlaybackSessionDelegate Methods

ios/BrightcoveIMAPlayerViewManager.m

@@ -27,7 +27,7 @@ - (dispatch_queue_t)methodQueue {
 RCT_EXPORT_VIEW_PROPERTY(bitRate, NSNumber);
 RCT_EXPORT_VIEW_PROPERTY(adVideoLoadTimeout, NSNumber);
 RCT_EXPORT_VIEW_PROPERTY(playbackRate, NSNumber);
-RCT_EXPORT_VIEW_PROPERTY(onAdStarted, RCTDirectEventBlock);
+RCT_EXPORT_VIEW_PROPERTY(onAdsLoaded, RCTDirectEventBlock);
 RCT_EXPORT_VIEW_PROPERTY(onReady, RCTDirectEventBlock);
 RCT_EXPORT_VIEW_PROPERTY(onPlay, RCTDirectEventBlock);
 RCT_EXPORT_VIEW_PROPERTY(onPause, RCTDirectEventBlock);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-brightcove-ima-player",
-  "version": "2.2.8",
+  "version": "2.2.9",
   "description": "React Native implementation of Brightcove Player native SDK",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

src/BrightcoveIMAPlayer.tsx

@@ -54,7 +54,7 @@ type BrightcoveIMAPlayerProps = ViewProps & {
    */
   adVideoLoadTimeout?: number;
   playbackRate?: number;
-  onAdStarted?: (
+  onAdsLoaded?: (
     event: NativeSyntheticEvent<TBrightcoveIMAPlayerEventBase>
   ) => void;
   onReady?: (