# airplay-js

> JS Native Apple AirPlay client library for AppleTV

Latest version **0.3.0** (published 2016-07-01) · 0 weekly downloads

## Install

```sh
npm install airplay-js
pnpm add airplay-js
yarn add airplay-js
bun add airplay-js
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2016-07-01 |
| First published | 2014-07-21 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | zfkun |
| Maintainers | guerrerocarlos |
| Keywords | apple, mac, media, airplay, hls, ffmpeg |

## Links

- npm: https://www.npmjs.com/package/airplay-js
- npm.io page: https://npm.io/package/airplay-js

## Dependencies (2)

- [mdns-js](https://npm.io/package/mdns-js.md) 0.5.0
- [plist-with-patches](https://npm.io/package/plist-with-patches.md) 0.5.1

## Recent versions

- 0.3.0 (latest) — 2016-07-01
- 0.2.16 — 2015-09-21
- 0.2.15 — 2015-04-23
- 0.2.13 — 2015-03-21
- 0.2.12 — 2015-02-20
- 0.2.11 — 2015-01-11
- 0.2.10 — 2015-01-11
- 0.2.9 — 2015-01-11
- 0.2.8 — 2015-01-11
- 0.2.7 — 2015-01-10
- 0.2.6 — 2014-11-28
- 0.2.5 — 2014-10-26
- 0.2.4 — 2014-10-23
- 0.2.3 — 2014-10-14
- 0.2.2 — 2014-08-01
- … 2 more at https://npm.io/package/airplay-js/versions

## README

node-airplay 
=================

node-airplay is a native javascript client library for Apple's AirPlay remote playback protocol.

## Installation

From npm:

	npm install airplay-js

## Usage

``` javascript
// remote video
var browser = require( 'airplay-js' ).createBrowser();
browser.on( 'deviceOn', function( device ) {
    device.play( 'http://remotehost/video.mp4', 0, function() {
        console.info( 'video playing...' );
    });
});
browser.start();
```

## Testing

```
npm install
npm test
```
...then, turn on your AppleTV!


## Help

+ [Unofficial AirPlay Protocol Specification](http://nto.github.io/AirPlay.html)
+ [HLS(HTTP Live Streaming)](http://tools.ietf.org/html/draft-pantos-http-live-streaming-12)
+ [ffmpeg build for ios](http://www.cocoachina.com/bbs/read.php?tid=142628&page=1)
+ [ffmpeg build for MacOS](http://trac.ffmpeg.org/wiki/MacOSXCompilationGuide#Shortcut:CompileFFmpegthroughHomebrew)
+ [mdns User Guide](http://agnat.github.io/node_mdns/user_guide.html)


## API

+ [Browser](https://github.com/zfkun/node-airplay/wiki/Browser-API)
+ [Device](https://github.com/zfkun/node-airplay/wiki/Device-API)
+ [Client](https://github.com/zfkun/node-airplay/wiki/Client-API)
+ [HLS](https://github.com/zfkun/node-airplay/wiki/HLS-API)

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