ios-sdk

This codebase contains the MixRadio iOS SDK.

Version

0.9.5

Overview

The MixRadio iOS SDK lets you easily integrate your iOS app with MixRadio.

The SDK lets you perform searches, get charts and recommendations and user data such as play history within your app. You can link through to the MixRadio apps to give your users a full listening experience.

Installation

You need two things to start using the SDK:

1. The SDK itself - you can clone our source from GitHub or use CocoaPods, a dependency manager that automates and simplifies the process of using 3rd-party libraries in your projects. See the CocaPods Getting Started Guide and Usage Guide for more info.

   1.1 Download CocoaPods

   CocoaPods is distributed as a ruby gem, and is installed by running the following commands in Terminal:

   $ sudo gem install cocoapods
   $ pod setup
   

   1.2 Create a Podfile

   Dependencies managed by CocoaPods are specified in a file called Podfile. Create this file in the same directory as your Xcode project (.xcodeproj) file:

   $ touch Podfile
   $ open -a Xcode Podfile
   

   Copy and paste the following lines in:

   pod 'MixRadio'
   

   1.3 Install Dependencies

   Now you can install the dependencies in your project:

   $ pod install
   

   From now on, be sure to always open the generated Xcode workspace (.xcworkspace) instead of the project file when building your project.

2. Credentials - visit our API Registration page and request your credentials.

Quick Start

Impatient to get going? Head over to the Quick Start guide.

Source License

The MixRadio iOS SDK source code is released under the 3-clause license ("New BSD License" or "Modified BSD License") - see https://raw.github.com/mixradio/ios-sdk/master/LICENSE.txt.

Terms

Usage of the SDK is subject to the following terms: http://dev.mixrad.io/terms.html

Releases

• 0.9.5 Correction to mixRadioId type, enhanced BandsAround example
• 0.9.4 Fixes for user authentication and implementation for getUserPlayHistory
• 0.9.2 Initial release of SDK

Documentation

The documentation for this component is at http://dev.mixrad.io/doc/iossdk

Metadata Methods

Examples of the data you can get in your app:

• Search for content
• Get top artists
• Get charts
• Get new releases
• Get a list of genres
• Get albums and tracks by an artist
• Get artist recommendations
• Get a list of available mixes

User Data API Methods

Examples of user data you can access (provided the user authorises your app!):

• Read the user's play history
• Read the user's top artists
• Read the user's recent mixes

Contributing

If you want to contribute to the project, check out the Issues tab.

You can:

• Raise an issue
• Suggest a feature for the application

Feeling like writing some code? Why not take the next step:

• Fork the repository
• Make the changes to the codebase
• Send a pull request once you're happy with it

The team will then review the changes, discuss if anything needs to be addressed, and integrate your changes back into the application.

Feedback

If you have a suggestion, you can tell us about it on our MixRadio API UserVoice