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

Document butterchurn entrypoint

Browse source
This commit is contained in:
Jordan Eldredge 2025-07-14 17:57:20 -07:00
parent 5e88d4e37b
commit a4dec85406
4 changed files with 9 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

9
examples/minimalMilkdrop/index.html
View file

@ -11,12 +11,11 @@
</div>
<script type="module">
/**
* Webamp includes a `webamp/butterchurn` entrypoint which includes the Butterchurn
* library to enable the Milkdrop visualizer. It hasn't been included in a
* stable version yet, until it is, you can use by installing
* `webamp@next`.
* Starting in version 2.2.0, Webamp includes a `webamp/butterchurn`
* entrypoint which includes the Butterchurn library to enable the
* Milkdrop visualizer.
*/
import Webamp from "https://unpkg.com/webamp@0.0.0-next-7cdc35b/butterchurn";
import Webamp from "https://unpkg.com/webamp@^2/butterchurn";
const webamp = new Webamp({
initialTracks: [
{

2
packages/webamp-docs/docs/05_features/02_mikdrop.md
View file

@ -2,7 +2,7 @@
Webamp uses [Butterchurn](https://butterchurnviz.com/) to provide a Milkdrop visualizer. Butterchurn is a JavaScript port of the original Milkdrop visualizer, and it can run in any modern web browser.
The [next release](../12_changelog.md#unreleased) of Webamp will includes a `webamp/butterchurn` entrypoint that includes Butterchurn, so you can use it to create a Webamp instance with Milkdrop visualizer enabled.
Starting with [v2.2.0](../12_changelog.md#220) Webamp includes a `webamp/butterchurn` entrypoint that includes Butterchurn, so you can use it to create a Webamp instance with Milkdrop visualizer enabled. See "Minimal Milkdrop" in [examples](../04_examples.md) for more details.
## Hotkeys

2
packages/webamp-docs/docs/06_API/02_webamp-constructor.md
View file

@ -239,7 +239,7 @@ const webamp = new Webamp({
### `enableMediaSession`
**Since** [Unreleased](../12_changelog.md#unreleased)
**Since** [v2.2.0](../12_changelog.md#220)
Have Webamp connect to the browser's [Media Session
API](https://developer.mozilla.org/en-US/docs/Web/API/Media_Session_API), if the browser supports it.

6
packages/webamp-docs/docs/06_API/03_instance-methods.md
View file

@ -110,7 +110,7 @@ Get the current "playing" status of the player. Similar to `getMediaStatus()`, b
The return value is one of: `"PLAYING"`, `"STOPPED"`, `"PAUSED"`, `"ENDED"`, or `"CLOSED"`.
**Since** [Unreleased](../12_changelog.md#unreleased)
**Since** [v2.2.0](../12_changelog.md#220)
```ts
const playerStatus = webamp.getPlayerMediaStatus();
@ -201,7 +201,7 @@ if (webamp.isShuffleEnabled()) {
Toggle shuffle mode between enabled and disabled.
**Since** [Unreleased](../12_changelog.md#unreleased)
**Since** [v2.2.0](../12_changelog.md#220)
```ts
webamp.toggleShuffle();
@ -223,7 +223,7 @@ if (webamp.isRepeatEnabled()) {
Toggle repeat mode between enabled and disabled.
**Since** [Unreleased](../12_changelog.md#unreleased)
**Since** [v2.2.0](../12_changelog.md#220)
```ts
webamp.toggleRepeat();