Tag attributes
Every attribute of <sonic-player>. Words
inside an attribute turn its extras on; anything unknown is
ignored.
Attributes
| Attribute | Values | Player option |
|---|---|---|
src |
an address | src |
preload |
none,
metadata, auto
|
preload |
peaks |
a .dat, audiowaveform JSON
or list address
|
peaks: () =>
loadWaveform(…)
|
peaks-channel |
all or a number |
channel |
peaks-max |
a number | maxPeaks |
peaks-normalize |
present | normalize: true |
decode-stream |
present; false leaves it
off
|
decode.stream: true |
decode-stream-max-bytes
|
a number of bytes, only lower than the default | decode.stream.maxBytes |
decode-stream-max-seconds
|
a number of seconds, only lower than the default |
decode.stream.maxSeconds
|
theme |
a theme's name | theme |
palette |
a palette's name, auto |
palette |
wave |
a drawing's name | wave |
font |
a stack name or family | font |
font-src,
font-stylesheet
|
an address |
font: { src },
font: { stylesheet }
|
label |
text | a11y.label |
artist |
text |
artist (and the media
controls' artist without
media-artist)
|
line |
part names, by spaces:
"play wave title"
|
look.line; a word that
names no part is left out
|
meta |
part names, by spaces | look.meta |
volume |
present | volume: true |
spectrogram |
present | spectrogram: true |
zoom |
wheel scroll pinch keys follow
center edge-scroll buttons
|
zoom |
zoom-max |
a number | zoom.max |
minimap |
present;
above auto-hide wheel
|
minimap |
chapters |
a WebVTT or Podcasting 2.0 JSON address | chapters: { src } |
chapters-options |
list popover drawer left backdrop
open stay-open animation slide swipe
lane above images links no-keys
no-lines
|
chapters
(above:
lanePlacement: 'above')
|
media-session |
present | mediaSession |
media-title |
text; the a11y-label or
label without it
|
mediaSession.title |
media-artist |
text | mediaSession.artist |
media-album |
text | mediaSession.album |
media-artwork |
a picture's address | mediaSession.artwork |
keys |
present; page |
keys
(page:
scope: 'page')
|
remember |
present;
position volume speed
(all three without words)
|
remember |
remember-key |
text | remember.key |
time-precision |
seconds,
tenths,
hundredths,
milliseconds,
frames
|
look.timePrecision |
time-fps |
a number, 1 to 120 | look.timeFps |
time-hours |
auto, always,
needed
|
look.timeHours |
time-decimal |
., ,,
auto
|
look.timeDecimal |
time-format |
a mask, as written (H and
h are not the same)
|
look.timeFormat |
a11y-lang |
a language tag, auto |
a11y.lang |
a11y-label |
text; wins over label |
a11y.label |
a11y-chapters |
announce readable
no-value-note
|
chapters.a11y
(announce,
tooltip.readable,
valueNote: false)
|
a11y-description |
present;
keys pause-in-value speech announce
button animation fade
|
a11y.description |
a11y-zoom |
announce |
a11y.zoom.announce |
a11y-minimap |
keys |
a11y.minimap.keys |
a11y-keys |
announce |
a11y.keys.announce |
a11y-remember |
announce |
a11y.remember.announce |
load-error |
false (on without it) |
loadError |
a11y-load-error |
false (on without it) |
a11y.loadError.announce
|
a11y-slider-name |
position,
label or
both
|
a11y.sliderName |
background-color |
a color | look.background.color |
background-gradient |
colors separated by spaces |
look.background.gradient.colors
|
background-image |
an address |
look.background.image.src
|
background-options |
radial, conic,
contain, auto,
repeat, top,
bottom, left,
right, center
|
The gradient's kind, the image's size, repeat and place. |
background-angle,
background-blur,
background-opacity
|
numbers |
gradient.angle,
filters.blur,
opacity
|
background-effects |
dim, vignette,
frost, tint,
duotone, grain
|
look.background.effects
|
background-animation |
pan, zoom,
pulse, hue,
flow, always,
pause-on-hover
|
look.backgroundAnimation
|
background-duration |
seconds |
look.backgroundAnimation.duration
|
Changing an attribute updates the player; the ones that change what is built (the sound, its peaks, zoom, the minimap, the chapters, the words) build it again.
The words follow the options' names in kebab-case
(stay-open, edge-scroll,
auto-hide). The type
PlayerAttribute names every attribute the
tag reads.