{"id":13471379,"url":"https://github.com/inway/flutter_ringtone_player","last_synced_at":"2025-10-23T07:29:10.448Z","repository":{"id":34783900,"uuid":"183676802","full_name":"inway/flutter_ringtone_player","owner":"inway","description":"Simple Flutter plugin to play ringtone, alarm \u0026 notification sounds","archived":false,"fork":false,"pushed_at":"2025-02-21T14:02:37.000Z","size":3272,"stargazers_count":98,"open_issues_count":12,"forks_count":81,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-02-21T14:32:16.893Z","etag":null,"topics":["android","dart","flutter","flutter-plugin","ios","ringtone","sound"],"latest_commit_sha":null,"homepage":"","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/inway.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"inway"}},"created_at":"2019-04-26T18:31:23.000Z","updated_at":"2025-02-21T14:02:32.000Z","dependencies_parsed_at":"2023-02-14T05:00:28.250Z","dependency_job_id":"902a3867-a29a-44d8-80f7-e8e8e8e2b459","html_url":"https://github.com/inway/flutter_ringtone_player","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inway%2Fflutter_ringtone_player","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inway%2Fflutter_ringtone_player/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inway%2Fflutter_ringtone_player/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inway%2Fflutter_ringtone_player/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inway","download_url":"https://codeload.github.com/inway/flutter_ringtone_player/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245662788,"owners_count":20652084,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","dart","flutter","flutter-plugin","ios","ringtone","sound"],"created_at":"2024-07-31T16:00:43.959Z","updated_at":"2025-10-23T07:29:10.393Z","avatar_url":"https://github.com/inway.png","language":"Dart","funding_links":["https://github.com/sponsors/inway"],"categories":["Dart"],"sub_categories":[],"readme":"# flutter_ringtone_player\n\nA simple ringtone, alarm \u0026 notification player plugin.\n\n[![pub package](https://img.shields.io/pub/v/flutter_ringtone_player.svg)](https://pub.dartlang.org/packages/flutter_ringtone_player)\n[![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)\n\n## Usage\n\nAdd following import to your code:\n\n```dart\nimport 'package:flutter_ringtone_player/flutter_ringtone_player.dart';\n```\n\nThen simply call this to play system default notification sound:\n\n```dart\nFlutterRingtonePlayer().playNotification();\n```\n\nThere's also this generic method allowing you to specify in detail what kind of ringtone should be played:\n\n```dart\nFlutterRingtonePlayer().play(\n  android: AndroidSounds.notification,\n  ios: IosSounds.glass,\n  looping: true, // Android only - API \u003e= 28\n  volume: 0.1, // Android only - API \u003e= 28\n  asAlarm: false, // Android only - all APIs\n);\n```\n\nAlso you can specify a custom ringtone from assets, or provide direct path to file that works for \nboth Android and iOS:\n\n```dart\nFlutterRingtonePlayer().play(fromAsset: \"assets/ringtone.wav\");  \n```\n\n```dart\nFlutterRingtonePlayer().play(fromFile: \"assets/ringtone.wav\");  \n```\n\nYou can specify a platform specific ringtone and it will override the one from assets:\n```dart\nFlutterRingtonePlayer().play(  \n fromAsset: \"assets/ringtone.wav\", // will be the sound on Android\n ios: IosSounds.glass \t\t\t   // will be the sound on iOS\n );  \n```\n\n### .play() optional attributes\n\n| Attribute       |  Description |\n| --------------  | ------------ |\n| `bool` looping  | Enables looping of ringtone. Requires `FlutterRingtonePlayer().stop();` to stop ringing. |\n| `double` volume | Sets ringtone volume in range 0 to 1.0. |\n| `bool` asAlarm  | Allows to ignore device's silent/vibration mode and play given sound anyway. |\n\n\nTo stop looped ringtone please use:\n\n```dart\nFlutterRingtonePlayer().stop();\n```\n\nAbove works only on Android, and please note that by default Alarm \u0026 Ringtone sounds are looped.\n\n## Default sounds\n\n| Method           | Android | iOS |\n| ---------------- | ------- | --- |\n| playAlarm        | [RingtoneManager.TYPE_ALARM](https://developer.android.com/reference/android/media/RingtoneManager#TYPE_ALARM) | IosSounds.alarm |\n| playNotification | [RingtoneManager.TYPE_NOTIFICATION](https://developer.android.com/reference/android/media/RingtoneManager#TYPE_NOTIFICATION) | IosSounds.triTone |\n| playRingtone     | [RingtoneManager.TYPE_RINGTONE](https://developer.android.com/reference/android/media/RingtoneManager#TYPE_RINGTONE) | IosSounds.electronic |\n\n### Note on iOS sounds\n\nIf you want to use any other sound on iOS you can always specify a valid Sound ID and manually construct [IosSound]:\n\n```dart\nFlutterRingtonePlayer().play(\n  android: AndroidSounds.notification,\n  ios: const IosSound(1023),\n  looping: true,\n  volume: 0.1,\n);\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finway%2Fflutter_ringtone_player","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finway%2Fflutter_ringtone_player","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finway%2Fflutter_ringtone_player/lists"}