flutter_ringtone_player 1.0.3

flutter_ringtone_player #

A simple ringtone, alarm & notification player plugin.

pub package

Usage #

Add following import to your code:

import 'package:flutter_ringtone_player/flutter_ringtone_player.dart';

Then simply call this to play system default notification sound:

FlutterRingtonePlayer.playNotification();

You can also specify some additional parameters (works only on Android with API 28 and above):

FlutterRingtonePlayer.playNotification(volume: 0.5, looping: true);

There's also this generic method allowing you to specify in detail what kind of ringtone should be played:

FlutterRingtonePlayer.play(
  android: AndroidSounds.notification,
  ios: IosSounds.glass,
  looping: true,
  volume: 0.1,
);

To stop looped ringtone please use:

FlutterRingtonePlayer.stop();

Above works only on Android, and please note that by default Alarm & Ringtone sounds are looped.

Default sounds #

MethodAndroidiOS
playAlarmSystem#DEFAULT_ALARM_ALERT_URIIosSounds.alarm
playNotificationSystem#DEFAULT_NOTIFICATION_URIIosSounds.triTone
playRingtoneSystem#DEFAULT_RINGTONE_URIIosSounds.electronic

Note on iOS sounds #

If you want to use any other sound on iOS you can always specify a valid Sound ID and manually construct [IosSound]:

FlutterRingtonePlayer.play(
  android: AndroidSounds.notification,
  ios: const IosSound(1023),
  looping: true,
  volume: 0.1,
);

1.0.3 #

  • Fix iOS issues

1.0.2 #

  • Organize return & results logic to fix #1

1.0.1 #

  • Refactor API to allow arbitrary sound ID's on iOS

1.0.0 #

  • Stable version with iOS & Android support

0.0.1 #

  • Initial release.

example/README.md

flutter_ringtone_player_example #

Demonstrates how to use the flutter_ringtone_player plugin.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  flutter_ringtone_player: ^1.0.3

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:flutter_ringtone_player/flutter_ringtone_player.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
78
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
89
Learn more about scoring.

We analyzed this package on Jul 17, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.4.0
  • pana: 0.12.19
  • Flutter: 1.7.8+hotfix.3

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11
meta 1.1.6 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test

Admin