sound_mode 0.1.3 sound_mode: ^0.1.3 copied to clipboard
A plugin to manage a device's sound mode for android. This plugin also supports requesting the required permissions to modify the device's sound mode for Android API 24 and above.
sound_mode #
A Flutter plugin to manage a device's sound mode on Android.
Usage #
Add sound_mode
as a dependency in your pubspec.yaml file
Add the following permission to AndroidManifest.xml
for the app to appear in the 'Do Not Disturb Access' list
<manifest ... >
<uses-permission android:name="android.permission.ACCESS_NOTIFICATION_POLICY"/>
<application ... >
...
</manifest>
Features #
- Detect device's current sound mode
- Able to toggle between Normal, Silent & Vibrate mode
- Grant Do No Disturb permissions for devices above platform version
Android 6.0 (API 23)
Example #
To get the device's current sound mode:
String ringerStatus = await SoundMode.ringerModeStatus;
print(ringerStatus);
To change the device's sound mode:
import 'package:sound_mode/utils/sound_profiles.dart';
// Handle Platform Exceptions for devices running above Android 6.0
try {
await SoundMode.setSoundMode(Profiles.SILENT);
} on PlatformException {
print('Please enable permissions required');
}
List of modes available
Mode | Description |
---|---|
Profiles.NORMAL | Sets the device to normal mode |
Profiles.SILENT | Sets the device to silent mode |
Profiles.VIBRATE | Sets the device to vibrate mode |
For Android 6.0 and above
For devices with Android 6.0 and above, it is required for the user to grant Do No Disturb Access to set their device's sound mode.
To check if the user has granted the permissions and prompt for approval
import 'package:sound_mode/permission_handler.dart';
bool isGranted = await PermissionHandler.permissionsGranted;
if (!isGranted) {
// Opens the Do Not Disturb Access settings to grant the access
await PermissionHandler.openDoNotDisturbSetting();
}
Contributing #
Feel free to edit the plugin and submit a pull request or open an issue on github to leave a feedback