kplayer

Description:

kplayer

kplayer #
Flutter player (currently only audio)

online preview: Go live





sopport #
no action required, just add package and use it
packages has wrapper #
by default kplayer use audioplayers package

recommended: audioplayers (kplayer_with_audioplayers)
not updated: just_audio (kplayer_with_just_audio)
deprecated: dart_vlc (kplayer_with_dart_vlc)

Getting Started #
main.dart
void main() {
Player.boot(); //add this line (optional)
runApp(MyApp());
}
copied to clipboard
Play from assets:
var player = Player.asset("/assets/sound.mp3");
copied to clipboard
Play from network:
var player = Player.network("https://example.com/sound.mp3");
copied to clipboard
Play from file:
var player = Player.file("C/.../sound.mp3");
copied to clipboard
Play from bytes: // beta
var player = Player.bytes(fileAsBytes);
copied to clipboard
or:
var player = Player.create(asset: PlayerMedia.asset("/assets/sound.mp3"), autoPlay: true, once: true)
..init()
copied to clipboard
you have also:
var player = Player.asset("/assets/sound.mp3");


// info
var package = player.package; // "current_apaptive_package_name"
var position = player.position; // setter an getter like seek()
var duration = player.duration; // getter (Duration are unmodifiable)
var status = player.status; // current status (playing, paused, ...)
var loop = player.loop; // bool
var playing = player.playing;
var volume = player.volume; // get current volume
var speed = player.speed; // get current speed (playback rate)
...
// streams
player.streams.playing.stream;
player.streams.position.stream;
player.streams.status.stream;
player.streams.volume.stream;
player.streams.speed.stream;
player.streams.loop.stream;

// control (all async)
player.play();
player.pause();
player.toggle();
player.stop();
player.setPosition(Duration(seconds: 10));
player.setVolume(0.8);
player.setSpeed(1.5);
player.setLoop(true);

//other
player.dispose();
player.player; // the native player

// all players
PlayerController.players; // List<PlayerController>
// dispose all players
PlayerController.disposeAll();

// all other players
player.others; // List<PlayerController>

// example pause all other players
player.others.forEach((player) => player.pause());

// Widgets
PlayerBar(player: player, options: []);
PlayerBuilder(
player: player,
rebuild: (event, oldEvent) => event != oldEvent, // by default it will rebuild when event changed
builder: (context, event){
return // TODO
});
copied to clipboard
mixins #
you can use PlayerStateMixin on State to get full access player state and handle streams dispose automatically
class MyPage extends StatefulWidget {
final PlayerController player;
const MyPage({super.key, required this.player});
@override
_MyPageState createState() => _MyPageState();
}
class _MyPageState extends State<MyPage> with PlayerStateMixin {
@override
void initState() {
usePlayer(widget.player);
super.initState();
}
@override
Widget build(BuildContext context) {
return // TODO
}

@override
void onPlayingChanged(bool playing) {
print('onPlayingChanged $playing');
}
@override
void onPositionChanged(Duration position) {
print('onPositionChanged $position');
}
@override
void onDurationChanged(Duration duration) {
print('onDurationChanged $duration');
}
@override
void onStatusChanged(PlayerStatus status) {
print('onStatusChanged $status');
}
@override
void onEvent(PlayerStatus status) {
print('onStatusChanged $status');
}
}
copied to clipboard
QA #
how to add options on setting menu? #
Just add widgets to player bar options, example:
PlayerBar(player: player, options: [
SwitchListTile(
secondary: const Icon(Icons.brightness_2),
title: const Text("Dark mode"),
);
])
copied to clipboard
how to controll auto playing? #
use autoPlay param:
var player = Player.asset("/assets/sound.mp3",autoPlay: false);
copied to clipboard
use only one player #
currently you need to dispose the previous player
for example:
var player = Player.asset("/assets/sound.mp3",autoPlay: false);
player.play()
// ...
player.dispose();
player = Player.network("www.example.com/file.mp3");
copied to clipboard
but i plan it to add somthing like player.reuse() to re use player by defrent source
also i will add Player.disposeAll() to easly dispose All players
acces to all players #
you can acces to all players by PlayerController.players return List<PlayerController>
Source code #
check the repository on github (https://github.com/physia/kflutter/tree/main/kplayer/kplayer)
Check list #

✅ add disposeAll, pauseAll, playAll
✅ add setMedia
✅ replace setters with async methods
✅ add more widget
❌ support playLists
❌ add style option and sub widget

Support ☺️ #
Coffee for my mind:

E n g o j :)