About
Shikwasa is an web audio player born for podcast. If you're tired of using music players as a substitute to play podcast, you've come to the right place. SAY NO to players that does not even support podcast common features!
🚀 Ultra lightweight🐣 Dependency free🎬 Podcast chapters🏎 Playback speed control🎮 Skip forward/backward👓 Accessibility-aware🌙 Dark Mode- SSR compatible
- Playlist
📖 Table of Contents
Installation
npm install shikwasa
Also available on CDN: https://www.jsdelivr.com/package/npm/shikwasa
Usage
-
include stylesheet and script
<head> <link rel="stylesheet" href="shikwasa.min.css"> </head> <body> <script src="shikwasa.min.js"></script> </body>
-
Specify a container to inject the player component.
<div class="element-of-your-choice"> <!-- this is where the player will be injected --> </div>
-
Create an instance of the player
// an example with basic init options const player = new Shikwasa({ container: () => document.querySelector('.element-of-your-choice'), audio: { title: 'Hello World!', artist: 'Shikwasa FM', cover: 'image.png', src: 'audio.mp3', }, })
Any child nodes inside
containerwill be cleared upon the time Shiwkasa mounts. -
If you use module system, import like this:
import 'shikwasa/dist/shikwasa.min.css' import Shikwasa from 'shikwasa' const player = new Shikwasa(options)
To use the Chapter feature, you need to import the chapter script and stylesheets as well. View details
API
Methods
.play()
Start playing the current audio. Updating audio via this method is deprecated, please use update(audio) instead.
.pause()
Pause the current audio.
.toggle()
Toggle audio play state between play and pause.
.seek(time)
Seek the audio to the new time. time is a number that specifies target playback time in seconds.
.update(audio)
Passing an audio object in will replace the current audio source.
player.update({
title: 'Embrace the universe with a cup of shikwasa juice',
artist: 'Shikwasa',
cover: 'image.png',
src: 'sourceAudio.mp3'
}).destroy()
Destroy the player instance.
.on(event, callback)
Register an event listener. Supported events see: Events
Properties
.currentTime
- Read-only
- type:
Number - default:
0
The current playback time. Similar to the native HTMLMediaElement.currentTime.
.muted
- type:
Boolean - default:
options.muted
The current mute state of the player. Similar to the native HTMLMediaElement.muted, except thatmuted's value will not be affected when audio source is updated.
.playbackRate
- type:
Number - default:
1
The current playbackRate of the player. Similar to the native HTMLMediaElement.playbackRate, except thatplaybackRate's value will not be affected when audio source is updated.
.duration
- type:
Number|NaN - default:
audio.duration || options.audio.duration
Options
audio
(Required) The target audio to be played. If duration is passed in, players with preload option set to none will have a audio duration time display before the audio metadata is fetched. However, after the audio metadata is loaded, this prop will be ignored.
- required
- type:
Object - default:
null - properties:
audio: {
title: String,
artist: String,
cover: String,
src: String,
duration: Number, // optional
album: String, // optional, album text will only display in Mediametadata, not visible in player UI.
}container
(Optional) The container element for the player. If document is not available in the env, pass a function that will return the container element.
- type:
HTMLElement - default:
() => document.querySelector('body')
fixed
(Optional) Whether player should be fixed to viewport.
- type:
Object - default:
fixed: {
type: 'auto',
position: 'bottom',
}- details:
| Property | Type | Description |
|---|---|---|
| type | String |
either auto, static or fixed auto: player position is controlled by media queries. Normally the player stays static, but on small screens it will be fixed to viewportstatic: force the player to remain static regardless of screen widthfixed: force the player to fix to viewport |
| position | String |
either bottom or top position will be ignored when type is set to static |
themeColor
(Optional) Theme color of the player.
- type:
String - default:
#00869B
autoplay
(Optional) If audio should autoplay on load. muted is set to true by default. To comply with this policy, see details in Chrome Developers and Webkit Announcement.
- type:
Boolean - default:
false
muted
Whether audio should be muted by default. Similar to HTMLMediaElement's defaultMuted.
- type:
Boolean - default:
false
preload
(Optional) Choose from auto, metadata and none. For details view MDN Doumentation.
If a parser is used, the audio will be requested immediately on page load for the parser to work properly, even if preload is set to none.
- type:
String - default:
metadata
speedOptions
(Optional) The playback speed range. Each value of the array should be between the range of 0.25 to 5.0, or will likely be ignored by certain browsers.
- type:
Array - default:
[0.5, 0.75, 1.25, 1.5]
download
(Optional) Whether the current audio source is download-able. When set to true, the player will provide an anchor with downlaod attribute and href set to audio.src. Cross-origin href will not prompt download due to anchor's nature, but you can offer an alternative blob:, data: url or a same-origin direct download link(DDL).
- type:
Boolean|String - default:
false - alternatives:
download: true
// or with a url
download: 'data:audio/mp3;base64,...'parser
(Optional) To focus on the player itself as well as to maintain Shikwasa as efficient as possible, we don't extract data from audio files. If you don't have control over the chapter data but would like to implement chapter feature, we support using jsmediatags as an external parser to parse the current audio's metadata.
It will read the audio's title, artist, duration and chapters, meaning you don't have to provide these four properties into audio manually unless you preferred your own. Priority: property values passed to audio > parsed data.
- type:
Null|Object - default:
null - usage:
npm install jsmediatags // https://github.com/aadsm/jsmediatags import jsmediatags from 'jsmediatags'
new Shikwasa({
...
parser: jsmediatags,
audio: { src: ... },
})audio.src is not of the same origin, proper CORS configuration will be needed to use the parser.
Due to jsmediatags limitation, relative urls are not supported. Please use absolute urls for audio.src.
Events
Support all HTMLMediaElement native events.
Player events:
audioupdate: fired when audio source is updated.
audioparse: fired when audio file data is parsed.
Chapters
Shikwasa supports chapters display and playback control with the help of its external chapter plugin. To use this feature:
-
Register the chapter plugin before creating a Shikwasa instance.
import Chapter as 'shikwasa/dist/shikwasa.chapter.cjs' import 'shikwasa/dist/shikwasa.chapter.min.css' Shikwasa.use(Chapter) new Shikwasa({...})
-
This does not guarantee that the audio will display chapters. To display chapters, you need to provide chapter data to the player.
If you don't have direct access to the chapter data, Shikwasa has built-in support to work with jsmediatags to read and extract the data from the audio file;
- (1) To manually provide chapters, add the
chaptersproperty when passingaudiointo options or.update(audio).
audio: { ... chapters: [ // Array, optional { title, startTime, endTime }, // the first chapter { title, startTime, endTime }, // the second chatper ], }
The structure of a single chapter object:
Property Type Description title String chapter title startTime Number chapter start time in seconds endTime Number chapter end time in seconds ⚠️ Note:endTimeshould be the same asstartTimeof the next chapter.- (2) To use an external parser, pass
jsmediatagsin theparseroptions. How to use a parser?
- (1) To manually provide chapters, add the
(1) will take the higher priority.
Registering Chapter plugin will empower Shikwasa instance with the following API:
.updateChapter(index)
Seek the audio to the target chapter. index is the index of of chapters array.
.chapters
- Read-only
- type:
Array - default:
[]
Chapter metadata of the current audio, if any. See Chapter.
.currentChapter
- Read-only
- type:
Null|Object - default:
null
Indicate which chapter is currently on play, if any. See Chapter.
Events:
chapterchange: fired when currentChapter changes.
Roadmap
- rewrittern with Typescript – currently working on this one
Under v2.0.0:
- supporting audio id3 metadata
- cleaner & sleeker interface
- dark mode
- a complete rewrite
- keyboard support
What about the weird name of this project?
Shikwasa is the name of a popular citrus fruit from Okinawa, Japan.
Love it, name after it.