# discord-radio-player

> An easy to radio player for discord which supports over 25k radios over the world.With custom ffmpeg filters support!

Latest version **1.6.0** (published 2020-07-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install discord-radio-player
pnpm add discord-radio-player
yarn add discord-radio-player
bun add discord-radio-player
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.6.0 |
| Published | 2020-07-30 |
| First published | 2020-07-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 18 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Abh80 |
| Maintainers | abh78989 |

## Links

- npm: https://www.npmjs.com/package/discord-radio-player
- Repository: https://github.com/abh80/discord-radio-player
- Homepage: https://github.com/abh80/discord-radio-player#readme
- Issues: https://github.com/abh80/discord-radio-player/issues
- npm.io page: https://npm.io/package/discord-radio-player

## Dependencies (4)

- [@types/ws](https://npm.io/package/@types/ws.md) ^7.2.6
- [discord.js](https://npm.io/package/discord.js.md) ^12.2.0
- [prism-media](https://npm.io/package/prism-media.md) ^1.2.2
- [radio-browser](https://npm.io/package/radio-browser.md) ^2.1.2

## Recent versions

- 1.6.0 (latest) — 2020-07-30
- 1.5.0 — 2020-07-29
- 1.1.0 — 2020-07-28
- 1.0.2 — 2020-07-28
- 1.0.0 — 2020-07-28

## README

# discord-radio-player
A radio player module for discord which has custom ffmpeg args support.
# Installation
```bash
npm i discord-radio-player
```
# Installing Required Dependencies
```bash
npm i @discordjs/opus ffmpeg-static
```

# Searching Radio
```js
const radio = require('discord-radio-player')
const search = await radio.Radio.search({searchterm:'kissfm',limit:1,by:'name'}) //returns radio results by name
```
# Playing Radio from search results
```js
const radio = require('discord-radio-player')
const search = await radio.Radio.search({searchterm:'kissfm',limit:1})
let streamUrl = search[0].url_resolved
let stream = radio.Radio.getStream(streamUrl)
message.member.voice.channel.join().then(c=>c.play(stream,{type:'opus'}))
//starts playing radio
```
# Adding Custom FFmpeg filters
This is an example for enabling bassboost filter
```js
const radio = require('discord-radio-player')
const search = await radio.Radio.search({searchterm:'kissfm',limit:1})
let streamUrl = search[0].url_resolved
// loading filters
let FFmpegfilters = [
    "-af","bass=g=20,dynaudnorm" //bassboost filter for example
]
let stream = radio.Radio.getStream(streamUrl,{filters:FFmpegfilters}) //defining filters 
message.member.voice.channel.join().then(c=>c.play(stream,{type:'opus'}))
//starts playing radio
```
# Setting Volume
```js
let stream = radio.Radio.getStream(streamUrl,{volume:2}) // 1 is default volume and 2 is double volume whereas 0.5 is half volume
```
# Pre Existing Filters
- Bassboost
```js
const radio = require('discord-radio-player')
const search = await radio.Radio.search({searchterm:'kissfm',limit:1})
let streamUrl = search[0].url_resolved
// Adding bassboost effect
let stream = radio.Radio.getStream(streamUrl,{bassboost:30}) //sets the bassboost to 30DB
// bassboost with normalizer
let stream = radio.Radio.getStream(streamUrl,{bassboost:30,normalizer:true}
message.member.voice.channel.join().then(c=>c.play(stream,{type:'opus'}))
//starts playing radio
```
- 8D
```js
let streamUrl = search[0].url_resolved
// Adding 8D effect
let stream = radio.Radio.getStream(streamUrl,{'8d':true}) //generates 8d effect x)
```
- Karaoke
```js
let streamUrl = search[0].url_resolved
// Adding karaoke effect
let stream = radio.Radio.getStream(streamUrl,{karaoke:true}) //generates karaoke like effect
```
- Pulsator
```js
let streamUrl = search[0].url_resolved
// Adding pulsator effect
let stream = radio.Radio.getStream(streamUrl,{pulsator:true}) //generates pulsator effect
```

---
_Source: https://npm.io/package/discord-radio-player · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._