Subsonic - SwiftUI音频播放库简化声音控制

Sitrep 标志

Subsonic 是一个小型库，它使在 SwiftUI 中播放音频变得更加容易，允许你以命令式（"立即播放这个声音"）和声明式（"当某个状态变为真时播放这个声音"）的方式工作。

Subsonic 适用于 iOS 14+、macOS 11+、tvOS 14+ 和 watchOS 7+。

为什么叫"subsonic"？因为它小到几乎难以察觉 ✨

安装

要在 SwiftPM 项目中使用 Subsonic，请在 Package.swift 文件的依赖项中添加以下行：

.package(url: "https://github.com/twostraws/Subsonic", from: "0.2.0"),

然后，你应该根据需要在 Swift 文件中添加 import Subsonic。

播放声音

根据你需要的控制程度，有四种使用 Subsonic 的方式。

方式 1：直接播放声音

如果你只是想播放包中的音频文件，可以在任何视图内调用 play(sound:)：

Button("播放声音") {
    play(sound: "example.mp3")
}

这将在你的主包中定位 example.mp3，然后立即播放它。如果你想从不同的包中加载文件，请参阅下面的选项。

方式 2：播放声音，但保持控制

如果你想播放声音的同时精确控制它的存在，可以创建一个包含 SubsonicPlayer 对象的 @StateObject 属性，如下所示：

struct ContentView: View {
    @StateObject private var sound = SubsonicPlayer(sound: "example.mp3")

    var body: some View {
        VStack {
            Button("开始") {
                sound.play()
            }

            Button("停止") {
                sound.stop()
            }

            Slider(value: $sound.volume)
        }
    }
}

使用这种方法，你可以根据需要播放和停止音频，调整音量、重复次数等。

方式 3：将播放绑定到程序状态

如果你想根据程序的状态开始或停止播放声音，可以在 SwiftUI 视图上使用 sound() 修饰符，并将其绑定到你的状态：

struct ContentView: View {
    @State private var isPlaying = false

    var body: some View {
        Button {
            isPlaying.toggle()
        } label: {
            Image(systemName: isPlaying ? "speaker.wave.3" : "speaker")
        }
        .sound("example.mp3", isPlaying: $isPlaying)
    }
}

方式 4：自行管理

如果你想准备声音但不实际播放它，可以调用 prepare(sound:) 来获取一个 AVAudioPlayer，然后你可以根据需要操作和播放：

Button("播放声音") {
    let player = prepare(sound: "example.mp3")
    // 根据需要进行配置，然后在准备好时播放
}

重要提示： 你有责任存储 prepare(sound:) 返回的 player 对象，并在需要时播放它。如果你不存储返回的对象，它将立即被销毁，并且不会播放任何内容。

停止声音

一旦声音开始播放，停止它的方式取决于你如何播放它：

如果你使用了 play(sound:)，你可以使用 stop(sound: "example.mp3") 来停止所有 example.mp3 的实例，或使用 stopAllManagedSounds() 来停止所有使用 play(sound:) 播放的声音。
如果你创建了 SubsonicPlayer 的实例，你可以随时在它上面调用 stop()。
如果你使用 sound() 修饰符根据程序状态播放声音，那么同样的状态也负责停止声音。
如果你使用 prepare(sound:)，你需要自行负责播放和停止声音。

重要提示： 调用 stopAllManagedSounds() 不会影响不是使用 play(sound:) 创建的声音 - 这包括使用 SubsonicPlayer 创建的任何声音、使用 prepare(sound:) 创建的任何声音，以及使用 sound() 修饰符正在播放的任何声音。

选项

在使用 play(sound:) 和 sound() 修饰符时，你可以根据需要提供各种额外参数：

bundle 控制包含你的声音文件的包。默认为 Bundle.main。
volume 控制声音的相对大小，其中 0 是静音，1 是最大音量。默认为 1。
repeatCount 控制声音应重复的次数。设置为 0 表示播放一次，设置为 1 表示播放两次，依此类推，或使用 .continuous 无限重复声音。默认为 0。

sound() 修饰符还有一个额外选项 playMode，它控制声音在之前停止后恢复播放时会发生什么。默认设置为 .reset，这意味着当声音恢复播放时，它将从头开始，但你可以使用 .continue 让声音从停止的地方继续播放。

使用 prepare(sound:) 时，你也可以传递自定义包，同样默认为 Bundle.main。

如果你使用 SubsonicPlayer，你可以在初始化器中设置包、音量、重复次数和播放模式，但后三个也是可以动态调整的变量属性。

致谢

如果你觉得 Subsonic 有用，你可能会发现我的网站上充满 Swift 教程同样有用：Hacking with Swift。