soundcloud-badge

1.1.0 • Public • Published

soundcloud-badge experimental

A SoundCloud "now playing"-type thing that you can drop into browserify demos. Makes it easy to stream from SoundCloud and ensure you're giving the appropriate credit too.

soundcloud-badge

Usage

require('soundcloud-badge')({
    client_id: 'your API client ID'
  , song: 'https://soundcloud.com/dylan_king/modern-housing'
  , dark: true
  , getFonts: true
}, function(err, src, data, div) {
  if (err) throw err
 
  // Play the song on
  // a modern browser
  var audio = new Audio
  audio.src = src
  audio.play()
 
  // Metadata related to the song
  // retrieved by the API.
  console.log(data)
})

Just call soundcloud-badge, these options should do these things:

  • client_id: your SoundCloud API client ID.
  • song: the SoundCloud URL for your song: using soundcloud-resolve you'll get the matching data for your song included.
  • dark: true for black text/icons, and false for white. Defaults to true.
  • getFonts: by default, the badge will pull in fonts from Google Fonts. Set this to false if you'd rather it not do that.

Package Sidebar

Install

npm i soundcloud-badge

Weekly Downloads

5

Version

1.1.0

License

MIT

Last publish

Collaborators

  • hughsk