Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/tbaranes/AudioPlayerSwift

AudioPlayer is a simple class for playing audio in iOS, macOS and tvOS apps.
https://github.com/tbaranes/AudioPlayerSwift

Last synced: about 1 month ago
JSON representation

AudioPlayer is a simple class for playing audio in iOS, macOS and tvOS apps.

Lists

README 

        







# AudioPlayer



[![Travis](https://img.shields.io/travis/tbaranes/AudioPlayerSwift.svg)](https://travis-ci.org/tbaranes/AudioPlayerSwift)

![Language](https://img.shields.io/badge/language-Swift%205.0-orange.svg)

[![CocoaPods](https://img.shields.io/cocoapods/v/AudioPlayerSwift.svg?style=flat)](https://github.com/tbaranes/AudioPlayerSwift)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![Platform](https://img.shields.io/cocoapods/p/AudioPlayerSwift.svg?style=flat)](http://cocoadocs.org/docsets/AudioPlayerSwiftft)



AudioPlayer is a simple class for playing audio in iOS, macOS and tvOS apps.



## Usage



```swift

// Initialize

let audioPlayer = AudioPlayer("sound.mp3")



// Start playing

audioPlayer.play()



// Stop playing with a fade out

audioPlayer.fadeOut()

```



See the samples project to see advanced usage



## Installation



### CocoaPods



Add the following to your Podfile:



```

pod 'AudioPlayerSwift'

```



### Carthage



Add the following to your Cartfile:



```

github 'tbaranes/AudioPlayerSwift'

```



### Swift Package Manager



AudioPlayer is available on SPM. Just add the following to your Package file:



```swift

import PackageDescription



let package = Package(

    dependencies: [

        .Package(url: "https://github.com/tbaranes/AudioPlayerSwift.git", majorVersion: 1)

    ]

)

```



### Manual Installation



Just drag the `Source/*.swift` files into your project.



## AudioPlayer properties



```swift

name

```



The name of the sound. This is either the name that was passed to the `init`, or the last path component of the audio file.



```swift

url

```



The absolute URL of the audio file.



```swift

completionHandler

```



A callback closure that will be called when the audio finishes playing, or is stopped.



```swift

isPlaying

```



Is it playing or not?



```swift

duration

```



The duration of the sound.



```swift

currentTime

```



The current time offset into the sound of the current playback position.



```swift

volume

```



The volume for the sound. The nominal range is from 0.0 to 1.0.



```swift

numberOfLoops

```



Number of times that the sound will return to the beginning upon reaching the end.



- A value of zero means to play the sound just once.

- A value of one will result in playing the sound twice, and so on..

- Any negative number will loop indefinitely until stopped.

  

  

```swift

pan

```



The left/right stereo pan of the file. -1.0 is left, 0.0 is center, 1.0 is right.

 

## AudioPlayer methods



```swift

init(fileName: String) throws

init(contentsOfPath path: String) throws

init(contentsOf url: URL) throws

```



These methods create a new AudioPlayer instance from a file name or file path.



```swift

func play()

```



Plays the sound. Has no effect if the sound is already playing.



```swift

func stop()

```



Stops the sound. Has no effect if the sound is not already playing. 



```swift

func fadeTo(volume: Float, duration: TimeInterval = 1.0)

```



This method fades a sound from it's current volume to the specified volume over the specified time period. 



```swift

func fadeIn(duration: TimeInterval = 1.0)

```



Fades the sound volume from 0.0 to 1.0 over the specified duration. 



```swift

func fadeOut(duration: TimeInterval = 1.0)

```



Fades the sound from it's current volume to 0.0 over the specified duration. 



## Notifications



```swift

SoundDidFinishPlayingNotification

```



This notification is fired (via NSNotificationCenter) whenever a sound finishes playing, either due to it ending naturally, or because the stop method was called. The notification object is an instance of the AudioPlayer class. You can access the AudioPlayer class's `name` property to find out which sound has finished.



## What's next



- AudioPlayerManager

- Your features!



## Contribution



- If you found a **bug**, open an **issue**

- If you have a **feature request**, open an **issue**

- If you want to **contribute**, submit a **pull request**



## Licence



AudioPlayerSwift is available under the MIT license. See the LICENSE file for more info.