[video_player_avplay] Add getActiveTrackInfo interface (#836)

Author: xiaowei-guan

packages/video_player_avplay/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5.18
+
+* Add getActiveTrackInfo interface.
+
 ## 0.5.17
 
 * Update readme.

packages/video_player_avplay/README.md

@@ -12,7 +12,7 @@ To use this package, add `video_player_avplay` as a dependency in your `pubspec.
 
 ```yaml
 dependencies:
-  video_player_avplay: ^0.5.17
+  video_player_avplay: ^0.5.18
 ```
 
 Then you can import `video_player_avplay` in your Dart code:

packages/video_player_avplay/lib/src/messages.g.dart

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import 'package:flutter/foundation.dart';
+
 /// Type of the track.
 enum TrackType {
   /// The video track.
@@ -31,13 +33,20 @@ class Track {
   ///
   /// The [trackId] and [trackType] arguments are required.
   ///
-  const Track({required this.trackId, required this.trackType});
+  const Track({
+    required this.trackId,
+    required this.trackType,
+    required this.mimetype,
+  });
 
   /// The track id of track that uses to determine track.
   final int trackId;
 
   /// The type of the track.
   final TrackType trackType;
+
+  /// The strack mime type.
+  final String mimetype;
 }
 
 /// A representation of a video track.
@@ -50,6 +59,7 @@ class VideoTrack extends Track {
   VideoTrack({
     required super.trackId,
     super.trackType = TrackType.video,
+    required super.mimetype,
     required this.width,
     required this.height,
     required this.bitrate,
@@ -63,6 +73,17 @@ class VideoTrack extends Track {
 
   /// The bitrate of video track.
   final int bitrate;
+
+  @override
+  String toString() {
+    return '${objectRuntimeType(this, 'VideoTrack')}('
+        'trackId: $trackId, '
+        'trackType: $trackType, '
+        'mimetype: $mimetype, '
+        'width: $width, '
+        'height: $height, '
+        'bitrate: $bitrate),';
+  }
 }
 
 /// A representation of a audio track.
@@ -75,6 +96,7 @@ class AudioTrack extends Track {
   AudioTrack({
     required super.trackId,
     super.trackType = TrackType.audio,
+    required super.mimetype,
     required this.language,
     required this.channel,
     required this.bitrate,
@@ -88,6 +110,17 @@ class AudioTrack extends Track {
 
   /// The bitrate of audio track.
   final int bitrate;
+
+  @override
+  String toString() {
+    return '${objectRuntimeType(this, 'AudioTrack')}('
+        'trackId: $trackId, '
+        'trackType: $trackType, '
+        'mimetype: $mimetype, '
+        'language: $language, '
+        'channel: $channel, '
+        'bitrate: $bitrate),';
+  }
 }
 
 /// A representation of a text track.
@@ -100,9 +133,19 @@ class TextTrack extends Track {
   TextTrack({
     required super.trackId,
     super.trackType = TrackType.text,
+    required super.mimetype,
     required this.language,
   });
 
   /// The language of text track.
   final String language;
+
+  @override
+  String toString() {
+    return '${objectRuntimeType(this, 'TextTrack')}('
+        'trackId: $trackId, '
+        'trackType: $trackType, '
+        'mimetype: $mimetype, '
+        'language: $language),';
+  }
 }

packages/video_player_avplay/lib/src/tracks.dart

@@ -114,13 +114,15 @@ class VideoPlayerTizen extends VideoPlayerPlatform {
     final List<VideoTrack> videoTracks = <VideoTrack>[];
     for (final Map<Object?, Object?>? trackMap in response.tracks) {
       final int trackId = trackMap!['trackId']! as int;
+      final String mimetype = trackMap['mimetype']! as String;
       final int bitrate = trackMap['bitrate']! as int;
       final int width = trackMap['width']! as int;
       final int height = trackMap['height']! as int;
 
       videoTracks.add(
         VideoTrack(
           trackId: trackId,
+          mimetype: mimetype,
           width: width,
           height: height,
           bitrate: bitrate,
@@ -140,13 +142,15 @@ class VideoPlayerTizen extends VideoPlayerPlatform {
     final List<AudioTrack> audioTracks = <AudioTrack>[];
     for (final Map<Object?, Object?>? trackMap in response.tracks) {
       final int trackId = trackMap!['trackId']! as int;
+      final String mimetype = trackMap['mimetype']! as String;
       final String language = trackMap['language']! as String;
       final int channel = trackMap['channel']! as int;
       final int bitrate = trackMap['bitrate']! as int;
 
       audioTracks.add(
         AudioTrack(
           trackId: trackId,
+          mimetype: mimetype,
           language: language,
           channel: channel,
           bitrate: bitrate,
@@ -166,9 +170,12 @@ class VideoPlayerTizen extends VideoPlayerPlatform {
     final List<TextTrack> textTracks = <TextTrack>[];
     for (final Map<Object?, Object?>? trackMap in response.tracks) {
       final int trackId = trackMap!['trackId']! as int;
+      final String mimetype = trackMap['mimetype']! as String;
       final String language = trackMap['language']! as String;
 
-      textTracks.add(TextTrack(trackId: trackId, language: language));
+      textTracks.add(
+        TextTrack(trackId: trackId, mimetype: mimetype, language: language),
+      );
     }
 
     return textTracks;
@@ -282,6 +289,52 @@ class VideoPlayerTizen extends VideoPlayerPlatform {
     };
   }
 
+  @override
+  Future<List<Track>> getActiveTrackInfo(int playerId) async {
+    final TrackMessage msg = await _api.getActiveTrackInfo(
+      PlayerMessage(playerId: playerId),
+    );
+    final List<Track> tracks = <Track>[];
+    for (final Map<Object?, Object?>? trackMap in msg.tracks) {
+      final String trackType = trackMap!['trackType']! as String;
+      final int trackId = trackMap['trackId']! as int;
+      final String mimetype = trackMap['mimetype']! as String;
+      if (trackType == 'video') {
+        final int bitrate = trackMap['bitrate']! as int;
+        final int width = trackMap['width']! as int;
+        final int height = trackMap['height']! as int;
+        tracks.add(
+          VideoTrack(
+            trackId: trackId,
+            mimetype: mimetype,
+            width: width,
+            height: height,
+            bitrate: bitrate,
+          ),
+        );
+      } else if (trackType == 'audio') {
+        final String language = trackMap['language']! as String;
+        final int channel = trackMap['channel']! as int;
+        final int bitrate = trackMap['bitrate']! as int;
+        tracks.add(
+          AudioTrack(
+            trackId: trackId,
+            mimetype: mimetype,
+            language: language,
+            channel: channel,
+            bitrate: bitrate,
+          ),
+        );
+      } else if (trackType == 'text') {
+        final String language = trackMap['language']! as String;
+        tracks.add(
+          TextTrack(trackId: trackId, mimetype: mimetype, language: language),
+        );
+      }
+    }
+    return tracks;
+  }
+
   @override
   Future<void> setStreamingProperty(
     int playerId,

packages/video_player_avplay/lib/src/video_player_tizen.dart

@@ -885,6 +885,15 @@ class VideoPlayerController extends ValueNotifier<VideoPlayerValue> {
     return _videoPlayerPlatform.getData(playerId, keys);
   }
 
+  /// Get activated(selected) track infomation of the associated media.
+  Future<List<Track>> getActiveTrackInfo() async {
+    if (_isDisposedOrNotInitialized) {
+      return <Track>[];
+    }
+
+    return _videoPlayerPlatform.getActiveTrackInfo(playerId);
+  }
+
   /// Sets the playback speed of [this].
   ///
   /// [speed] indicates a speed value with different platforms accepting

packages/video_player_avplay/lib/video_player.dart

@@ -170,6 +170,11 @@ abstract class VideoPlayerPlatform extends PlatformInterface {
     throw UnimplementedError('getData() has not been implemented.');
   }
 
+  /// Get activated(selected) track infomation of the associated media.
+  Future<List<Track>> getActiveTrackInfo(int playerId) {
+    throw UnimplementedError('getActiveTrackInfo() has not been implemented.');
+  }
+
   /// Set streamingengine property.
   Future<void> setStreamingProperty(
     int playerId,

packages/video_player_avplay/lib/video_player_platform_interface.dart

@@ -170,4 +170,5 @@ abstract class VideoPlayerAvplayApi {
   bool setDisplayMode(DisplayModeMessage msg);
   bool setData(DashPropertyMapMessage msg);
   DashPropertyMapMessage getData(DashPropertyTypeListMessage msg);
+  TrackMessage getActiveTrackInfo(PlayerMessage msg);
 }

packages/video_player_avplay/pigeons/messages.dart

@@ -2,7 +2,7 @@ name: video_player_avplay
 description: Flutter plugin for displaying inline video on Tizen TV devices.
 homepage: https://github.com/flutter-tizen/plugins
 repository: https://github.com/flutter-tizen/plugins/tree/master/packages/video_player_avplay
-version: 0.5.17
+version: 0.5.18
 
 environment:
   sdk: ">=3.1.0 <4.0.0"
@@ -26,4 +26,4 @@ dependencies:
 dev_dependencies:
   flutter_test:
     sdk: flutter
-  pigeon: ^22.7.2
+  pigeon: ^10.0.0