1.2.1 • Published 4 years ago
vizio-speaker v1.2.1
vizio-speaker
Module to communicate with Vizio SmartCast speakers.
(If you need to communicate with Vizio SmartCast TVs, see heathbar/vizio-smart-cast)
Example
let vizio = require('vizio-speaker')
let speaker = new vizio('192.168.0.101')
speaker.input.current().then(console.log)
// example output: 'HDMI'Installation
npm install vizio-speaker --save- Note 1: There is no discovery. You must know the IP address.
- Note 2: Pairing is required only once between each client/speaker pair.
API
All function calls return a Promise.
pair()
Pairs with speaker if not already done. Resolves to a Result.
power
| Call | Description | Resolves To |
|---|---|---|
power.get() | Get current power mode | State |
power.on() | Turn speaker on | Result |
power.off() | Turn speaker off | Result |
power.toggle() | Toggle speaker power | Result |
input
| Call | Description | Resolves To |
|---|---|---|
input.get() | Get current input mode | String |
input.list() | Get list of all input modes | Array of String |
input.set(inputName) | Set input mode | Result |
volume
| Call | Description | Resolves To |
|---|---|---|
volume.get() | Get current volume | Number |
volume.up() | Increase volume | Result |
volume.down() | Decrease volume | Result |
volume.set(level) | Set speaker volume | Result |
volume.getMute() | Get mute state | State |
volume.unmute() | Unmute | Result |
volume.mute() | Mute | Result |
volume.toggleMute() | Toggle mute state | Result |
media
| Call | Description | Resolves To |
|---|---|---|
media.play() | Resume media that was playing | Result |
media.pause() | Pause media that is playing | Result |
settings
A Menu object that replicates the menu found in the SmartCast App.
Types
Result
String <SUCCESS|INVALID_PARAMETER>
State
String <On|Off>
Menu
Object
cache- An object of the menu's last known settingsget()- A promise to retrieve the latest menu settings- other keys - Sub Menu, Setting or Action object
Setting
Object
cache- The last known value of the settingget()- A promise to retrieve the latest setting valueset(value)- A promise to change the setting value
Action
Object
do()- A promise to do the action