Skip to content

Latest commit

 

History

History
240 lines (214 loc) · 7.06 KB

README.md

File metadata and controls

240 lines (214 loc) · 7.06 KB
Raw

MusicApi

主要功能点

  • 封装网易云、百度音乐、虾米音乐、QQ音乐Api
  • 通过DSBridge for Android 解决Android跨域问题，Android端解析调用js音乐API的api
  • 增加NeteaseMusicApi接口
  • 具体的接口实现请看主项目 MusicLake

DSbridge使用

通过BaseApiImpl，调用js方法拼接api请求地址，然后AjaxHandler收到请求地址，再通过okhhtp请求，获取返回数据，然后在回到js组装返回数据。最后返回一个json字符串，在BaseApiImpl 回调方法中gson解析成具体对象。

更新记录

  • 1.1.4
  • 更新字段类型长整型，导致歌单列表数据解析异常问题。
  • 1.1.2
    • 新增getAllNeteaseTopList、getAllQQTopList、getQQTopList、getTopList接口
  • 1.1.1
  • 更新netease接口字段解析

Usage

Step 1. Add the JitPack repository to your build file ​```gradle allprojects { repositories { ... maven { url 'https://jitpack.io' } } }

Step 2. Add the dependency

​```gradle

dependencies {
     implementation 'com.github.caiyonglong:musicapi:1.1.4'
}

提示

API

  • 百度音乐Api接口定义 : BaiduApiService（具体实现在MusicLake）

  • 网易音乐Api接口定义 : NeteaseApiService（具体实现在MusicLake）

  • 在线歌单Api接口定义 : PlaylistApiService（具体实现在MusicLake）

  • 音乐播放Api接口app.native.js : 同PC端Api接口sunzongzheng/musicApi/dist/app.native.js 为了节省时间，减少维护成本，PC端和Android端使用同一api js，使用 DSbridge 解决Android跨域问题， 实现Android js交互

  • BaseApiImpl接口详情：

    • 搜索
       /**
     * 搜索
     *
     * @param query 搜索文本
     * @param limit 每页多少歌曲
     * @param offset 偏移量
     * @param success 结果返回回调
     * @param fail 失败返回回调
     */
      fun searchSong(query: String, limit: Int, offset: Int, success: (result: SearchData) -> Unit, fail: ((String?) -> Unit)? = null) {
          .....
      }
    • 按歌曲类型搜索
    /**
   * 独立请求
   * @param query 搜索文本
   * @param type 歌曲类型 [QQ,XIAMI,NETEASE]
   * @param limit 每页多少歌曲
   * @param offset 偏移量
   * @param success 结果返回回调
   */
  fun searchSongSingle(query: String, type: String, limit: Int, offset: Int, success: (result: SearchSingleData) -> Unit) {
      .....
  }
    • 获取歌曲详情
      /**
   * 获取歌曲详情
   * @param vendor 歌曲类型 [qq,xiami,netease]
   * @param id 歌曲Id
   * @param success 结果返回回调
   * @param fail 失败返回回调
   */
  fun getSongDetail(vendor: String, id: String, success: (result: SongDetail) -> Unit, fail: (() -> Unit)? = null) {
      .....
  }
    • 批量获取歌曲详情
     /**
   * 批量获取歌曲详情
   *
   * @param vendor 歌曲类型 [qq,xiami,netease]
   * @param ids 歌曲Ids [101126,16435051,139808]
   * @param success 成功回调
   */
  fun getBatchSongDetail(vendor: String, ids: Array<String>, success: (result: BatchSongDetail) -> Unit) {
      .....
  }
    • 获取歌词信息
      /**
   * 获取歌词信息
   *
   * @param vendor 歌曲类型 [qq,xiami,netease]
   * @param success 成功回调
   */
  fun getLyricInfo(vendor: String, id: String, success: (result: LyricData) -> Unit) {
      .....
  }
    • 获取评论信息
      /**
   * 获取评论信息
   *
   * @param vendor 歌曲类型 [qq,xiami,netease]
   * @param id 歌曲Id
   * @param success 成功回调
   */
  fun getComment(vendor: String, id: String, success: (result: Any) -> Unit, fail: ((String) -> Unit)? = null) {
      .....
  }
    • 获取播放地址
    /**
   * 获取播放地址
   * @param vendor 歌曲类型 [qq,xiami,netease]
   * @param id 歌曲Id
   * @param br 音质 默认12800
   * @param success 成功回调
   * @param fail 失败回调
   */
  fun getSongUrl(vendor: String, id: String, br: Int = 128000, success: (result: SongBean) -> Unit, fail: (() -> Unit)? = null) {
      .....
  }
    • 获取歌手单曲列表
     /**
   * 获取歌手单曲列表
   * @param vendor 歌曲类型 [qq,xiami,netease]
   * @param id 歌手ID
   * @param offset 偏移量
   * @param limit 每页限制
   * @param success 成功回调
   * @param fail 失败回调
   */
  fun getArtistSongs(vendor: String, id: String, offset: Int, limit: Int, success: (result: ArtistSongsData) -> Unit, fail: ((String) -> Unit)? = null) {
      .....
  }
    • 获取歌单详情
    /**
   * 获取歌单歌曲列表
   * @param vendor 歌曲类型 [qq,xiami,netease]
   * @param id 专辑ID
   * @param success 成功回调
   * @param fail 失败回调
   */
  fun getPlaylistDetail(vendor: String, id: String, success: (result: ArtistSongs) -> Unit, fail: ((String) -> Unit)? = null) {
  ...
  }
    • 获取专辑详情
     /**
   * 获取专辑详情
   * @param vendor 歌曲类型 [qq,xiami,netease]
   * @param id 专辑ID
   * @param success 成功回调
   * @param fail 失败回调
   */
  fun getAlbumDetail(vendor: String, id: String, success: (result: AlbumData) -> Unit, fail: ((String) -> Unit)? = null) {
      .....
  }
    • 获取歌手列表详情
    /**
   * 获取歌手列表详情（qq歌手列表）
   * @param offset 偏移量
   * @param params 例：val params = mapOf("area" to area, "sex" to sex, "genre" to genre, "index" to index)
   * @param success 成功回调
   * @param fail 失败回调
   */
  fun getArtists(offset: Int, params: Any, success: (result: ArtistsData) -> Unit, fail: ((String) -> Unit)? = null) {
      .....
  }
    • 获取任意平台歌手详情
    /**
   * 获取任意平台歌手详情
   * id，专辑ID
   * @param ids 歌手ID列表 map(id,vendor) 歌手id 和 歌曲类型 [qq,xiami,netease]
   * @param success 成功回调
   * @param fail 失败回调
   */
  fun getAnyVendorSongDetail(ids: MutableList<Map<String, String?>>, success: (result: MutableList<MusicInfo>) -> Unit, fail: ((String) -> Unit)? = null) {
      .....
  }
    • 获取QQ音乐排行榜
      fun getAllQQTopList(success: (result: List<TopListBean>) -> Unit, fail: ((String) -> Unit)? = null) {
  ...
  }
    • 获取网易云排行榜
    fun getAllNeteaseTopList(success: (result: List<TopListBean>) -> Unit, fail: ((String) -> Unit)? = null) {
	...
  }