Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

[#1115] Added docs for soundcloud player

  • Loading branch information...
commit 140d43238ee57f272931e3582412e904e6147112 1 parent 5b605b0
@dseif dseif authored
Showing with 41 additions and 0 deletions.
  1. +41 −0 players/_posts/2012-12-12-soundcloud.md
View
41 players/_posts/2012-12-12-soundcloud.md
@@ -0,0 +1,41 @@
+---
+title: soundcloud
+---
+# soundcloud( id, url ) #
+
+## Purpose ##
+
+The SoundCloud player allows the use of any SoundCloud audio tracks with the Popcorn.js framework.
+
+The SoundCloud player plugin allows for the use of all functions and properties that it inherits from the [baseplayer](#baseplayer) ( play, pause, volume, mute, etc ). This means that once created, your SoundCloud instance of Popcorn will work normally like any other Popcorn instance.
+
+## Options ##
+
+* **id** \[String\] - the id of the HTML element that the SoundCloud player will populate
+* **url** \[String\] - the url of the SoundCloud audio track you wish to use
+
+* Note - Currently SoundCloud does not support all of the events that the HTML5 media elements do, view the [full list of events](/popcorn-docs/events/) for more details
+
+## Examples ##
+
+{% highlight js linenos %}
+ var pop = Popcorn.soundcloud( "#video", "http://soundcloud.com/lilleput/popcorn" );
+
+ pop.footnote({
+ start: 1,
+ end: 5,
+ text: "Works with SoundCloud!",
+ target: "footnote-div"
+ });
+
+ pop.play();
+{% endhighlight %}
+
+[Live demo of the SoundCloud player](http://jsfiddle.net/popcornjs/7Ku6T/)
+
+## Related ##
+
+* [baseplayer](#baseplayer)
+* [Popcorn Constructor](/popcorn-docs/popcorn-constructor/)
+* [Vimeo](#vimeo)
+* [YouTube](#youtube)
Please sign in to comment.
Something went wrong with that request. Please try again.