Hermes 项目技术文档

1. 安装指南

Hermes 是一个 macOS 平台上的 Pandora 客户端。由于该项目目前处于未维护状态，因此建议用户通过以下方式安装 Hermes：

1. 直接下载安装：

   • 访问 hermesapp.org 网站，点击下载按钮进行安装。

2. 使用 Homebrew 安装：

   • 打开终端，输入以下命令进行安装：

     brew cask install hermes
     

2. 项目的使用说明

Hermes 是一个 Pandora 音乐服务的 macOS 客户端，用户可以通过 Hermes 收听 Pandora 上的音乐。以下是 Hermes 的基本使用说明：

1. 播放与暂停：

   • 使用 play 命令开始播放音乐，使用 pause 命令暂停播放。
   • 使用 playpause 命令可以在播放和暂停之间切换。

2. 切换歌曲：

   • 使用 next song 命令跳转到下一首歌曲。

3. 歌曲评价：

   • 使用 thumbs up 命令喜欢当前歌曲。
   • 使用 thumbs down 命令不喜欢当前歌曲，并跳转到下一首。
   • 使用 tired of song 命令标记当前歌曲为“已听腻”。

4. 音量控制：

   • 使用 raise volume 和 lower volume 命令调整音量。
   • 使用 full volume 命令将音量调至最大。
   • 使用 mute 和 unmute 命令分别静音和取消静音。

5. 获取和设置播放状态：

   • 使用 get playback state 获取当前播放状态。
   • 使用 set playback state to playing 设置播放状态为播放。

6. 获取和设置播放音量：

   • 使用 get playback volume 获取当前音量。
   • 使用 set playback volume to 92 设置音量为 92。

7. 切换电台：

   • 使用 set the current station to station 4 切换到指定电台。

8. 获取歌曲信息：

   • 使用 set title to the current song's title 获取当前歌曲的标题。
   • 使用 set artist to the current song's artist 获取当前歌曲的艺术家。
   • 使用 set album to the current song's album 获取当前歌曲的专辑。

3. 项目API使用文档

Hermes 提供了两种 API 供开发者使用：

1. NSDistributedNotificationCenter：

   • 每当播放新歌曲时，Hermes 会通过 NSDistributedNotificationCenter 发布一个通知，通知名称为 hermes.song，对象为 hermes，userInfo 包含当前播放歌曲的信息。开发者可以通过监听该通知获取歌曲信息。

2. AppleScript：

   • Hermes 支持 AppleScript 脚本控制，开发者可以通过 AppleScript 实现对 Hermes 的控制，如播放、暂停、切换歌曲、调整音量等操作。

4. 项目安装方式

如果你希望自行编译 Hermes，可以按照以下步骤进行：

1. 克隆项目代码：

   • 使用 git clone 命令克隆 Hermes 项目代码到本地。

2. 编译项目：

   • 在项目根目录下，使用以下命令进行编译：

     make
     

   • 如果需要运行项目，可以使用以下命令：

     make run
     

   • 如果需要调试项目，可以使用以下命令：

     make dbg
     

3. 配置编译选项：

   • 默认情况下，Hermes 使用 Debug 配置进行编译。如果需要使用 Release 配置，可以使用以下命令：

     make CONFIGURATION=Release [run|dbg]
     

4. 注意事项：

   • 如果使用 CONFIGURATION=Debug 进行编译，媒体键快捷方式将无法正常工作。

5. 许可证

Hermes 项目的代码基于 MIT 许可证发布，详细信息请参考项目根目录下的 LICENSE 文件。