Documented .destroy() method

qi-shun-wang · Feb 18, 2017 · 7f580a7 · 7f580a7
1 parent ae2f96a
commit 7f580a7
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/README.md b/README.md
@@ -72,6 +72,7 @@ A `JSMpeg.Player` instance supports the following methods and properties:
 - `.play()` – start playback
 - `.pause()` – pause playback
 - `.stop()` – stop playback and seek to the beginning
+- `.destroy()` – stops playback, disconnects the source and cleans up WebGL and WebAudio state. The player can not be used afterwards.
 - `.volume` – get or set the audio volume (0-1)
 - `.currentTime` – get or set the current playback position in seconds