Artist browsing


Typedefs
typedef void	artistbrowse_complete_cb (sp_artistbrowse result, void userdata)
Functions
sp_artistbrowse *	sp_artistbrowse_create (sp_session session, sp_artist artist, artistbrowse_complete_cb callback, void userdata)
bool	sp_artistbrowse_is_loaded (sp_artistbrowse *arb)
sp_error	sp_artistbrowse_error (sp_artistbrowse *arb)
sp_artist *	sp_artistbrowse_artist (sp_artistbrowse *arb)
int	sp_artistbrowse_num_portraits (sp_artistbrowse *arb)
const byte *	sp_artistbrowse_portrait (sp_artistbrowse *arb, int index)
int	sp_artistbrowse_num_tracks (sp_artistbrowse *arb)
sp_track *	sp_artistbrowse_track (sp_artistbrowse *arb, int index)
int	sp_artistbrowse_num_albums (sp_artistbrowse *arb)
sp_album *	sp_artistbrowse_album (sp_artistbrowse *arb, int index)
int	sp_artistbrowse_num_similar_artists (sp_artistbrowse *arb)
sp_artist *	sp_artistbrowse_similar_artist (sp_artistbrowse *arb, int index)
const char *	sp_artistbrowse_biography (sp_artistbrowse *arb)
void	sp_artistbrowse_add_ref (sp_artistbrowse *arb)
void	sp_artistbrowse_release (sp_artistbrowse *arb)

Detailed Description

Artist browsing initiates the fetching of information for a certain artist.

Note:: There is currently no built-in functionality available for getting the albums belonging to an artist. For now, just iterate over all tracks and note the album to build a list of all albums. This feature will be added in a future version of the library.

Typedef Documentation

typedef void artistbrowse_complete_cb(sp_artistbrowse *result, void *userdata)

The type of a callback used in sp_artistbrowse_create()

When the callback is called, the metadata of all tracks belonging to it will have been loaded, so sp_track_is_loaded() will return non-zero. The same goes for the similar artist data.

Parameters:

`[in]`	result	The same pointer returned by sp_artistbrowse_create()
`[in]`	userdata	The opaque pointer given to sp_artistbrowse_create()

Function Documentation

void sp_artistbrowse_add_ref ( sp_artistbrowse * arb )

Increase the reference count of an artist browse result

Parameters:

[in] arb The artist browse result object

sp_album* sp_artistbrowse_album	(	sp_artistbrowse *	arb,
		int	index
	)

Given an artist browse object, return one of its albums

Parameters:

`[in]`	arb	Album browse object
`[in]`	index	The index for the album. Should be in the interval [0, sp_artistbrowse_num_albums() - 1]

Returns:: A album object, or NULL if the index is out of range.

See also:: Album subsystem

sp_artist* sp_artistbrowse_artist ( sp_artistbrowse * arb )

Given an artist browse object, return a pointer to its artist object

Parameters:

[in] arb Artist browse object

Returns:: Artist object

const char* sp_artistbrowse_biography ( sp_artistbrowse * arb )

Given an artist browse object, return the artists biography

Note:: This function must be called from the same thread that did sp_session_create()

Parameters:

[in] arb Artist browse object

Returns:: Biography string in UTF-8 format. Returned string is valid as long as the album object stays allocated and no longer than the next call to sp_session_process_events()

sp_artistbrowse* sp_artistbrowse_create	(	sp_session *	session,
		sp_artist *	artist,
		artistbrowse_complete_cb *	callback,
		void *	userdata
	)

Initiate a request for browsing an artist

The user is responsible for freeing the returned artist browse using sp_artistbrowse_release(). This can be done in the callback.

Parameters:

`[in]`	session	Session object
`[in]`	artist	Artist to be browsed. The artist metadata does not have to be loaded
`[in]`	callback	Callback to be invoked when browsing has been completed. Pass NULL if you are not interested in this event.
`[in]`	userdata	Userdata passed to callback.

Returns:: Artist browse object

See also:: artistbrowse_complete_cb

sp_error sp_artistbrowse_error ( sp_artistbrowse * arb )

Check if browsing returned an error code.

Parameters:

[in] arb Artist browse object

Returns:: Error code

bool sp_artistbrowse_is_loaded ( sp_artistbrowse * arb )

Check if an artist browse request is completed

Parameters:

[in] arb Artist browse object

Returns:: True if browsing is completed, false if not

int sp_artistbrowse_num_albums ( sp_artistbrowse * arb )

Given an artist browse object, return number of albums

Parameters:

[in] arb Artist browse object

Returns:: Number of albums for given artist

int sp_artistbrowse_num_portraits ( sp_artistbrowse * arb )

Given an artist browse object, return number of portraits available

Parameters:

[in] arb Artist browse object

Returns:: Number of portraits for given artist

int sp_artistbrowse_num_similar_artists ( sp_artistbrowse * arb )

Given an artist browse object, return number of similar artists

Parameters:

[in] arb Artist browse object

Returns:: Number of similar artists for given artist

int sp_artistbrowse_num_tracks ( sp_artistbrowse * arb )

Given an artist browse object, return number of tracks

Parameters:

[in] arb Artist browse object

Returns:: Number of tracks for given artist

const byte* sp_artistbrowse_portrait	(	sp_artistbrowse *	arb,
		int	index
	)

Return image ID representing a portrait of the artist

Parameters:

`[in]`	arb	Artist object
`[in]`	index	The index of the portrait. Should be in the interval [0, sp_artistbrowse_num_portraits() - 1]

Returns:: ID byte sequence that can be passed to sp_image_create()

See also:: sp_image_create

void sp_artistbrowse_release ( sp_artistbrowse * arb )

Decrease the reference count of an artist browse result

Parameters:

[in] arb The artist browse result object

sp_artist* sp_artistbrowse_similar_artist	(	sp_artistbrowse *	arb,
		int	index
	)

Given an artist browse object, return a similar artist by index

Parameters:

`[in]`	arb	Album browse object
`[in]`	index	The index for the artist. Should be in the interval [0, sp_artistbrowse_num_similar_artists() - 1]

Returns:: A pointer to an artist object.

See also:: Artist subsystem

sp_track* sp_artistbrowse_track	(	sp_artistbrowse *	arb,
		int	index
	)

Given an artist browse object, return one of its tracks

Parameters:

`[in]`	arb	Album browse object
`[in]`	index	The index for the track. Should be in the interval [0, sp_artistbrowse_num_tracks() - 1]

Returns:: A track object, or NULL if the index is out of range.

See also:: Track subsystem

Artist browsing

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation