Refactor VideoPlayer to be less exposed to EventChannel & related
#6908
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| // 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. | ||
|
|
||
| package io.flutter.plugins.videoplayer; | ||
|
|
||
| import androidx.annotation.NonNull; | ||
| import androidx.annotation.Nullable; | ||
|
|
||
| /** | ||
| * Callbacks representing events invoked by {@link VideoPlayer}. | ||
| * | ||
| * <p>In the actual plugin, this will always be {@link VideoPlayerEventCallbacks}, which creates the | ||
| * expected events to send back through the plugin channel. In tests methods can be overridden in | ||
| * order to assert results. | ||
| * | ||
| * <p>See {@link androidx.media3.common.Player.Listener} for details. | ||
| */ | ||
| interface VideoPlayerCallbacks { | ||
| void onInitialized(int width, int height, long durationInMs, int rotationCorrectionInDegrees); | ||
|
|
||
| void onBufferingStart(); | ||
|
|
||
| void onBufferingUpdate(long bufferedPosition); | ||
|
|
||
| void onBufferingEnd(); | ||
|
|
||
| void onCompleted(); | ||
|
|
||
| void onError(@NonNull String code, @Nullable String message, @Nullable Object details); | ||
|
|
||
| void onIsPlayingStateUpdate(boolean isPlaying); | ||
| } | ||
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,98 @@ | ||
| // 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. | ||
|
|
||
| package io.flutter.plugins.videoplayer; | ||
|
|
||
| import androidx.annotation.NonNull; | ||
| import androidx.annotation.Nullable; | ||
| import androidx.annotation.VisibleForTesting; | ||
| import io.flutter.plugin.common.EventChannel; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| final class VideoPlayerEventCallbacks implements VideoPlayerCallbacks { | ||
| private final EventChannel.EventSink eventSink; | ||
|
|
||
| static VideoPlayerEventCallbacks bindTo(EventChannel eventChannel) { | ||
| QueuingEventSink eventSink = new QueuingEventSink(); | ||
| eventChannel.setStreamHandler( | ||
| new EventChannel.StreamHandler() { | ||
| @Override | ||
| public void onListen(Object arguments, EventChannel.EventSink events) { | ||
| eventSink.setDelegate(events); | ||
| } | ||
|
|
||
| @Override | ||
| public void onCancel(Object arguments) { | ||
| eventSink.setDelegate(null); | ||
| } | ||
| }); | ||
| return VideoPlayerEventCallbacks.withSink(eventSink); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| static VideoPlayerEventCallbacks withSink(EventChannel.EventSink eventSink) { | ||
|
|
||
| return new VideoPlayerEventCallbacks(eventSink); | ||
| } | ||
|
|
||
| private VideoPlayerEventCallbacks(EventChannel.EventSink eventSink) { | ||
| this.eventSink = eventSink; | ||
| } | ||
|
|
||
| @Override | ||
| public void onInitialized( | ||
| int width, int height, long durationInMs, int rotationCorrectionInDegrees) { | ||
| Map<String, Object> event = new HashMap<>(); | ||
| event.put("event", "initialized"); | ||
| event.put("width", width); | ||
| event.put("height", height); | ||
| event.put("duration", durationInMs); | ||
| if (rotationCorrectionInDegrees != 0) { | ||
| event.put("rotationCorrection", rotationCorrectionInDegrees); | ||
| } | ||
| eventSink.success(event); | ||
| } | ||
|
|
||
| @Override | ||
| public void onBufferingStart() { | ||
| Map<String, Object> event = new HashMap<>(); | ||
| event.put("event", "bufferingStart"); | ||
| eventSink.success(event); | ||
| } | ||
|
|
||
| @Override | ||
| public void onBufferingUpdate(long bufferedPosition) { | ||
| // iOS supports a list of buffered ranges, so we send as a list with a single range. | ||
| Map<String, Object> event = new HashMap<>(); | ||
| event.put("values", Collections.singletonList(bufferedPosition)); | ||
| eventSink.success(event); | ||
| } | ||
|
|
||
| @Override | ||
| public void onBufferingEnd() { | ||
| Map<String, Object> event = new HashMap<>(); | ||
|
There was a problem hiding this comment. nit: All of these events are allocating new HashMap with the same value. They could be private constants to avoid generating garbage. None of them seem that chatty though. There was a problem hiding this comment. I'm going to leave it as-is for now, hopefully we can use |
||
| event.put("event", "bufferingEnd"); | ||
| eventSink.success(event); | ||
| } | ||
|
|
||
| @Override | ||
| public void onCompleted() { | ||
| Map<String, Object> event = new HashMap<>(); | ||
| event.put("event", "completed"); | ||
| eventSink.success(event); | ||
| } | ||
|
|
||
| @Override | ||
| public void onError(@NonNull String code, @Nullable String message, @Nullable Object details) { | ||
| eventSink.error(code, message, details); | ||
| } | ||
|
|
||
| @Override | ||
| public void onIsPlayingStateUpdate(boolean isPlaying) { | ||
| Map<String, Object> event = new HashMap<>(); | ||
| event.put("isPlaying", isPlaying); | ||
| eventSink.success(event); | ||
| } | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe link the
Player.Listenerdocs to the callbacks that directly map to one of those events?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!