Release 2.6.0

Example/SwiftAudioPlayer/ViewController.swift

@@ -244,7 +244,7 @@ class ViewController: UIViewController {
                         self.currentUrlLocationLabel.text = "saved to: \(url.lastPathComponent)"
                         self.savedUrls[self.selectedAudio] = url
                         
-                        SAPlayer.shared.initializeSavedAudio(withSavedUrl: url)
+                        SAPlayer.shared.startSavedAudio(withSavedUrl: url)
                     }
                 })
                 streamButton.isEnabled = false
@@ -259,7 +259,7 @@ class ViewController: UIViewController {
     
     @IBAction func streamTouched(_ sender: Any) {
         if !isStreaming {
-            SAPlayer.shared.initializeRemoteAudio(withRemoteUrl: selectedAudio.url)
+            SAPlayer.shared.startRemoteAudio(withRemoteUrl: selectedAudio.url)
             streamButton.setTitle("Cancel streaming", for: .normal)
             downloadButton.isEnabled = false
         } else {

README.md

@@ -39,7 +39,7 @@ pod 'SwiftAudioPlayer'
 To play remote audio:
 ```swift
 let url = URL(string: "https://randomwebsite.com/audio.mp3")!
-SAPlayer.shared.initializeAudio(withRemoteUrl: url)
+SAPlayer.shared.startRemoteAudio(withRemoteUrl: url)
 SAPlayer.shared.play()
 ```
 
@@ -121,8 +121,8 @@ Access the player and all of its fields and functions through `SAPlayer.shared`.
 ### Playing Audio (Basic Commands)
 
 To set up player with audio to play, use either: 
-* `initializeSavedAudio(withSavedUrl url: URL, mediaInfo: SALockScreenInfo?)` to play audio that is saved on the device.
-* `initializeRemoteAudio(withRemoteUrl url: URL, mediaInfo: SALockScreenInfo?)` to play audio streamed from a remote location.
+* `startSavedAudio(withSavedUrl url: URL, mediaInfo: SALockScreenInfo?)` to play audio that is saved on the device.
+* `startRemoteAudio(withRemoteUrl url: URL, mediaInfo: SALockScreenInfo?)` to play audio streamed from a remote location.
 
 Both of these expect a URL of the location of the audio and an optional media information to display on the lockscreen. 
 

Source/SAPlayer.swift

@@ -198,21 +198,27 @@ public class SAPlayer {
 //MARK: - External Player Controls
 extension SAPlayer {
     /**
-     Toggles between the play and pause state of the player if the player is not buffering (thus is playable).
+     Toggles between the play and pause state of the player. If nothing is playable (aka still in buffering state or no audio is initialized) no action will be taken. Please call `startSavedAudio` or `startRemoteAudio` to set up the player with audio before this.
+     
+     - Note: If you are streaming, wait till the status from `SAPlayer.Updates.PlayingStatus` is not `.buffering`.
      */
     public func togglePlayAndPause() {
         presenter.handleTogglePlayingAndPausing()
     }
     
     /**
-     Attempts to play the player even if nothing playable is loaded (aka still in buffering state or no audio is initialized).
+     Attempts to play the player. If nothing is playable (aka still in buffering state or no audio is initialized) no action will be taken. Please call `startSavedAudio` or `startRemoteAudio` to set up the player with audio before this.
+     
+     - Note: If you are streaming, wait till the status from `SAPlayer.Updates.PlayingStatus` is not `.buffering`.
      */
     public func play() {
         presenter.handlePlay()
     }
     
     /**
-     Attempts to pause the player even if nothing playable is loaded (aka still in buffering state or no audio is initialized).
+     Attempts to pause the player. If nothing is playable (aka still in buffering state or no audio is initialized) no action will be taken. Please call `startSavedAudio` or `startRemoteAudio` to set up the player with audio before this.
+     
+     - Note:If you are streaming, wait till the status from `SAPlayer.Updates.PlayingStatus` is not `.buffering`.
      */
     public func pause() {
         presenter.handlePause()
@@ -264,13 +270,19 @@ extension SAPlayer {
      - Parameter withSavedUrl: The URL of the audio saved on the device.
      - Parameter mediaInfo: The media information of the audio to show on the lockscreen media player (optional).
      */
+    public func startSavedAudio(withSavedUrl url: URL, mediaInfo: SALockScreenInfo? = nil) {
+        self.mediaInfo = mediaInfo
+        presenter.handlePlaySavedAudio(withSavedUrl: url)
+    }
+    
+    @available(*, deprecated, renamed: "startSavedAudio")
     public func initializeSavedAudio(withSavedUrl url: URL, mediaInfo: SALockScreenInfo? = nil) {
         self.mediaInfo = mediaInfo
         presenter.handlePlaySavedAudio(withSavedUrl: url)
     }
     
     /**
-     Sets up player to play audio that will be streamed from a remote location.
+     Sets up player to play audio that will be streamed from a remote location. After this is called, it will connect to the server and start to receive and process data. The player is not playable the SAAudioAvailabilityRange notifies that player is ready for playing (you can subscribe to these updates through `SAPlayer.Updates.StreamingBuffer`). You can alternatively see when the player is available to play by subscribing to `SAPlayer.Updates.PlayingStatus` and waiting for a status that isn't `.buffering`.
      
      - Important: If intending to use [AVAudioUnit](https://developer.apple.com/documentation/avfoundation/audio_track_engineering/audio_engine_building_blocks/audio_enhancements) audio modifiers during playback, the list of audio modifiers under `SAPlayer.shared.audioModifiers` must be finalized before calling this function. After all realtime audio manipulations within the this will be effective.
      
@@ -279,6 +291,12 @@ extension SAPlayer {
      - Parameter withRemoteUrl: The URL of the remote audio.
      - Parameter mediaInfo: The media information of the audio to show on the lockscreen media player (optional).
      */
+    public func startRemoteAudio(withRemoteUrl url: URL, mediaInfo: SALockScreenInfo? = nil) {
+        self.mediaInfo = mediaInfo
+        presenter.handlePlayStreamedAudio(withRemoteUrl: url)
+    }
+    
+    @available(*, deprecated, renamed: "startRemoteAudio")
     public func initializeRemoteAudio(withRemoteUrl url: URL, mediaInfo: SALockScreenInfo? = nil) {
         self.mediaInfo = mediaInfo
         presenter.handlePlayStreamedAudio(withRemoteUrl: url)

Source/SAPlayerUpdateSubscription.swift

@@ -66,12 +66,16 @@ extension SAPlayer {
         
         /**
          Updates to changes in the duration of the current initialized audio. Especially helpful for audio that is being streamed and can change with more data.
+         
+         - Note: If you are streaming from a source that does not have an expected size at the beginning of a stream, such as live streams, duration will be constantly updating to best known value at the time (which is the seconds buffered currently and not necessarily the actual total duration of audio).
          */
         public struct Duration {
             
             /**
              Subscribe to updates to changes in duration of the current audio initialized.
              
+             - Note: If you are streaming from a source that does not have an expected size at the beginning of a stream, such as live streams, duration will be constantly updating to best known value at the time (which is the seconds buffered currently and not necessarily the actual total duration of audio).
+             
              - Note: It's recommended to have a weak reference to a class that uses this function
              
              - Parameter closure: The closure that will receive the updates of the changes in duration.
@@ -136,6 +140,8 @@ extension SAPlayer {
             /**
              Subscribe to updates to changes in the progress of downloading audio for streaming. Information about range of audio available and if the audio is playable. Look at SAAudioAvailabilityRange for more information. For progress of downloading audio that saves to the phone for playback later, look at AudioDownloading instead.
              
+             - Note: For live streams that don't have an expected audio length from the beginning of the stream; the duration is constantly changing and equal to the total seconds buffered from the SAAudioAvailabilityRange.
+             
              - Note: It's recommended to have a weak reference to a class that uses this function
              
              - Parameter closure: The closure that will receive the updates of the changes in duration.
@@ -172,7 +178,7 @@ extension SAPlayer {
              
              - Parameter closure: The closure that will receive the updates of the changes in duration.
              - Parameter url: The corresponding remote URL for the updated download progress.
-             - Parameter progress: Value from 0.0 to 1.0 indicating progress of download. This is unreliable for live streams that don't have an expected audio length from the beginning of the stream; in that case it will always be 1.0.
+             - Parameter progress: Value from 0.0 to 1.0 indicating progress of download.
              - Returns: the id for the subscription in the case you would like to unsubscribe to updates for the closure.
              */
             public static func subscribe(_ closure: @escaping (_ url: URL, _ progress: Double) -> ()) -> UInt {

SwiftAudioPlayer.podspec

@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = 'SwiftAudioPlayer'
-  s.version          = '2.5.1'
+  s.version          = '2.6.0'
   s.summary          = 'SwiftAudioPlayer is a Swift based audio player that can handle streaming from a remote location and audio manipulation.'
 
 # This description is used to generate tags and improve search results.