Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Official SoundCloud Javascript SDK

Adding RTMP support back to JavaScript SDK. Also introducing new build

process to avoid introducing backward-incompatible changes.

RTMP support is available as of sdk-2.0.0.js. The new build process will
produce minified JavaScript builds with the version number included. This
change will not effect users of sdk.js.
latest commit 260e921708
Paul Osman paulosman authored December 04, 2013
Octocat-spinner-32 bin path.exists is now called fs.exists July 12, 2013
Octocat-spinner-32 examples Cleanup trailing whitespace July 12, 2013
Octocat-spinner-32 releases Adding RTMP support back to JavaScript SDK. Also introducing new build December 04, 2013
Octocat-spinner-32 src Adding RTMP support back to JavaScript SDK. Also introducing new build December 04, 2013
Octocat-spinner-32 test Backing out changes that break backwards compatibility. November 28, 2013
Octocat-spinner-32 vendor Adding RTMP support back to JavaScript SDK. Also introducing new build December 04, 2013
Octocat-spinner-32 .gitignore Add pkgignore November 25, 2013
Octocat-spinner-32 .gitmodules updating vendor/dialogs April 27, 2012
Octocat-spinner-32 .pkgignore Add pkgignore November 25, 2013
Octocat-spinner-32 LICENSE adding MIT license March 30, 2012
Octocat-spinner-32 Makefile Adding RTMP support back to JavaScript SDK. Also introducing new build December 04, 2013
Octocat-spinner-32 Procfile Fix caching settings January 02, 2013
Octocat-spinner-32 README.md README: minor improvements March 18, 2013
Octocat-spinner-32 package.json Specify uglify-js version. Newer version is 404'ing November 28, 2013
Octocat-spinner-32 sdk.js Fix indentation July 24, 2013
README.md

SoundCloud JavaScript SDK

Introduction

The SoundCloud JavaScript SDK lets you easily integrate SoundCloud into your website or web app.

In most cases it's highly recommended that you use the hosted version from http://connect.soundcloud.com/sdk.js in your website. This README provides development-related information.

Dependencies

  • npm
  • - coffee-script
  • - uglify-js
  • - jslint

Development

To check out the repository locally and initialize all submodules in vendor/, run:

$ git clone git@github.com:soundcloud/soundcloud-javascript.git
$ cd soundcloud-javascript
$ git submodule update --init
$ npm install

To build the release version in build/, just run:

$ make build

To run the tests or use sdk.js, run this from either the top level of your repo or build/:

$ bin/server

The file sdk.js will automatically compile all coffeescript files in src/ on the fly when loaded. For sdk.js to work it must be accessed from http://connect.soundcloud.dev instead of http://localhost:9090.

Testing

To run the tests, just start an HTTP server in the project root and navigate to http://yourhost/test/test.html. In development mode the tests will automatically compile the coffeescript on each reload. In build mode the tests will laod the compiled sdk.js.

Repository Structure

  • build/ — contains compiled JS (as it's hosted on http://connect.soundcloud.com)
  • src/ — contains coffeescript source code
  • vendor/ — includes git submodules of external projects
  • test/ — tests live here
  • examples/ — here there be examples
Something went wrong with that request. Please try again.