LeechCraft  0.6.70-15082-g543737046d
Modular cross-platform feature rich live environment.
Media::IRecommendedArtists Class Referenceabstract

Interface for plugins supporting recommended artists. More...

#include "irecommendedartists.h"

Public Member Functions

virtual ~IRecommendedArtists ()
 
virtual QFuture< SimilarityQueryResult_tRequestRecommended (int count)=0
 Requests the recommended artists. More...
 

Detailed Description

Interface for plugins supporting recommended artists.

If a plugin supports fetching information about recommended artists, for example, based on user's musical taste, it should implement this interface.

See also
ISimilarArtists

Definition at line 27 of file irecommendedartists.h.

Constructor & Destructor Documentation

◆ ~IRecommendedArtists()

virtual Media::IRecommendedArtists::~IRecommendedArtists ( )
inlinevirtual

Definition at line 30 of file irecommendedartists.h.

Member Function Documentation

◆ RequestRecommended()

virtual QFuture<SimilarityQueryResult_t> Media::IRecommendedArtists::RequestRecommended ( int  count)
pure virtual

Requests the recommended artists.

This function initiates request for the list of recommended artists for our user and returns a handle through which the results of this search could be obtained. The handle owns itself and deletes itself after results are available — see its documentation for more details.

The results of the returned handle will typically have only SimilarityInfo::SimilarTo_ field set, while SimilarityInfo::Similarity_ field may be unset. Though if the latter is set it should be interpreted as some kind of "match percentage" displaying how interesting an artist can be to our user.

Also, IPendingSimilarArtists::GetSourceArtistName() can return an empty string in this case since it there is no source artist for which recommendations are fetched.

Parameters
[in]countThe number of recommended artists to fetch.

The documentation for this class was generated from the following file: