Merge pull request #2231 from bomoko/Documentation/Add_p5_MediaElement_play_example

Added example for p5.MediaElement.play

Author: lmccart

lib/addons/p5.dom.js

@@ -1818,10 +1818,44 @@
 
 
   /**
-   * Play an HTML5 media element.
+   *  Play an HTML5 media element.
    *
-   * @method play
-   * @return {Object|p5.Element}
+   *  @method play
+   *  @return {Object|p5.Element}
+   *  @example
+   *  <div><code>
+   *  var ele;
+   *
+   *  function setup() {
+   *    //p5.MediaElement objects are usually created
+   *    //by calling the createAudio(), createVideo(),
+   *    //and createCapture() functions.
+   *
+   *    //In this example we create
+   *    //a new p5.MediaElement via createAudio().
+   *    ele = createAudio('assets/beat.mp3');
+   *
+   *    background(250);
+   *    textAlign(CENTER);
+   *    text("Click to Play!", width/2, height/2);
+   *  }
+   *
+   *  function mouseClicked() {
+   *    //here we test if the mouse is over the
+   *    //canvas element when it's clicked
+   *    if(mouseX >= 0 && mouseX <= width &&
+   *      mouseY >= 0 && mouseY <= height) {
+   *
+   *      //Here we call the play() function on
+   *      //the p5.MediaElement we created above.
+   *      //This will start the audio sample.
+   *      ele.play();
+   *
+   *      background(200);
+   *      text("You clicked Play!", width/2, height/2);
+   *    }
+   *  }
+   *  </code></div>
    */
   p5.MediaElement.prototype.play = function() {
     if (this.elt.currentTime === this.elt.duration) {