fridgefm-radio-core

KO | EN

gitlite — search

#swift #python #machine-learning #javascript #ios #css #golang #jquery #testing #go #docker #graphql

fridgefm-radio-core

★ 51 Open GitHub ↗

Simple lightweight package for creating your own radio station via NodeJS heavily inspired by Shoutcast and Icecast.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Radio engine for NodeJS
[![build](https://img.shields.io/github/actions/workflow/status/ch1ller0/fridgefm-radio-core/publish.yml)](https://github.com/ch1ller0/fridgefm-radio-core/actions/workflows/publish.yml)
[![coverage](https://img.shields.io/codecov/c/gh/ch1ller0/fridgefm-radio-core.svg)](https://codecov.io/gh/ch1ller0/fridgefm-radio-core)
[![npm](https://img.shields.io/npm/dm/@fridgefm/radio-core.svg)](https://www.npmjs.com/package/@fridgefm/radio-core)
![GitHub](https://img.shields.io/github/license/ch1ller0/fridgefm-radio-core.svg)

## Usage

> Simple lightweight package to start your own `live` radio station 📻 Just drop your `mp3` files and broadcast them to the world 🌎Heavily inspired by [Shoutcast](https://www.shoutcast.com) and [Icecast](http://icecast.org).

## Setup

### Installation
```
npm i @fridgefm/radio-core --save
```
### Server
```ts
const { Station } = require('@fridgefm/radio-core');
const station = new Station();

station.addFolder('User/Music');

server.get('/stream', (req, res) => {
  station.connectListener(req, res);
});

station.start();
```
### Client
```html
<audio
    controls
    type='audio/mp3'
    src='/stream'
/>
```

## Station constructor
Creating a station is as simple as 
```ts
const myAwesomeStation = new Station({
  verbose: false, // if true - enables verbose logging (for debugging purposes),
  responseHeaders: { // in case you want custom response headers for your endpoint
    'icy-genre': 'jazz'
  }
})
```

## Station methods
`connectListener` connects real users to your station, this is the only method that should be exposed to listeners  
response argument is required
```ts
station.connectListener(request, response, callback);
```
`addFolder` adds track within a folder to the playlist
```ts
station.addFolder('User/Music');
```
`start` starts broadcasting
```ts
station.start();
```
`next` instantly switches track to the next one
```ts
station.next();
```
`togglePause` pauses the stream
```ts
station.togglePause(); // no argument, changes the pause state to the opposite
station.togglePause(true); // force pause, regardless of the previous state
station.togglePause(false); 
```
`getPlaylist` just returns you the entire playlist
```ts
station.getPlaylist();
```
`reorderPlaylist` lets you manipulate the entire playlist via passed callback
```ts
const myShuffleMethod = (list) => list
  // doubles the list (making it twice as long)
  .concat(list)
  // filters out the specific track
  .filter(track => track.fsStats.name !== 'Artist - Track');

station.reorderPlaylist(myShuffleMethod);
```
There are also some built-in shuffle methods
```ts
const { SHUFFLE_METHODS } = require('@fridgefm/radio-core')

// This one randomly shuffles the playlist (keeping the length the same)
station.reorderPlaylist(SHUFFLE_METHODS.randomShuffle());

// This one moves the track on the 1st position and moves it to the 2nd position 
station.reorderPlaylist(SHUFFLE_METHODS.rearrange({ from: 1, to: 2 }));

```
`on` lets you make a subscription to station events (see below)

## Station events
Station emits several events - they are available via 
```ts
const { PUBLIC_EVENTS } = require('@fridgefm/radio-core')
```
#### `NEXT_TRACK`
event fires when track changes  
useful for getting to know when exactly the track changed and what track that is
```ts
station.on(PUBLIC_EVENTS.NEXT_TRACK, (track) => {
  const result = await track.getMetaAsync();
  console.log(result)
})
```

#### `START`
Event fires on station start  
```ts
station.on(PUBLIC_EVENTS.START, () => { console.log('Station started') });
```

#### `RESTART`
Event fires on station restart (when playlist is drained and new one is created)  
it might be a nice time to shuffle your playlist for example
```ts
station.on(PUBLIC_EVENTS.RESTART, () => { /* do something*/ });
```

#### `ERROR`
Event fires when there is some error. You `should` add this handler - otherwise any error will be treated as unhandled (causing `process.exit` depending on Node version)
```ts
station.on(PUBLIC_EVENTS.ERROR, (e) => { handleError(e) });
```

> or just go to [examples](./examples/server.js)
## Development
```
npm run dev
```
or
```
npm run dev [path/to/your_mp3tracks]
# in this case it would take a little more time, just wait
```

## Demo
Sandbox is available here on [Codesandbox](https://codesandbox.io/p/github/ch1ller0/fridgefm-radio-core/main)\
Fully working demo is available on [FridgeFM](https://fridgefm.com)

fridgefm-radio-core

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README