This framework is a wrapper for Spotify Web API. It has been designed and implemented to facilitate the usage of Web API. Spotify iOS Metadata Framework is implemented in Objective-C and allows making Web API requests and storing the received data conveniently in a manner that is comfortable for a developer of iOS mobile applications.
Open bug tickets | Open feature requests | All
For known issues and release notes, see the CHANGELOG.md file.
The Spotify iOS Metadata framework requires a deployment target of iOS 7 or higher. The
following architectures are supported: armv7, armv7s and arm64 for devices,
and i386 and x86_64 for the iOS Simulator. The i386 and x86_64 slices
cannot be used to build Mac applications.
Spotify Developer Portal | Web API Reference
Getting the Spotify iOS Metadata framework into your application is easy:
- Add the library
SpotifyMetadata.frameworkto your Xcode project. - Add the
-ObjCflag to your project'sOther Linker Flagsbuild setting. - Import the umbrella header
<SpotifyMetadata/SpotifyMetadata.h>from the framework into your source files.
After that you are ready to develop your application.
The library headers are extensively documented, and they come with an Xcode documentation set which can be indexed by Xcode itself and applications like Dash.
You can also generate Appledoc documentation for the framework in following way:
- Download AppleDoc tool and put it in the "tools" folder next to "AppledocSettings.plist" file. If you put AppleDoc folder in some other folder, update
--templatesfield in the AppledocSettings.plist" file. You should use AppleDoc ver. 2.2 (build 963) in order to be able to generate the documentation using existing settings and documentation style. - Run the following command from the main folder to generate documentation (update this command paths if you are running it from other folder or you have changed the location of the Appledoc tool, "AppledocSettings.plist" file or the Spotify Metadata framework)
"./tools/appledoc/appledoc" -o . "./AppledocSettings.plist" "./Spotify Metadata/src"
- Move the documentation from the folder in which it was generated to the docs folder in the main folder. The former location is determined by values of the variables
--docset-install-pathand--docset-bundle-filename. By default, it will be the folder "Spotify iOS Metadata.docset" in the same folder in which you executed the previous command.
mv "./Spotify iOS Metadata.docset/Contents/Resources/Documents" "./docs"
- Metadata classes contain methods for doing corresponding metadata lookup.
SPTUseris for userinfo,SPTSearchfor searching.
You can generate your application's Client ID, Client Secret and define your callback URIs at the My Applications section of the Spotify Developer Website. To use that functionality, use Spotify iOS Authentication framework, which is currently a part of the Spotify iOS SDK
When connecting a user to your app, you must provide the scopes your application needs to operate. A scope is a permission to access a certain part of a user's account, and if you don't ask for the scopes you need you will receive "permission denied" errors when trying to perform various tasks.
You do not need a scope to access non-user specific information, such as to perform searches, look up metadata, etc. A full list of scopes can be found on Scopes section of the Spotify Developer Website.
If your application's scope needs to change after a user is connected to your app, you will need to throw out your stored credentials and re-authenticate the user with the new scopes.
Important: Only ask for the scopes your application needs. Requesting playlist access when your app doesn't use playlists, for example, is bad form.
You are welcome to contribute to this project. Please make sure that:
- New code is covered with tests
- Features and APIs are well documented
- Bitcode support remains enabled
This project adheres to the Open Code of Conduct. By participating, you are expected to honor this code.