Struct VideoClient 

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

Video domain API client.

Implementations

impl<'a> VideoClient<'a>

pub async fn like(&self, params: VideoLikeParams) -> BpiResult<CoinData>

Likes or unlikes a video and returns the canonical payload result.

pub async fn coin(&self, params: VideoCoinParams) -> BpiResult<CoinData>

Gives coins to a video and returns the canonical payload result.

pub async fn favorite( &self, params: VideoFavoriteParams, ) -> BpiResult<FavoriteData>

Favorites a video to, or removes it from, favorite folders.

impl<'a> VideoClient<'a>

pub async fn view(&self, params: VideoViewParams) -> BpiResult<VideoView>

Fetches web video detail by AV ID or BV ID.

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 quickstart compiled; set BPI_RUN_EXAMPLE=1 to call live APIs");
        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 async fn detail(&self, params: VideoDetailParams) -> BpiResult<VideoDetail>

Fetches web video detail, including tags and related videos.

pub async fn page_list( &self, params: VideoPageListParams, ) -> BpiResult<Vec<VideoPage>>

Fetches the page/content IDs for a video.

pub async fn desc(&self, params: VideoDescParams) -> BpiResult<String>

Fetches the plain text video description.

pub async fn play_url( &self, params: VideoPlayUrlParams, ) -> BpiResult<PlayUrlResponseData>

Fetches signed web playback URLs by AV ID or BV ID plus page/content ID.

pub async fn seasons_archives_list( &self, params: VideoCollectionSeasonsArchivesParams, ) -> BpiResult<GetSeasonsArchivesData>

Fetches the videos in a specific video season.

pub async fn home_seasons_series( &self, params: VideoCollectionHomeSeasonsSeriesParams, ) -> BpiResult<GetSeasonsSeriesData>

Fetches a user’s home season and series lists.

pub async fn seasons_series_list( &self, params: VideoCollectionSeasonsSeriesParams, ) -> BpiResult<GetSeasonsSeriesData>

Fetches a user’s season and series list with pagination.

pub async fn series_info( &self, params: VideoCollectionSeriesInfoParams, ) -> BpiResult<GetSeriesData>

Fetches metadata for a specific video series.

pub async fn series_archives( &self, params: VideoCollectionSeriesArchivesParams, ) -> BpiResult<GetSeriesArchivesData>

Fetches videos in a specific video series.

pub async fn online_total( &self, params: VideoOnlineTotalParams, ) -> BpiResult<OnlineTotalResponseData>

Fetches the online viewer counters for a video page.

pub async fn player_info_v2( &self, params: VideoPlayerInfoParams, ) -> BpiResult<PlayerInfoResponseData>

Fetches web player metadata for a video page.

pub async fn related_videos( &self, params: VideoRelatedParams, ) -> BpiResult<Vec<RelatedVideo>>

Fetches videos related to a video.

pub async fn homepage_recommendations( &self, params: VideoHomepageRecommendationsParams, ) -> BpiResult<RcmdFeedResponseData>

Fetches homepage video recommendations.

pub async fn ai_summary( &self, params: VideoAiSummaryParams, ) -> BpiResult<AiSummaryResponseData>

Fetches the AI summary for a video.

pub async fn tags(&self, params: VideoTagsParams) -> BpiResult<Vec<VideoTag>>

Fetches tags attached to a video.

pub async fn interactive_video_info( &self, params: InteractiveVideoInfoParams, ) -> BpiResult<InteractiveVideoInfoResponseData>

Fetches metadata for an interactive video node.

impl<'a> VideoClient<'a>

pub async fn create_collection_series( &self, params: CollectionCreateAndAddArchivesParams, ) -> BpiResult<CreateSeriesResponseData>

Creates a video series and optionally adds archives to it.

pub async fn delete_collection_series( &self, params: CollectionDeleteSeriesParams, ) -> BpiResult<Option<Value>>

Deletes a video series.

pub async fn delete_collection_archives( &self, params: CollectionArchivesMutationParams, ) -> BpiResult<Option<Value>>

Deletes archives from a video series.

pub async fn add_collection_archives( &self, params: CollectionArchivesMutationParams, ) -> BpiResult<Option<Value>>

Adds archives to a video series.

pub async fn update_collection_series( &self, params: CollectionUpdateSeriesParams, ) -> BpiResult<Option<Value>>

Updates a video series.

impl<'a> VideoClient<'a>

pub async fn report_watch_progress( &self, params: VideoWatchProgressParams, ) -> BpiResult<Option<Value>>

Reports video watch progress and returns the canonical payload result.

Trait Implementations

impl<'a> Clone for VideoClient<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for VideoClient<'a>