···11+artwork:
22+ - url: "components/artwork/audio-metadata/element.js"
33+ title: "Audio Metadata"
44+ desc: "Extracts embedded artwork from audio files using the music-metadata library."
55+ - url: "components/artwork/input/element.js"
66+ title: "Input"
77+ desc: "Fetches artwork by delegating to the configured input element's artwork method."
88+ - url: "components/artwork/last.fm/element.js"
99+ title: "Last.fm"
1010+ desc: "Fetches cover art from the Last.fm API using track artist and album tags."
1111+ - url: "components/artwork/musicbrainz/element.js"
1212+ title: "MusicBrainz"
1313+ desc: "Fetches cover art from MusicBrainz and the Cover Art Archive using track artist and album tags."
1414+1515+configurators:
1616+ - url: "components/configurator/artwork/element.js"
1717+ title: "Artwork"
1818+ desc: "Takes artwork components as children and tries each in sequence, returning the first non-null result."
1919+ - url: "components/configurator/input/element.js"
2020+ title: "Input"
2121+ desc: "Allows for multiple inputs to be used at once."
2222+ - url: "components/configurator/metadata/element.js"
2323+ title: "Metadata"
2424+ desc: "Takes metadata components as children and chains their patches in sequence."
2525+ - url: "components/configurator/output/element.js"
2626+ title: "Output"
2727+ desc: "Enables the user to configure a specific output. If no default output is set, it creates a temporary session by storing everything in memory."
2828+ - url: "components/configurator/scrobbles/element.js"
2929+ title: "Scrobbles"
3030+ desc: "Configure multiple scrobblers (music trackers)."
3131+3232+engines:
3333+ - url: "components/engine/audio/element.js"
3434+ title: "Audio"
3535+ desc: "Plays audio through audio elements."
3636+ - url: "components/engine/queue/element.js"
3737+ title: "Queue"
3838+ desc: "A queue for tracks."
3939+ - url: "components/engine/repeat-shuffle/element.js"
4040+ title: "Repeat & Shuffle"
4141+ desc: "Signals synced with local storage (classified by group) that decide if audio should be repeated and if the queue should be shuffled when filling it."
4242+ - url: "components/engine/scope/element.js"
4343+ title: "Scope"
4444+ desc: "Signals that could influence the scope of a set of tracks."
4545+4646+input:
4747+ - url: "components/input/dropbox/element.js"
4848+ title: "Dropbox"
4949+ desc: "Audio files from Dropbox, using the Dropbox v2 HTTP API."
5050+ - url: "components/input/ephemeral-cache/element.js"
5151+ title: "Ephemeral Cache"
5252+ desc: "Wraps another input and caches its track listing in memory for the duration of the session."
5353+ - url: "components/input/https/element.js"
5454+ title: "HTTPS"
5555+ desc: "HTTPS URLs to audio files or streams."
5656+ - url: "components/input/icecast/element.js"
5757+ title: "Icecast"
5858+ desc: "Icecast internet radio streams. Fetches ICY metadata to populate track information."
5959+ - url: "components/input/local/element.js"
6060+ title: "Local"
6161+ desc: "Audio files or directories from your local device, using the browser's File System Access API."
6262+ - url: "components/input/opensubsonic/element.js"
6363+ title: "Opensubsonic"
6464+ desc: "Add any (open)subsonic server."
6565+ - url: "components/input/s3/element.js"
6666+ title: "S3"
6767+ desc: "AWS S3 and services that provide the same surface API such as Cloudflare R2."
6868+ - url: "components/input/webdav/element.js"
6969+ title: "WebDAV"
7070+ desc: "Add any WebDAV server."
7171+7272+metadata:
7373+ - url: "components/metadata/audio-file/element.js"
7474+ title: "Audio File"
7575+ desc: "Extracts tags and audio stats from audio files using the music-metadata library."
7676+7777+orchestrators:
7878+ - url: "components/orchestrator/artwork/element.js"
7979+ title: "Artwork"
8080+ desc: "Fetches cover art for a given set of tracks, stored locally in indexedDB. Uses the artwork configurator to try each configured source in sequence."
8181+ - url: "components/orchestrator/auto-queue/element.js"
8282+ title: "Automatic Queue"
8383+ desc: "Fill the queue automatically with non-manual items (shuffled or regular, based on repeat-shuffle engine)."
8484+ - url: "components/orchestrator/controller/element.js"
8585+ title: "Controller"
8686+ desc: "Provides commonly used computed signals derived from the audio engine, queue engine, and output. Exposes currentTrack(), isPlaying(), and references to the underlying engines."
8787+ - url: "components/orchestrator/cover-groups/element.js"
8888+ title: "Cover Groups"
8989+ desc: "Groups tracks by cover art to form collections."
9090+ - url: "components/orchestrator/favourites/element.js"
9191+ title: "Favourites"
9292+ desc: "Mark tracks as favourites. Automatically creates an unordered 'Favourites' playlist."
9393+ - url: "components/orchestrator/media-session/element.js"
9494+ title: "Media Session"
9595+ desc: "Keeps the browser/os media session in sync with queue and audio state. Adds handlers for previous, next, seek to, etc."
9696+ - url: "components/orchestrator/offline/element.js"
9797+ title: "Offline"
9898+ desc: "Registers a service worker that makes the page available offline. Resources (except audio & video) are cached as they load and served from cache when offline."
9999+ - url: "components/orchestrator/output/element.js"
100100+ title: "Output"
101101+ desc: "A default output configuration. Contains all the outputs provided here along with the relevant transformers."
102102+ - url: "components/orchestrator/path-collections/element.js"
103103+ title: "Path Collections"
104104+ desc: "Wraps an output element to generate ephemeral playlists based on the first path segment of each track's URI. Ephemeral items are excluded from storage."
105105+ - url: "components/orchestrator/process-tracks/element.js"
106106+ title: "Process Inputs Into Tracks"
107107+ desc: "Whenever the cached tracks are initially loaded through the passed output element it will list tracks by using the passed input element. Afterwards it loops over all tracks and checks if metadata needs to be fetched. If anything has changed, it'll pass the results to the output element."
108108+ - url: "components/orchestrator/queue-audio/element.js"
109109+ title: "Queue ⭤ Audio"
110110+ desc: "Connects the given queue engine to the given audio engine."
111111+ - url: "components/orchestrator/scoped-tracks/element.js"
112112+ title: "Scoped Tracks"
113113+ desc: "Watches the given output's tracks collection and runs them through a built-in search index. Can perform a search and other ways to reduce the scope of tracks based on the given scope engine. Provides a tracks signal similar to output.tracks.collection."
114114+ - url: "components/orchestrator/scrobble-audio/element.js"
115115+ title: "Scrobble ⭤ Audio"
116116+ desc: "Connects the audio engine with a scrobbler element. Calls nowPlaying when a track starts playing and scrobble once the user has listened long enough."
117117+ - url: "components/orchestrator/sources/element.js"
118118+ title: "Sources"
119119+ desc: "Monitor tracks from the given output to form a list of sources based on the input's sources return value."
120120+121121+output:
122122+ - url: "components/output/polymorphic/indexed-db/element.js"
123123+ title: "Polymorphic / IndexedDB"
124124+ desc: "Stores output into the local indexedDB. Supports any type of data that indexedDB supports."
125125+ - url: "components/output/bytes/s3/element.js"
126126+ title: "Bytes / S3"
127127+ desc: "Store output data on AWS S3 or compatible services such as Cloudflare R2."
128128+ - url: "components/output/raw/atproto/element.js"
129129+ title: "Raw / AT Protocol"
130130+ desc: "Store your user data on the storage associated with your ATProtocol identity. Data is lexicon shaped by default so this element takes in that data directly without any transformations."
131131+132132+supplements:
133133+ - url: "components/supplement/last.fm/element.js"
134134+ title: "Last.fm Scrobbler"
135135+ desc: "Scrobbles track plays to Last.fm."
136136+ - url: "components/supplement/listenbrainz/element.js"
137137+ title: "ListenBrainz Scrobbler"
138138+ desc: "Scrobbles track plays to ListenBrainz."
139139+ todo: true
140140+ - url: "components/supplement/rocksky/element.js"
141141+ title: "Rocksky Scrobbler"
142142+ desc: "Scrobbles track plays to Rocksky."
143143+ todo: true
144144+145145+transformers:
146146+ - url: "components/transformer/output/bytes/automerge/element.js"
147147+ title: "Output / Bytes / Automerge"
148148+ desc: "Translate data to and from an Automerge CRDT."
149149+ todo: true
150150+ - url: "components/transformer/output/bytes/dasl-sync/element.js"
151151+ title: "Output / Bytes / DASL Sync"
152152+ desc: "Syncs data between local and remote using CID-based diffing and performs union merges with tombstone tracking when both sides have diverged."
153153+ - url: "components/transformer/output/bytes/json/element.js"
154154+ title: "Output / Bytes / JSON"
155155+ desc: "Raw data schema output to and from JSON Uint8Array."
156156+ - url: "components/transformer/output/raw/atproto-sync/element.js"
157157+ title: "Output / Raw / AT Protocol Sync"
158158+ desc: "Wraps an AT Protocol output with a local IndexedDB cache. Uses the repo revision to skip unnecessary fetches and performs union merges with tombstone tracking when both local and remote have diverged."
159159+ - url: "components/transformer/output/refiner/default/element.js"
160160+ title: "Output / Refiner / Default"
161161+ desc: "Removes output state that is not meant to be saved to storage, such as ephemeral tracks. Ideally part of every theme."
162162+ - url: "components/transformer/output/refiner/initial-contents/element.js"
163163+ title: "Output / Refiner / Initial Contents"
164164+ desc: "Sets the initial contents for an output on first load."
165165+ - url: "components/transformer/output/refiner/passkey-encryption/element.js"
166166+ title: "Output / Refiner / Track URI Passkey"
167167+ desc: "Encrypts track URIs using a passkey-derived PRF key. On read, decrypts encrypted:// URIs transparently; on write, re-encrypts all URIs before passing downstream."
168168+ - url: "components/transformer/output/string/json/element.js"
169169+ title: "Output / String / JSON"
170170+ desc: "Raw data schema output to and from JSON UTF8 string."
171171+172172+definitions:
173173+ - title: "Output / Collaboration"
174174+ desc: "Represents a collaboration between multiple collaborators on a subject, such as a playlist."
175175+ url: "definitions/output/collaboration.json"
176176+ - title: "Output / Facet"
177177+ desc: "Facet pointer or HTML snippet."
178178+ url: "definitions/output/facet.json"
179179+ - title: "Output / Playlist Item"
180180+ desc: "Represents a single item in a playlist. Tracks are matched based on the given criteria. A playlist is formed by grouping items by their playlist property."
181181+ url: "definitions/output/playlistItem.json"
182182+ - title: "Output / Progress"
183183+ desc: "Used to track progress of (long) audio playback."
184184+ todo: true
185185+ - title: "Output / Track"
186186+ desc: "Represents audio that can be played, or a placeholder for a source of tracks. Contains a URI that will resolve to the audio."
187187+ url: "definitions/output/track.json"
188188+ - title: "Output / Track Bundle"
189189+ desc: "A bundle of tracks."
190190+ url: "definitions/output/trackBundle.json"
···88 - styles/diffuse/page.css
99 - vendor/@phosphor-icons/web/bold/style.css
1010 - vendor/@phosphor-icons/web/fill/style.css
1111-1212-# ELEMENTS
1313-1414-artwork:
1515- - url: "components/artwork/audio-metadata/element.js"
1616- title: "Audio Metadata"
1717- desc: "Extracts embedded artwork from audio files using the music-metadata library."
1818- - url: "components/artwork/last.fm/element.js"
1919- title: "Last.fm"
2020- desc: "Fetches cover art from the Last.fm API using track artist and album tags."
2121- - url: "components/artwork/musicbrainz/element.js"
2222- title: "MusicBrainz"
2323- desc: "Fetches cover art from MusicBrainz and the Cover Art Archive using track artist and album tags."
2424-2525-configurators:
2626- - url: "components/configurator/artwork/element.js"
2727- title: "Artwork"
2828- desc: "Takes artwork components as children and tries each in sequence, returning the first non-null result."
2929- - url: "components/configurator/input/element.js"
3030- title: "Input"
3131- desc: "Allows for multiple inputs to be used at once."
3232- - url: "components/configurator/metadata/element.js"
3333- title: "Metadata"
3434- desc: "Takes metadata components as children and chains their patches in sequence."
3535- - url: "components/configurator/output/element.js"
3636- title: "Output"
3737- desc: "Enables the user to configure a specific output. If no default output is set, it creates a temporary session by storing everything in memory."
3838- - url: "components/configurator/scrobbles/element.js"
3939- title: "Scrobbles"
4040- desc: "Configure multiple scrobblers (music trackers)."
4141-4242-engines:
4343- - url: "components/engine/audio/element.js"
4444- title: "Audio"
4545- desc: "Plays audio through audio elements."
4646- - url: "components/engine/queue/element.js"
4747- title: "Queue"
4848- desc: "A queue for tracks."
4949- - url: "components/engine/repeat-shuffle/element.js"
5050- title: "Repeat & Shuffle"
5151- desc: "Signals synced with local storage (classified by group) that decide if audio should be repeated and if the queue should be shuffled when filling it."
5252- - url: "components/engine/scope/element.js"
5353- title: "Scope"
5454- desc: >
5555- Signals that could influence the scope of a set of tracks.
5656-5757-input:
5858- - url: "components/input/dropbox/element.js"
5959- title: "Dropbox"
6060- desc: >
6161- Audio files from Dropbox, using the Dropbox v2 HTTP API.
6262- - url: "components/input/https/element.js"
6363- title: "HTTPS"
6464- desc: >
6565- HTTPS URLs to audio files or streams.
6666- - title: "HTTPS (JSON)"
6767- desc: >
6868- Generate tracks based on HTTPS servers that provide JSON (directory) listings.
6969- todo: true
7070- - url: "components/input/icecast/element.js"
7171- title: "Icecast"
7272- desc: >
7373- Icecast internet radio streams. Fetches ICY metadata to populate track information.
7474- - url: "components/input/local/element.js"
7575- title: "Local"
7676- desc: >
7777- Audio files or directories from your local device, using the browser's File System Access API.
7878- - url: "components/input/opensubsonic/element.js"
7979- title: "Opensubsonic"
8080- desc: >
8181- Add any (open)subsonic server.
8282- - url: "components/input/s3/element.js"
8383- title: "S3"
8484- desc: >
8585- AWS S3 and services that provide the same surface API such as Cloudflare R2.
8686- - title: "WebDAV"
8787- desc: >
8888- Add any WebDAV server.
8989- todo: true
9090-9191-orchestrators:
9292- - url: "components/orchestrator/auto-queue/element.js"
9393- title: "Automatic Queue"
9494- desc: >
9595- Fill the queue automatically with non-manual items (shuffled or regular, based on repeat-shuffle engine).
9696- - url: "components/orchestrator/favourites/element.js"
9797- title: "Favourites"
9898- desc: >
9999- Mark tracks as favourites. Automatically creates an unordered 'Favourites' playlist.
100100- - url: "components/orchestrator/input/element.js"
101101- title: "Input"
102102- desc: "**A default input configuration.** Contains all the inputs provided here."
103103- - url: "components/orchestrator/media-session/element.js"
104104- title: "Media Session"
105105- desc: "Keeps the browser/os media session in sync with queue and audio state. Adds handlers for previous, next, seek to, etc."
106106- - url: "components/orchestrator/offline/element.js"
107107- title: "Offline"
108108- desc: "Registers a service worker that makes the page available offline. Resources (except audio & video) are cached as they load and served from cache when offline."
109109- - url: "components/orchestrator/output/element.js"
110110- title: "Output"
111111- desc: "**A default output configuration.** Contains all the outputs provided here along with the relevant transformers."
112112- - url: "components/orchestrator/path-collections/element.js"
113113- title: "Path Collections"
114114- desc: "Wraps an output element to generate ephemeral playlists based on the first path segment of each track's URI. Ephemeral items are excluded from storage."
115115- - url: "components/orchestrator/process-tracks/element.js"
116116- title: "Process Inputs Into Tracks"
117117- desc: "Whenever the cached tracks are initially loaded through the passed output element it will list tracks by using the passed input element. Afterwards it loops over all tracks and checks if metadata needs to be fetched. If anything has changed, it'll pass the results to the output element."
118118- - url: "components/orchestrator/queue-audio/element.js"
119119- title: "Queue ⭤ Audio"
120120- desc: "Connects the given queue engine to the given audio engine."
121121- - url: "components/orchestrator/scrobble-audio/element.js"
122122- title: "Scrobble ⭤ Audio"
123123- desc: "Connects the audio engine with a scrobbler element. Calls `nowPlaying` when a track starts playing and `scrobble` once the user has listened long enough."
124124- - url: "components/orchestrator/sources/element.js"
125125- title: "Sources"
126126- desc: "Monitor tracks from the given output to form a list of sources based on the input's sources return value."
127127- - url: "components/orchestrator/artwork/element.js"
128128- title: "Artwork"
129129- desc: "Fetches cover art for a given set of tracks, stored locally in indexedDB. Uses the artwork configurator to try each configured source in sequence."
130130- - url: "components/orchestrator/scoped-tracks/element.js"
131131- title: "Scoped Tracks"
132132- desc: "Watches the given output's tracks collection and runs them through a built-in search index. Can perform a search and other ways to reduce the scope of tracks based on the given scope engine. Provides a `tracks` signal similar to `output.tracks.collection`"
133133-134134-output:
135135- - url: "components/output/polymorphic/indexed-db/element.js"
136136- title: "Polymorphic / IndexedDB"
137137- desc: "Stores output into the local indexedDB. Supports any type of data that indexedDB supports."
138138- - url: "components/output/bytes/s3/element.js"
139139- title: "Bytes / S3"
140140- desc: >
141141- Store output data on AWS S3 or compatible services such as Cloudflare R2.
142142- - url: "components/output/raw/atproto/element.js"
143143- title: "Raw / AT Protocol"
144144- desc: >
145145- Store your user data on the storage associated with your ATProtocol identity. Data is lexicon shaped by default so this element takes in that data directly without any transformations.
146146-147147-metadata:
148148- - url: "components/metadata/audio-file/element.js"
149149- title: "Audio File"
150150- desc: "Extracts tags and audio stats from audio files using the music-metadata library."
151151-152152-supplements:
153153- - url: "components/supplement/last.fm/element.js"
154154- title: "Last.fm Scrobbler"
155155- - title: "ListenBrainz Scrobbler"
156156- todo: true
157157- - title: "Rocksky Scrobbler"
158158- todo: true
159159- - title: "Teal.fm Scrobbler"
160160- todo: true
161161-162162-transformers:
163163- - title: "Output / Bytes / Automerge"
164164- desc: "Translate data to and from an Automerge CRDT."
165165- url: "components/transformer/output/bytes/automerge/element.js"
166166- todo: true
167167- - title: "Output / Bytes / Cambria Lenses"
168168- desc: "Uses the Cambria library to seamlessly translate between data schemas so that no data migration is needed."
169169- todo: true
170170- - title: "Output / Bytes / DASL Sync"
171171- desc: "Syncs data between local and remote using CID-based diffing and performs union merges with tombstone tracking when both sides have diverged."
172172- url: "components/transformer/output/bytes/dasl-sync/element.js"
173173- - title: "Output / Bytes / JSON"
174174- desc: "Raw data schema output ⇄ JSON Uint8Array."
175175- url: "components/transformer/output/bytes/json/element.js"
176176- - title: "Output / Raw / AT Protocol Sync"
177177- desc: "Wraps an AT Protocol output with a local IndexedDB cache. Uses the repo revision to skip unnecessary fetches and performs union merges with tombstone tracking when both local and remote have diverged."
178178- url: "components/transformer/output/raw/atproto-sync/element.js"
179179- - title: "Output / Refiner / Default"
180180- desc: "The task of a refiner transformer is to remove the output state that is not meant to be saved to storage. For example, ephemeral tracks; this transformer will keep them in memory, but they will not be present in the output. **Ideally this is part of every theme, but you may swap it out with another transformer that might provide better defaults.**"
181181- url: "components/transformer/output/refiner/default/element.js"
182182- - title: "Output / Refiner / Track URI Passkey"
183183- desc: "Encrypts track URIs using a passkey-derived PRF key. On read, decrypts `encrypted://` URIs transparently; on write, re-encrypts all URIs before passing downstream. Tracks that cannot be decrypted are held separately and excluded from the visible collection."
184184- url: "components/transformer/output/refiner/passkey-encryption/element.js"
185185- - title: "Output / String / JSON"
186186- desc: "Raw data schema output ⇄ JSON UTF8 string."
187187- url: "components/transformer/output/string/json/element.js"
188188-189189-# DEFINITIONS
190190-191191-definitions:
192192- - title: "Output / Collaboration"
193193- desc: >
194194- Represents a collaboration between multiple collaborators on a subject, such as a playlist.
195195- url: "definitions/output/collaboration.json"
196196- - title: "Output / Facet"
197197- desc: >
198198- Facet pointer or HTML snippet.
199199- url: "definitions/output/facet.json"
200200- - title: "Output / Playlist Item"
201201- desc: >
202202- Represents a single item in a playlist. Tracks are matched based on the given criteria. A playlist is formed by grouping items by their playlist property.
203203- url: "definitions/output/playlistItem.json"
204204- - title: "Output / Progress"
205205- desc: >
206206- Used to track progress of (long) audio playback.
207207- todo: true
208208- - title: "Output / Track"
209209- desc: >
210210- Represents audio that can be played, or a placeholder for a source of tracks. Contains a URI that will resolve to the audio.
211211- url: "definitions/output/track.json"
212212- - title: "Output / Track Bundle"
213213- desc: >
214214- A bundle of tracks.
215215- url: "definitions/output/trackBundle.json"
216216-21711---
2181221913<header>
···25246 <div class="columns">
25347 {{ await comp.element({
25448 title: "Artwork",
255255- items: artwork,
4949+ items: elements.artwork,
25650 content: `
25751 Elements that provide artwork for tracks.
25852 `
···2605426155 {{ await comp.element({
26256 title: "Configurators",
263263- items: configurators,
5757+ items: elements.configurators,
26458 content: `
26559 Intermediates in order to make a particular kind of element configurable. In other words, these allow for an element to be swapped out with another that takes the same set of the actions and data output.
26660 `
···2686226963 {{ await comp.element({
27064 title: "Engines",
271271- items: engines,
6565+ items: elements.engines,
27266 content: `
27367 Elements with each a singular purpose. There are orchestrator elements that control these.
27468 `
···2767027771 {{ await comp.element({
27872 title: "Input",
279279- items: input,
7373+ items: elements.input,
28074 content: `
28175 Inputs are sources of audio tracks. Each track is an entry in the list of possible items to play. These can be files or streams, static or dynamic.
28276 `
···2847828579 {{ await comp.element({
28680 title: "Metadata",
287287- items: metadata,
8181+ items: elements.metadata,
28882 content: `
28983 Elements that provide metadata for tracks.
29084 `
···2928629387 {{ await comp.element({
29488 title: "Orchestrators",
295295- items: orchestrators,
8989+ items: elements.orchestrators,
29690 content: `
29791 These are element compositions, logic only. Mostly exist in order to construct sensible defaults.
29892 `
···3009430195 {{ await comp.element({
30296 title: "Output",
303303- items: output,
9797+ items: elements.output,
30498 content: `
30599 Output is application-derived data such as playlists. These elements can receive such data and keep it around. These are categorised by the type of data they ingest, or many types in the case of polymorphic. Optionally use transformers to convert output into the expected format.
306100 `
···308102309103 {{ await comp.element({
310104 title: "Supplements",
311311- items: supplements,
105105+ items: elements.supplements,
312106 content: `
313107 Additional elements, such as scrobblers.
314108 `
···316110317111 {{ await comp.element({
318112 title: "Transformers",
319319- items: transformers,
113113+ items: elements.transformers,
320114 content: `
321115 Transform data from one format or schema into another. See the definitions section below for more information. Just as configurators, these are intermediates and require to have the same set of actions as the element it targets.
322116 `
···330124331125 <p>All of the elements here are built with these data definitions in mind. That said, you can mix elements that use different definitions; you just have to put a transformer between them in order to translate between them, if needed.</p>
332126333333- {{ await comp.list({ items: definitions }) }}
127127+ {{ await comp.list({ items: elements.definitions }) }}
334128 </section>
335129</main>
336130