https://github.com/inway/flutter_ringtone_player

Simple Flutter plugin to play ringtone, alarm & notification sounds
https://github.com/inway/flutter_ringtone_player

android dart flutter flutter-plugin ios ringtone sound

Last synced: 11 days ago
JSON representation

Simple Flutter plugin to play ringtone, alarm & notification sounds

• Host: GitHub
• URL: https://github.com/inway/flutter_ringtone_player
• Owner: inway
• License: mit
• Created: 2019-04-26T18:31:23.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-06-03T14:06:40.000Z (5 months ago)
• Last Synced: 2024-08-01T16:26:34.130Z (3 months ago)
• Topics: android, dart, flutter, flutter-plugin, ios, ringtone, sound
• Language: Dart
• Homepage:
• Size: 3.12 MB
• Stars: 89
• Watchers: 4
• Forks: 57
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# flutter_ringtone_player

A simple ringtone, alarm & notification player plugin.

[![pub package](https://img.shields.io/pub/v/flutter_ringtone_player.svg)](https://pub.dartlang.org/packages/flutter_ringtone_player)

[![flutter](https://github.com/inway/flutter_ringtone_player/actions/workflows/flutter.yml/badge.svg)](https://github.com/inway/flutter_ringtone_player/actions/workflows/flutter.yml)

## Usage

Add following import to your code:

```dart

import 'package:flutter_ringtone_player/flutter_ringtone_player.dart';

```

Then simply call this to play system default notification sound:

```dart

FlutterRingtonePlayer().playNotification();

```

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

```dart

FlutterRingtonePlayer().play(

  android: AndroidSounds.notification,

  ios: IosSounds.glass,

  looping: true, // Android only - API >= 28

  volume: 0.1, // Android only - API >= 28

  asAlarm: false, // Android only - all APIs

);

```

Also you can specify a custom ringtone from assets, or provide direct path to file that works for 

both Android and iOS:

```dart

FlutterRingtonePlayer().play(fromAsset: "assets/ringtone.wav");  

```

```dart

FlutterRingtonePlayer().play(fromFile: "assets/ringtone.wav");  

```

You can specify a platform specific ringtone and it will override the one from assets:

```dart

FlutterRingtonePlayer().play(  

 fromAsset: "assets/ringtone.wav", // will be the sound on Android

 ios: IosSounds.glass 			   // will be the sound on iOS

 );  

```

### .play() optional attributes

| Attribute       |  Description |

| --------------  | ------------ |

| `bool` looping  | Enables looping of ringtone. Requires `FlutterRingtonePlayer().stop();` to stop ringing. |

| `double` volume | Sets ringtone volume in range 0 to 1.0. |

| `bool` asAlarm  | Allows to ignore device's silent/vibration mode and play given sound anyway. |

To stop looped ringtone please use:

```dart

FlutterRingtonePlayer().stop();

```

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

## Default sounds

| Method           | Android | iOS |

| ---------------- | ------- | --- |

| playAlarm        | [RingtoneManager.TYPE_ALARM](https://developer.android.com/reference/android/media/RingtoneManager#TYPE_ALARM) | IosSounds.alarm |

| playNotification | [RingtoneManager.TYPE_NOTIFICATION](https://developer.android.com/reference/android/media/RingtoneManager#TYPE_NOTIFICATION) | IosSounds.triTone |

| playRingtone     | [RingtoneManager.TYPE_RINGTONE](https://developer.android.com/reference/android/media/RingtoneManager#TYPE_RINGTONE) | IosSounds.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]:

```dart

FlutterRingtonePlayer().play(

  android: AndroidSounds.notification,

  ios: const IosSound(1023),

  looping: true,

  volume: 0.1,

);

```