@videojs/html 10.0.0-beta.30 → 10.0.0-beta.31

package/docs/reference/spotify-audio.md

@@ -0,0 +1,394 @@
+# spotify-audio
+
+Audio component that plays Spotify tracks, episodes, playlists, and shows through the Spotify embed
+
+Audio component that plays Spotify content through the [Spotify embed](https://developer.spotify.com/documentation/embeds): tracks, episodes, albums, playlists, shows, and artists. Podcast episodes play in full for signed-out listeners; music plays as a preview until the listener logs in to Spotify.
+
+## Load a source
+
+`src` takes an `open.spotify.com` URL for any embeddable entity, including the localized (`/intl-de/`) and already-embedded (`/embed/`) forms, or a `spotify:<type>:<id>` URI. A `t` parameter sets the start position in seconds.
+
+html
+
+```
+<spotify-audio src="https://open.spotify.com/episode/7makk4oTQel546B0PZlDM5" controls></spotify-audio>
+```
+
+## Controls
+
+Spotify’s own chrome is the only UI the embed offers, so `controls` decides whether the element is visible at all. With `controls`, it shows Spotify’s player. Without it, the element hides itself and plays as an invisible transport: a hidden iframe still loads and plays, so a [player skin](../concepts/skins.md)’s buttons drive playback while the embed takes no room on the page.
+
+## Behavior
+
+The Spotify embed exposes less than a native `<audio>` element:
+
+*   No volume and no mute: the embed takes neither command and reports neither value, so a player skin shows no volume controls at all.
+*   No playback rate and no text tracks.
+*   `loop` replays the entity from the top when it ends; without it, the embed continues into whatever Spotify queues next.
+
+## Examples
+
+### Basic Usage
+
+index.html
+
+index.css
+
+index.ts
+
+```
+<spotify-audio
+    class="spotify-audio"
+    src="https://open.spotify.com/episode/7makk4oTQel546B0PZlDM5"
+    controls
+></spotify-audio>
+```
+```
+.spotify-audio {
+  width: 100%;
+  height: 152px;
+}
+```
+```
+import '@videojs/html/media/spotify-audio';
+```
+
+## API Reference
+
+### Attributes
+
+These attributes configure the embedded media adapter:
+
+Attribute
+
+Type
+
+Default
+
+Details
+
+`autoplay`
+
+`boolean`
+
+`—`
+
+`controls`
+
+`boolean`
+
+`—`
+
+`loop`
+
+`boolean`
+
+`—`
+
+`playsinline`
+
+`boolean`
+
+`—`
+
+`poster`
+
+`string`
+
+`—`
+
+`preload`
+
+`MediaPreloadType`
+
+`—`
+
+`src`
+
+`string`
+
+`—`
+
+### Properties
+
+Property
+
+Type
+
+Default
+
+Details
+
+`autoplay`
+
+`boolean`
+
+`—`
+
+`buffered`
+
+`TimeRangeLike`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`controls`
+
+`boolean`
+
+`—`
+
+`currentSrc`
+
+`string`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`currentTime`
+
+`number`
+
+`—`
+
+`duration`
+
+`number`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`ended`
+
+`boolean`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`engine`
+
+`SpotifyControllerApi | null`
+
+`—`
+
+▸
+
+Description
+
+Read-only. Underlying Spotify iframe API controller (null until the API loads).
+
+`error`
+
+`MediaError | null`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`loop`
+
+`boolean`
+
+`—`
+
+`paused`
+
+`boolean`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`playsInline`
+
+`boolean`
+
+`—`
+
+`poster`
+
+`string`
+
+`—`
+
+`preload`
+
+`MediaPreloadType`
+
+`—`
+
+`readyState`
+
+`number`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`seekable`
+
+`TimeRangeLike`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`seeking`
+
+`boolean`
+
+`—`
+
+▸
+
+Description
+
+Read-only.
+
+`source`
+
+`SpotifySource | null`
+
+`—`
+
+▸
+
+Description
+
+Spotify URL or URI in `src`, plus embed options under `engine.spotify`. Replacing it re-derives `src`.
+
+`src`
+
+`string`
+
+`—`
+
+`textTracks`
+
+`TextTrackListLike`
+
+`—`
+
+▸
+
+Description
+
+Read-only. Always empty: the embed exposes no captions or other text tracks.
+
+### Engine options
+
+#### `source.engine.spotify`
+
+Pass [Spotify embed options](https://developer.spotify.com/documentation/embeds) under `source.engine.spotify`, spelled exactly as Spotify spells them, plus anything Spotify adds next. [Media Sources](../concepts/media-sources.md) covers how engine options fit into a structured source.
+
+ts
+
+```
+const audio = document.querySelector('spotify-audio');
+audio.source = {
+  src: 'https://open.spotify.com/episode/7makk4oTQel546B0PZlDM5',
+  engine: { spotify: { t: 90, theme: 0 } },
+};
+```
+
+Option
+
+Type
+
+Details
+
+`preferVideo`
+
+`boolean`
+
+▸
+
+Description
+
+Embed the video variant of an episode when it has one. Not a URL parameter: the video embed lives at its own path.
+
+`referrerPolicy`
+
+`ReferrerPolicy`
+
+▸
+
+Description
+
+`referrerpolicy` for the embed iframe. Not a Spotify embed parameter.
+
+`t`
+
+`number`
+
+▸
+
+Description
+
+Start position in seconds.
+
+`theme`
+
+`0`
+
+▸
+
+Description
+
+`0` renders the embed in its dark theme. Defaults to the light theme. Spotify documents no other value, and the embed goes by whether the parameter is there, so leaving it out is the only way to ask for the default.
+
+### Methods
+
+Supports these media methods: `load``pause``play`
+
+### Events
+
+Implements these standard media events through the embedded player: `durationchange``emptied``ended``error``loadedmetadata``loadstart``pause``play``playing``seeked``seeking``timeupdate``waiting`
+
+Also emits these Video.js-specific events:
+
+Event
+
+Description
+
+`loadcomplete`
+
+`sourcechange`
+
+Fired when \`source\` changes, either directly or by resolving a new \`src\`. Read \`source\` for the new value.