sb

soundcloud-badge

A SoundCloud 'now-playing' badge you can just drop into browserify demos

Showing:

Popularity

Downloads/wk

0

GitHub Stars

31

Maintenance

Last Commit

6yrs ago

Contributors

1

Package

Dependencies

5

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

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.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial