JSPM – nodecast@0.0.5

Package Exports

nodecast

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (nodecast) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Information

Package	nodecast
Description	Node interface to DIAL/RAMP/ChromeCast
Node Version	>= 0.4

This library has been tested with ChromeCast, Roku, and a Panasonic Viera TV. It fully supports any device that uses the DIAL protocol. RAMP support is being worked on for certain ChromeCast functionality.

How this works

DIAL

This uses the DIAL discovery protocol over SSDP to discover devices. Once you get a device, you can access applications on it using the DIAL relaxation protocol.

Client Usage

var nodecast = require('nodecast');

var devices = nodecast.find();

devices.once('device', function(device) {
    var yt = device.app('YouTube');

    yt.info(function(err, info){
        // returns info about the app
        // who wrote it, capabilities, etc.
    });

    yt.start('v=12345', function(err) {
        // starts the app on the device
        // also optionally takes data to pass to the app
        // (for example: youtube takes v=id to launch with a video)
    });
    
    yt.stop(function(err){});
    
    // RAMP stuff
    yt.connect();
    yt.send('hey youtube');
});

Command Line

This comes with two demo command line tools.

rollcast will play rick roll on every device in your network.

ytcast <video url> will play a youtube video of your choice on every device in your network.

Custom Devices

If you look in ./lib/devices you can see we have custom support for certain devices. Every vendor has their own spin on DIAL so we try to support the cool stuff they add on top of it. ChromeCast for example, has it's own RAMP protocol. Roku has an interface that lets you emulate a remote. Viera has some limitations.

ChromeCast

RAMP support is still being worked on. RAMP is DIAL + a WebSocket to do streaming video progress and more. Currently Netflix isn't working either due to their proprietary protocol.

Examples

You can view more examples in the example folder.

Testing

To run the tests you either need to run the ChromeCast emulator locally. Mute your speakers because it will pop up videos and close them.

LICENSE

(MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.