cast-scanner v1.0.0

cast-scanner

Scan your local network for all Chromecast devices.

Originally based on xat/chromecast-scanner.

Installation

npm install dcpesses/cast-scanner

Usage

var scanner = require('cast-scanner');

Results can be obtained through either a callback and/or an event.

Simple Callback

scanner(function(data) {
    console.log('data:', data);
});

Event Listener

scanner.on('results', function(data) {
    console.log('data:', data);
});

More usage examples can be found in the examples folder.

API

scanner([options], [callback]);

• options: Object (optional)
• ttl Number (optional) - Lifespan (in milliseconds) to wait for responses from all devices. Default: 5000
• mdns Object (optional) - Config to pass to multicast-dns. Default: {}
• debug: Verbose logging to console. Default: false
• callback Function (optional)

Returns CastScanner instance

Creates a CastScanner instance using any provided options and/or a callback function.

Events

Event: init Returns:

• event Event
• type String
• timestamp Number - Unix timestamp of when initialization occurred.

Emitted after the module is initialized.

Event: update Returns:

• event Event
• type String
• device Object - Chromecast device object
• name String - Local domain name
• displayName String - Name displayed to users
• shortName String
• host String
• ip String - IP address of device
• records Object - DNS records received from device like (e.g. "A", "SRV", "TXT", etc)

Emitted when a response is received from a valid casting device.

Event: close Returns:

• event Event
• type String
• timestamp Number - Unix timestamp of when initialization occurred.
• duration Number - Approximate ttl used to wait for device responses.

Emitted when the connection is closed

Event: results Returns:

• event Event
• type String
• devices Array - All valid Chromecast devices found.

Emitted once the scanner is no longer listening for any more devices and all of the responses have been processed.

Each object in the devices array uses the same format as the details object emitted from an 'update' event.

Methods

scanner.close()

Stops waiting for device responses and clears the ttl timeout.

License

MIT