Sound API 2

[hiroshihorie]

Conveniently prepare and play short audio clips locally and/or for remote participants.

// Prepare
let sound = try await SoundPlayer.shared.prepare(
    fileURL: fileURL,
    named: "sample01" // optional
)

// Playback
try await sound.play(
    options: SoundPlaybackOptions(
        mode: .concurrent,
        loop: false,
        destination: .localAndRemote
    )
)

// Stop / release
await sound.stop()
await sound.release()

Remote playback is best-effort and usually requires the microphone/WebRTC input path to be published.

Example: livekit-examples/swift-example#89

[github-actions]

⚠️ This PR does not contain any files in the .changes directory.

[pblazej]

There's no way to propagate the error atm, right?

[pblazej]

Have you considered an explicit lifecycle here (e.g. coupled with AudioManager, Room etc.)

[pblazej]

Nit: if this is a singleton, can leverage https://www.avanderlee.com/concurrency/global-actor/

[pblazej]

This probably should be called on deinit.

[pblazej]

I think this is more than enough for V1, good point about gradual evolution.

Trivia I'd address before merging:

• rename url to fileURL still (just self-documenting)
• auto-release session on handle's deinit
• adding globalActor

Follow-ups:

• playOnce addition (no hard feelings)?
• lazy pool
• caching converted audio

For me as a consumer the biggest confusion comes from the fact that .remote cannot be played without mic track - which is not clear just reading the APIs. I get the best-effort tradeoff, maybe we can escalate the log to .warning at least / or rename the enum more aggressively:

    public enum Destination: Sendable {
        case local
        case remoteIfAvailable // ?
        case localAndRemoteIfAvailable

that could be an OptionSet as well e.g.

  public struct Destination: OptionSet, Sendable {
      public static let local  = Destination(rawValue: 1 << 0)
      public static let remoteIfAvailable = Destination(rawValue: 1 << 1)
  }

you pass like this:

  options: .init(destination: [.local, .remoteIfAvailable])
  options: .init(destination: .local)

[hiroshihorie]

Thanks @pblazej , will work on a second pass of polishing this up.