Struct BpiClient 

pub struct BpiClient { /* private fields */ }

Bilibili API 客户端。

Implementations

impl BpiClient

pub fn new() -> Result<Self, BpiError>

使用默认配置创建自有客户端。

Examples found in repository

examples/live_room_info.rs (line 24)

async fn main() -> BpiResult<()> {
    let room_id = room_id()?;
    let client = BpiClient::new()?;
    let info = client.live().room_info(room_id).await?;

    println!("直播间: {} ({})", info.title, info.room_id);
    println!("主播 mid: {}", info.uid);
    println!(
        "状态: live_status={} 分区={}·{}",
        info.live_status, info.parent_area_name, info.area_name
    );
    println!("在线: {} 关注: {}", info.online, info.attention);

    Ok(())
}

examples/video_info.rs (line 23)

async fn main() -> BpiResult<()> {
    let bvid = video_bvid()?;
    let client = BpiClient::new()?;
    let video = client.video();

    let view = video.view(VideoViewParams::from_bvid(bvid.clone())).await?;
    println!(
        "视频: {} ({}) UP={} 播放={} 点赞={}",
        view.title, view.bvid, view.owner.name, view.stat.view, view.stat.like
    );

    let pages = video
        .page_list(VideoPageListParams::from_bvid(bvid.clone()))
        .await?;
    println!("分 P 数: {}", pages.len());
    for page in pages.iter().take(5) {
        println!("  P{} cid={} {}", page.page, page.cid, page.part);
    }

    let desc = video.desc(VideoDescParams::from_bvid(bvid)).await?;
    let first_line = desc.lines().next().unwrap_or("");
    println!("简介首行: {first_line}");

    Ok(())
}

pub fn builder() -> BpiClientBuilder

开始配置客户端。

Examples found in repository

examples/common/account.rs (line 23)

pub fn authenticated_client() -> BpiResult<BpiClient> {
    BpiClient::builder().account(load_account()?).build()
}

examples/module_clients.rs (line 35)

fn client_from_env() -> BpiResult<BpiClient> {
    match env::var("BPI_COOKIE") {
        Ok(cookie) if !cookie.trim().is_empty() => BpiClient::builder().cookie(cookie).build(),
        _ => BpiClient::builder().build(),
    }
}

pub fn set_account(&self, account: Account) -> Result<(), BpiError>

设置账号信息并更新此客户端的 cookie 状态。

pub fn clear_account(&self)

清除此客户端的账号信息。

pub fn set_account_from_cookie_str( &self, cookie_str: &str, ) -> Result<(), BpiError>

从原始 Cookie 请求头字符串设置账号信息。

pub fn has_login_cookies(&self) -> bool

检查此客户端是否有登录 cookie。

pub fn get_account(&self) -> Option<Account>

返回当前账号信息。

pub fn csrf(&self) -> Result<String, BpiError>

从账号信息获取当前 CSRF token。

pub fn get(&self, url: &str) -> RequestBuilder

使用此客户端默认的 Bilibili 请求头创建 GET 请求。

pub fn post(&self, url: &str) -> RequestBuilder

使用此客户端默认的 Bilibili 请求头创建 POST 请求。

impl BpiClient

pub fn activity(&self) -> ActivityClient<'_>

创建 activity 领域客户端。

pub fn article(&self) -> ArticleClient<'_>

创建 article 领域客户端。

pub fn audio(&self) -> AudioClient<'_>

创建 audio 领域客户端。

pub fn bangumi(&self) -> BangumiClient<'_>

创建 bangumi 领域客户端。

Examples found in repository

examples/module_clients.rs (line 22)

async fn main() -> BpiResult<()> {
    let client = client_from_env()?;
    let video_params = VideoViewParams::from_bvid("BV1xx411c7mD".parse::<Bvid>()?);
    let bangumi_params = BangumiInfoParams::new(MediaId::new(28_220_978)?);

    if !run_live_example() {
        println!("module-client 快速示例已编译；设置 BPI_RUN_EXAMPLE=1 后会发起真实网络请求");
        return Ok(());
    }

    let video = client.video().view(video_params).await?;
    println!("video: {}", video.title);

    let bangumi = client.bangumi().info(bangumi_params).await?;
    println!("bangumi: {}", bangumi.media.title);

    if env::var_os("BPI_COOKIE").is_some() {
        let nav = client.login().nav().await?;
        println!("logged in: {}", nav.is_login);
    }

    Ok(())
}

pub fn cheese(&self) -> CheeseClient<'_>

创建 cheese 课程领域客户端。

pub fn clientinfo(&self) -> ClientInfoClient<'_>

创建 client info 领域客户端。

pub fn comment(&self) -> CommentClient<'_>

创建 comment 领域客户端。

pub fn creativecenter(&self) -> CreativeCenterClient<'_>

创建 creative center 领域客户端。

pub fn danmaku(&self) -> DanmakuClient<'_>

创建 danmaku 领域客户端。

pub fn dynamic(&self) -> DynamicClient<'_>

创建 dynamic 领域客户端。

pub fn electric(&self) -> ElectricClient<'_>

创建 electric charging 领域客户端。

pub fn fav(&self) -> FavClient<'_>

创建 favorite 领域客户端。

pub fn historytoview(&self) -> HistoryToViewClient<'_>

创建 history and to-view 领域客户端。

pub fn login(&self) -> LoginClient<'_>

创建 login 领域客户端。

Examples found in repository

examples/module_clients.rs (line 26)

async fn main() -> BpiResult<()> {
    let client = client_from_env()?;
    let video_params = VideoViewParams::from_bvid("BV1xx411c7mD".parse::<Bvid>()?);
    let bangumi_params = BangumiInfoParams::new(MediaId::new(28_220_978)?);

    if !run_live_example() {
        println!("module-client 快速示例已编译；设置 BPI_RUN_EXAMPLE=1 后会发起真实网络请求");
        return Ok(());
    }

    let video = client.video().view(video_params).await?;
    println!("video: {}", video.title);

    let bangumi = client.bangumi().info(bangumi_params).await?;
    println!("bangumi: {}", bangumi.media.title);

    if env::var_os("BPI_COOKIE").is_some() {
        let nav = client.login().nav().await?;
        println!("logged in: {}", nav.is_login);
    }

    Ok(())
}

examples/login_status.rs (line 17)

async fn main() -> BpiResult<()> {
    let client = account::authenticated_client()?;
    let login = client.login();

    let nav = login.nav().await?;
    println!(
        "登录状态: is_login={} mid={:?} uname={}",
        nav.is_login,
        nav.mid,
        nav.uname.as_deref().unwrap_or("<unknown>")
    );

    let coin = login.coin().await?;
    println!("硬币余额: {:.2}", coin.money);

    match login.daily_reward().await {
        Ok(reward) => println!(
            "每日奖励: login={} watch={} coins={} share={}",
            reward.login, reward.watch, reward.coins, reward.share
        ),
        Err(err) if err.is_risk_control() => {
            println!("每日奖励: 当前请求被风控拦截，已跳过 ({err})");
        }
        Err(err) => return Err(err),
    }

    let vip = login.vip_info().await?;
    println!(
        "VIP: active={} type={} status={}",
        vip.is_active(),
        vip.vip_type,
        vip.vip_status
    );

    Ok(())
}

pub fn live(&self) -> LiveClient<'_>

创建 live 领域客户端。

Examples found in repository

examples/live_room_info.rs (line 25)

async fn main() -> BpiResult<()> {
    let room_id = room_id()?;
    let client = BpiClient::new()?;
    let info = client.live().room_info(room_id).await?;

    println!("直播间: {} ({})", info.title, info.room_id);
    println!("主播 mid: {}", info.uid);
    println!(
        "状态: live_status={} 分区={}·{}",
        info.live_status, info.parent_area_name, info.area_name
    );
    println!("在线: {} 关注: {}", info.online, info.attention);

    Ok(())
}

examples/live_web_start.rs (line 53)

async fn main() -> BpiResult<()> {
    let stop_if_live = std::env::args().any(|a| a == "--stop-if-live");
    let stop_only = std::env::args().any(|a| a == "--stop-only");
    let room_id: i64 = std::env::var("BILI_ROOM_ID")
        .ok()
        .and_then(|s| s.parse().ok())
        .unwrap_or(DEFAULT_ROOM_ID);
    let area_id: u64 = std::env::var("BILI_AREA_ID")
        .ok()
        .and_then(|s| s.parse().ok())
        .unwrap_or(DEFAULT_AREA_ID);

    let bpi = account::authenticated_client()?;

    println!("=== Rust 网页自动开播验证 ===");
    println!("room_id={room_id} area_v2={area_id}");

    let live = bpi.live();
    let info = live.room_info(room_id).await?;
    println!(
        "当前状态: live_status={} title={} area={}·{}",
        info.live_status, info.title, info.parent_area_name, info.area_name
    );

    if !mutating_enabled() {
        println!("{MUTATING_ENV}=1 未设置，只读取直播间状态，不执行开播、关播或获取推流码。");
        return Ok(());
    }

    if stop_only {
        if info.live_status == 1 {
            println!("执行关播...");
            let stop = live.live_stop(room_id as u64, "pc").await?;
            println!("关播结果: status={}", stop.status);
            tokio::time::sleep(std::time::Duration::from_secs(3)).await;
        } else {
            println!("当前未开播，跳过关播接口。");
        }

        let after = live.room_info(room_id).await?;
        println!(
            "验证: live_status={} ({})",
            after.live_status,
            if after.live_status == 0 {
                "关播成功"
            } else {
                "仍在直播中"
            }
        );
        return Ok(());
    }

    if info.live_status == 1 {
        if stop_if_live {
            println!("已在直播，--stop-if-live：先关播...");
            let stop = live.live_stop(room_id as u64, "pc").await?;
            println!("关播结果: status={}", stop.status);
            tokio::time::sleep(std::time::Duration::from_secs(2)).await;
        } else {
            println!("已在直播中。若要完整验证开播链路，请加 --stop-if-live 或先手动关播。");
            println!("仍尝试 FetchWebUpStreamAddr（只读）...");
            let stream = live.live_fetch_web_up_stream_addr().await?;
            println!("推流地址: {}{}", stream.addr.addr, mask(&stream.addr.code));
            return Ok(());
        }
    }

    println!("\n[1/2] FetchWebUpStreamAddr...");
    let stream = live.live_fetch_web_up_stream_addr().await?;
    println!("  rtmp: {}{}", stream.addr.addr, mask(&stream.addr.code));

    println!("\n[2/2] WebLiveCenterStartLive (WBI)...");
    let start = live.live_web_center_start(room_id as u64, area_id).await?;
    println!("  status={} live_key={}", start.status, start.live_key);
    if let Some(rtmp) = &start.rtmp {
        println!("  rtmp(响应): {}{}", rtmp.addr, mask(&rtmp.code));
    } else {
        println!("  rtmp(响应): null（正常，推流码以 Fetch 为准）");
    }

    tokio::time::sleep(std::time::Duration::from_secs(2)).await;
    let after = live.room_info(room_id).await?;
    println!(
        "\n验证: live_status={} ({})",
        after.live_status,
        if after.live_status == 1 {
            "开播成功"
        } else {
            "未变为直播中（可能需 OBS 推流）"
        }
    );

    Ok(())
}

pub fn manga(&self) -> MangaClient<'_>

创建 manga 领域客户端。

pub fn misc(&self) -> MiscClient<'_>

创建 misc 领域客户端。

pub fn message(&self) -> MessageClient<'_>

创建 message 领域客户端。

pub fn note(&self) -> NoteClient<'_>

创建 note 领域客户端。

pub fn opus(&self) -> OpusClient<'_>

创建 opus 领域客户端。

pub fn search(&self) -> SearchClient<'_>

创建 search 领域客户端。

pub fn video(&self) -> VideoClient<'_>

创建 video 领域客户端。

Examples found in repository

examples/module_clients.rs (line 19)

async fn main() -> BpiResult<()> {
    let client = client_from_env()?;
    let video_params = VideoViewParams::from_bvid("BV1xx411c7mD".parse::<Bvid>()?);
    let bangumi_params = BangumiInfoParams::new(MediaId::new(28_220_978)?);

    if !run_live_example() {
        println!("module-client 快速示例已编译；设置 BPI_RUN_EXAMPLE=1 后会发起真实网络请求");
        return Ok(());
    }

    let video = client.video().view(video_params).await?;
    println!("video: {}", video.title);

    let bangumi = client.bangumi().info(bangumi_params).await?;
    println!("bangumi: {}", bangumi.media.title);

    if env::var_os("BPI_COOKIE").is_some() {
        let nav = client.login().nav().await?;
        println!("logged in: {}", nav.is_login);
    }

    Ok(())
}

examples/video_info.rs (line 24)

async fn main() -> BpiResult<()> {
    let bvid = video_bvid()?;
    let client = BpiClient::new()?;
    let video = client.video();

    let view = video.view(VideoViewParams::from_bvid(bvid.clone())).await?;
    println!(
        "视频: {} ({}) UP={} 播放={} 点赞={}",
        view.title, view.bvid, view.owner.name, view.stat.view, view.stat.like
    );

    let pages = video
        .page_list(VideoPageListParams::from_bvid(bvid.clone()))
        .await?;
    println!("分 P 数: {}", pages.len());
    for page in pages.iter().take(5) {
        println!("  P{} cid={} {}", page.page, page.cid, page.part);
    }

    let desc = video.desc(VideoDescParams::from_bvid(bvid)).await?;
    let first_line = desc.lines().next().unwrap_or("");
    println!("简介首行: {first_line}");

    Ok(())
}

pub fn video_ranking(&self) -> VideoRankingClient<'_>

创建 video ranking 领域客户端。

pub fn vip(&self) -> VipClient<'_>

创建 VIP 领域客户端。

pub fn wallet(&self) -> WalletClient<'_>

创建 wallet 领域客户端。

pub fn user(&self) -> UserClient<'_>

创建 user 领域客户端。

pub fn web_widget(&self) -> WebWidgetClient<'_>

创建 web widget 领域客户端。

pub fn from_config(config: &Account) -> Result<Self, BpiError>

从结构化账号配置创建客户端。