navidrome/core/agents
Deluan 8afa2cd833 Remove dependency of deprecated `ioutil` package 2021-07-20 20:12:28 -04:00
..
lastfm Remove dependency of deprecated `ioutil` package 2021-07-20 20:12:28 -04:00
spotify Remove dependency of deprecated `ioutil` package 2021-07-20 20:12:28 -04:00
README.md Add some info about how to create new agents 2021-02-08 17:18:43 -05:00
agents.go Fix small lint errors found by gocritic 2021-07-15 13:43:03 -04:00
agents_suite_test.go Add a cached http client 2021-02-08 16:54:51 -05:00
agents_test.go Send NowPlaying and Scrobbles to Last.fm 2021-06-23 11:01:58 -04:00
interfaces.go Refactor Agents to be singleton 2021-06-23 11:01:58 -04:00
placeholders.go Refactor Agents to be singleton 2021-06-23 11:01:58 -04:00

README.md

This folder abstracts metadata lookup into "agents". Each agent can be implemented to get as much info as the external source provides, by using a granular set of interfaces (see interfaces].

A new agent must comply with these simple implementation rules:

  1. Implement the AgentName() method. It just returns the name of the agent for logging purposes.
  2. Implement one or more of the *Retriever() interfaces. That's where the agent's logic resides.
  3. Register itself (in its init() function).

For an agent to be used it needs to be listed in the Agents config option (default is "lastfm,spotify"). The order dictates the priority of the agents

For a simple Agent example, look at the placeholders.go agent source code.