update: allow starting new views with videoChange without changing AVPlayerItem

MUXSDKStats/MUXSDKStats/MUXSDKPlayerBinding.h

@@ -107,10 +107,12 @@ typedef NS_ENUM(NSUInteger, MUXSDKViewOrientation) {
 - (void)dispatchPause;
 - (void)dispatchTimeUpdateEvent:(CMTime)time;
 - (void)dispatchError;
+- (void)dispatchVideoChange;
 - (void)dispatchViewEnd;
 - (void)dispatchOrientationChange:(MUXSDKViewOrientation) orientation;
 - (void)dispatchAdEvent:(MUXSDKPlaybackEvent *)event;
 - (float)getCurrentPlayheadTimeMs;
+- (NSString *)playerName;
 - (void)dispatchRenditionChange;
 - (void)setAdPlaying:(BOOL)isAdPlaying;
 - (BOOL)setAutomaticErrorTracking:(BOOL)automaticErrorTracking;

MUXSDKStats/MUXSDKStats/MUXSDKPlayerBinding.m

@@ -403,38 +403,50 @@ - (void)detachAVPlayer {
     }
 }
 
+- (void)dispatchVideoChange {
+    // end the current view if it's not already been ended
+    if (_state != MUXSDKPlayerStateViewEnd) {
+        [self dispatchViewEnd];
+    }
+
+    [self.playDispatchDelegate videoChangedForPlayer:_name];
+    // TODO: test that we have all the metadata we need on the subsequent view. On android we needed to catch up with the current state
+
+    //
+    // Special case for AVQueuePlayer
+    // In a normal videoChange: world - the KVO for "rate" will fire - and
+    // subsequently after that this binding will dispatchPlay. In fact, any time
+    // an AVPlayer gets an item loaded into it the KVO for "rate" changes.
+    //
+    // However, in AVQueuePlayer world - the "rate" doesn't fire when the video is
+    // changed. I don't know why, but I guess that is the intended behavior. For that
+    // reason, if we're handling a videoChange event and we're dealing with AVQueuePlayer
+    // then we have to fire the play event here.
+    //
+    if (_shouldHandleAVQueuePlayerItem) {
+        _shouldHandleAVQueuePlayerItem = false;
+        [self dispatchPlay];
+    }
+}
+
 - (void)monitorAVPlayerItem {
-    if ((!_automaticVideoChange && !_didTriggerManualVideoChange) || _isAdPlaying) {
+    NSLog(@"MUXSDK-INFO - monitorAVPlayeritem: Called");
+    // The player item could be the the ad itself, and we monitor ads differentlty than main content
+    if (_isAdPlaying) {
         return;
     }
+
     if (_playerItem) {
-        if (_didTriggerManualVideoChange) {
-            _didTriggerManualVideoChange = false;
-        }
-        [self dispatchViewEnd];
         [self stopMonitoringAVPlayerItem];
-
-        if (_player.currentItem) {
-            [self.playDispatchDelegate videoChangedForPlayer:_name];
-        }
-
-        //
-        // Special case for AVQueuePlayer
-        // In a normal videoChange: world - the KVO for "rate" will fire - and
-        // subsequently after that this binding will dispatchPlay. In fact, any time
-        // an AVPlayer gets an item loaded into it the KVO for "rate" changes.
-        //
-        // However, in AVQueuePlayer world - the "rate" doesn't fire when the video is
-        // changed. I don't know why, but I guess that is the intended behavior. For that
-        // reason, if we're handling a videoChange event and we're dealing with AVQueuePlayer
-        // then we have to fire the play event here.
-        //
-        if (_shouldHandleAVQueuePlayerItem) {
-            _shouldHandleAVQueuePlayerItem = false;
-            [self dispatchPlay];
-        }
     }
     if (_player && _player.currentItem) {
+        // change the video automatically if enabled, unless the customer changed video manually already, and only if there's an item
+        NSLog(@"MUXSDK-INFO - monitorAVPlayeritem: checking to change video: %b, %lu, %b", _automaticVideoChange, (unsigned long)_state, _didTriggerManualVideoChange);
+        if (_automaticVideoChange && _state != MUXSDKPlayerStateReady && !_didTriggerManualVideoChange) {
+            NSLog(@"MUXSDK-INFO - automatically changing video");
+            [self dispatchVideoChange];
+        }
+
         _playerItem = _player.currentItem;
         [_playerItem addObserver:self
                       forKeyPath:@"status"
@@ -447,6 +459,9 @@ - (void)monitorAVPlayerItem {
 
         [self dispatchSessionData];
     }
+
+    // reset for the next media item
+    _didTriggerManualVideoChange = false;
 }
 
 - (void)dispatchSessionData {
@@ -488,13 +503,15 @@ - (void)stopMonitoringAVPlayerItem {
     [self safelyRemovePlayerItemObserverForKeyPath:@"status"];
     [self safelyRemovePlayerItemObserverForKeyPath:@"playbackBufferEmpty"];
     _playerItem = nil;
-    if (!_isAdPlaying) {
-        [MUXSDKCore destroyPlayer: _name];
-    }
+}
+
+/// Cleans up our Core monitor. Call when we are detaching from an AVPlayer
+- (void)destroyPlayer {
+    [MUXSDKCore destroyPlayer: _name];
 }
 
 - (void) programChangedForPlayer {
-    [self monitorAVPlayerItem];
+    [self dispatchVideoChange];
     [self dispatchPlay];
     [self dispatchPlaying];
 }
@@ -510,6 +527,10 @@ - (CMTime)getTimeObserverInternal {
     return CMTimeMakeWithSeconds(0.1, NSEC_PER_SEC);
 }
 
+- (NSString *)playerName {
+    return _name;
+}
+
 - (float)getCurrentPlayheadTimeMs {
     return CMTimeGetSeconds([_player currentTime]) * 1000;
 }
@@ -775,6 +796,7 @@ - (void)dispatchViewInit {
         return;
     }
     [self resetVideoData];
+
     MUXSDKPlayerData *playerData = [self getPlayerData];
     MUXSDKViewInitEvent *event = [[MUXSDKViewInitEvent alloc] init];
     [event setPlayerData:playerData];
@@ -1232,6 +1254,7 @@ - (BOOL) doubleValueIsEqual:(NSNumber *) x toOther:(NSNumber *) n {
 }
 
 - (void)didTriggerManualVideoChange {
+    NSLog(@"MUXSDK-INFO - didTriggerManualVideoChange");
     _didTriggerManualVideoChange = true;
 }
 @end

MUXSDKStats/MUXSDKStats/MUXSDKStats.m

@@ -603,13 +603,10 @@ + (void)videoChangeForPlayer:(nonnull NSString *)name withCustomerData:(nullable
     MUXSDKCustomerVideoData *videoData = [customerData customerVideoData];
     MUXSDKCustomData *customData = [customerData customData];
 
-    if (!(videoData || viewData || customData)) {
-        return;
-    }
     MUXSDKPlayerBinding *player = [_viewControllers valueForKey:name];
     if (player) {
-        [player didTriggerManualVideoChange];
         [player dispatchViewEnd];
+
         if (videoData) {
             [_customerVideoDataStore setVideoData:videoData forPlayerName:name];
         }
@@ -622,6 +619,9 @@ + (void)videoChangeForPlayer:(nonnull NSString *)name withCustomerData:(nullable
         if (customData) {
             [_customerCustomDataStore setCustomData:customData forPlayerName:name];
         }
+
+        [player dispatchVideoChange];
+        [player didTriggerManualVideoChange];
         [player prepareForAvQueuePlayerNextItem];
     }
 }
@@ -630,8 +630,28 @@ + (void)videoChangeForPlayer:(nonnull NSString *)name withCustomerData:(nullable
 
 + (void)programChangeForPlayer:(nonnull NSString *)name
               withCustomerData:(nullable MUXSDKCustomerData *)customerData {
-    [MUXSDKStats videoChangeForPlayer:name withCustomerData:customerData];
     MUXSDKPlayerBinding *player = [_viewControllers valueForKey:name];
+    [player dispatchViewEnd];
+
+    if (customerData) {
+        MUXSDKCustomerPlayerData *playerData = customerData.customerPlayerData;
+        MUXSDKCustomerVideoData *videoData = customerData.customerVideoData;
+        MUXSDKCustomerViewData *viewData = customerData.customerViewData;
+        MUXSDKCustomData *customData = customerData.customData;
+        if (videoData) {
+            [_customerVideoDataStore setVideoData:videoData forPlayerName:name];
+        }
+        if (viewData) {
+            [_customerViewDataStore setViewData:viewData forPlayerName:name];
+        }
+        if (playerData) {
+            [_customerPlayerDataStore setPlayerData:playerData forPlayerName:name];
+        }
+        if (customData) {
+            [_customerCustomDataStore setCustomData:customData forPlayerName:name];
+        }
+    }
+
     if (player) {
         [player programChangedForPlayer];
     }

MUXSDKStats/MUXSDKStatsTests/MUXSDKPlayerBindingTests.m

@@ -106,7 +106,9 @@ - (void)testPlayerBindingManagerStartsNewViews {
     [self setupViewControllerPlayerBinding:name
                               softwareName:@"TestSoftware"
                            softwareVersion:@"0.1.0"];
-
+
+    NSDictionary *events = [MUXSDKCore capturedEventsForPlayer:name];
+
     XCTAssertEqual(3, [MUXSDKCore eventsCountForPlayer:name]);
     id<MUXSDKEventTyping> event0 = [MUXSDKCore eventAtIndex:0 forPlayer:name];
     id<MUXSDKEventTyping> event1 = [MUXSDKCore eventAtIndex:1 forPlayer:name];

MUXSDKStats/MUXSDKStatsTests/MUXSDKStatsTests.m

@@ -183,8 +183,11 @@ - (void)testVideoChangeForAVPlayerViewControllerWithCustomData{
     NSArray *expectedEventTypes = @[MUXSDKPlaybackEventViewInitEventType,
                                     MUXSDKDataEventType,
                                     MUXSDKPlaybackEventPlayerReadyEventType,
-                                    MUXSDKPlaybackEventViewEndEventType
+                                    MUXSDKPlaybackEventViewEndEventType,
+                                    MUXSDKPlaybackEventViewInitEventType,
+                                    MUXSDKDataEventType,
     ];
+
     [self assertPlayer:playName dispatchedEventTypes:expectedEventTypes];
     [self assertPlayer:playName dispatchedDataEventsAtIndex:1 withCustomData:@{@"c1": @"bar"}];
     [MUXSDKStats destroyPlayer:playName];
@@ -206,10 +209,13 @@ - (void)testVideoChangeForAVPlayerViewControllerWithCustomerViewData{
     XCTAssertNotNil(playerBinding, "expected monitorAVPlayerViewController to return a playerBinding");
     [customerViewData setViewSessionId:@"bar"];
     [MUXSDKStats videoChangeForPlayer:playName withCustomerData:customerData];
-    NSArray *expectedEventTypes = @[MUXSDKPlaybackEventViewInitEventType,
-                                    MUXSDKDataEventType,
-                                    MUXSDKPlaybackEventPlayerReadyEventType,
-                                    MUXSDKPlaybackEventViewEndEventType
+    NSArray *expectedEventTypes = @[MUXSDKPlaybackEventViewInitEventType, // from first view
+                                    MUXSDKDataEventType, // from first view
+                                    MUXSDKPlaybackEventPlayerReadyEventType, // from first view
+                                    MUXSDKPlaybackEventViewEndEventType, // changing video for second view
+                                    MUXSDKPlaybackEventViewInitEventType, // from the second view starting
+                                    MUXSDKDataEventType, // from the second view starting
+                                    MUXSDKPlaybackEventViewEndEventType, // from destroyPlayer
     ];
     [MUXSDKStats destroyPlayer:playName];
     [self assertPlayer:playName dispatchedEventTypes:expectedEventTypes];
@@ -233,7 +239,10 @@ - (void)testVideoChangeForAVPlayerViewController{
     NSArray *expectedEventTypes = @[MUXSDKPlaybackEventViewInitEventType,
                                     MUXSDKDataEventType,
                                     MUXSDKPlaybackEventPlayerReadyEventType,
-                                    MUXSDKPlaybackEventViewEndEventType
+                                    MUXSDKPlaybackEventViewEndEventType,
+                                    MUXSDKPlaybackEventViewInitEventType,
+                                    MUXSDKDataEventType,
+                                    MUXSDKPlaybackEventViewEndEventType,
     ];
     [MUXSDKStats destroyPlayer:playName];
     [self assertPlayer:playName dispatchedEventTypes:expectedEventTypes];
@@ -258,7 +267,7 @@ - (void)testManualVideoChangeForAVPlayerViewController{
 
     NSArray *expectedEventTypes = @[MUXSDKPlaybackEventViewInitEventType,
                                     MUXSDKDataEventType,
-                                    MUXSDKPlaybackEventPlayerReadyEventType
+                                    MUXSDKPlaybackEventPlayerReadyEventType,
     ];
     [self assertPlayer:playName dispatchedEventTypes:expectedEventTypes];
     [self assertPlayer:playName dispatchedDataEventsAtIndex:1 withCustomerVideoData:@{@"vtt": @"01234"}];
@@ -329,7 +338,11 @@ - (void)testVideoChangeForAVPlayerLayerWithCustomerViewData API_UNAVAILABLE(visi
     NSArray *expectedEventTypes = @[MUXSDKPlaybackEventViewInitEventType,
                                     MUXSDKDataEventType,
                                     MUXSDKPlaybackEventPlayerReadyEventType,
-                                    MUXSDKPlaybackEventViewEndEventType
+                                    MUXSDKPlaybackEventViewEndEventType, // from changing to the new view
+                                    MUXSDKPlaybackEventViewInitEventType, // from changing to the new view
+                                    MUXSDKDataEventType, // from changing to the new view
+                                    MUXSDKPlaybackEventViewEndEventType, // from destroying the player
+
     ];
     [MUXSDKStats destroyPlayer:playName];
     [self assertPlayer:playName dispatchedEventTypes:expectedEventTypes];
@@ -353,7 +366,10 @@ - (void)testVideoChangeForAVPlayerLayer API_UNAVAILABLE(visionos) {
     NSArray *expectedEventTypes = @[MUXSDKPlaybackEventViewInitEventType,
                                     MUXSDKDataEventType,
                                     MUXSDKPlaybackEventPlayerReadyEventType,
-                                    MUXSDKPlaybackEventViewEndEventType
+                                    MUXSDKPlaybackEventViewEndEventType,
+                                    MUXSDKPlaybackEventViewInitEventType,
+                                    MUXSDKDataEventType,
+                                    MUXSDKPlaybackEventViewEndEventType,
     ];
     [MUXSDKStats destroyPlayer:playName];
     [self assertPlayer:playName dispatchedEventTypes:expectedEventTypes];
@@ -449,6 +465,8 @@ - (void)testProgramChangeForAVPlayerViewController{
                                     MUXSDKDataEventType,
                                     MUXSDKPlaybackEventPlayerReadyEventType,
                                     MUXSDKPlaybackEventViewEndEventType,
+                                    MUXSDKPlaybackEventViewInitEventType,
+                                    MUXSDKDataEventType,
                                     MUXSDKPlaybackEventPlayEventType,
                                     MUXSDKPlaybackEventPlayingEventType,
                                     MUXSDKPlaybackEventViewEndEventType,

MUXSDKStats/MUXSDKStatsTests/Utils/MUXSDKCore+Mock.h

@@ -26,6 +26,7 @@
 + (NSUInteger) eventsCountForPlayer:(NSString *)playerId;
 + (MUXSDKDataEvent *) globalEventAtIndex:(NSUInteger)index;
 + (NSUInteger) globalEventsCount;
++ (NSArray *) capturedEventsForPlayer: (NSString *)player;
 
 @end
 

MUXSDKStats/MUXSDKStatsTests/Utils/MUXSDKCore+Mock.m

@@ -86,4 +86,8 @@ + (NSUInteger) globalEventsCount {
     return globalEvents.count;
 }
 
++ (NSArray *) capturedEventsForPlayer: (NSString *)player {
+    return [[events objectForKey:player] copy];
+}
+
 @end