Flutter 3.47 鸿蒙三方库适配实战:从 0 到 1 处理 flutter_beep

提示音是最小的反馈单元:扫码成功的“嘀”声、支付失败的警示音。flutter_beep 通过系统音效 ID 播放提示音,是权衡依赖体积后的常见选择。把它带到鸿蒙时,系统音效资源是适配的切入点。

本文以 flutter_beep 1.0.0 为例,记录我如何保留原有 Dart API、补齐 Flutter OH 插件入口、在鸿蒙端接入真实系统能力,并在 HarmonyOS API 26 真机上完成构建、安装、启动和按钮调用验证。

适配仓库: oh-flutter/flutter_beep

适配分支: feat/ohos_flutter_beep_1.0.0

适配 TAG: 1.0.0-ohos.2

一、先看最终效果

图 1:HarmonyOS API 26 真机启动 Demo。页面显示 flutter_beep 1.0.0。

图 2:点击“播放系统提示音”后返回 playSysSound 调用完成——合成提示音经 AudioRenderer 真实播放。

验证点实测结果证据
Flutter OH 3.47 工程构建通过entry-default-signed.hap
安装、启动(真机)通过图 1
playSysSound真实播放合成提示音图 2
beep(false)播放失败音(下行双音)图 3
音频实现AudioRenderer 实时合成 PCM代码

图 3:点击“播放失败提示音”后返回调用完成,播放下行双音。

二、这个库原来是怎么工作的

flutter_beep 的接口面极小:

Dart FlutterBeep
  -> MethodChannel('flutter_beep')
  -> Android ToneGenerator / iOS AudioServicesPlaySystemSound
  -> playSysSound(soundId) / beep(success)

beep(true/false) 是常用的语义化封装:成功播一个音、失败播另一个。

三、实际环境

Flutter 鸿蒙环境搭建不在本文重复展开,直接参考 Flutter OH 环境搭建指南。

组件版本
Flutter OH3.47.4-ohos-1.0.4
Dart3.13.3
DevEco Studio26.0.0 Release
HarmonyOS SDKAPI 26
测试设备华为畅享 90 Pro Max,HarmonyOS 7.0.0.105(API 26)
目标库flutter_beep 1.0.0
flutter --version
hdc list targets

四、确认上游版本并同步到 AtomGit

上游包地址是 https://github.com/trietho/flutter_beep,版本 1.0.0 使用 BSD 3-Clause(Copyright 2020 GONoter) License。适配前我在 AtomGit 目标组织中搜索了同名库,没有找到可以直接使用的 OHOS 实现。

仓库适配提交为 60ea072,分支与 TAG 1.0.0-ohos.2 均指向该提交。

git clone https://atomgit.com/oh-flutter/flutter_beep.git
cd flutter_beep
git switch feat/ohos_flutter_beep_1.0.0
git log --oneline -5

五、创建适配分支并检查工程结构

git switch -c feat/ohos_flutter_beep_1.0.0

关键目录如下:

flutter_beep/
├── lib/                                        # 原有 Dart API 和 MethodChannel
├── ohos/
│   ├── index.ets                               # OHOS 插件导出入口
│   └── src/main/ets/components/plugin/
│       └── FlutterBeepPlugin.ets                           # 通道实现
├── example/lib/main.dart                        # 真机验证 Demo
├── example/ohos/                                # Flutter OH 宿主工程
├── pubspec.yaml                                # 声明 ohos 平台
└── README.OpenHarmony_CN.md                    # 鸿蒙适配说明

pubspec.yaml 中的关键声明是:

flutter:
  plugin:
    platforms:
      ohos:
        pluginClass: FlutterBeepPlugin

pluginClass 必须和 ohos/index.ets 导出的类名一致,否则 Dart 端能编译,运行时却不会注册插件。

六、适配过程:注册通道并对齐语义

// 按音调类别合成 16-bit PCM 正弦波
private synthesizeTone(soundId: number): ArrayBuffer {
  const totalSamples = Math.floor(SAMPLE_RATE * DURATION_MS / 1000);
  const buffer = new ArrayBuffer(totalSamples * 2);
  const view = new DataView(buffer);
  for (let i = 0; i < totalSamples; i++) {
    let frequency = 1047;                              // 默认
    if (SUCCESS_TONES.has(soundId)) frequency = 1568;  // 成功:上行单音
    else if (FAILURE_TONES.has(soundId)) {
      frequency = i < totalSamples / 2 ? 784 : 523;    // 失败:下行双音
    }
    const fade = Math.min(1, Math.min(i, totalSamples - i - 1) / 240);
    view.setInt16(i * 2, Math.round(0.35 * 0x7FFF * fade
      * Math.sin(2 * Math.PI * frequency * i / SAMPLE_RATE)), true);
  }
  return buffer;
}

// 用 AudioRenderer 播放
const renderer = await audio.createAudioRenderer({ /* 48kHz 单声道 S16LE */ });
await renderer.start();
await renderer.write(pcm);
方法OpenHarmony 实现
playSysSound(soundId)AudioRenderer 合成 PCM 并播放
beep(success)成功/失败两类音调
stopSysSound释放渲染器

七、构建配置与签名

示例工程的目标 SDK 对齐到 26,与 @ohos/flutter_ohos 的最低要求一致:

{
  "name": "default",
  "compatibleSdkVersion": "26.0.0",
  "targetSdkVersion": "26.0.0",
  "runtimeOS": "HarmonyOS"
}

Demo 的 AppScope/app.json5 统一成 com.example.flutter_oh_demo,与 DevEco 调试签名对应。证书、p12、p7b 和密码没有提交到仓库,读者应在自己的 DevEco Studio 中生成调试签名。

八、通过 AtomGit 引入适配版

在另一个 Flutter OH 应用中使用时,建议锁定 TAG:

dependencies:
  flutter_beep:
    git:
      url: https://atomgit.com/oh-flutter/flutter_beep.git
      ref: 1.0.0-ohos.2
flutter pub get

然后在 pubspec.lock 检查 source: git、AtomGit 地址和 resolved-ref,确认没有解析到 pub.dev 的同名版本。

九、构建、安装和真机验证

cd example
flutter pub get
flutter analyze
flutter build hap --debug
hdc install -r build/ohos/hap/entry-default-signed.hap
hdc shell aa start -a EntryAbility -b com.example.flutter_oh_demo

构建输出为 ✓ Built build/ohos/hap/entry-default-signed.hap.,随后 hdc 报告安装成功并启动 Ability。真机上按本文的截图顺序逐一点击按钮完成验证。

十、适配结果和当前边界

鸿蒙公开 SDK 没有 ToneGenerator / TonePlayer 等价接口,因此不能按系统音调 ID 播放。本实现改为实时合成 PCM 正弦波:成功提示上行、失败提示下行,语义上与上游一致,但不是系统音效本身。

这是刻意的取舍:与其让调用方完全没声音,不如用可听感一致的合成音替代,并在文档中说明这一实现差异。

十一、FAQ

Q1:提示音失败会影响主流程吗?

  • 现象: 合成音在本地播放,不依赖网络或系统音效资源。
  • 解决方法: 调用方无需额外容错。
  • 验证结果: 真机播放正常。

Q2:为什么要用 beep(false) 验证?

  • 现象: 它对应失败提示音,走的是与成功音不同的分支。
  • 解决方法: 用于确认两类音调都正确。
  • 验证结果: 图 3 显示调用完成。

Q3:接入后需要改业务代码吗?

  • 现象: 不需要,Dart API 未变。
  • 解决方法: 直接替换依赖版本。
  • 验证结果: 调用方式不变。

十二、总结

flutter_beep 1.0.0 在鸿蒙上用 AudioRenderer 实时合成 PCM 提示音:成功音上行、失败音下行,通过扬声器真实播放。这是对"鸿蒙没有 TonePlayer"这一平台限制的工程替代。

十三、参考资料和仓库地址

欢迎加入CPF-Flutter 鸿蒙社区:https://atomgit.com/CPF-Flutter

Logo

作为“人工智能6S店”的官方数字引擎,为AI开发者与企业提供一个覆盖软硬件全栈、一站式门户。

更多推荐