radio_player 1.7.0 radio_player: ^1.7.0 copied to clipboard
A Flutter plugin to play streaming audio content with background support and lock screen controls.
Radio Player #
A Flutter plugin to play streaming audio content with background support and lock screen controls.
Installation #
To use this package, add radio_player
as a dependency in your pubspec.yaml
file.
dependencies:
radio_player: ^1.7.0
By default iOS forbids loading from non-https url. To cancel this restriction edit your .plist and add:
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
</dict>
If necessary, add permissions to play in the background:
<key>UIBackgroundModes</key>
<array>
<string>audio</string>
<string>processing</string>
</array>
Usage #
To create RadioPlayer
instance, simply call the constructor.
RadioPlayer radioPlayer = RadioPlayer();
Configure it with your data.
radioPlayer.setChannel(title: TITLE, url: URL, imagePath: IMAGEPATH?);
Player Controls #
radioPlayer.play();
radioPlayer.pause();
State Event #
You can use it to show if player playing or paused.
bool isPlaying = false;
//...
radioPlayer.stateStream.listen((value) {
setState(() { isPlaying = value; });
});
Metadata Event #
This Event returns the current metadata.
List<String>? metadata;
//...
radioPlayer.metadataStream.listen((value) {
setState(() { metadata = value; });
});
Image from metadata can be retrieved using getArtworkImage()
Requirements #
- iOS: SDK 10.0 or later
- Android: API Level 23 or later
Contributing #
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.