@sovpro/heos-lib/lib/declarations.js

A Node.js library for HEOS device interaction

const {
  matchingProps
, getPayload
, getMessage
, getItems
, makeBrowseSourceShortcut
} = require ('./util')

const declrations = [

  { name: 'registerForChangeEvents'
  , command: 'system/register_for_change_events'
  , args: ['enable']
  , success: getMessage
  , sequence: true
  }

, { name: 'checkAccount'
  , command: 'system/check_account'
  , success: getMessage
  }

, { name: 'signIn'
  , command: 'system/sign_in'
  , args: ['un', 'pw']
  , success: getMessage
  }

, { name: 'signOut'
  , command: 'system/sign_out'
  , success: getMessage
  }

, { name: 'heartBeat'
  , command: 'system/heart_beat'
  , success: getMessage
  }

, { name: 'getPlayers'
  , command: 'player/get_players'
  , success: getPayload
  }

, { name: 'getPlayerInfo'
  , command: 'player/get_player_info'
  , args: ['pid']
  , success: getPayload
  , sequence: true
  }

, { name: 'getPlayState'
  , command: 'player/get_play_state'
  , args: ['pid']
  , success: getMessage
  }

, { name: 'setPlayState'
  , command: 'player/set_play_state'
  , args: ['pid', 'state']
  , success: getMessage
  , sequence: true
  }

, { name: 'getNowPlayingMedia'
  , command: 'player/get_now_playing_media'
  , args: ['pid']
  , success: getPayload
  , sequence: true
  }

, { name: 'getVolume'
  , command: 'player/get_volume'
  , args: ['pid']
  , success: getMessage
  }

, { name: 'setVolume'
  , command: 'player/set_volume'
  , args: ['pid', 'level']
  , success: getMessage
  , sequence: true
  }

, { name: 'volumeUp'
  , command: 'player/volume_up'
  , args: ['pid', 'step']
  , success: getMessage
  , sequence: true
  }

, { name: 'volumeDown'
  , command: 'player/volume_down'
  , args: ['pid', 'step']
  , success: getMessage
  , sequence: true
  }

, { name: 'getMute'
  , command: 'player/get_mute'
  , args: ['pid']
  , success: getMessage
  }

, { name: 'setMute'
  , command: 'player/set_mute'
  , args: ['pid', 'state']
  , success: getMessage
  , sequence: true
  }

, { name: 'toggleMute'
  , command: 'player/toggle_mute'
  , args: ['pid']
  , success: getMessage
  , sequence: true
  }

, { name: 'getPlayMode'
  , command: 'player/get_play_mode'
  , args: ['pid']
  , success: getMessage
  }

, { name: 'setPlayMode'
  , command: 'player/set_play_mode'
  , args: ['pid', 'repeat', 'shuffle']
  , success: getMessage
  , sequence: true
  }

, { name: 'getQueue'
  , command: 'player/get_queue'
  , args: ['pid', 'range']
  , success: getItems
  , sequence: true
  }

, { name: 'playQueueItem'
  , command: 'player/play_queue'
  , args: ['pid', 'qid']
  , success: getMessage
  , sequence: true
  }

, { name: 'removeFromQueue'
  , command: 'player/remove_from_queue'
  , args: ['pid', 'qid']
  , success: getMessage
  , sequence: true
  }

, { name: 'saveQueue'
  , command: 'player/save_queue'
  , args: ['pid', 'name']
  , success: getMessage
  , sequence: true
  }

, { name: 'clearQueue'
  , command: 'player/clear_queue'
  , args: ['pid']
  , success: getMessage
  , sequence: true
  }

, { name: 'moveQueueItem'
  , command: 'player/move_queue_item'
  , args: ['pid', 'sqid', 'dqid']
  , success: getMessage
  , sequence: true
  }

, { name: 'playNext'
  , command: 'player/play_next'
  , args: ['pid']
  , success: getMessage
  , sequence: true
  }

, { name: 'playPrevious'
  , command: 'player/play_previous'
  , args: ['pid']
  , success: getMessage
  , sequence: true
  }

, { name: 'getMusicSources'
  , command: 'player/get_music_sources'
  , success: getPayload
  }

, { name: 'getSourceInfo'
  , command: 'player/get_source_info'
  , args: ['sid']
  , success: getPayload
  }

, { name: 'browseSource'
  , command: 'browse/browse'
  , args: ['sid', 'range']
  , success: getItems
  , sequence: true
  }

, { name: 'browseSourceContainers'
  , command: 'browse/browse'
  , args: ['sid', 'cid', 'range']
  , success: getItems
  , sequence: true
  }

, { name: 'getSourceSearchCriteria'
  , command: 'player/get_search_criteria'
  , args: ['sid']
  , success: getPayload
  , sequence: true
  }

, { name: 'browseSearch'
  , command: 'browse/search'
  , args: ['sid', 'search', 'scid', 'range']
  , success: getItems
  , sequence: true
  }

, { name: 'playStation'
  , command: 'browse/play_stream'
  , args: ['sid', 'cid', 'mid', 'pid', 'name']
  , success: getMessage
  , sequence: true
  }

, { name: 'playPresetStation'
  , command: 'browse/play_preset'
  , args: ['pid', 'preset']
  , success: getMessage
  , sequence: true
  }

, { name: 'playInputSource'
  , command: 'browse/play_input'
  , args: ['pid', 'input']
  , success: getMessage
  , sequence: true
  }

, { name: 'playInputSourceFrom'
  , command: 'browse/play_input'
  , args: ['pid', 'spid', 'input']
  , success: getMessage
  , sequence: true
  }

, { name: 'playUrl'
  , command: 'browse/play_stream'
  , args: ['pid', 'url']
  , success: getMessage
  }

, { name: 'addContainerToQueue'
  , command: 'browse/add_to_queue'
  , args: ['sid', 'cid', 'aid', 'pid']
  , success: getMessage
  , sequence: true
  }

, { name: 'addTrackToQueue'
  , command: 'browse/add_to_queue'
  , args: ['sid', 'cid', 'mid', 'aid', 'pid']
  , success: getMessage
  , sequence: true
  }

, { name: 'getHeosPlaylists'
  , func:  makeBrowseSourceShortcut ('Playlists')
  }

, { name: 'getHeosFavorites'
  , func:  makeBrowseSourceShortcut ('Favorites')
  }

, { name: 'renameHeosPlaylist'
  , command: 'browse/rename_playlist'
  , args: ['sid', 'cid', 'name']
  , success: getMessage
  , sequence: true
  }

, { name: 'deleteHeosPlaylist'
  , command: 'browse/delete_playlist'
  , args: ['sid', 'cid']
  , success: getMessage
  , sequence: true
  }

, { name: 'getHeosHistory'
  , func: async function (type, range) {
      let _type = type
      let _range = range
      if (typeof type === 'object') {
        _type = type.type
        _range = type.range
      }
      const music_sources = await this.getMusicSources ()
      const history_source = music_sources.find (matchingProps ({name: 'History'}, false))
      const response = await this.browseSource (history_source.sid)
      const typed = response.items.find (matchingProps ({name: _type}, false))
      return this.browseSourceContainers (history_source.sid, typed.cid, _range)
    }
  }

, { name: 'retrieveMetadata'
  , command: 'browse/retrieve_metadata'
  , args: ['sid', 'cid']
  , success: getPayload
  , sequence: true
  }

, { name: 'setServiceOption'
  , command: 'browse/set_service_option'
  , args: ['sid', 'option', 'pid']
  , success: getMessage
  , sequence: true
  }

]

module.exports = {
  get declarations () {
    return declrations.slice ()
  }
}