Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jessesquires/JSQSystemSoundPlayer
A fancy Obj-C wrapper for Cocoa System Sound Services
https://github.com/jessesquires/JSQSystemSoundPlayer
audio ios jsqsystemsoundplayer sound-services
Last synced: 4 months ago
JSON representation
A fancy Obj-C wrapper for Cocoa System Sound Services
- Host: GitHub
- URL: https://github.com/jessesquires/JSQSystemSoundPlayer
- Owner: jessesquires
- License: other
- Created: 2013-11-21T05:31:22.000Z (over 11 years ago)
- Default Branch: develop
- Last Pushed: 2022-10-09T18:55:06.000Z (over 2 years ago)
- Last Synced: 2024-05-22T15:31:35.206Z (9 months ago)
- Topics: audio, ios, jsqsystemsoundplayer, sound-services
- Language: Objective-C
- Homepage: https://jessesquires.github.io/JSQSystemSoundPlayer/
- Size: 1010 KB
- Stars: 581
- Watchers: 22
- Forks: 109
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- Awesome-iOS - JSQSystemSoundPlayer - A fancy Obj-C wrapper for Cocoa System Sound Services (Media)
README
# JSQSystemSoundPlayer
[](https://travis-ci.org/jessesquires/JSQSystemSoundPlayer) [][podLink] [][mitLink] [](https://codecov.io/gh/jessesquires/JSQSystemSoundPlayer) [][docsLink] [](https://github.com/Carthage/Carthage)
*A fancy Obj-C wrapper for Cocoa [System Sound Services](https://developer.apple.com/library/ios/documentation/AudioToolbox/Reference/SystemSoundServicesReference/Reference/reference.html), for iOS and OS X.*
## About
This library is a light-weight component to play sound effects in your app.
To determine your audio needs, see [Best Practices for iOS Audio](https://developer.apple.com/library/ios/DOCUMENTATION/AudioVideo/Conceptual/MultimediaPG/UsingAudio/UsingAudio.html#//apple_ref/doc/uid/TP40009767-CH2-SW10).
**tl;dr**
>*When your sole audio need is to play alerts and user-interface sound effects, use Core Audio’s System Sound Services.*
>
>Your sound files must be:
>
>* No longer than 30 seconds in duration
>* In linear PCM or IMA4 (IMA/ADPCM) format
>* Packaged in a `.caf`, `.aif`, or `.wav` file
If this does not fit your needs, then this library is not for you!
See [AVAudioPlayer](https://developer.apple.com/library/ios/DOCUMENTATION/AVFoundation/Reference/AVAudioPlayerClassReference/Reference/Reference.html), instead.
![screenshot ios][imgLinkiOS] ![screenshot osx][imgLinkOSX]
## Usage
```objc
JSQSystemSoundPlayer *sharedPlayer = [JSQSystemSoundPlayer sharedPlayer];
// Play a built-in sound
[sharedPlayer playSoundWithSoundID:1000 // new mail sound
asAlert:YES
completion:^{
NSLog(@"Sound finished playing. Executing completion block...");
}];
// Play a sound from a file
[sharedPlayer playSoundWithFilename:@"Basso"
fileExtension:kJSQSystemSoundTypeAIF
completion:^{
NSLog(@"Sound finished playing. Executing completion block...");
}];
```
## Features
* Play sound effects and alert sounds with a single line of code
* "Play" vibration (if available on device)
* Block-based completion handlers
* Integration with `NSUserDefaults` to globally toggle sound effects in your app
* Efficient memory management
* Caches sounds (`SystemSoundID` instances) and purges on memory warning
* Works with Swift!
## Requirements
* Xcode 9+
* iOS 9.0+
* tvOS 9.0+
* macOS 10.10+
## Installation
### [CocoaPods](https://cocoapods.org) (recommended)
````ruby
pod 'JSQSystemSoundPlayer'
````
### [Carthage](https://github.com/Carthage/Carthage)
````bash
github "jessesquires/JSQSystemSoundPlayer"
````
## Documentation
Read the [docs][docsLink]. Generated with [jazzy](https://github.com/realm/jazzy). Hosted by [GitHub Pages](https://pages.github.com).
#### Generate
````bash
$ ./build_docs.sh
````
#### Preview
````bash
$ open index.html -a Safari
````
## Contributing
Interested in making contributions to this project? Please review the guides below.
- [Contributing Guidelines](https://github.com/jessesquires/.github/blob/master/CONTRIBUTING.md)
- [Code of Conduct](https://github.com/jessesquires/.github/blob/master/CODE_OF_CONDUCT.md)
- [Support and Help](https://github.com/jessesquires/.github/blob/master/SUPPORT.md)
- [Security Policy](https://github.com/jessesquires/.github/blob/master/SECURITY.md)
Also, consider [sponsoring this project](https://www.jessesquires.com/sponsor/) or [buying my apps](https://www.hexedbits.com)! :v:
## Credits
Created and maintained by [**@jesse_squires**](https://twitter.com/jesse_squires).
## License
`JSQSystemSoundPlayer` is released under an [MIT License][mitLink]. See `LICENSE` for details.
>**Copyright © 2013-present Jesse Squires.**
*Please provide attribution, it is greatly appreciated.*
[docsLink]:https://jessesquires.github.io/JSQSystemSoundPlayer
[podLink]:https://cocoapods.org/pods/JSQSystemSoundPlayer
[mitLink]:https://opensource.org/licenses/MIT
[imgLinkiOS]:https://raw.githubusercontent.com/jessesquires/JSQSystemSoundPlayer/develop/Screenshots/ios.png
[imgLinkOSX]:https://raw.githubusercontent.com/jessesquires/JSQSystemSoundPlayer/develop/Screenshots/osx.png