README

SoundCloud Custom Player as a jQuery plugin

This plugin allows you to create easily customizable, HTML/CSS/JS based audio players. It uses the official SoundCloud Flash widget for the audio streaming and widget API for it's control or native HTML5 streaming. Supports iPad, iPhone OS4, Palm Pre etc.

Getting started
The player setup is relatively easy:

Download the CSS and JS files for the sc-player here:
http://github.com/soundcloud/soundcloud-custom-player/archives/master

First, add the player css files in the 'head' tag of your page source:
<link rel="stylesheet" href="../css/sc-player-standard.css" type="text/css">
<link rel="stylesheet" href="../css/sc-player.css" type="text/css">

Then add the script tags at the end of your 'body' tag (in case you're already using jQuery on your site, skip the first script tag):
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
<script type="text/javascript" src="../js/soundcloud.player.api.js"></script>
<script type="text/javascript" src="../js/sc-player.js"></script>


And now let's create a player! Put this into you HTML code:
<a href="http://soundcloud.com/matas/hobnotropic" class="sc-player">My new dub track</a>

Now reload your page, and instead of the link you should see a cool new widget.

Note: when you're doing the test, please make sure you're running it on the local or remote web-server (http://localhost, 127.0.0.1/testpage, yoursite.com, etc.) Only so you can be sure that the Flash component will be initialized correctly and the track will actually play. If you're still experiencing problems, verify that the links to JS files are correct. Also make sure you're using an url of an existing track :)

Per default the player works in 'zero-config' mode. It means, you don't need to change or write any JavaScript to get a working player on your site. More advanced techniques are described in the documentation:
http://wiki.github.com/soundcloud/soundcloud-custom-player


The project is published under an MIT license:

Copyright (c) 2010 SoundCloud Ltd.

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.