Get favorites from sonos

[gupsho]

Is it possible to get a list of favorites from sonos?

[bencevans]

Appears to have been implemented for radio but that is all. PR welcome 😸

node-sonos/lib/sonos.js

Lines 951 to 1019 in 230a6b8

	/**
	* Get Favorites Radio Stations
	* @param {Object} options Optional - default {start: 0, total: 100}
	* @param {Function} callback (err, result) result - {returned: {String}, total: {String}, items:[{title:{String}, uri: {String}}]}
	*/
	Sonos.prototype.getFavoritesRadioStations = function (options, callback) {
	this.getFavoritesRadio('stations', options, callback)
	}
	/**
	* Get Favorites Radio Shows
	* @param {Object} options Optional - default {start: 0, total: 100}
	* @param {Function} callback (err, result) result - {returned: {String}, total: {String}, items:[{title:{String}, uri: {String}}]}
	*/
	Sonos.prototype.getFavoritesRadioShows = function (options, callback) {
	this.getFavoritesRadio('shows', options, callback)
	}
	/**
	* Get Favorites Radio for a given radio type
	* @param {String} favoriteRadioType Choice - stations, shows
	* @param {Object} options Optional - default {start: 0, total: 100}
	* @param {Function} callback (err, result) result - {returned: {String}, total: {String}, items:[{title:{String}, uri: {String}}]}
	*/
	Sonos.prototype.getFavoritesRadio = function (favoriteRadioType, options, callback) {
	var radioTypes = {
	'stations': 'R:0/0',
	'shows': 'R:0/1'
	}
	var defaultOptions = {
	BrowseFlag: 'BrowseDirectChildren',
	Filter: '*',
	StartingIndex: '0',
	RequestedCount: '100',
	SortCriteria: '',
	ObjectID: 'R:0/0'
	}
	var opts = {
	ObjectID: radioTypes[favoriteRadioType]
	}
	if (options.start !== undefined) opts.StartingIndex = options.start
	if (options.total !== undefined) opts.RequestedCount = options.total
	opts = _.extend(defaultOptions, opts)
	var contentDirectory = new Services.ContentDirectory(this.host, this.port)
	return contentDirectory.Browse(opts, function (err, data) {
	if (err) return callback(err)
	return (new xml2js.Parser()).parseString(data.Result, function (err, didl) {
	if (err) return callback(err, data)
	var items = []
	if ((!didl) || (!didl['DIDL-Lite'])) {
	return callback(new Error('Cannot parse DIDTL result'), data)
	}
	var resultcontainer = didl['DIDL-Lite'].item
	if (!Array.isArray(resultcontainer)) {
	return callback(new Error('Cannot parse DIDTL result'), data)
	}
	_.each(resultcontainer, function (item) {
	items.push({
	'title': Array.isArray(item['dc:title']) ? item['dc:title'][0] : null,
	'uri': Array.isArray(item.res) ? item.res[0]._ : null
	})
	})
	var result = {
	returned: data.NumberReturned,
	total: data.TotalMatches,
	items: items
	}
	return callback(null, result)
	})
	})
	}