Struct AudioClient 

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

Audio API client.

Implementations

impl<'a> AudioClient<'a>

pub async fn favorite( &self, params: AudioCollectionToFavParams, ) -> BpiResult<PromptData>

Favorites an audio song to, or removes it from, favorite folders.

pub async fn collect(&self, params: AudioCollectionToParams) -> BpiResult<bool>

Adds an audio song to a collection.

pub async fn coin(&self, params: AudioCoinParams) -> BpiResult<String>

Gives coins to an audio song and returns the canonical payload result.

impl<'a> AudioClient<'a>

pub async fn info(&self, params: AudioSongParams) -> BpiResult<AudioInfoData>

Gets basic information for an audio track.

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

Gets tags for an audio track.

pub async fn members( &self, params: AudioSongParams, ) -> BpiResult<Vec<AudioMemberType>>

Gets creator members for an audio track.

pub async fn lyric(&self, params: AudioSongParams) -> BpiResult<String>

Gets the lyric body for an audio track.

pub async fn status_number( &self, params: AudioSongParams, ) -> BpiResult<AudioStatusNumberData>

Gets status counters for an audio track.

pub async fn collection_status( &self, params: AudioSongParams, ) -> BpiResult<bool>

Gets whether the current account has collected an audio track.

pub async fn coin_count(&self, params: AudioSongParams) -> BpiResult<i32>

Gets the current account’s coin count for an audio track.

pub async fn stream_url_web( &self, params: AudioStreamUrlWebParams, ) -> BpiResult<AudioStreamUrlWebData>

Gets the web audio stream URL payload.

pub async fn stream_url( &self, params: AudioStreamUrlParams, ) -> BpiResult<AudioStreamUrlData>

Gets the app-style audio stream URL payload.

pub async fn collections_list( &self, params: AudioPageParams, ) -> BpiResult<AudioCollectionsListData>

Gets the current account’s created audio collections.

pub async fn collection_info( &self, params: AudioCollectionInfoParams, ) -> BpiResult<Option<AudioCollection>>

Gets information for an audio collection.

pub async fn hot_menu( &self, params: AudioPageParams, ) -> BpiResult<AudioHotMenuData>

Gets popular audio collections.

pub async fn rank_menu( &self, params: AudioPageParams, ) -> BpiResult<AudioRankMenuData>

Gets ranked audio collection menus.

pub async fn rank_period( &self, params: AudioRankPeriodParams, ) -> BpiResult<AudioRankPeriodData>

Gets available periods for an audio rank list.

pub async fn rank_detail( &self, params: AudioRankListParams, ) -> BpiResult<AudioRankDetailData>

Gets detail for a single audio rank list period.

pub async fn rank_music_list( &self, params: AudioRankListParams, ) -> BpiResult<AudioRankMusicListData>

Gets music entries for a single audio rank list period.

impl<'a> AudioClient<'a>

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

Subscribes or unsubscribes from an audio rank list.

Trait Implementations

impl<'a> Clone for AudioClient<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for AudioClient<'a>