Struct ksoft::music::Music

pub struct Music {
    pub http: Arc<HttpClient>,
}

Fields

http: Arc<HttpClient>

Implementations

impl Music

pub fn new(http_client: Arc<HttpClient>) -> Self

pub async fn advanced_lyrics<'_>(
    &'_ self,
    query: impl ToString,
    text_only: bool,
    limit: u32
) -> Result<Lyrics>

Get lyrics of a song specifying custom parameters

Example

if let Ok(res) = client.music.advanced_lyrics("despacito", false, 10).await {
    match res {
        Ok(lyrics) => {
            //do something with lyrics
        },
        Err(why) => {
            //do something with the <MusicError> struct
        }
    }
}

pub async fn lyrics<'_>(&'_ self, query: impl ToString) -> Result<Lyrics>

Get lyrics of a song

Example

if let Ok(res) = client.music.lyrics("despacito").await {
    match res {
        Ok(lyrics) => {
            //do something with lyrics
        },
        Err(why) => {
            //do something with the <MusicError> struct
        }
    }
}

pub async fn advanced_recommendations<'_>(
    &'_ self,
    tracks: ProviderType,
    youtube_token: Option<String>,
    limit: Option<u32>,
    recommend_type: Option<String>
) -> HttpResult<MusicRecommendationsResponse, MusicError>

Get recommendations of songs with given query specifying custom parameters

You need a premium plan to use this endpoint

Example

if let Ok(res) = client.music.advanced_recommendations(
        ProviderType::YoutubeTitles(vec![String::from("despacito")]), None, None, None).await {
    match res {
        Ok(recommendations) => {
            //do something with recommendations
        },
        Err(why) => {
            //do something with the <MusicError> struct
        }
    }

pub async fn recommendations<'_>(
    &'_ self,
    tracks: ProviderType
) -> HttpResult<MusicRecommendationsResponse, MusicError>

Get recommendations of songs with given query

You need a premium plan to use this endpoint

Example

if let Ok(res) = client.music.recommendations(
        ProviderType::YoutubeTitles(vec![String::from("despacito")])).await {
    match res {
        Ok(recommendations) => {
            //do something with recommendations
        },
        Err(why) => {
            //do something with the <MusicError> struct
        }
    }