跳转至

Namespace qqmusic

Namespace List > qqmusic

More...

Namespaces

Type Name
namespace details
namespace utils
简易Cookie管理器, 负责cookie的序列化和反序列化, 依赖 nlohmann::json 实现 目前不支持路径嵌套和Expires 和HttpOnly 这样的特性

Classes

Type Name
class BaseMediaFileType
媒体文件类型基类
class EncryptedSongFileType
加密歌曲文件类型
struct Lyric
struct MvUrl
struct PhoneLoginResult
struct QRCode
class QRCodeLoginEvent
struct QRCodeLoginResult
class SongFileType
未加密的歌曲文件类枚举
struct SongInfo
class TabType
标签类

Public Types

Type Name
enum int AreaType
区域类型枚举
enum int GenderType
性别类型枚举
enum int GenreType
风格类型枚举
enum int IndexType
索引类型枚举, 按首字母筛选时需要
enum int PhoneLoginEvent
enum QRLoginType
typedef Result< T, qqmusic::utils::Exception > Result
enum unsigned SearchType
typedef boost::asio::awaitable< T > Task
enum int cover_size

Public Functions

Type Name
qqmusic::Task< qqmusic::Result< QRCodeLoginResult > > check_qq_qr (QRCode & qrc)
qqmusic::Task< qqmusic::Result< QRCodeLoginResult > > check_wx_qr (QRCode & qrc)
Task< Result< nlohmann::json > > general_search (std::string_view keyword, unsigned num, unsigned page, bool highlight)
std::string get_album_cover_url (std::string_view mid, cover_size size)
Task< Result< nlohmann::json > > get_album_detail (std::string_view album_mid)
Task< Result< nlohmann::json > > get_album_detail (uint64_t album_id)
Task< Result< nlohmann::json > > get_album_list (std::string_view mid, unsigned number=10, unsigned begin=0)
获取歌手专辑列表
Task< Result< nlohmann::json > > get_album_list_all (std::string_view mid)
获取歌手所有专辑
Task< Result< nlohmann::json > > get_album_songs (std::string_view album_mid, unsigned int num, unsigned int page)
Task< Result< nlohmann::json > > get_album_songs (uint64_t album_id, unsigned int num, unsigned int page)
Task< Result< nlohmann::json > > get_created_songlist (uint64_t musicid, std::optional< utils::Credential > credential)
Task< Result< std::string > > get_euin (uint64_t musicid)
Task< Result< nlohmann::json > > get_fans (std::string_view euin, unsigned page, unsigned num, std::optional< utils::Credential > credential)
Task< Result< nlohmann::json > > get_fav_album (std::string_view euin, unsigned page, unsigned num, std::optional< utils::Credential > credential)
Task< Result< nlohmann::json > > get_fav_mv (std::string_view euin, unsigned page, unsigned num, std::optional< utils::Credential > credential)
Task< Result< nlohmann::json > > get_fav_num (std::span< uint64_t > id_list, bool readable=true)
获取歌曲的收藏量
Task< Result< nlohmann::json > > get_fav_song (std::string_view euin, unsigned page, unsigned num, std::optional< utils::Credential > credential)
Task< Result< nlohmann::json > > get_fav_songlist (std::string_view euin, unsigned page, unsigned num, std::optional< utils::Credential > credential)
Task< Result< nlohmann::json > > get_follow_singers (std::string_view euin, unsigned page, unsigned num, std::optional< utils::Credential > credential)
Task< Result< nlohmann::json > > get_follow_usr (std::string_view euin, unsigned page, unsigned num, std::optional< utils::Credential > credential)
Task< Result< nlohmann::json > > get_friend_list (unsigned page, unsigned num, std::optional< utils::Credential > credential)
Task< Result< nlohmann::json > > get_homepage (std::string_view euin, std::optional< utils::Credential > credential)
Task< Result< nlohmann::json > > get_labels (uint64_t songid)
获取歌曲标签信息
Task< Result< Lyric > > get_lyric (std::string_view mid, bool qrc, bool trans, bool roma)
Task< Result< Lyric > > get_lyric (uint64_t id, bool qrc, bool trans, bool roma)
Task< Result< nlohmann::json > > get_music_gene (std::string_view euin, std::optional< utils::Credential > credential)
Task< Result< uint64_t > > get_musicid (std::string_view euin)
Task< Result< nlohmann::json > > get_mv_detail (std::span< std::string > vids)
Task< Result< nlohmann::json > > get_mv_list (std::string_view mid, unsigned number=10, unsigned begin=0)
获取歌手MV列表
Task< Result< nlohmann::json > > get_mv_list_all (std::string_view mid)
获取歌手所有MV
Task< Result< std::vector< MvUrl > > > get_mv_urls (std::span< std::string > vids)
Task< Result< nlohmann::json > > get_other_version (std::string_view mid)
获取同名歌曲的其他版本
Task< Result< nlohmann::json > > get_other_version (uint64_t id)
获取同名歌曲的其他版本
Task< Result< nlohmann::json > > get_producer_info (std::string_view mid)
获取歌曲制作者信息
Task< Result< nlohmann::json > > get_producer_info (uint64_t id)
获取歌曲制作者信息
qqmusic::Task< qqmusic::Result< QRCode > > get_qrcode (QRLoginType login_type)
Task< Result< nlohmann::json > > get_related_mv (uint64_t songid, std::optional< std::string > last_mvid=std::nullopt)
获取相关MV
Task< Result< nlohmann::json > > get_related_songlist (uint64_t songid)
获取相关歌单列表
Task< Result< nlohmann::json > > get_sheet (std::string_view mid)
获取曲谱信息
Task< Result< nlohmann::json > > get_similar_singers (std::string_view mid, unsigned number=10)
获取相似歌手信息
Task< Result< nlohmann::json > > get_similar_songs (uint64_t songid)
获取相似歌曲列表
Task< Result< nlohmann::json > > get_singer_desc (std::span< std::string > mids, unsigned number=10)
获取多个歌手的简介
Task< Result< nlohmann::json > > get_singer_info (std::string_view mid)
获取歌手基本信息
Task< Result< nlohmann::json > > get_singer_list (AreaType area=AreaType::ALL, GenderType gender=GenderType::ALL, GenreType genre=GenreType::ALL)
获取符合筛选条件的歌手信息表单
Task< Result< nlohmann::json > > get_singer_list_index (AreaType area=AreaType::ALL, GenderType gender=GenderType::ALL, GenreType genre=GenreType::ALL, IndexType index=IndexType::ALL, unsigned sin=0, unsigned cur_page=1)
筛选获得歌曲歌单原始数据
Task< Result< nlohmann::json > > get_singer_list_index_all (AreaType area=AreaType::ALL, GenderType gender=GenderType::ALL, GenreType genre=GenreType::ALL, IndexType index=IndexType::ALL)
获取所有符合条件的歌单原始数据
Task< Result< nlohmann::json > > get_song_detail (std::string_view mid)
获取歌曲详细信息
Task< Result< nlohmann::json > > get_song_detail (uint64_t id)
获取歌曲详细信息
Task< Result< std::vector< SongInfo > > > get_song_urls (std::span< std::string > mids, std::unique_ptr< BaseMediaFileType > file_type=std::make_unique< SongFileType >(), std::optional< utils::Credential > credential=std::nullopt)
批量获取歌曲播放链接
Task< Result< nlohmann::json > > get_songlist (uint64_t songlist_id, unsigned dirid)
Task< Result< nlohmann::json > > get_songlist_detail (uint64_t songlist_id, unsigned dirid, unsigned num, unsigned page, bool only_song, bool tag, bool user_info)
Task< Result< nlohmann::json > > get_songs_list (std::string_view mid, unsigned num=10, unsigned begin=0)
获取歌手歌曲原始数据
Task< Result< nlohmann::json > > get_songs_list_all (std::string_view mid)
获取歌手的所有歌曲
Task< Result< nlohmann::json > > get_tab_detail (std::string_view mid, TabType type, unsigned page=1, unsigned num=10)
返回标签详细信息
Task< Result< nlohmann::json > > get_toplist_category ()
获取所有排行榜
Task< Result< nlohmann::json > > get_toplist_item_detail (unsigned top_id, unsigned num, unsigned page, bool tag)
获取排行榜条目信息
Task< Result< std::string > > get_try_url (std::string_view mid, std::string_view vs)
获取试听链接
Task< Result< nlohmann::json > > get_vip_info (std::optional< utils::Credential > credential)
Task< Result< nlohmann::json > > hotkey ()
Task< Result< nlohmann::json > > keyword_complete (std::string_view keyword)
qqmusic::Task< qqmusic::Result< utils::Credential > > phone_authorize (std::string_view phone, std::string_view auth_code, std::string_view country_code)
Task< Result< nlohmann::json > > query_song (std::span< std::string > mids)
批量查询歌曲信息
Task< Result< nlohmann::json > > query_song (std::span< uint64_t > ids)
批量查询歌曲信息
Task< Result< nlohmann::json > > quick_search (std::string_view keyword)
Task< Result< nlohmann::json > > search_by_type (std::string_view keyword, SearchType type, unsigned num_per_page, unsigned page, bool highlight)
qqmusic::Task< qqmusic::Result< PhoneLoginResult > > send_authcode (std::string_view phone, std::string_view country_code)
Task< Result< bool > > songlist_add_songs (uint64_t dirid, std::span< uint64_t > song_ids, std::optional< utils::Credential > credential)
Task< Result< nlohmann::json > > songlist_create (std::string_view dirname, std::optional< utils::Credential > credential)
Task< Result< bool > > songlist_delete (uint64_t dirid, std::optional< utils::Credential > credential)
Task< Result< bool > > songlist_delete_songs (uint64_t dirid, std::span< uint64_t > song_ids, std::optional< utils::Credential > credential)

Detailed Description

-----------------------------------qqmusic/search.h----------------------------------------

Searching

------------------------------------qqmusic/user.h-----------------------------------------

Get user's favourite song lists and user info

Public Types Documentation

enum AreaType

区域类型枚举 

enum qqmusic::AreaType {
    ALL = -100,
    CHINA = 200,
    TAIWAN = 2,
    AMERICA = 5,
    JAPAN = 4,
    KOREA = 3
};

enum GenderType

性别类型枚举 

enum qqmusic::GenderType {
    ALL = -100,
    MALE = 0,
    FEMALE = 1,
    GROUP = 2
};

enum GenreType

风格类型枚举 

enum qqmusic::GenreType {
    ALL = -100,
    POP = 7,
    RAP = 3,
    CHINESE_STYLE = 19,
    ROCK = 4,
    ELECTRONIC = 2,
    FOLK = 8,
    R_AND_B = 11,
    ETHNIC = 37,
    LIGHT_MUSIC = 93,
    JAZZ = 14,
    CLASSICAL = 33,
    COUNTRY = 13,
    BLUES = 10
};

enum IndexType

索引类型枚举, 按首字母筛选时需要 

enum qqmusic::IndexType {
    A = 1,
    B,
    C,
    D,
    E,
    F,
    G,
    H,
    I,
    J,
    K,
    L,
    M,
    N,
    O,
    P,
    Q,
    R,
    S,
    T,
    U,
    V,
    W,
    X,
    Y,
    Z,
    HASH,
    ALL = -100
};

enum PhoneLoginEvent

enum qqmusic::PhoneLoginEvent {
    SEND = 0,
    CAPTCHA = 20276,
    FREQUENCY = 100001,
    OTHER = -1
};

enum QRLoginType

enum qqmusic::QRLoginType {
    QQ,
    WX
};

typedef Result

using qqmusic::Result = typedef Result<T, qqmusic::utils::Exception>;

enum SearchType

enum qqmusic::SearchType {
    SONG = 0,
    SINGER = 1,
    ALBUM = 2,
    SONG_LIST = 3,
    MV = 4,
    LYRIC = 7,
    USER = 8,
    AUDIO_ALBUM = 15,
    AUDIO = 18
};

typedef Task

using qqmusic::Task = typedef boost::asio::awaitable<T>;

enum cover_size

enum qqmusic::cover_size {
    SMALL = 150,
    DEFAULT = 300,
    MIDIUM = 500,
    LARGE = 800
};

Public Functions Documentation

function check_qq_qr

qqmusic::Task< qqmusic::Result< QRCodeLoginResult > > qqmusic::check_qq_qr (
    QRCode & qrc
)

function check_wx_qr

qqmusic::Task< qqmusic::Result< QRCodeLoginResult > > qqmusic::check_wx_qr (
    QRCode & qrc
) 

Task< Result < nlohmann::json > > qqmusic::general_search (
    std::string_view keyword,
    unsigned num,
    unsigned page,
    bool highlight
)

function get_album_cover_url

std::string qqmusic::get_album_cover_url (
    std::string_view mid,
    cover_size size
)

function get_album_detail

Task< Result < nlohmann::json > > qqmusic::get_album_detail (
    std::string_view album_mid
)

function get_album_detail

Task< Result < nlohmann::json > > qqmusic::get_album_detail (
    uint64_t album_id
)

function get_album_list

获取歌手专辑列表 

Task< Result < nlohmann::json > > qqmusic::get_album_list (
    std::string_view mid,
    unsigned number=10,
    unsigned begin=0
)

Parameters:

  • mid 歌手mid
  • number 单次获取数据量, 默认10
  • begin 从第几个开始

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_album_list_all

获取歌手所有专辑 

Task< Result < nlohmann::json > > qqmusic::get_album_list_all (
    std::string_view mid
)

Parameters:

  • mid 歌手mid

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_album_songs

Task< Result < nlohmann::json > > qqmusic::get_album_songs (
    std::string_view album_mid,
    unsigned int num,
    unsigned int page
)

function get_album_songs

Task< Result < nlohmann::json > > qqmusic::get_album_songs (
    uint64_t album_id,
    unsigned int num,
    unsigned int page
)

function get_created_songlist

Task< Result < nlohmann::json > > qqmusic::get_created_songlist (
    uint64_t musicid,
    std::optional< utils::Credential > credential
)

function get_euin

Task< Result < std::string > > qqmusic::get_euin (
    uint64_t musicid
)

function get_fans

Task< Result < nlohmann::json > > qqmusic::get_fans (
    std::string_view euin,
    unsigned page,
    unsigned num,
    std::optional< utils::Credential > credential
)

function get_fav_album

Task< Result < nlohmann::json > > qqmusic::get_fav_album (
    std::string_view euin,
    unsigned page,
    unsigned num,
    std::optional< utils::Credential > credential
)

function get_fav_mv

Task< Result < nlohmann::json > > qqmusic::get_fav_mv (
    std::string_view euin,
    unsigned page,
    unsigned num,
    std::optional< utils::Credential > credential
)

function get_fav_num

获取歌曲的收藏量 

Task< Result < nlohmann::json > > qqmusic::get_fav_num (
    std::span< uint64_t > id_list,
    bool readable=true
)

Parameters:

  • id_list 歌曲id列表
  • readable 是否人类可读

示例:

readable == false 返回: {'438910555': 1000001}
readable == true 返回:  {'438910555': '550w+'}

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_fav_song

Task< Result < nlohmann::json > > qqmusic::get_fav_song (
    std::string_view euin,
    unsigned page,
    unsigned num,
    std::optional< utils::Credential > credential
)

function get_fav_songlist

Task< Result < nlohmann::json > > qqmusic::get_fav_songlist (
    std::string_view euin,
    unsigned page,
    unsigned num,
    std::optional< utils::Credential > credential
)

function get_follow_singers

Task< Result < nlohmann::json > > qqmusic::get_follow_singers (
    std::string_view euin,
    unsigned page,
    unsigned num,
    std::optional< utils::Credential > credential
)

function get_follow_usr

Task< Result < nlohmann::json > > qqmusic::get_follow_usr (
    std::string_view euin,
    unsigned page,
    unsigned num,
    std::optional< utils::Credential > credential
)

function get_friend_list

Task< Result < nlohmann::json > > qqmusic::get_friend_list (
    unsigned page,
    unsigned num,
    std::optional< utils::Credential > credential
)

function get_homepage

Task< Result < nlohmann::json > > qqmusic::get_homepage (
    std::string_view euin,
    std::optional< utils::Credential > credential
)

function get_labels

获取歌曲标签信息 

Task< Result < nlohmann::json > > qqmusic::get_labels (
    uint64_t songid
)

Parameters:

  • id 歌曲id

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_lyric

Task< Result < Lyric > > qqmusic::get_lyric (
    std::string_view mid,
    bool qrc,
    bool trans,
    bool roma
)

function get_lyric

Task< Result < Lyric > > qqmusic::get_lyric (
    uint64_t id,
    bool qrc,
    bool trans,
    bool roma
)

function get_music_gene

Task< Result < nlohmann::json > > qqmusic::get_music_gene (
    std::string_view euin,
    std::optional< utils::Credential > credential
)

function get_musicid

Task< Result < uint64_t > > qqmusic::get_musicid (
    std::string_view euin
)

function get_mv_detail

Task< Result < nlohmann::json > > qqmusic::get_mv_detail (
    std::span< std::string > vids
)

function get_mv_list

获取歌手MV列表 

Task< Result < nlohmann::json > > qqmusic::get_mv_list (
    std::string_view mid,
    unsigned number=10,
    unsigned begin=0
)

Parameters:

  • mid 歌手mid
  • number 单次获取数据量, 默认10
  • begin 从第几个开始

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_mv_list_all

获取歌手所有MV 

Task< Result < nlohmann::json > > qqmusic::get_mv_list_all (
    std::string_view mid
)

Parameters:

  • mid 歌手mid

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_mv_urls

Task< Result < std::vector< MvUrl > > > qqmusic::get_mv_urls (
    std::span< std::string > vids
)

function get_other_version

获取同名歌曲的其他版本 

Task< Result < nlohmann::json > > qqmusic::get_other_version (
    std::string_view mid
)

Parameters:

  • mid 歌曲mid

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_other_version

获取同名歌曲的其他版本 

Task< Result < nlohmann::json > > qqmusic::get_other_version (
    uint64_t id
)

Parameters:

  • id 歌曲id

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_producer_info

获取歌曲制作者信息 

Task< Result < nlohmann::json > > qqmusic::get_producer_info (
    std::string_view mid
)

Parameters:

  • mid 歌曲mid

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

可能返回JSON的null, 即没有制作者信息

Note:

异步函数, 返回Task

function get_producer_info

获取歌曲制作者信息 

Task< Result < nlohmann::json > > qqmusic::get_producer_info (
    uint64_t id
)

Parameters:

  • id 歌曲id

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

可能返回JSON的null, 即没有制作者信息

Note:

异步函数, 返回Task

function get_qrcode

qqmusic::Task< qqmusic::Result< QRCode > > qqmusic::get_qrcode (
    QRLoginType login_type
)

获取相关MV 

Task< Result < nlohmann::json > > qqmusic::get_related_mv (
    uint64_t songid,
    std::optional< std::string > last_mvid=std::nullopt
)

Parameters:

  • id 歌曲id

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

获取相关歌单列表 

Task< Result < nlohmann::json > > qqmusic::get_related_songlist (
    uint64_t songid
)

Parameters:

  • id 歌曲id

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_sheet

获取曲谱信息 

Task< Result < nlohmann::json > > qqmusic::get_sheet (
    std::string_view mid
)

Parameters:

  • mid 歌曲mid

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_similar_singers

获取相似歌手信息 

Task< Result < nlohmann::json > > qqmusic::get_similar_singers (
    std::string_view mid,
    unsigned number=10
)

Parameters:

  • mids 歌手mid
  • number 相似歌手数量, 默认为0

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

See also: TabType

Note:

异步函数, 返回Task

function get_similar_songs

获取相似歌曲列表 

Task< Result < nlohmann::json > > qqmusic::get_similar_songs (
    uint64_t songid
)

Parameters:

  • id 歌曲id

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_singer_desc

获取多个歌手的简介 

Task< Result < nlohmann::json > > qqmusic::get_singer_desc (
    std::span< std::string > mids,
    unsigned number=10
)

Parameters:

  • mids 歌手mid列表
  • number 相似歌手数量, 默认为0

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

See also: TabType

Note:

异步函数, 返回Task

function get_singer_info

获取歌手基本信息 

Task< Result < nlohmann::json > > qqmusic::get_singer_info (
    std::string_view mid
)

Parameters:

  • 歌手mid

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_singer_list

获取符合筛选条件的歌手信息表单 

Task< Result < nlohmann::json > > qqmusic::get_singer_list (
    AreaType area=AreaType::ALL,
    GenderType gender=GenderType::ALL,
    GenreType genre=GenreType::ALL
)

获取JSON格式的歌手信息, 可以使用area, gender和genre筛选

Parameters:

  • area 区域信息筛选, 默认AreaType::ALL.
  • gender 性别信息筛选, 默认GenderType::ALL.
  • genre 风格信息筛选, 默认GenreType::ALL.

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

See also: AreaType, GenderType, GenreType

Note:

异步函数, 返回Task

function get_singer_list_index

筛选获得歌曲歌单原始数据 

Task< Result < nlohmann::json > > qqmusic::get_singer_list_index (
    AreaType area=AreaType::ALL,
    GenderType gender=GenderType::ALL,
    GenreType genre=GenreType::ALL,
    IndexType index=IndexType::ALL,
    unsigned sin=0,
    unsigned cur_page=1
)

Parameters:

  • area 区域信息筛选, 默认AreaType::ALL.
  • gender 性别信息筛选, 默认GenderType::ALL.
  • genre 风格信息筛选, 默认GenreType::ALL.
  • sin 跳过的条目数量, 默认0
  • cur_page 当前页面的索引, 默认1

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

See also: AreaType, GenderType, GenreType, IndexType

Note:

异步函数, 返回Task

function get_singer_list_index_all

获取所有符合条件的歌单原始数据 

Task< Result < nlohmann::json > > qqmusic::get_singer_list_index_all (
    AreaType area=AreaType::ALL,
    GenderType gender=GenderType::ALL,
    GenreType genre=GenreType::ALL,
    IndexType index=IndexType::ALL
)

Parameters:

  • area 区域信息筛选, 默认AreaType::ALL.
  • gender 性别信息筛选, 默认GenderType::ALL.
  • genre 风格信息筛选, 默认GenreType::ALL.
  • index 索引信息筛选, 默认IndexType::ALL.

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

See also: AreaType, GenderType, GenreType, IndexType

Note:

异步函数, 返回Task

function get_song_detail

获取歌曲详细信息 

Task< Result < nlohmann::json > > qqmusic::get_song_detail (
    std::string_view mid
)

Parameters:

  • mid 歌曲mid

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_song_detail

获取歌曲详细信息 

Task< Result < nlohmann::json > > qqmusic::get_song_detail (
    uint64_t id
)

Parameters:

  • id 歌曲id

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_song_urls

批量获取歌曲播放链接 

Task< Result < std::vector< SongInfo > > > qqmusic::get_song_urls (
    std::span< std::string > mids,
    std::unique_ptr< BaseMediaFileType > file_type=std::make_unique< SongFileType >(),
    std::optional< utils::Credential > credential=std::nullopt
)

@params mids 歌曲mid列表 @params file_type 歌曲文件类型, 默认MP3_128类型 @params credential 凭证信息

调用示例: 

std::vector<std::string> mids{"002n5zzy3VVGau"};

// 未加密类型
auto res = co_await get_song_urls(mids,
    std::make_unique<SongFileType>(SongFileType::ACC_192));

// 加密文件类型 
auto res = co_await get_song_urls(mids,
    std::make_unique<EncryptedSongFileType>(EncryptedSongFileType::MASTER));

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

See also: BaseMediaFileType, SongFileType, EncryptedSongFileType

Note:

异步函数, 返回Task

function get_songlist

Task< Result < nlohmann::json > > qqmusic::get_songlist (
    uint64_t songlist_id,
    unsigned dirid
)

function get_songlist_detail

Task< Result < nlohmann::json > > qqmusic::get_songlist_detail (
    uint64_t songlist_id,
    unsigned dirid,
    unsigned num,
    unsigned page,
    bool only_song,
    bool tag,
    bool user_info
)

function get_songs_list

获取歌手歌曲原始数据 

Task< Result < nlohmann::json > > qqmusic::get_songs_list (
    std::string_view mid,
    unsigned num=10,
    unsigned begin=0
)

Parameters:

  • mid 歌手mid
  • num 每次获取的最大数量, 默认10, 最大30
  • begin 从第几个开始

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_songs_list_all

获取歌手的所有歌曲 

Task< Result < nlohmann::json > > qqmusic::get_songs_list_all (
    std::string_view mid
)

Parameters:

  • mid 歌手mid

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function get_tab_detail

返回标签详细信息 

Task< Result < nlohmann::json > > qqmusic::get_tab_detail (
    std::string_view mid,
    TabType type,
    unsigned page=1,
    unsigned num=10
)

Parameters:

  • mid 歌手mid
  • type 标签信息
  • page 页码
  • num 每页返回数量

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

See also: TabType

Note:

异步函数, 返回Task

function get_toplist_category

获取所有排行榜 

Task< Result < nlohmann::json > > qqmusic::get_toplist_category ()

function get_toplist_item_detail

获取排行榜条目信息 

Task< Result < nlohmann::json > > qqmusic::get_toplist_item_detail (
    unsigned top_id,
    unsigned num,
    unsigned page,
    bool tag
)

function get_try_url

获取试听链接 

Task< Result < std::string > > qqmusic::get_try_url (
    std::string_view mid,
    std::string_view vs
)

Parameters:

  • area 区域信息筛选, 默认AreaType::ALL.
  • gender 性别信息筛选, 默认GenderType::ALL.
  • genre 风格信息筛选, 默认GenreType::ALL.

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

See also: AreaType, GenderType, GenreType

Note:

异步函数, 返回Task

function get_vip_info

Task< Result < nlohmann::json > > qqmusic::get_vip_info (
    std::optional< utils::Credential > credential
)

function hotkey

Task< Result < nlohmann::json > > qqmusic::hotkey ()

function keyword_complete

Task< Result < nlohmann::json > > qqmusic::keyword_complete (
    std::string_view keyword
)

function phone_authorize

qqmusic::Task< qqmusic::Result< utils::Credential > > qqmusic::phone_authorize (
    std::string_view phone,
    std::string_view auth_code,
    std::string_view country_code
)

function query_song

批量查询歌曲信息 

Task< Result < nlohmann::json > > qqmusic::query_song (
    std::span< std::string > mids
)

Parameters:

  • mids 待查询歌曲mid列表

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task

function query_song

批量查询歌曲信息 

Task< Result < nlohmann::json > > qqmusic::query_song (
    std::span< uint64_t > ids
)

Parameters:

  • mids 待查询歌曲id列表

Returns:

包含正确JSON格式结果的Task< Result <nlohmann::json>>. 如果产生错误, 返回值包含错误结果和错误类型枚举

Note:

异步函数, 返回Task 

Task< Result < nlohmann::json > > qqmusic::quick_search (
    std::string_view keyword
)

function search_by_type

Task< Result < nlohmann::json > > qqmusic::search_by_type (
    std::string_view keyword,
    SearchType type,
    unsigned num_per_page,
    unsigned page,
    bool highlight
)

function send_authcode

qqmusic::Task< qqmusic::Result< PhoneLoginResult > > qqmusic::send_authcode (
    std::string_view phone,
    std::string_view country_code
)

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
)

function songlist_create

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

function songlist_delete

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

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
)

The documentation for this class was generated from the following file src/album.cc