跳转至

SongList

歌单相关Api

function get_songlist_detail

获取歌单信息

Task< Result < nlohmann::json > > qqmusic::get_songlist_detail (
    uint64_t dissid,
    unsigned dirid=0,
    unsigned num=10,
    unsigned page=1,
    bool only_song=false,
    bool tag=true,
    bool user_info=true
) 

Parameters:

  • dissid 歌单ID
  • dirid 歌单drid, 默认为0
  • num 返回songlist元素数量, 默认为10
  • page 第几页, 默认为1
  • only_song 是否仅返回歌曲信息, 默认false
  • tag 是否返回歌单标签信息, 默认true
  • user_info 是否返回歌单创建者的用户信息, 默认true

Returns:

Json格式的歌单信息

Note:

异步函数, 返回Task


function get_songlist

获取歌单列表

Task< Result < nlohmann::json > > qqmusic::get_songlist (
    uint64_t dissid,
    unsigned dirid=0
) 

Parameters:

  • dissid 歌单ID
  • dirid 歌单dirid, 默认为0

Returns:

Json格式歌单列表

Note:

异步函数, 返回Task


function songlist_create

创建歌单

Task< Result < nlohmann::json > > qqmusic::songlist_create (
    std::string_view dirname,
    std::optional< utils::Credential > credential=std::nullopt
) 

Parameters:

  • dirname 新的歌单名称
  • credential 凭据信息

Returns:

创建歌单的基本信息

Note:

异步函数, 返回Task

Warning:

歌单名称不应该含有除了正常字符之外的东西, 例如emoji, 这将导致歌单虽然被正确创建, 但是返回时json解析异常报错


function songlist_delete

删除歌单

Task< Result < bool > > qqmusic::songlist_delete (
    uint64_t dirid,
    std::optional< utils::Credential > credential=std::nullopt
) 

Parameters:

  • dirid 歌单ID
  • credential 凭据信息

Returns:

是否删除成功, 如果不存在这个歌单则返回false


function songlist_add_songs

向歌单内添加歌曲

Task< Result < bool > > qqmusic::songlist_add_songs (
    uint64_t dirid,
    std::span< uint64_t > song_ids,
    std::optional< utils::Credential > credential=std::nullopt
) 

Parameters:

  • dirid 歌单ID
  • song_ids 待添加歌单列表
  • credential 凭据信息

Returns:

是否添加成功, 歌曲已存在则返回false


function songlist_delete_songs

删除歌单内指定歌曲

Task< Result < bool > > qqmusic::songlist_delete_songs (
    uint64_t dirid,
    std::span< uint64_t > song_ids,
    std::optional< utils::Credential > credential=std::nullopt
) 

Parameters:

  • dirid 歌单ID
  • song_ids 待删除歌单列表
  • credential 凭据信息

Returns:

是否删除成功, 歌曲不存在则返回false