Netease Music SDK 开发文档
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Accessors

Methods

Properties

user

user: User

用户信息，当手动调用登录或者 load 之后，此对象会自动实例化 通过调用 user.toJSON() 获取可以用于存储的对象，当下次实例化的时候，通过 client.load 恢复登录状态

Accessors

cookie

cookie:

isLogin

isLogin:

Methods

checkLogin

  • checkLogin(): Promise<void>

createPlaylist

  • createPlaylist(name: string): Promise<any>

doLikeComment

  • doLikeComment(rid: number, cid: number, type?: ResourceType, like?: boolean): Promise<any>

  • 喜欢某一条评论

    Parameters

    • rid: number

      资源的 ID，比如歌曲就是歌曲 ID，MV 就是 MV ID

    • cid: number

      评论 ID

    • Default value type: ResourceType = ResourceType.SONG

      资源类型

    • Default value like: boolean = true

      是喜欢还是取消喜欢

    Returns Promise<any>

doLikeMusic

  • doLikeMusic(id: number, like?: boolean): Promise<any>

doPlaylistTrack

emailLogin

  • emailLogin(email: string, password: string): Promise<any>

  • 邮件登录，通过文件我们得知暂时是无法使用的，我本人也测试过了

    deprecated

    Parameters

    • email: string
    • password: string

    Returns Promise<any>

getAlbum

  • getAlbum(id: number): Promise<any>

getAlbumComment

  • getAlbumComment(id: number, limit?: number, offset?: number): Promise<any>

getArtistAlbums

  • getArtistAlbums(id: number, limit?: number, offset?: number): Promise<any>

getArtistHotSongs

  • getArtistHotSongs(id: number): Promise<any>

getArtistInfo

  • getArtistInfo(id: number): Promise<any>

getArtistList

getArtistMvs

  • getArtistMvs(id: number, limit?: number, offset?: number): Promise<any>

  • 获取歌手的全部 MV

    不知道为什么，当 limit 为某些值的时候，offset 的结果会出现紊乱

    经过测试，在 30 以内的有 9 10 14 20 21 24 25 的 limit 值不正确，请尽量不要使用这几个值。

    Parameters

    • id: number
    • Default value limit: number = 30
    • Default value offset: number = 0

    Returns Promise<any>

getArtistSongs

  • getArtistSongs(id: number, limit?: number, offset?: number): Promise<any>

getBanner

  • getBanner(): Promise<any>

getDjComment

  • getDjComment(id: number, limit?: number, offset?: number): Promise<any>

getMusicUrl

  • getMusicUrl(id: number | string[] | string, br?: number): Promise<any>

  • 获取音乐的连接，很多歌曲都不会直接返回歌曲链接，需要你通过这个接口手动获取

    Parameters

    • id: number | string[] | string
    • Default value br: number = 999000

    Returns Promise<any>

getMvComment

  • getMvComment(id: number, limit?: number, offset?: number): Promise<any>

getMvInfo

  • getMvInfo(mvid: number): Promise<any>

  • 获取 MV 信息

    数据包含 MV 名字，歌手，发布时间，mv 视频地址等数据 其中 MV 视频网易做了防盗链处理，不能直接获取，需要添加 referer: 'http://music.163.com/' 更多内容请查看 Code

    Parameters

    • mvid: number

      MV 的 ID

    Returns Promise<any>

getPersonalDj

  • getPersonalDj(): Promise<any>

getPersonalFM

  • getPersonalFM(): Promise<any>

getPersonalNewSong

  • getPersonalNewSong(): Promise<any>

getPersonalPlaylist

  • getPersonalPlaylist(limit?: number, offset?: number): Promise<any>

getPersonalPrivateContent

  • getPersonalPrivateContent(): Promise<any>

getPlaylistCatalogue

  • getPlaylistCatalogue(): Promise<any>

getPlaylistComment

  • getPlaylistComment(id: number, limit?: number, offset?: number): Promise<any>

getPlaylistHotTag

  • getPlaylistHotTag(): Promise<any>

getPlaylistInfo

  • getPlaylistInfo(id: number): Promise<any>

getRadioCategory

  • getRadioCategory(): Promise<any>

getRadioInfo

  • getRadioInfo(rid: number): Promise<any>

getRadioProgram

  • getRadioProgram(rid: number, asc?: boolean, limit?: number, offset?: number): Promise<any>

  • 获取电台的节目

    Parameters

    • rid: number
    • Default value asc: boolean = true

      是否为升序，默认是升序

    • Default value limit: number = 30
    • Default value offset: number = 0

    Returns Promise<any>

getRadioProgramInfo

  • getRadioProgramInfo(pid: number): Promise<any>

getRadioRecommend

  • getRadioRecommend(cid?: number): Promise<any>

getRecommendList

  • getRecommendList(): Promise<any>

getRecommendSong

  • getRecommendSong(limit?: number, offset?: number): Promise<any>

getSimiArtist

  • getSimiArtist(aid: number): Promise<any>

getSimiMv

  • getSimiMv(mid: number): Promise<any>

getSimiPlaylist

  • getSimiPlaylist(sid: number): Promise<any>

getSimiSong

  • getSimiSong(sid: number): Promise<any>

getSimiUser

  • getSimiUser(sid: number): Promise<any>

getSongComment

  • getSongComment(id: number, limit?: number, offset?: number): Promise<any>

getSongInfo

  • getSongInfo(id: number): Promise<any>

getSongLyric

  • getSongLyric(sid: number): Promise<any>

getTopAlbum

  • getTopAlbum(area: TopResourceArea, limit?: number, offset?: number): Promise<any>

getTopArtist

  • getTopArtist(limit?: number, offset?: number): Promise<any>

getTopList

getTopPlaylist

  • getTopPlaylist(cat: string, order: TopPlaylistOrder, limit?: number, offset?: number): Promise<any>

getTopPlaylistHighquality

  • getTopPlaylistHighquality(cat: string, limit?: number): Promise<any>

getUserDetail

  • getUserDetail(uid: number): Promise<any>

getUserDj

  • getUserDj(uid: number, limit?: number, offset?: number): Promise<any>

getUserEvent

  • getUserEvent(uid: number): Promise<any>

getUserFolloweds

  • getUserFolloweds(uid: number, limit?: number, offset?: number): Promise<any>

getUserFollows

  • getUserFollows(uid: number, limit?: number, offset?: number): Promise<any>

getUserPlaylist

  • getUserPlaylist(uid: number, limit?: number, offset?: number): Promise<any>

getUserRecord

getUserSubcount

  • getUserSubcount(): Promise<any>

load

  • load(store: any): void

multiSearch

  • multiSearch(keyword: string, type?: SearchType): Promise<any>

  • 获取多重搜索 PS: 理论上应该会有 Offset 和 Limit 参数，但是经过我的测试，Type 也没有用，不知道这个和 MusicClient#searchSuggest 的区别

    Parameters

    • keyword: string
    • Default value type: SearchType = SearchType.SONG

    Returns Promise<any>

phoneLogin

  • phoneLogin(phone: string, password: string): Promise<any>

refreshLogin

  • refreshLogin(): Promise<any>

request

  • request(host: string, path: string, method: string, payload?: any): Promise<any>

requestWithSetCookie

  • requestWithSetCookie(host: string, path: string, method: string, payload?: any): Promise<any>

search

  • search(keyword: string, type?: SearchType, limit?: number, offset?: number): Promise<any>

searchHot

  • searchHot(): Promise<any>

searchSuggest

  • searchSuggest(keyword: string): Promise<any>

sendPlaylistMessage

  • sendPlaylistMessage(userIds: number | number[], text: string, playlistId: number): Promise<any>

  • 发送私信(带歌单)

    说明 : 登陆后调用此接口 , 传入用户 id 和要发送的信息和歌单 id, 可以发送带歌单的私信(注:不能发送重复的歌单)

    Parameters

    • userIds: number | number[]

      用户 ID

    • text: string

      要发送的私信

    • playlistId: number

      歌单列表

    Returns Promise<any>

sendTextMessage

  • sendTextMessage(userIds: number | number[], text: string): Promise<any>

  • 发送私信

    说明：登陆后调用此接口 , 传入用户 id 和要发送的信息, 可以发送私信,返回内容为历史私信,包含带歌单的私信信息(注:不能发送私信给自己)

    Parameters

    • userIds: number | number[]

      用户 ID

    • text: string

      要发送的消息

    Returns Promise<any>

subscribeArtist

  • subscribeArtist(id: number, action?: "subscribe" | "unsubscribe"): Promise<any>

subscribePlyalist

  • subscribePlyalist(playlistId: number, action?: "subscribe" | "unsubscribe"): Promise<any>

updatePlaylist

  • updatePlaylist(id: number, name: string, desc: string, tags: string): Promise<any>

updateUser

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc