alarm 2.1.1 alarm: ^2.1.1 copied to clipboard
A simple Flutter alarm manager plugin for both iOS and Android.
🏆 Winner of the 2023 OnePub Community Choice Awards.
Alarm plugin for iOS and Android #
This Flutter plugin provides a simple and easy-to-use interface for setting and canceling alarms on iOS and Android devices. It utilizes the
android_alarm_manager_plus plugin for Android and the native iOS
🔧 Installation steps #
Please carefully follow these installation steps. They have been updated for plugin version
📖 How to use #
Add to your pubspec.yaml:
flutter pub add alarm
First, you have to initialize the Alarm service in your
Then, you have to define your alarm settings:
final alarmSettings = AlarmSettings( id: 42, dateTime: dateTime, assetAudioPath: 'assets/alarm.mp3', loopAudio: true, vibrate: true, volumeMax: true, fadeDuration: 3.0, notificationTitle: 'This is the title', notificationBody: 'This is the body', enableNotificationOnKill: true, );
And finally set the alarm:
await Alarm.set(alarmSettings: alarmSettings)
||Unique identifier of the alarm.|
||The date and time you want your alarm to ring.|
||The path to you audio asset you want to use as ringtone. Can be a path in your assets folder or a downloaded local file path.|
||If true, audio will repeat indefinitely until alarm is stopped.|
||If true, device will vibrate indefinitely until alarm is stopped. If [loopAudio] is set to false, vibrations will stop when audio ends.|
||If true, set system volume to maximum when [dateTime] is reached. Set back to previous volume when alarm is stopped.|
||Duration, in seconds, over which to fade the alarm volume. Set to 0 by default, which means no fade.|
||The title of the notification triggered when alarm rings if app is on background.|
||The body of the notification.|
||Whether to show a notification when application is killed to warn the user that the alarm he set may not ring. Enabled by default.|
||Whether to stop the alarm when opening the received notification. Disabled by default.|
||Whether to turn screen on when android alarm notification is triggered. Enabled by default.|
The notification shown on alarm ring can be disabled simply by ignoring the parameters
notificationBody. However, if you want a notification to be triggered, you will have to provide both of them.
If you enabled
enableNotificationOnKill, you can chose your own notification title and body by using this method before setting your alarms:
await Alarm.setNotificationOnAppKillContent(title, body)
This is how to stop/cancel your alarm:
This is how to run some code when alarm starts ringing. We implemented it as a stream so even if your app was previously killed, your custom callback can still be triggered.
Alarm.ringStream.stream.listen((_) => yourOnRingCallback());
To avoid unexpected behaviors, if you set an alarm for the same time as an existing one, the new alarm will replace the existing one.
📱 Example app #
Don't hesitate to check out the example's code, and take a look at the app:
⏰ Alarm behaviour #
|Silent / Mute||✅||✅||✅||✅|
|Do not disturb||✅||✅||✅||Silenced|
|While playing other media||✅||✅||✅||✅|
Silenced: Means that the notification is not shown directly on the top of the screen. You have to go in your notification center to see it.
❓ FAQ #
Why didn't my alarm fire on iOS? #
Several factors could prevent your alarm from ringing:
- Your iPhone was restarted (either from a manual reboot or due to an iOS update).
- The app was either manually terminated or was closed because of memory constraints.
My alarm is not firing on a specific Android device #
Some Android manufacturers prefer battery life over proper functionality of your apps. Check out dontkillmyapp.com to find out about more about optimizations done by different vendors, and potential workarounds. Most common solution is to educate users to disable battery optimization settings. Source: android_alarm_manager_plus FAQ
How can I increase the reliability of the alarm ringing? #
The more time the app spends in the background, the higher the chance the OS might stop it from running due to memory or battery optimizations. Here's how you can optimize:
- Regular App Usage: Encourage users to open the app at least once a day.
- Leverage Background Modes: Engage in activities like weather API calls that keep the app active in the background.
- User Settings: Educate users to refrain from using 'Do Not Disturb' (DnD) and 'Low Power Mode' when they're expecting the alarm to ring.
⚙️ Under the hood #
oneShotAt from the
android_alarm_manager_plus plugin with a two-way communication isolated callback to start/stop the alarm.
Keeps the app awake using a silent
AVAudioPlayer until alarm rings. When in the background, it also uses
Background App Refresh to periodically ensure the app is still active.
✉️ Feature request #
If you have a feature request, just open an issue explaining clearly what you want and if you convince me I will develop it for you.
💙 Contributing #
We welcome contributions to this plugin! If you would like to make a change or add a new feature, please follow these steps:
- Fork the repository and create a new branch for your changes.
- Make your changes
flutter formatto ensure that your code is correctly formatted.
- Submit a pull request with a detailed description of your changes.
These are some features that I have in mind that could be useful:
jnigenbinding generators to call native code more efficiently instead of using method channels.
- Notification actions: stop and snooze.
- Stop alarm sound when notification is dismissed.
- Make alarm ring even if app was terminated.
Thank you for considering contributing to this plugin. Your help is greatly appreciated!