A simple, style-able soundcloud widget for Apostrophe.
You must have a SoundCloud client id in order to use this module. To obtain a client id, log in to SoundCloud and register an "application" on this page. It doesn't take long.
Enable the module and configure your client id in
modules:apostrophe-soundcloud:clientId: 'xxxxxxxxxxxxxxx'// ...other modules
Now in a template, you can simply call the widget as an
You can also add it to the controls aray of an
aposArea to make it available in the "Add Content" menu
You can set a
multiPlay option that allows multiple soundcloud widgets to play on the page at once. This defaults to
false, making sure that when a user clicks "play" on a soundcloud widget, the soundcloud manager will stop the playback of any other soundcloud widgets on the page.
You can also pass a
displayOptions object to customize the display of your waveforms
sampleSizethe resolution of the waveform. The higher the number, the chunkier it gets.
innerColorthe fill color of the waveform before it has been interacted with.
loadedColorthe fill color of the part of waveform that has been loaded after play
playedColorthe fill color for the part of the waveform that has already been played
scrubberColorthe color of the bar that appears when your cursor hovers over a sound that is playing
modules:apostrophe-soundcloud:clientId: 'xxxxxxxxxxxxxxxxxxx'multiPlay: falsedisplayOptions:sampleSize: 1innerColor: 'rgba(255, 255, 255)'loadedColor: 'rgb(240, 240, 240)'playedColor: 'rgb(160, 160, 160)'scrubberColor: '#00ff00'
Instead of specifying site-wide
displayOptions, you can pass them directly into your widget. If you have configured
displayOptions in your
app.js, setting them in your singleton's options will extend what you have already set in