Player constructor

Player({ PlayerConfiguration configuration = const PlayerConfiguration(), })

Player

Player class provides high-level abstraction for media playback. Large number of features have been exposed as class methods & properties.

The instantaneous state may be accessed using the state getter & subscription to the them may be made using the stream available.

Call dispose to free the allocated resources back to the system.

import 'package:media_kit/media_kit.dart';

MediaKit.ensureInitialized();

// Create a [Player] instance for audio or video playback.

final player = Player();

// Subscribe to event stream & listen to updates.

player.stream.playlist.listen((e) => print(e));
player.stream.playing.listen((e) => print(e));
player.stream.completed.listen((e) => print(e));
player.stream.position.listen((e) => print(e));
player.stream.duration.listen((e) => print(e));
player.stream.volume.listen((e) => print(e));
player.stream.rate.listen((e) => print(e));
player.stream.pitch.listen((e) => print(e));
player.stream.buffering.listen((e) => print(e));

// Open a playable [Media] or [Playlist].

await player.open(Media('asset:///assets/videos/sample.mp4'));
await player.open(Media('file:///C:/Users/Hitesh/Music/Sample.mp3'));
await player.open(
  Playlist(
    [
      Media('file:///C:/Users/Hitesh/Music/Sample.mp3'),
      Media('file:///C:/Users/Hitesh/Video/Sample.mkv'),
      Media('https://www.example.com/sample.mp4'),
      Media('rtsp://www.example.com/live'),
    ],
  ),
);

// Control playback state.

await player.play();
await player.pause();
await player.playOrPause();
await player.seek(const Duration(seconds: 10));

// Use or modify the queue.

await player.next();
await player.previous();
await player.jump(2);
await player.add(Media('https://www.example.com/sample.mp4'));
await player.move(0, 2);

// Customize speed, pitch, volume, shuffle, playlist mode, audio device.

await player.setRate(1.0);
await player.setPitch(1.2);
await player.setVolume(50.0);
await player.setShuffle(false);
await player.setPlaylistMode(PlaylistMode.loop);
await player.setAudioDevice(AudioDevice.auto());

// Release allocated resources back to the system.

await player.dispose();

Implementation

Player({
  PlayerConfiguration configuration = const PlayerConfiguration(),
}) {
  if (UniversalPlatform.isWindows) {
    platform = NativePlayer(configuration: configuration);
  } else if (UniversalPlatform.isLinux) {
    platform = NativePlayer(configuration: configuration);
  } else if (UniversalPlatform.isMacOS) {
    platform = NativePlayer(configuration: configuration);
  } else if (UniversalPlatform.isIOS) {
    platform = NativePlayer(configuration: configuration);
  } else if (UniversalPlatform.isAndroid) {
    platform = NativePlayer(configuration: configuration);
  } else if (UniversalPlatform.isWeb) {
    platform = WebPlayer(configuration: configuration);
  }
}