Struct LiveClient 

pub struct LiveClient<'a> { /* private fields */ }

Live API client.

Implementations

impl<'a> LiveClient<'a>

pub async fn area_list(&self) -> BpiResult<Vec<LiveParentArea>>

Fetches all live area categories.

pub async fn room_info(&self, room_id: i64) -> BpiResult<RoomInfoData>

Fetches public room information by real room ID.

pub async fn stream( &self, cid: i64, platform: Option<&str>, quality: Option<i32>, qn: Option<i32>, ) -> BpiResult<LiveStreamData>

Fetches live stream URLs by real room ID.

pub async fn recommend(&self) -> BpiResult<RecommendData>

Fetches the web homepage live recommendation list.

pub async fn version(&self) -> BpiResult<PcLiveVersionData>

Fetches the current PC live client version metadata.

pub async fn gift_types(&self) -> BpiResult<Vec<GiftTypeItem>>

Fetches the authenticated live gift type list.

pub async fn room_gift_list( &self, room_id: i64, area_parent_id: Option<i32>, area_id: Option<i32>, ) -> BpiResult<RoomGiftData>

Fetches the gift panel for a live room.

pub async fn blind_gift_info(&self, gift_id: i64) -> BpiResult<BlindGiftData>

Fetches blind gift probability details.

pub async fn danmu_info( &self, room_id: u64, info_type: u8, ) -> BpiResult<LiveDanmuInfoData>

Fetches live WebSocket danmu token and host information.

pub async fn emoticons( &self, room_id: i64, platform: &str, ) -> BpiResult<EmoticonData>

Fetches live room emoticon packages.

pub async fn lottery_info(&self, room_id: i64) -> BpiResult<LotteryInfoData>

Fetches live room lottery information.

pub async fn my_medals( &self, page: i32, page_size: i32, ) -> BpiResult<MyMedalsData>

Fetches the current account’s live fan medals.

pub async fn follow_up_list( &self, page: Option<i32>, page_size: Option<i32>, ignore_record: Option<i32>, hit_ab: Option<bool>, ) -> BpiResult<FollowUpLiveData>

Fetches followed streamers and their live status.

pub async fn follow_up_web_list( &self, hit_ab: Option<bool>, ) -> BpiResult<LiveWebListData>

Fetches followed streamers that are currently live.

pub async fn replay_list( &self, page: Option<i32>, page_size: Option<i32>, ) -> BpiResult<ReplayListData>

Fetches the current account’s live replay list.

pub async fn guard_list( &self, room_id: i64, ruid: i64, page: Option<i32>, page_size: Option<i32>, typ: Option<i32>, ) -> BpiResult<GuardListData>

Fetches live guard members for a room.

pub async fn silent_users( &self, params: LiveSilentUserListParams, ) -> BpiResult<SilentUserListData>

Fetches silent users for a live room.

pub async fn banned_users( &self, params: LiveBannedUserListParams, ) -> BpiResult<BannedUserListData>

Fetches banned users for a live anchor.

pub async fn shield_keywords( &self, params: LiveShieldKeywordListParams, ) -> BpiResult<ShieldKeywordListData>

Fetches shield keywords for a live room.

pub async fn web_heart_beat( &self, params: LiveWebHeartBeatParams, ) -> BpiResult<HeartBeatData>

Sends a web heartbeat for live telemetry.

impl<'a> LiveClient<'a>

pub async fn live_send_danmu( &self, room_id: u64, message: &str, color: Option<u32>, font_size: Option<u32>, ) -> BpiResult<SendDanmuData>

发送直播间弹幕

参数

• room_id - 直播间 ID
• message - 弹幕内容
• color - 十进制颜色值，默认 16777215 (白色)
• font_size - 字体大小，默认 25

impl<'a> LiveClient<'a>

pub async fn live_create_room(&self) -> BpiResult<CreateRoomData>

开通直播间

pub async fn live_update_room_info( &self, room_id: u64, title: Option<&str>, area_id: Option<u64>, add_tag: Option<&str>, del_tag: Option<&str>, ) -> BpiResult<UpdateRoomData>

更新直播间信息

参数

• room_id - 直播间 ID
• title - 标题，可选
• area_id - 分区 ID，可选
• add_tag - 要添加的标签，可选
• del_tag - 要删除的标签，可选

pub async fn live_stop( &self, room_id: u64, platform: &str, ) -> BpiResult<StopLiveData>

关闭直播

参数

• room_id - 直播间 ID
• platform - 直播平台，如 “pc_link”

pub async fn live_update_pre_live_info( &self, title: Option<&str>, cover: Option<&str>, ) -> BpiResult<UpdatePreLiveInfoData>

预更新直播间信息

参数

• title - 标题，可选
• cover - 封面 URL，可选

pub async fn live_update_room_news( &self, room_id: u64, uid: u64, content: &str, ) -> BpiResult<Value>

更新直播间公告

参数

• room_id - 直播间 ID
• uid - 用户ID
• content - 公告内容

impl<'a> LiveClient<'a>

pub async fn live_add_silent_user( &self, room_id: i64, tuid: i64, hour: i32, msg: Option<String>, ) -> BpiResult<Option<Value>>

禁言观众 tuid: 用户uid hour: -1永久 0本场直播 msg: 禁言理由，一般为禁言的弹幕，选填

pub async fn live_del_block_user( &self, roomid: i64, tuid: i64, ) -> BpiResult<Option<Value>>

解除禁言

pub async fn live_add_banned_user( &self, room_id: i64, anchor_id: i64, tuid: i64, ) -> BpiResult<Option<Value>>

拉黑观众 anchor_id：主播uid

pub async fn live_del_banned_user( &self, room_id: i64, anchor_id: i64, tuid: i64, ) -> BpiResult<Option<Value>>

解除拉黑 anchor_id：主播uid

pub async fn live_add_shield_keyword( &self, room_id: i64, keyword: String, ) -> BpiResult<Option<Value>>

添加屏蔽词

pub async fn live_del_shield_keyword( &self, room_id: i64, keyword: String, ) -> BpiResult<Option<Value>>

删除屏蔽词

Trait Implementations

impl<'a> Clone for LiveClient<'a>

fn clone(&self) -> LiveClient<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for LiveClient<'a>