Skip to content

📚 API 参考

本节介绍 GlassMusicPlayer 的核心 API 模块。

📖 目录

📝 代码风格

  • 📘 所有 API 使用 TypeScript 编写
  • 🪝 组合式函数使用 useXxx 命名
  • 🗄️ Store 模块使用 useXxxStore 命名
  • 📂 HTTP 请求函数按功能分组

🔍 快速索引

🪝 Composables

函数说明
🎧 useAudio()音频播放控制
📝 useLyrics()歌词解析与同步
⌨️ useGlobalKeyboard()全局键盘快捷键

🗄️ Stores

Store说明
🎧 useAudioStore播放器状态
🌐 useGlobalStore全局状态(主题、语言、搜索历史)
⚙️ useSettingsStore设置状态(背景、歌词)
👤 useUserStore用户登录状态

🌐 HTTP API

分类示例函数
🔐 登录loginCellphone, qrLoginKey, loginStatus
🔍 搜索search, cloudSearch, searchSuggest
🎵 歌曲songDetail, songUrl, lyric
📋 歌单playlistDetail, playlistTrackAll
🎤 艺术家artistDetail, artistTopSong, artistAlbum
💿 专辑albumDetail, albumNew
🎬 MVmvDetail, mvUrl, mvAll
📊 排行榜toplist, topSong
✨ 推荐personalized, recommendSongs
💬 评论commentMusic, commentNew

基于 PolyForm-Noncommercial-1.0.0 许可发布