Skip to content

Added syntax highlighting to readme examples #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
amilajack wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added syntax highlighting to readme examples #15

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d59fd7
Added syntax highlighting to readme example
amilajack Sep 14, 2016
5d7eb68
Changed Quickstart to Example
amilajack Sep 14, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
189 changes: 98 additions & 91 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,27 +16,24 @@ Coming soon (maybe):
* Robust error handling
* Better device information formatting (supported features/etc)

## Quickstart
## Example

npm install airplay
node
> var browser = require('airplay').createBrowser();
> browser.on('deviceOnline', function(device) {
device.play('http://host/somevideo.mp4', 0);
});
> browser.start();
```js
const browser = require('airplay').createBrowser();

## Installation

With [npm](http://npmjs.org):
browser.on('deviceOnline', (device) => {
device.play('http://host/somevideo.mp4', 0);
});

npm install airplay
browser.start();
```

From source:
## Installation

cd ~
git clone https://benvanik@github.com/benvanik/node-airplay.git
npm link node-airplay/
With [npm](http://npmjs.org):
```console
npm install airplay --save
```

node-airplay depends on both
[node-plist](https://github.com/TooTallNate/node-plist) and
Expand All @@ -47,10 +44,12 @@ resulting in [a fork](https://github.com/benvanik/node_mdns).
If you're running node on FreeBSD (or maybe Linux) you may get errors during
install about a missing dns_sd.h file. If so, install the Apple mDNS SDK:

wget http://www.opensource.apple.com/tarballs/mDNSResponder/mDNSResponder-522.1.11.tar.gz
tar zxvf mDNSResponder-522.11.tar.gz
cd mDNSResponder-333.10/mDNSPosix/
sudo gmake os=freebsd install
```console
wget http://www.opensource.apple.com/tarballs/mDNSResponder/mDNSResponder-522.1.11.tar.gz
tar zxvf mDNSResponder-522.11.tar.gz
cd mDNSResponder-333.10/mDNSPosix/
sudo gmake os=freebsd install
```

## API

Expand All @@ -61,31 +60,34 @@ AirPlay-compatiable devices on the local network(s). Try only to create one
browser per node instance, and if it's no longer needed stop it.

Create a browser using the `createBrowser` method:

var browser = require('airplay').createBrowser();
```js
const browser = require('airplay').createBrowser();
```

Attach to the browser events to track device discovery:

browser.on('deviceOnline', function(device) {
console.log('device online: ' + device.id);
});
browser.on('deviceOffline', function(device) {
console.log('device offline: ' + device.id);
});
```js
browser.on('deviceOnline', (device) => {
console.log('device online: ' + device.id);
});
browser.on('deviceOffline', (device) => {
console.log('device offline: ' + device.id);
});
```

Start or stop the discovery process:

browser.start();
browser.stop();
```js
browser.start();
browser.stop();
```

If you are running a server you can use the built-in device list instead of
maintaining your own via the events:

function myHandler() {
var devices = browser.getDevices();
console.log(devices);
}

```js
function myHandler() {
const devices = browser.getDevices();
console.log(devices);
}
```
### Device

A device instance represents a single AirPlay device on the local network.
Expand All @@ -94,66 +96,71 @@ connection. Each device has only a single control channel, and all methods are
asynchronous.

Obtain devices using the browser API:

// Get all ready devices
var allDevices = browser.getDevices();
// Grab a device to play with
var device = allDevices[0];
```js
// Get all ready devices
const allDevices = browser.getDevices();
// Grab a device to play with
const device = allDevices[0];
```

*TODO* At some point, you'll be able to connect directly:

var device = require('airplay').connect(deviceHost);
device.on('ready', function() {
// Ready to accept commands
});
```js
const device = require('airplay').connect(deviceHost);
device.on('ready', () => {
// Ready to accept commands
});
```

If you are done with the device, close the connection (note that this will stop
any playback):

device.close();
```js
device.close();
```

Issue various device control calls. All calls are asynchronous and have an
optional callback that provides the result - for most, it's an empty object if
the call was successful and null if the call failed.

// Get the current playback status
device.getStatus(function(res) {
// res = {
// duration: number, -- in seconds
// position: number, -- in seconds
// rate: number, -- 0 = paused, 1 = playing
// ...
// }
// or, if nothing is playing, res = {}
});

// Play the given content (audio/video/etc)
var content = 'http://host/content.mp4';
var startPosition = 0; // in seconds
device.play(content, startPosition, function(res) {
if (res) {
// playing
} else {
// failed to start playback
}
});

// Stop playback and return to the main menu
device.stop();

// Seek to the given offset in the media (if seek is supported)
var position = 500; // in seconds
device.scrub(position);

// Reverse playback direction (rewind)
// NOTE: may not be supported
device.reverse();

// Change the playback rate
// NOTE: only 0 and 1 seem to be supported for most media types
var rate = 0; // 0 = pause, 1 = resume
device.rate(rate);

// Adjust playback volume
// NOTE: may not be supported
device.volume(value);
```js
// Get the current playback status
device.getStatus(function(res) {
// res = {
// duration: number, -- in seconds
// position: number, -- in seconds
// rate: number, -- 0 = paused, 1 = playing
// ...
// }
// or, if nothing is playing, res = {}
});

// Play the given content (audio/video/etc)
const content = 'http://host/content.mp4';
const startPosition = 0; // in seconds
device.play(content, startPosition, (res) => {
if (res) {
// playing
} else {
// failed to start playback
}
});

// Stop playback and return to the main menu
device.stop();

// Seek to the given offset in the media (if seek is supported)
const position = 500; // in seconds
device.scrub(position);

// Reverse playback direction (rewind)
// NOTE: may not be supported
device.reverse();

// Change the playback rate
// NOTE: only 0 and 1 seem to be supported for most media types
const rate = 0; // 0 = pause, 1 = resume
device.rate(rate);

// Adjust playback volume
// NOTE: may not be supported
device.volume(value);
```