# upnp-client-ts > A modern UPNP client made in Typescript. Latest version **1.1.1** (published 2023-12-28) · MIT license · 0 weekly downloads ## Install ```sh npm install upnp-client-ts pnpm add upnp-client-ts yarn add upnp-client-ts bun add upnp-client-ts ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.1 | | Published | 2023-12-28 | | First published | 2023-01-28 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >=18.0.0 | | Dependencies | 1 | | Unpacked size | 249.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 11 | | Author | Corentin Mors | | Maintainers | mikescops | | Keywords | upnp, client, mediarenderer, typescript, module | ## Links - npm: https://www.npmjs.com/package/upnp-client-ts - Repository: https://github.com/Mikescops/upnp-client-ts - Homepage: https://github.com/Mikescops/upnp-client-ts#readme - Issues: https://github.com/Mikescops/upnp-client-ts/issues - npm.io page: https://npm.io/package/upnp-client-ts ## Dependencies (1) - [elementtree](https://npm.io/package/elementtree.md) ^0.1.7 ## Alternatives - [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads - [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads - [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads - [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads - [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads ## Recent versions - 1.1.1 (latest) — 2023-12-28 - 1.1.0 — 2023-09-05 - 1.0.1 — 2023-01-28 - 1.0.0 — 2023-01-28 ## README # UPNP Client and MediaRenderer for NodeJS ![GitHub package.json version](https://img.shields.io/github/package-json/v/mikescops/upnp-client-ts) ![npm](https://img.shields.io/npm/v/upnp-client-ts) ![npm](https://img.shields.io/npm/dw/upnp-client-ts) ![GitHub](https://img.shields.io/github/license/mikescops/upnp-client-ts) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mikescops/upnp-client-ts/pr-validation.yml) A modern UPNP client made in Typescript. Compatible with both ESM and CommonJS. - UpnpDeviceClient: to connect to any UPNP devices - UpnpMediaRendererClient: to play medias on UPNP devices - also includes DLNA helpers ## Install ```bash $ npm install upnp-client-ts ``` ## Usage of UpnpDeviceClient ```ts import upnp from 'upnp-client'; // Instantiate a client with a device description URL (discovered by SSDP) const client = new upnp.UpnpDeviceClient('http://192.168.1.50:4873/foo.xml'); // Get the device description const deviceDescription = await client.getDeviceDescription(); console.log(deviceDescription); // Get the device's AVTransport service description const serviceDescription = await client.getServiceDescription('AVTransport'); console.log(serviceDescription); // Call GetMediaInfo on the AVTransport service const callActionResponse = await client.callAction('AVTransport', 'GetMediaInfo', { InstanceID: 0 }); console.log(callActionResponse); const listener = (event: UpnpEvent) => { console.log(event); }; await client.subscribe('AVTransport', listener); // Will receive events like { InstanceID: 0, TransportState: 'PLAYING' } when playing media await client.unsubscribe('AVTransport', listener); ``` ## Usage of UpnpMediaRendererClient ```ts import upnp from 'upnp-client'; const client = new upnp.UpnpMediaRendererClient('http://192.168.1.50:54380/MediaRenderer_HT-A9.xml'); const options = { autoplay: true, contentType: 'audio/flac', dlnaFeatures: dlnaContentFeatures, // see below for dlnaHelpers metadata: { title: 'My song', creator: 'My creator', artist: 'My artist', album: 'My album', albumArtURI: 'http://127.0.0.1/albumArtURI.jpg', type: 'audio' } }; await client.load('http://127.0.0.1/music.flac', options); await client.loadNext('http://127.0.0.1/next-music.flac', options); await client.pause(); await client.play(); await client.stop(); await client.next(); await client.previous(); await client.seek(60); // you can also call any AVTransport action supported by your device const response = await client.callAVTransport('YourCustomAVTransportCall', { InstanceID: client.instanceId }); ``` ## Usage of dlnaHelpers You can generate DLNA flags and features thanks to the provided helpers, for instance: ```ts const dlnaContentFeatures = `${upnp.dlnaHelpers.getDlnaSeekModeFeature('range')};` + `${upnp.dlnaHelpers.getDlnaTranscodeFeature(false)};` + `${upnp.dlnaHelpers.defaultFlags.DLNA_STREAMING_TIME_BASED_FLAGS}`; ``` ## Tips and tricks In the metadata you're passing to your speaker, make sure to avoid using accents and special characters. Here is a simple helper you could use: ```ts const escapeSpecialChars = (value: string) => { return value .normalize('NFD') .replace(/[\u0300-\u036f]/g, '') // remove all accents from characters .replace(/&/g, '&') .replace(//g, '>') .replace(/’/g, "'"); }; ``` ## Debugging Run with debug traces ```sh $ DEBUG=true node index.js ``` ## Inspiration This project is based on the [awesome work from @thibauts](https://github.com/thibauts/node-upnp-device-client). ## Maintainer | [![twitter/mikescops](https://avatars0.githubusercontent.com/u/4266283?s=100&v=4)](https://pixelswap.fr 'Personal Website') | | --------------------------------------------------------------------------------------------------------------------------- | | [Corentin Mors](https://pixelswap.fr/) | --- _Source: https://npm.io/package/upnp-client-ts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._