lastfm-node 技术文档

本文档旨在帮助用户安装和使用 lastfm-node 项目，并提供项目 API 的使用说明。

1. 安装指南

在开始之前，确保您已经安装了 Node.js。以下是安装 lastfm-node 的步骤：

npm install lastfm

2. 项目的使用说明

lastfm-node 是一个用于读取和写入用户在 Last.fm 上的最近播放信息的 Node.js 库。以下是如何使用该库的基本示例：

var LastFmNode = require('lastfm').LastFmNode;

var lastfm = new LastFmNode({
  api_key: 'apikey',    // 在 http://www.last.fm/api 注册以获取密钥
  secret: 'secret',
  useragent: 'appname/vX.X MyApp' // 可选。默认为 lastfm-node。
});

3. 项目API使用文档

以下是 lastfm-node 提供的主要 API 类和方法的使用文档。

LastFmRequest

用于发送请求到 Last.fm。

lastfm.request(method, options);

• method: Last.fm API 方法名，如 "artist.getInfo"。
• options: 发送到 Last.fm 的所有选项，除了以下特殊选项：
  • write: 强制请求作为写入方法。
  • signed: 强制请求签名。
  • handlers: 创建时附加到请求对象的默认事件处理器。

事件

• success(json): 从 Last.fm 接收到的 JSON 响应。
• error(error): 来自 Last.fm 的错误或传输错误。

RecentTracksStream

用于流式传输最近的播放信息。

lastfm.stream(username);

• username: Last.fm 用户的用户名。

方法

• start(): 开始流式传输最近播放信息。
• stop(): 停止流式传输最近播放信息。
• isStreaming(): 布尔值。如果正在积极获取播放/最近播放数据，则为 true。
• on(event, listener): 添加指定事件的监听器。
• removeListener(event, listener): 移除指定事件的监听器。

选项

• autostart: 默认为 false。是否自动开始流式传输。
• extended: 是否在每个艺术家中包含扩展数据，以及用户是否喜欢每首曲目。
• handlers: 创建时附加到请求对象的默认事件处理器。

事件

• lastPlayed(track): 用户最近上传的曲目。
• nowPlaying(track): 用户当前正在听的歌曲。
• scrobbled(track): 当前播放的曲目已上传。
• stoppedPlaying(track): 用户停止播放当前曲目。
• error(error): 错误。

LastFmSession

用于管理 Last.fm 会话。

lastfm.session(options);

• options: 包含用户名、会话密钥或授权令牌的选项。

方法

• authorise(token, [options]): 授权用户与 Last.fm API。
• on(event, handler): 添加事件监听器。
• removeListener(event, handler): 移除事件监听器。
• isAuthorised(): 如果会话已授权或构造函数中指定了密钥，则返回 true。
• cancel(): 防止进一步的授权重试。

事件

• success(session): 会话授权成功。
• authorised(session): 授权成功的旧版本事件。
• retrying(retry): 授权请求未成功，但将在延迟后重试。
• error(track, error): 授权未成功且不会重试。

LastFmUpdate

用于更新当前播放或上传曲目。

lastfm.update(method, session, options);

• method: 'nowplaying' 或 'scrobble'。
• session: 授权的 LastFmSession 实例。
• options: 更新请求的选项。

事件

• success(track): 更新请求成功。
• retrying(retry): 更新请求未成功，但将重试。
• error(track, error): 错误。

LastFmInfo

用于获取 Last.fm 项目的扩展信息。

lastfm.info(itemtype, [options]);

• itemtype: Last.fm 项目类型，如用户、曲目、艺术家等。
• options: 附加到对象的事件处理器。

4. 项目安装方式

如安装指南中所述，使用 npm 进行安装：

npm install lastfm

以上就是 lastfm-node 的技术文档，希望对您有所帮助。