swift-chunked-audio-player

1.0.3

Simple audio player for sync / async chunked audio streams
mihai8804858/swift-chunked-audio-player

What's New

1.0.3

2024-06-14T17:51:01Z

What's Changed

  • Add didStartPlaying and didFinishPlaying completions by @mikeg0184 in #6

New Contributors

Full Changelog: 1.0.2...1.0.3

ChunkedAudioPlayer

Simple audio player for sync / async chunked audio streams.

CI

Installation

You can add swift-chunked-audio-player to an Xcode project by adding it to your project as a package.

https://github.com/mihai8804858/swift-chunked-audio-player

If you want to use swift-chunked-audio-player in a SwiftPM project, it's as simple as adding it to your Package.swift:

dependencies: [
  .package(url: "https://github.com/mihai8804858/swift-chunked-audio-player", from: "1.0.0")
]

And then adding the product to any target that needs access to the library:

.product(name: "ChunkedAudioPlayer", package: "swift-chunked-audio-player"),

Overview

ChunkedAudioPlayer uses the following approach to stream real time audio:

Quick Start

  • Create an instance of AudioPlayer:
private let player = AudioPlayer()
  • Get the audio data stream (can be either AsyncThrowableStream or AnyPublisher):
let stream = AsyncThrowableStream<Data, Error> = ...
  • Start playing the audio stream:
// type parameter is optional, but recommended (if the stream type is known)
player.start(stream, type: kAudioFileMP3Type)
  • Listen for changes:
player.$state.sink { state in
  // handle player state
}.store(in: &bag)

player.$rate.sink { rate in
  // handle player rate
}.store(in: &bag)

player.$currentTime.sink { time in
  // handle player time
}.store(in: &bag)

player.$error.sink { error in
  if let error {
    // handle player error
  }
}.store(in: &bag)
  • Control playback:
// Pause current stream
player.pause()

// Resume current stream
player.resume()

// Stop current stream
player.stop()
  • SwiftUI Support

AudioPlayer conforms to ObservableObject so it can be easily integrated into SwiftUI View and automatically update the UI when properties change:

struct ContentView: View {
  @ObservedObject private var player = AudioPlayer()

  var body: some View {
    Text("State \(player.state)")
    Text("Rate \(player.rate)")
    Text("Time \(player.currentTime)")
    if let error = player.error {
        Text("Error \(error)")
    }
  }
}

License

This library is released under the MIT license. See LICENSE for details.

Description

  • Swift Tools 5.9.0
View More Packages from this Author

Dependencies

  • None
Last updated: Sun Dec 08 2024 04:50:27 GMT-1000 (Hawaii-Aleutian Standard Time)