UPnP Remote


Remote control for UPnP media devices (tv, speakers, amplifiers, network streamers).

Install

npm i node-upnp-remote

Usage

``js
const UPnPRemote = require('node-upnp-remote');

const remote = new UPnPRemote({
url: 'http://192.168.1.150:44042/some.xml'
});

function volumeHandler(vol) {
console.log('Volume', vol);
}

await remote.on('Volume', volumeHandler);
const volume = await remote.getVolume();
await remote.setVolume(volume + 1);
await remote.off('Volume', volumeHandler);

`

$3

UPnP Remote adds following events for convenience:

- Transitioning
- Playing
- Paused
- Stopped

_note that all events names start with a capital letter as it is defined in UPnP_

API

$3

loads the media file to the device. Options are:

* __protocolInfo__ – protocol information
* __upnpClass__ - string, or you can use const upnpclass = require('node-upnp-remote/upnpclass');
* __autoplay__ - boolean
* __uri__ – string, uri to the file
* __title__ – string, file title
* __creator__ - string, file creator

or

* __protocolInfo__ – protocol information
* __uri__ – string, uri to the file
* __metadata__ – object that reperesent metadata XML. Example:

`json
{
"@id": 0,
"@parentId": -1,
"@restricted": false,
"upnp:class": "object.item.audioItem",
"dc:title": "Title",
"dc:creator": "Artist",
"res": {
"@protocolInfo": "http-get::video/mp3:",
"#text": "https://archive.org/download/testmp3testfile/mpthreetest.mp3"
}
}
`

_Properties names start with '@' will be parsed as attributes in the XML_

$3

adds UPnP event listener

$3

removes UPnP event listener

$3

removes all listeners from all UPnP events

$3

sets the play speed, default is 1

$3

pauses current playback

$3

stops current playback

$3

sets the playback time to seconds`

$3

switches to next track

$3

switches to previous track

$3

Gets the volume for the channel

$3

Sets the volume for the channel

$3

gets the mute state for the channel

$3

sets the mute state for the channel

$3

returns the supported protocols

$3

returns the current media info

$3

returns the current position

$3

returns the transport info

$3

returns the transport settings

$3

returns the device capabilities

License MIT