Global

Type Definitions

HT5AP_classes

Classes added to the default elements when rendering the template. These classes will be added additionally to the default classes, not instead of them.
Type:
  • Object
Properties:
Name Type Attributes Description
currentlyPlaying string <optional>
Class added to the elment containing the name of the currently playing song
audioController string <optional>
Class added to the wrapper element wrapping around the controls
volumeKnob string <optional>
Class added to the svg of the volume knob
timeKnob string <optional>
Class added to the svg of the time knob
prev string <optional>
Class added to the previous button
next string <optional>
Class added to the next button
playpause string <optional>
Class added to to the play/pause button
playing string <optional>
Class added to the play/pause button (only in playing state)
paused string <optional>
Class added to the play/pause button (only in paused state)
playlist string <optional>
Class added to the playlist wrapper
song string <optional>
Class added to the currently active song
songActive string <optional>
Class added to the currently active song
Source:

HT5AP_KnobSettings

Type:
  • Object
Properties:
Name Type Attributes Default Description
element HTMLElement the Input element to build the knob out of. This must be a input[type="range"] Element that has the jim-knopf attributes set
thickness number <optional>
15 thickness of the arc in px
Source:

HT5AP_settings

Settings for the HTML5audioplayer. These have to be supplied to the constructor HTML5audioplayer
Type:
  • Object
Properties:
Name Type Attributes Default Description
element Node the audio element to use for playing the sounds
debug boolean <optional>
false Enables the debug mode when set to true. If the debug mode is set to true, debug messages are printed to the console and the HTML5 audio element is shown with controls
classes HT5AP_classes <optional>
themeColor string <optional>
'#ee0060' Theme color to use for the audioplayer
secondaryColor string <optional>
themeColor Secondary color, used for hover
Source:

HT5AP_song

Representation of a song used in the HTML5audioplayer. This is used for HTML5audioplayer#addSong
Type:
  • Object
Properties:
Name Type Attributes Description
name string Name of the song
mp3 string <optional>
Path to the mp3 file
ogg string <optional>
Path to the ogg file
element HTMLElement
Source: