Flutter自定义铃声设置插件ringtone_set_mul的使用

Flutter自定义铃声设置插件ringtone_set_mul的使用

概述

ringtone_set_mul 是一个用于在 Flutter 应用中设置设备默认铃声、通知音或闹钟音的插件。它仅支持 Android 平台。

使用步骤

1. 添加权限到 AndroidManifest.xml

在您的项目中，确保在 <manifest> 标签内添加以下权限：

<uses-permission android:name="android.permission.WRITE_SETTINGS"
    tools:ignore="ProtectedPermissions" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

2. 配置 pubspec.yaml

将插件添加到项目的依赖项中：

dependencies:
  ringtone_set_mul: ^0.0.1

同时，如果您的音频文件存储在 assets 文件夹中，请确保将其添加到 pubspec.yaml 的 assets 下：

flutter:
  assets:
    - assets/music.mp3

3. 导入插件

在 Dart 文件中导入插件：

import 'package:ringtone_set_mul/ringtone_set_mul.dart';

4. 设置铃声、通知音或闹钟音

从 Assets 文件夹设置

您可以从 assets 文件夹中选择音频文件来设置铃声、通知音或闹钟音：

// 设置默认铃声
RingtoneSet.setRingtone("assets/music.mp3");

// 设置通知音
RingtoneSet.setNotification("assets/music.mp3");

// 设置闹钟音
RingtoneSet.setAlarm("assets/music.mp3");

从网络 URL 设置

您还可以通过网络 URL 来设置铃声、通知音或闹钟音：

// 从网络设置默认铃声
RingtoneSet.setRingtoneFromNetwork("https://example.com/music.mp3");

// 从网络设置通知音
RingtoneSet.setNotificationFromNetwork("https://example.com/music.mp3");

// 从网络设置闹钟音
RingtoneSet.setAlarmFromNetwork("https://example.com/music.mp3");

从本地文件设置

最后，您也可以通过 File 对象来设置铃声、通知音或闹钟音：

// 创建文件对象
final File ringtoneFile = File("music.mp3");

// 设置默认铃声
RingtoneSet.setRingtoneFromFile(ringtoneFile);

// 设置通知音
RingtoneSet.setNotificationFromFile(ringtoneFile);

// 设置闹钟音
RingtoneSet.setAlarmFromFile(ringtoneFile);

完整示例代码

以下是一个完整的示例代码，展示了如何使用 ringtone_set_mul 插件来设置铃声、通知音和闹钟音。

import 'dart:async';
import 'dart:io';

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:ringtone_set_mul/ringtone_set_mul.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatefulWidget {
  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
  }

  // 初始化平台状态
  Future<void> initPlatformState() async {
    // 请求系统权限
    if (!await RingtoneSet.isWriteSettingsGranted()) {
      RingtoneSet.reqSystemPermissions();
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Ringtone Set Example'),
        ),
        body: Builder(builder: (context) {
          return Center(
            child: Column(
              mainAxisAlignment: MainAxisAlignment.spaceAround,
              children: <Widget>[
                // 设置铃声
                TextButton(
                  onPressed: () async {
                    bool success = false;
                    try {
                      success = await RingtoneSet.setRingtone("assets/h1.mp3");
                    } on PlatformException {
                      success = false;
                    }
                    var snackBar;
                    if (success) {
                      snackBar = SnackBar(
                        content: Text("Ringtone set successfully!"),
                      );
                    } else {
                      snackBar = SnackBar(content: Text("Error"));
                    }
                    ScaffoldMessenger.of(context).showSnackBar(snackBar);
                  },
                  child: Text("Set Ringtone"),
                ),
                // 设置通知音
                TextButton(
                  onPressed: () async {
                    bool success = false;
                    try {
                      success = await RingtoneSet.setNotification("assets/h1.mp3");
                    } on PlatformException {
                      success = false;
                    }
                    var snackBar;
                    if (success) {
                      snackBar = SnackBar(
                        content: Text("Notification set successfully!"),
                      );
                    } else {
                      snackBar = SnackBar(content: Text("Error"));
                    }
                    ScaffoldMessenger.of(context).showSnackBar(snackBar);
                  },
                  child: Text("Set Notification"),
                ),
                // 设置闹钟音
                TextButton(
                  onPressed: () async {
                    bool success = false;
                    try {
                      success = await RingtoneSet.setAlarm("assets/h1.mp3");
                    } on PlatformException {
                      success = false;
                    }
                    var snackBar;
                    if (success) {
                      snackBar = SnackBar(
                        content: Text("Alarm set successfully!"),
                      );
                    } else {
                      snackBar = SnackBar(content: Text("Error"));
                    }
                    ScaffoldMessenger.of(context).showSnackBar(snackBar);
                  },
                  child: Text("Set Alarm"),
                ),
                // 设置多个音频类型
                TextButton(
                  onPressed: () async {
                    bool success = false;
                    try {
                      success = await RingtoneSet.setMultipleAsset(
                          "assets/h2.mp3",
                          isAlarm: true,
                          isNotification: true,
                          isRingtone: true);
                    } on PlatformException {
                      success = false;
                    }
                    var snackBar;
                    if (success) {
                      snackBar = SnackBar(
                        content: Text("Multiple set successfully!"),
                      );
                    } else {
                      snackBar = SnackBar(content: Text("Error"));
                    }
                    ScaffoldMessenger.of(context).showSnackBar(snackBar);
                  },
                  child: Text("Set Multiple"),
                ),
              ],
            ),
          );
        }),
      ),
    );
  }
}