Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/azuracast/nowplaying

A lightweight PHP adapter for viewing the current now playing data in Icecast and SHOUTcast 1/2. A part of the AzuraCast software suite.
https://github.com/azuracast/nowplaying

azuracast icecast library php shoutcast web-radio webcasting

Last synced: about 6 hours ago
JSON representation

A lightweight PHP adapter for viewing the current now playing data in Icecast and SHOUTcast 1/2. A part of the AzuraCast software suite.

Awesome Lists containing this project

README

        

# NowPlaying

NowPlaying is a lightweight, modern, object-oriented PHP library that abstracts out the currently playing metadata from
popular radio broadcast software into a single common return format.

### Installing

NowPlaying is a Composer package that you can include in your project by running:

```bash
composer require azuracast/nowplaying
```

### Compatibility

| | Now Playing data | Detailed client information |
|----------------|------------------|-----------------------------|
| Icecast (2.4+) | ✅ | ✅ |
| SHOUTcast 2 | ✅ | ✅ |
| SHOUTcast 1 | ✅ | ❌ |

### Usage Example

```php
getAdapter(
NowPlaying\Enums\AdapterType::Shoutcast2,
'http://my-station-url.example.com:8000'
);

// You can also call:
// $adapterFactory->getShoutcast2Adapter('http://url');

// Optionally set administrator password
$adapter->setAdminUsername('admin'); // "admin" is the default
$adapter->setAdminPassword('AdminPassword!');

// The first argument to the functions is the mount point or
// stream ID (SID), to pull one specific stream's information.
$now_playing = $adapter->getNowPlaying('1');

$clients = $adapter->getClients('1');
```

Example "now playing" response (PHP objects represented in JSON):

```json
{
"currentSong": {
"text": "Joe Bagale - Until We Meet Again",
"title": "Until We Meet Again",
"artist": "Joe Bagale"
},
"listeners": {
"total": 0,
"unique": 0
},
"meta": {
"online": true,
"bitrate": 128,
"format": "audio/mpeg"
},
"clients": []
}
```

Example "clients" response:

```json
[
{
"uid": 1,
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.81 Safari/537.36",
"connectedSeconds": 123
}
]
```