Add badge for Carthage compatibility
This commit is contained in:
@@ -3,6 +3,7 @@
|
||||
[](https://cocoapods.org/pods/SwiftAudioPlayer)
|
||||
[](https://cocoapods.org/pods/SwiftAudioPlayer)
|
||||
[](https://cocoapods.org/pods/SwiftAudioPlayer)
|
||||
[](https://github.com/Carthage/Carthage)
|
||||
|
||||
Swift-based audio player with AVAudioEngine as its base. Allows for: streaming online audio, playing local file, changing audio speed (3.5X, 4X, 32X), pitch, and real-time audio manipulation using custom [audio enhancements](https://developer.apple.com/documentation/avfoundation/audio_track_engineering/audio_engine_building_blocks/audio_enhancements).
|
||||
|
||||
@@ -77,7 +78,7 @@ To receive streaming progress (for buffer progress %):
|
||||
|
||||
override func viewDidLoad() {
|
||||
super.viewDidLoad()
|
||||
|
||||
|
||||
_ = SAPlayer.Updates.StreamingBuffer.subscribe{ [weak self] buffer in
|
||||
guard let self = self else { return }
|
||||
|
||||
@@ -137,7 +138,7 @@ Known supported file types are `.mp3` and `.wav`.
|
||||
|
||||
### Playing Audio (Basic Commands)
|
||||
|
||||
To set up player with audio to play, use either:
|
||||
To set up player with audio to play, use either:
|
||||
* `startSavedAudio(withSavedUrl url: URL, mediaInfo: SALockScreenInfo?)` to play audio that is saved on the device.
|
||||
* `startRemoteAudio(withRemoteUrl url: URL, bitrate: SAPlayerBitrate, mediaInfo: SALockScreenInfo?)` to play audio streamed from a remote location.
|
||||
|
||||
@@ -157,7 +158,7 @@ skipBackwards()
|
||||
|
||||
### Queuing Audio for Autoplay
|
||||
|
||||
You can queue either remote or locally saved audio to be played automatically next.
|
||||
You can queue either remote or locally saved audio to be played automatically next.
|
||||
|
||||
To queue:
|
||||
```swift
|
||||
@@ -172,8 +173,8 @@ You can also directly access and modify the queue from `SAPlayer.shared.audioQue
|
||||
The engine can handle audio manipulations like speed, pitch, effects, etc. To do this, nodes for effects must be finalized before initialize is called. Look at [audio manipulation documentation](#realtime-audio-manipulation) for more information.
|
||||
|
||||
### LockScreen Media Player
|
||||
|
||||
Update and set what displays on the lockscreen's media player when the player is active.
|
||||
|
||||
Update and set what displays on the lockscreen's media player when the player is active.
|
||||
|
||||
`skipForwardSeconds` and `skipBackwardSeconds` for the intervals to skip forward and back with.
|
||||
|
||||
@@ -266,7 +267,7 @@ func subscribe(_ closure: @escaping (_ payload: <Payload>) -> ()) -> UInt
|
||||
Sometimes there is:
|
||||
- `url`: The corresponding remote URL for the update. In the case there might be multiple files observed, such as downloading many files at once.
|
||||
|
||||
Similarily unsubscribe takes the form of:
|
||||
Similarily unsubscribe takes the form of:
|
||||
```swift
|
||||
func unsubscribe(_ id: UInt)
|
||||
```
|
||||
@@ -294,7 +295,7 @@ Changes in the playing status of the player. Can be one of the following 4: `pla
|
||||
### StreamingBuffer
|
||||
Payload = `SAAudioAvailabilityRange`
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user