Amagi API 文档 - v5.6.3
    正在准备搜索索引...

    函数 createBoundBilibiliApi

    • 创建绑定了cookie的B站API对象

      参数

      • cookie: string

        要绑定的cookie(可选)

      • requestConfig: RequestConfig

      返回 {
          getVideoInfo: <M extends TypeMode = "loose">(
              options: Omit<{ methodType: "单个视频作品数据"; bvid: string }, "methodType"> & {
                  typeMode?: TypeMode;
              } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<BiliOneWork, M>>>;
          getVideoStream: <M extends TypeMode = "loose">(
              options: Omit<
                  { methodType: "单个视频下载信息数据"; avid: number; cid: number },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<
              ApiResponse<
                  ConditionalReturnType<
                      BiliVideoPlayurlIsLogin
                      | BiliBiliVideoPlayurlNoLogin,
                      M,
                  >,
              >,
          >;
          getComments: <M extends TypeMode = "loose">(
              options: Omit<
                  {
                      methodType: "评论数据";
                      type: number;
                      oid: string;
                      number?: number;
                      mode?: 0
                      | 1
                      | 2
                      | 3;
                      pagination_str?: string;
                      plat?: number;
                      seek_rpid?: string;
                      web_location?: string;
                  },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<BiliWorkComments, M>>>;
          getUserProfile: <M extends TypeMode = "loose">(
              options: Omit<
                  {
                      methodType: "用户主页数据"
                      | "用户主页动态列表数据"
                      | "获取UP主总播放量";
                      host_mid: number;
                  },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<BiliUserProfile, M>>>;
          getUserDynamic: <M extends TypeMode = "loose">(
              options: Omit<
                  {
                      methodType: "用户主页数据"
                      | "用户主页动态列表数据"
                      | "获取UP主总播放量";
                      host_mid: number;
                  },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<BiliUserDynamic, M>>>;
          getEmojiList: <M extends TypeMode = "loose">(
              options: Omit<{ methodType: "Emoji数据" }, "methodType"> & {
                  typeMode?: TypeMode;
              } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<BiliEmojiList, M>>>;
          getBangumiInfo: <M extends TypeMode = "loose">(
              options: Omit<
                  { methodType: "番剧基本信息数据"; season_id?: string; ep_id?: string },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<BiliBangumiVideoInfo, M>>>;
          getBangumiStream: <M extends TypeMode = "loose">(
              options: Omit<
                  { methodType: "番剧下载信息数据"; cid: number; ep_id: string },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<
              ApiResponse<
                  ConditionalReturnType<
                      BiliBangumiVideoPlayurlIsLogin
                      | BiliBangumiVideoPlayurlNoLogin,
                      M,
                  >,
              >,
          >;
          getDynamicInfo: <M extends TypeMode = "loose">(
              options: Omit<
                  { methodType: "动态详情数据"
                  | "动态卡片数据"; dynamic_id: string },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<BiliDynamicInfoUnion, M>>>;
          getDynamicCard: <M extends TypeMode = "loose">(
              options: Omit<
                  { methodType: "动态详情数据"
                  | "动态卡片数据"; dynamic_id: string },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<BiliDynamicCard, M>>>;
          getLiveRoomDetail: <M extends TypeMode = "loose">(
              options: Omit<
                  { methodType: "直播间信息"
                  | "直播间初始化信息"; room_id: string },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<BiliLiveRoomDetail, M>>>;
          getLiveRoomInitInfo: <M extends TypeMode = "loose">(
              options: Omit<
                  { methodType: "直播间信息"
                  | "直播间初始化信息"; room_id: string },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<BiliLiveRoomDef, M>>>;
          getLoginBasicInfo: <M extends TypeMode = "loose">(
              options: Omit<{ methodType: "登录基本信息" }, "methodType"> & {
                  typeMode?: TypeMode;
              } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<any, M>>>;
          getLoginQrcode: <M extends TypeMode = "loose">(
              options: Omit<{ methodType: "申请二维码" }, "methodType"> & {
                  typeMode?: TypeMode;
              } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<BiliNewLoginQrcode, M>>>;
          checkQrcodeStatus: <M extends TypeMode = "loose">(
              options: Omit<
                  { methodType: "二维码状态"; qrcode_key: string },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<BiliCheckQrcode, M>>>;
          getUserTotalPlayCount: <M extends TypeMode = "loose">(
              options: Omit<
                  {
                      methodType: "用户主页数据"
                      | "用户主页动态列表数据"
                      | "获取UP主总播放量";
                      host_mid: number;
                  },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<BiliUserFullView, M>>>;
          convertAvToBv: <M extends TypeMode = "loose">(
              options: Omit<{ methodType: "AV转BV"; avid: number }, "methodType"> & {
                  typeMode?: TypeMode;
              } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<BiliAv2Bv, M>>>;
          convertBvToAv: <M extends TypeMode = "loose">(
              options: Omit<{ methodType: "BV转AV"; bvid: string }, "methodType"> & {
                  typeMode?: TypeMode;
              } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<BiliBv2AV, M>>>;
      }

      绑定了cookie的B站API对象,调用时不需要再传递cookie

      • getVideoInfo: <M extends TypeMode = "loose">(
            options: Omit<{ methodType: "单个视频作品数据"; bvid: string }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<BiliOneWork, M>>>

        获取单个视频作品数据

      • getVideoStream: <M extends TypeMode = "loose">(
            options: Omit<
                { methodType: "单个视频下载信息数据"; avid: number; cid: number },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<
            ApiResponse<
                ConditionalReturnType<
                    BiliVideoPlayurlIsLogin
                    | BiliBiliVideoPlayurlNoLogin,
                    M,
                >,
            >,
        >

        获取单个视频下载信息数据

      • getComments: <M extends TypeMode = "loose">(
            options: Omit<
                {
                    methodType: "评论数据";
                    type: number;
                    oid: string;
                    number?: number;
                    mode?: 0
                    | 1
                    | 2
                    | 3;
                    pagination_str?: string;
                    plat?: number;
                    seek_rpid?: string;
                    web_location?: string;
                },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<BiliWorkComments, M>>>

        获取评论数据

      • getUserProfile: <M extends TypeMode = "loose">(
            options: Omit<
                { methodType: "用户主页数据"
                | "用户主页动态列表数据"
                | "获取UP主总播放量"; host_mid: number },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<BiliUserProfile, M>>>

        获取用户主页数据

      • getUserDynamic: <M extends TypeMode = "loose">(
            options: Omit<
                { methodType: "用户主页数据"
                | "用户主页动态列表数据"
                | "获取UP主总播放量"; host_mid: number },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<BiliUserDynamic, M>>>

        获取用户主页动态列表数据

      • getEmojiList: <M extends TypeMode = "loose">(
            options: Omit<{ methodType: "Emoji数据" }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<BiliEmojiList, M>>>

        获取 Emoji 数据

      • getBangumiInfo: <M extends TypeMode = "loose">(
            options: Omit<
                { methodType: "番剧基本信息数据"; season_id?: string; ep_id?: string },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<BiliBangumiVideoInfo, M>>>

        获取番剧基本信息数据

      • getBangumiStream: <M extends TypeMode = "loose">(
            options: Omit<
                { methodType: "番剧下载信息数据"; cid: number; ep_id: string },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<
            ApiResponse<
                ConditionalReturnType<
                    BiliBangumiVideoPlayurlIsLogin
                    | BiliBangumiVideoPlayurlNoLogin,
                    M,
                >,
            >,
        >

        获取番剧下载信息数据

      • getDynamicInfo: <M extends TypeMode = "loose">(
            options: Omit<
                { methodType: "动态详情数据"
                | "动态卡片数据"; dynamic_id: string },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<BiliDynamicInfoUnion, M>>>

        获取动态详情数据

      • getDynamicCard: <M extends TypeMode = "loose">(
            options: Omit<
                { methodType: "动态详情数据"
                | "动态卡片数据"; dynamic_id: string },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<BiliDynamicCard, M>>>

        获取动态卡片数据

      • getLiveRoomDetail: <M extends TypeMode = "loose">(
            options: Omit<
                { methodType: "直播间信息"
                | "直播间初始化信息"; room_id: string },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<BiliLiveRoomDetail, M>>>

        获取直播间信息

      • getLiveRoomInitInfo: <M extends TypeMode = "loose">(
            options: Omit<
                { methodType: "直播间信息"
                | "直播间初始化信息"; room_id: string },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<BiliLiveRoomDef, M>>>

        获取直播间初始化信息

      • getLoginBasicInfo: <M extends TypeMode = "loose">(
            options: Omit<{ methodType: "登录基本信息" }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<any, M>>>

        获取登录基本信息

      • getLoginQrcode: <M extends TypeMode = "loose">(
            options: Omit<{ methodType: "申请二维码" }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<BiliNewLoginQrcode, M>>>

        申请登录二维码

      • checkQrcodeStatus: <M extends TypeMode = "loose">(
            options: Omit<{ methodType: "二维码状态"; qrcode_key: string }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<BiliCheckQrcode, M>>>

        检查二维码状态

      • getUserTotalPlayCount: <M extends TypeMode = "loose">(
            options: Omit<
                { methodType: "用户主页数据"
                | "用户主页动态列表数据"
                | "获取UP主总播放量"; host_mid: number },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<BiliUserFullView, M>>>

        获取 UP 主总播放量

      • convertAvToBv: <M extends TypeMode = "loose">(
            options: Omit<{ methodType: "AV转BV"; avid: number }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<BiliAv2Bv, M>>>

        将 AV 号转换为 BV 号

      • convertBvToAv: <M extends TypeMode = "loose">(
            options: Omit<{ methodType: "BV转AV"; bvid: string }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<BiliBv2AV, M>>>

        将 BV 号转换为 AV 号