Mirrors/webamp
1
0
Fork 0
mirror of https://github.com/captbaritone/webamp.git synced 2026-01-23 02:15:01 +00:00
Code Issues Projects Releases Wiki Activity

Add note about when methods were added in usage.md

Browse source
This commit is contained in:
Jordan Eldredge 2019-03-25 06:19:44 -07:00
parent c4282817db
commit 28f0f98eb1
1 changed files with 20 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/usage.md
View file

@ -191,6 +191,8 @@ webamp.setTracksToPlay([
Play the previous track.
**Since** 1.3.0
```JavaScript
webamp.previousTrack();
```
@ -199,6 +201,8 @@ webamp.previousTrack();
Play the next track.
**Since** 1.3.0
```JavaScript
webamp.nextTrack();
```
@ -207,6 +211,8 @@ webamp.nextTrack();
Seek forward n seconds in the current track.
**Since** 1.3.0
```JavaScript
webamp.seekForward(10);
```
@ -215,6 +221,8 @@ webamp.seekForward(10);
Seek backward n seconds in the current track.
**Since** 1.3.0
```JavaScript
webamp.seekBackward(10);
```
@ -223,6 +231,8 @@ webamp.seekBackward(10);
Seek to a given time within the current track.
**Since** Unreleased
```JavaScript
webamp.seekToTime(15.5);
```
@ -231,6 +241,8 @@ webamp.seekToTime(15.5);
Get the current "playing" status. The return value is one of: `"PLAYING"`, `"STOPPED"`, or `"PAUSED"`.
**Since** Unreleased
```JavaScript
const isPlaying = webamp.getMediaStatus() === "PLAYING";
```
@ -239,6 +251,8 @@ const isPlaying = webamp.getMediaStatus() === "PLAYING";
Pause the current track.
**Since** 1.3.0
```JavaScript
webamp.pause();
```
@ -247,6 +261,8 @@ webamp.pause();
Play the current track.
**Since** 1.3.0
```JavaScript
webamp.play();
```
@ -255,6 +271,8 @@ webamp.play();
Stop the currently playing audio. Equivilant to pressing the "stop" button.
**Since** unreleased
```JavaScript
webamp.stop();
```
@ -323,6 +341,8 @@ unsubscribe();
After `.close()`ing this instance, you can reopen it by calling this method.
**Since** 1.3.0
```JavaScript
const icon = document.getElementById('webamp-icon');