[video_player] Separate event stream from player on iOS #9700
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| // Copyright 2013 The Flutter Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style license that can be | ||
| // found in the LICENSE file. | ||
|
|
||
| #import "./include/video_player_avfoundation/FVPEventBridge.h" | ||
|
|
||
| #import <Foundation/Foundation.h> | ||
|
|
||
| #if TARGET_OS_OSX | ||
| #import <FlutterMacOS/FlutterMacOS.h> | ||
| #else | ||
| #import <Flutter/Flutter.h> | ||
| #endif | ||
|
|
||
| @interface FVPEventBridge () <FlutterStreamHandler> | ||
|
|
||
| /// The event channel to dispatch notifications to. | ||
| // TODO(stuartmorgan): Convert this to Pigeon event channels once the plugin is using Swift | ||
| // Pigeon generation. | ||
| @property(nonatomic) FlutterEventChannel *eventChannel; | ||
|
|
||
| /// The event sink associated with eventChannel. | ||
| /// | ||
| /// Will be nil both before the channel listener is ready on the Dart side, and after it has been | ||
| /// closed on the Dart side. | ||
| @property(nonatomic, nullable) FlutterEventSink eventSink; | ||
|
|
||
| /// A queue of events received before eventSink is ready, to dispatch once the channel is fully | ||
| /// set up. | ||
| @property(nonatomic, copy) NSMutableArray<NSObject *> *queuedEvents; | ||
stuartmorgan-g marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| @end | ||
|
|
||
| @implementation FVPEventBridge | ||
|
|
||
| - (instancetype)initWithMessenger:(NSObject<FlutterBinaryMessenger> *)messenger | ||
| channelName:(NSString *)channelName { | ||
| self = [super init]; | ||
| if (self) { | ||
| _queuedEvents = [[NSMutableArray alloc] init]; | ||
| _eventChannel = [FlutterEventChannel eventChannelWithName:channelName | ||
| binaryMessenger:messenger]; | ||
| // This retain loop is broken in videoPlayerWasDisposed. | ||
| [_eventChannel setStreamHandler:self]; | ||
| } | ||
| return self; | ||
| } | ||
|
|
||
| #pragma mark FlutterStreamHandler | ||
|
|
||
| - (FlutterError *_Nullable)onListenWithArguments:(id _Nullable)arguments | ||
| eventSink:(nonnull FlutterEventSink)events { | ||
| self.eventSink = events; | ||
|
|
||
| // Send any events that came in before the sink was ready. | ||
| for (id event in self.queuedEvents) { | ||
| self.eventSink(event); | ||
| } | ||
| [self.queuedEvents removeAllObjects]; | ||
|
|
||
| return nil; | ||
| } | ||
|
|
||
| - (FlutterError *_Nullable)onCancelWithArguments:(id _Nullable)arguments { | ||
|
Contributor
There was a problem hiding this comment. The documentation says:
Are plugins destroyed and recreated during hot restart, or they live through hot restart? If it's the latter then the event queue is always nil after a hot restart?
Collaborator
Author
There was a problem hiding this comment. The native code's plugin instance survives hot restart, but (Even if it didn't, since these channels have ID-based names, and the IDs are assigned by the native code, after a hot restart it should never be possible for the Dart code to try re-listening to any previously-existing video player event channels anyway.) |
||
| self.eventSink = nil; | ||
| // No need to queue events coming in after this point; nil the queue so they will be discarded. | ||
| self.queuedEvents = nil; | ||
| return nil; | ||
| } | ||
|
|
||
| #pragma mark FVPVideoPlayerDelegate | ||
stuartmorgan-g marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - (void)videoPlayerDidInitializeWithDuration:(int64_t)duration size:(CGSize)size { | ||
| [self sendOrQueue:@{ | ||
| @"event" : @"initialized", | ||
| @"duration" : @(duration), | ||
| @"width" : @(size.width), | ||
| @"height" : @(size.height) | ||
| }]; | ||
| } | ||
|
|
||
| - (void)videoPlayerDidErrorWithMessage:(NSString *)errorMessage { | ||
| [self sendOrQueue:[FlutterError errorWithCode:@"VideoError" message:errorMessage details:nil]]; | ||
| } | ||
|
|
||
| - (void)videoPlayerDidComplete { | ||
| [self sendOrQueue:@{@"event" : @"completed"}]; | ||
| } | ||
|
|
||
| - (void)videoPlayerDidStartBuffering { | ||
| [self sendOrQueue:@{@"event" : @"bufferingStart"}]; | ||
| } | ||
|
|
||
| - (void)videoPlayerDidEndBuffering { | ||
| [self sendOrQueue:@{@"event" : @"bufferingEnd"}]; | ||
| } | ||
|
|
||
| - (void)videoPlayerDidUpdateBufferRegions:(NSArray<NSArray<NSValue *> *> *)regions { | ||
| [self sendOrQueue:@{@"event" : @"bufferingUpdate", @"values" : regions}]; | ||
| } | ||
|
|
||
| - (void)videoPlayerDidSetPlaying:(BOOL)playing { | ||
| [self sendOrQueue:@{@"event" : @"isPlayingStateUpdate", @"isPlaying" : @(playing)}]; | ||
| } | ||
|
|
||
| - (void)videoPlayerWasDisposed { | ||
| [self.eventChannel setStreamHandler:nil]; | ||
| } | ||
|
|
||
| #pragma mark Private methods | ||
|
|
||
| /// Sends the given event to the event sink if it is ready to receive events, or enqueues it to send | ||
| /// later if not. | ||
| - (void)sendOrQueue:(id)event { | ||
| if (self.eventSink) { | ||
| self.eventSink(event); | ||
| } else { | ||
| [self.queuedEvents addObject:event]; | ||
| } | ||
| } | ||
|
|
||
| @end | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.