Radio4000 Player

This is a web component that plays channels from Radio4000.
It uses the public radio4000-api and Vue.js.

• How to use
• API
  • Attributes
  • Examples
  • Events
  • Methods
• Development

How to use

You can load the player with a CDN, like this:

<script async src="https://cdn.jsdelivr.net/npm/radio4000-player"></script>
<radio4000-player channel-slug="good-time-radio"></radio4000-player>

OR, you can use a package manager:

// npm install radio4000-player
import 'radio4000-player'
// now you can use <radio4000-player> in your templates

OR, you can use an iframe (source):

<iframe src="https://api.radio4000.com/embed?slug=detecteve" width="320" height="500" frameborder="0"></iframe>

API

Attributes

Here's a complete list of all the attributes you can set and change on the web component. These do not affect the iframe version.

| Attribute | Type | Description | |---------------|-------------------|---------------------------------------------------------------------------------------------------------------------------| | channel-slug | string | Radio4000 channel slug (ex: oskar) | | channel-id | string | Radio4000 channel id (ex: -JYZvhj3vlGCjKXZ2cXO) | | track-id | string | Radio4000 track id (ex: -JYEosmvT82Ju0vcSHVP) | | volume | integer | from 0 to 100 (default: 100) | | autoplay | boolean [false] | if it should start playing automatically, if volume is set to 0. See note. | | shuffle | boolean [false] | if tracks should be shuffled | | r4-url | boolean [false] | use relative, internal links. When the player is used on radio4000.com we want the links to not open a new window | | showHeader | boolean [false] | Display or not the header part of the player. Where the channel image and current track are displayed | | showTracklist | boolean [false] | Display or not the player's list of tracks | | showControls | boolean [false] | Display or not the player's controls. Where the play, mute and next buttons are | | hostRootUrl | string | Root URL used to build links to the channel and tracks query, defaults to 'radio4000.com' | | platform | boolean [false] | Is this player used on a platform? If true, build URL starting from /, and use target="_self" to not reload the page |

Note: If you change showTracklist showControls showHeader, to true, you will have the effect of a fullscreen mode for the player. In which only the media is displayed. Mostly usefull for a tv effect, to easily display a channel on a website, for example as a animated background. See autoplay.

Note: To have autoplay working, you should also set the volume property to 0. It has for effect of muting the autio of all media played in the player, and this is required for the autoplay feature to work. This requirement is enforced by browsers (Firefox, Chromium, etc.), so the User Experience forbits video to be autoplayed on websites, if there is also audio.

Examples

The are three available attributes to start the player: channel-slug, channel-id and track-id.

In a HTML file, add the following to generate three players:

<script async src="https://cdn.jsdelivr.net/npm/radio4000-player"></script>

<radio4000-player channel-slug="good-time-radio"></radio4000-player>
<radio4000-player channel-id="-JYZvhj3vlGCjKXZ2cXO"></radio4000-player>
<radio4000-player track-id="-JYEosmvT82Ju0vcSHVP"></radio4000-player>

You can also set and update the player attributes using JavaScript. Remember that HTML attributes are dasherized channel-slug whereas JavaScript expects CamelCase channelSlug.

var player = document.querySelector('radio4000-player')

// Load radio channel either by slug or id.
player.channelSlug = 'sugar-hiccup'
player.channelId = '-JYZvhj3vlGCjKXZ2cXO'

// Load a specific track.
player.trackId = '-JYEosmvT82Ju0vcSHVP'

// Change the volume.
player.volume = 25

// Enable shuffle.
player.shuffle = true

To enable autoplay:

<radio4000-player channel-slug="200ok" autoplay="true"></radio4000-player>

Events

You can listen for events directly on each <radio4000-player> element.

|Event name|Description|Arguments| |----|----|----| |playerReady|Fires when ready| |trackChanged|Fires whenever the current track is changed|{previousTrack, track} |trackEnded|Fires when the current track finishes playing|{track} |mediaNotAvailable|Fires when a track can not be played by its provider (YouTube etc.)|{track}

Here's an example of how to listen for the trackChanged event. It is the same approach for all events. In the case of both trackChanged and trackEnded, the event.detail[0] argument will be a Radio4000 track object.

var player = document.querySelector('radio4000-player')
player.addEventListener('trackChanged', (event) => {
  console.info('trackChanged event', event.detail[0])
  // { track: { [...] } }
})

Methods

!!! Danger zone. We are still finalizing the API for methods so expect this to change.

It is possible to load data to the <radio4000-player> without any relation to the Radio4000 database. To do that use the updatePlaylist method, on the JavaScript instance of the player. It accepts a playlist object.

The playlist object

|Attribute|Type|Description| |----|----|----| |title|string|Displayed in the header |image|string|URL to an image (square ~60px) |tracks|string|An array of track objects

Here's an example an array of a playlist object. Note how the tracks' url key points to remote media in the ogg format (can be any format your browser supports).

// Create a playlist.
const playlist = {
  title: 'A title for this list',
  image: 'https://78.media.tumblr.com/5080191d7d19fe64da558f2b4324563e/tumblr_p8eoiltn1t1twkjb3o1_1280.png',
  tracks: [
    {
      id: '1',
      title: 'Randomfunk.ogg',
      url: 'https://ia801409.us.archive.org/5/items/DWK051/Rare_and_Cheese_-_01_-_Randomfunk.ogg'
    },
    {
      id: '2',
      title: 'Rare and Cheese - Jazzpolice',
      url: 'https://ia801409.us.archive.org/5/items/DWK051/Rare_and_Cheese_-_02_-_Jazzpolice.ogg'
    }
  ]
}

// Get access to the Vue component behind the web component to access methods,
// and update player with our new playlist.
var player = document.querySelector('radio4000-player')
var vue = player.getVueInstance()
vue.updatePlaylist(playlist)

The track object

The track object attributes are based on the track model of Radio4000 API. Available attributes can be found there: github.com/internet4000/radio4000-api#track

This is an array of track, which have a property ytid, so the <radio4000-player> will read them with YouTube's iframe player.

const tracks = {
    {
        "id": "-JYZtlEKiZY75Wt6QpA5",
        "title": "Kleeer - Tonight",
        "url":" https://www.youtube.com/watch?v=cVXURwACwtk",
        "ytid": "cVXURwACwtk"
    },
    {
        "id": "-Jf2HYHsVl7iPDGZNbCa",
        "title":" Patrick Watson - Adventures In Your Own Backyard (Altered Route Video Edit)",
        "url":" https://www.youtube.com/watch?v=cbSbbY5ibas",
        "ytid": "cbSbbY5ibas"
    }
}

If instead of a ytid (being a Youtube video id), you use the key url, the player will attempt to read the media to which this url points to. It will use an HTML <audio> element, to which the supported media type list can be found on Mozilla MDN documentation.

Development

As of April 2024 the project runs with Node.js version 16. Possibly others. But at least 16.

# 1. clone and install dependencies
git clone [email protected]:internet4000/radio4000-player.git
npm install

# 2. starts a server on http://localhost:4002 that autobuilds when files change
npm start

Testing

# run tests once
npm test

# (re)run tests as files change
npm start; npm run cypress open

Publishing a new release to npm

1. Push to the main branch
2. Update version in package.json
3. Create a tagged commit like 1.2.3
4. Create a new GitHub release on the repo
5. (this triggers automatic github action ci that will publish the package)

Running this command create a new, tagged "release" commit including a production build and pushes it to Git and NPM.

• https://www.npmjs.com/package/radio4000-player
• https://www.jsdelivr.com/package/npm/radio4000-player

Demo

The ./demo/index.html file will be deployed to player.radio4000.com via Netlify.

With docker and doker-compose

Run docker-compose up to start a local server and down to stop it; build will re-build a new images for changes made outside of the src folder.

Profiles can be dev (for src work) or demo for the website/iframe (src from cdn).

docker-compose --profile dev up
docker-compose --profile demo up

See docker-compose.yml and Dockerfile.

With docker compose, the folder ./src is mounted as a volume, to the container is used only for the node version 16 required by the project, and changes should be reflected in the live server.

With solely docker, re-build for every change, and re-run the image to see them on local server (run inside docker).