{"id":13611263,"url":"https://github.com/jessesquires/JSQSystemSoundPlayer","last_synced_at":"2025-04-13T01:35:25.733Z","repository":{"id":12000286,"uuid":"14578734","full_name":"jessesquires/JSQSystemSoundPlayer","owner":"jessesquires","description":"A fancy Obj-C wrapper for Cocoa System Sound Services","archived":false,"fork":false,"pushed_at":"2022-10-09T18:55:06.000Z","size":1033,"stargazers_count":581,"open_issues_count":6,"forks_count":109,"subscribers_count":22,"default_branch":"develop","last_synced_at":"2024-05-22T15:31:35.206Z","etag":null,"topics":["audio","ios","jsqsystemsoundplayer","sound-services"],"latest_commit_sha":null,"homepage":"https://jessesquires.github.io/JSQSystemSoundPlayer/","language":"Objective-C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jessesquires.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-11-21T05:31:22.000Z","updated_at":"2024-05-10T10:31:24.000Z","dependencies_parsed_at":"2022-09-01T14:51:48.252Z","dependency_job_id":null,"html_url":"https://github.com/jessesquires/JSQSystemSoundPlayer","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jessesquires%2FJSQSystemSoundPlayer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jessesquires%2FJSQSystemSoundPlayer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jessesquires%2FJSQSystemSoundPlayer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jessesquires%2FJSQSystemSoundPlayer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jessesquires","download_url":"https://codeload.github.com/jessesquires/JSQSystemSoundPlayer/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223430340,"owners_count":17143624,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["audio","ios","jsqsystemsoundplayer","sound-services"],"created_at":"2024-08-01T19:01:53.451Z","updated_at":"2024-11-07T17:31:47.415Z","avatar_url":"https://github.com/jessesquires.png","language":"Objective-C","readme":"# JSQSystemSoundPlayer\n\n[![Build Status](https://secure.travis-ci.org/jessesquires/JSQSystemSoundPlayer.svg)](https://travis-ci.org/jessesquires/JSQSystemSoundPlayer) [![Version Status](https://img.shields.io/cocoapods/v/JSQSystemSoundPlayer.svg)][podLink] [![license MIT](https://img.shields.io/cocoapods/l/JSQSystemSoundPlayer.svg)][mitLink] [![codecov](https://codecov.io/gh/jessesquires/JSQSystemSoundPlayer/branch/develop/graph/badge.svg)](https://codecov.io/gh/jessesquires/JSQSystemSoundPlayer) [![Platform](https://img.shields.io/cocoapods/p/JSQSystemSoundPlayer.svg)][docsLink] [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)\n\n*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.*\n\n## About\n\nThis library is a light-weight component to play sound effects in your app.\nTo 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).\n\n**tl;dr**\n\u003e*When your sole audio need is to play alerts and user-interface sound effects, use Core Audio’s System Sound Services.*\n\u003e\n\u003eYour sound files must be:\n\u003e\n\u003e* No longer than 30 seconds in duration\n\u003e* In linear PCM or IMA4 (IMA/ADPCM) format\n\u003e* Packaged in a `.caf`, `.aif`, or `.wav` file\n\nIf this does not fit your needs, then this library is not for you!\nSee [AVAudioPlayer](https://developer.apple.com/library/ios/DOCUMENTATION/AVFoundation/Reference/AVAudioPlayerClassReference/Reference/Reference.html), instead.\n\n![screenshot ios][imgLinkiOS] \u0026nbsp;\u0026nbsp;\u0026nbsp; ![screenshot osx][imgLinkOSX]\n\n## Usage\n\n```objc\nJSQSystemSoundPlayer *sharedPlayer = [JSQSystemSoundPlayer sharedPlayer];\n\n// Play a built-in sound\n[sharedPlayer playSoundWithSoundID:1000 // new mail sound\n                           asAlert:YES\n                        completion:^{\n                            NSLog(@\"Sound finished playing. Executing completion block...\");\n                        }];\n\n// Play a sound from a file\n[sharedPlayer playSoundWithFilename:@\"Basso\"\n                      fileExtension:kJSQSystemSoundTypeAIF\n                         completion:^{\n                             NSLog(@\"Sound finished playing. Executing completion block...\");\n                         }];\n```\n\n## Features\n\n* Play sound effects and alert sounds with a single line of code\n* \"Play\" vibration (if available on device)\n* Block-based completion handlers\n* Integration with `NSUserDefaults` to globally toggle sound effects in your app\n* Efficient memory management\n* Caches sounds (`SystemSoundID` instances) and purges on memory warning\n* Works with Swift!\n\n## Requirements\n\n* Xcode 9+\n* iOS 9.0+\n* tvOS 9.0+\n* macOS 10.10+\n\n## Installation\n\n### [CocoaPods](https://cocoapods.org) (recommended)\n\n````ruby\npod 'JSQSystemSoundPlayer'\n````\n\n### [Carthage](https://github.com/Carthage/Carthage)\n\n````bash\ngithub \"jessesquires/JSQSystemSoundPlayer\"\n````\n\n## Documentation\n\nRead the [docs][docsLink]. Generated with [jazzy](https://github.com/realm/jazzy). Hosted by [GitHub Pages](https://pages.github.com).\n\n#### Generate\n\n````bash\n$ ./build_docs.sh\n````\n\n#### Preview\n\n````bash\n$ open index.html -a Safari\n````\n\n## Contributing\n\nInterested in making contributions to this project? Please review the guides below.\n\n- [Contributing Guidelines](https://github.com/jessesquires/.github/blob/master/CONTRIBUTING.md)\n- [Code of Conduct](https://github.com/jessesquires/.github/blob/master/CODE_OF_CONDUCT.md)\n- [Support and Help](https://github.com/jessesquires/.github/blob/master/SUPPORT.md)\n- [Security Policy](https://github.com/jessesquires/.github/blob/master/SECURITY.md)\n\nAlso, consider [sponsoring this project](https://www.jessesquires.com/sponsor/) or [buying my apps](https://www.hexedbits.com)! :v:\n\n## Credits\n\nCreated and maintained by [**@jesse_squires**](https://twitter.com/jesse_squires).\n\n## License\n\n`JSQSystemSoundPlayer` is released under an [MIT License][mitLink]. See `LICENSE` for details.\n\n\u003e**Copyright \u0026copy; 2013-present Jesse Squires.**\n\n*Please provide attribution, it is greatly appreciated.*\n\n[docsLink]:https://jessesquires.github.io/JSQSystemSoundPlayer\n[podLink]:https://cocoapods.org/pods/JSQSystemSoundPlayer\n[mitLink]:https://opensource.org/licenses/MIT\n[imgLinkiOS]:https://raw.githubusercontent.com/jessesquires/JSQSystemSoundPlayer/develop/Screenshots/ios.png\n[imgLinkOSX]:https://raw.githubusercontent.com/jessesquires/JSQSystemSoundPlayer/develop/Screenshots/osx.png\n","funding_links":[],"categories":["Objective-C","Media"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjessesquires%2FJSQSystemSoundPlayer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjessesquires%2FJSQSystemSoundPlayer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjessesquires%2FJSQSystemSoundPlayer/lists"}