node-mpv/lib/mpv/_commands.js

A Node module for MPV

'use strict';
var cuid    = require('cuid');
var Promise = require('promise');

var commands = {
	// will send a get request for the specified property
	// if no idea is provided this will return a promise
	// if an id is provied the answer will come via a 'getrequest' event containing the id and data
	getProperty: function(property, id){
		// when the id is set use the classic approach
		if(id){
			console.log("Warning: Using getProperty with an id/event is DEPRECATED. Use the promise version instead.\nThis function version will be removed in a future release");
			this.socket.getProperty(property, id);
		}
		// when no id was set use the promise way
		else{
			// request Id
			let requestId = cuid()

			return new Promise(function(resolve, reject) {

				// this will be set by the message returned by mpv to resolve the promise
				// see the on('message') part in mpv.js
				this.gottenProperties[requestId] = resolve;

				// make the get request
				this.socket.getProperty(property, requestId);

			}.bind(this));
		}

	},
	// set a property specified by the mpv API
	setProperty: function(property, value){
		this.socket.setProperty(property, value);
	},
	// sets all properties defined in the properties Json object
	setMultipleProperties: function(properties){
		Object.keys(properties).forEach(function (property) {
			this.socket.setProperty(property, properties[property]);
		}.bind(this));
	},
	// adds the value to the property
	addProperty: function(property, value){
		this.socket.addProperty(property, value);
	},
	// multiplies the specified property by the value
	multiplyProperty: function(property, value) {
		this.socket.multiplyProperty(property, value);
	},
	// cycles a arbitrary property
	cycleProperty: function(property){
		this.socket.cycleProperty(property);
	},
	// send a command with arguments to mpv
	command: function(command, args){
		this.socket.command(command, args);
	},
	// sends a command specified by a JSON object to mpv
	commandJSON: function(command){
		this.socket.freeCommand(JSON.stringify(command));
	},
	// send a freely writeable command to mpv.
	// the required trailing \n will be added
	freeCommand: function(command){
		this.socket.freeCommand(command);
	},



	// observe a property for changes
	// will be added to event for property changes
	observeProperty: function(property, id) {
		this.observed[property] = null;
		this.observedIDs[id] = property;
		this.socket.command("observe_property", [id, property]);
	},
	// stop observing a property
	unobserveProperty: function(id) {
		delete this.observed[this.observedIDs[id]];
		delete this.observedIDs[id];
		this.socket.command("unobserve_property", [id]);
	}
}

module.exports = commands;