Flutter闹钟管理插件cfn_alarm的使用

cfn_alarm 是一个用于 Flutter 应用程序的闹钟管理插件。目前该插件仅支持 iOS 平台，并且能够实现音频在前台播放的功能。

特性

• 目前仅在 iOS 平台上可用。
• 支持前台音频下载和播放。

接下来，我们通过一个完整的示例来展示如何使用 cfn_alarm 插件。

示例代码

import 'package:cfn_alarm/app_enums.dart';
import 'package:flutter/material.dart';

import 'package:cfn_alarm/cfn_alarm.dart';
import 'package:cfn_alarm/models/alarm_setting.dart';
import 'package:intl/intl.dart';

void main() {
  // 确保 Flutter 框架已经初始化
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化 cfn_alarm 插件
  CfnAlarm.init();

  // 启动应用程序
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  // 用于显示平台版本信息
  String _platformVersion = '未知';
  String _platformVersion1 = '未知';

  @override
  void initState() {
    super.initState();
    
    // 初始化回调
    initCallBack();

    // 初始化平台状态
    initPlatformState();
  }

  /// 设置日期时间格式为 yyyy-MM-dd HH:mm:ss
  Future<void> initPlatformState() async {
    // 初始化并设置闹钟
    var initScheduleAlarm = await CfnAlarm.initScheduleAlarm(
      setting: AlarmSetting(
        id: 123,
        dateTime: DateFormat('yyyy-MM-dd HH:mm:ss').format(DateTime.now().copyWith(second: 0, minute: 6)),
        audioPath: "https://samplelib.com/lib/preview/mp3/sample-15s.mp3",
        title: "通知",
        body: "通知内容",
        audioType: AudioType.network,
      ),
    );

    // 更新界面状态
    setState(() {
      _platformVersion = initScheduleAlarm!.toString();
    });
  }

  @override
  void dispose() {
    // 取消闹钟
    CfnAlarm.onCancel();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: Center(
          child: Column(
            children: [
              // 显示当前平台版本信息
              Text('运行在: $_platformVersion\n'),
              const SizedBox(height: 35),
              
              // 停止调度闹钟按钮
              TextButton(
                onPressed: () async {
                  // 移除已设置的闹钟
                  var initScheduleAlarm = await CfnAlarm.removeScheduleAlarm(id: 123);

                  // 更新界面状态
                  setState(() {
                    _platformVersion1 = initScheduleAlarm!.toString();
                  });
                },
                child: Text("停止调度闹钟: $_platformVersion1"),
              )
            ],
          ),
        ),
      ),
    );
  }

  Future<void> initCallBack() async {
    // 监听闹钟接收事件
    CfnAlarm.onReceived.stream.listen((event) {
      // 处理接收到的闹钟事件
    });

    // 监听闹钟点击事件
    CfnAlarm.onTapReceived.stream.listen((event) {
      // 处理点击闹钟事件
    });
  }
}

代码解释

1. 初始化插件：

   WidgetsFlutterBinding.ensureInitialized();
   CfnAlarm.init();
   

   在启动应用之前，确保 Flutter 框架已经初始化，并调用 CfnAlarm.init() 方法初始化插件。

2. 设置闹钟：

   var initScheduleAlarm = await CfnAlarm.initScheduleAlarm(
     setting: AlarmSetting(
       id: 123,
       dateTime: DateFormat('yyyy-MM-dd HH:mm:ss').format(DateTime.now().copyWith(second: 0, minute: 6)),
       audioPath: "https://samplelib.com/lib/preview/mp3/sample-15s.mp3",
       title: "通知",
       body: "通知内容",
       audioType: AudioType.network,
     ),
   );
   

   使用 CfnAlarm.initScheduleAlarm 方法设置闹钟，参数包括闹钟 ID、日期时间、音频路径等。

3. 移除闹钟：

   var initScheduleAlarm = await CfnAlarm.removeScheduleAlarm(id: 123);
   

   使用 CfnAlarm.removeScheduleAlarm 方法移除已设置的闹钟。

4. 监听闹钟事件：

   CfnAlarm.onReceived.stream.listen((event) {
     // 处理接收到的闹钟事件
   });
   
   CfnAlarm.onTapReceived.stream.listen((event) {
     // 处理点击闹钟事件
   });