跳转到正文

@capgo/capacitor-native-audio

低延迟音效与流式音频,支持预加载、Now Playing 控件和后台播放选项。

使用 @capgo/capacitor-native-audio 当你的 Capacitor 应用需要为 UI 音效、短片段或音乐风格会话提供响应式播放,而无需在多个原生音频 API 之间切换时。支持预加载资源、循环播放、音量淡入淡出、流式传输远程 URL 或 HLS,并可选显示锁屏媒体控制。

典型适用场景:游戏音效、通知提示音、引导冥想、播客播放器,以及任何需要与设备上其他应用共享音频会话的流程。

平台支持备注
iOS是AVFoundation,可选的 Now Playing 和音频会话类别
Android是媒体播放、通知,可选前台服务以支持后台运行
Web 端部分支持核心播放功能;部分监听器事件在 Web 端不会触发
  • configure - 配置音频播放器。
  • preload - 加载音频文件。
  • playOnce - 播放一次音频文件并自动清理。
  • isPreloaded - 检查音频文件是否已预加载。
方法描述
configure配置音频播放器。
preload加载音频文件。
playOnce播放一次音频文件并自动清理。
isPreloaded检查音频文件是否已预加载。
play播放音频文件。
pause暂停音频文件。
resume恢复播放音频文件。
loop停止音频文件。
stop停止音频文件。
unload卸载音频文件。
setVolume设置音频文件的音量。
setRate设置音频文件的播放速率。
setCurrentTime设置音频文件的当前播放时间。
getCurrentTime获取音频文件的当前播放时间。
getDuration以秒为单位获取音频文件的时长。
isPlaying检查音频文件是否正在播放。
addListener监听播放完成事件。
addListener监听当前时间更新。音频播放期间每 100ms 触发一次。
addListener监听播放状态变化,包括通知和锁屏媒体控制。由 Android 和 iOS 触发。当前 Web 实现不触发此事件。
clearCache清除远程音频文件的音频缓存。
setDebugMode设置调试模式日志。
getPluginVersion获取原生 Capacitor 插件版本。
deinitPlugin反初始化插件并恢复原始音频会话设置。此方法会停止所有正在播放的音频,并撤销插件所做的任何音频会话更改。当需要确保与其他音频插件的兼容性时,请使用此方法。

此参考文档同步自 src/definitions.ts 中的 capacitor-native-audio.

如果你正在使用 @capgo/capacitor-native-audio 来规划原生媒体和界面行为,并将其与 使用 @capgo/capacitor-native-audio 关于使用 @capgo/capacitor-native-audio 中的原生能力, 使用 @capgo/capacitor-live-activities 用于使用 @capgo/capacitor-live-activities 时的原生能力, @capgo/capacitor-live-activities 在 @capgo/capacitor-live-activities 中的实现细节, 使用 @capgo/capacitor-video-player 有关使用 @capgo/capacitor-video-player 时的原生能力,以及 @capgo/capacitor-video-player 关于 @capgo/capacitor-video-player. 中的实现细节