Typedefs | |
typedef void | albumbrowse_complete_cb (sp_albumbrowse *result, void *userdata) |
Functions | |
sp_albumbrowse * | sp_albumbrowse_create (sp_session *session, sp_album *album, albumbrowse_complete_cb *callback, void *userdata) |
bool | sp_albumbrowse_is_loaded (sp_albumbrowse *alb) |
sp_error | sp_albumbrowse_error (sp_albumbrowse *alb) |
sp_album * | sp_albumbrowse_album (sp_albumbrowse *alb) |
sp_artist * | sp_albumbrowse_artist (sp_albumbrowse *alb) |
int | sp_albumbrowse_num_copyrights (sp_albumbrowse *alb) |
const char * | sp_albumbrowse_copyright (sp_albumbrowse *alb, int index) |
int | sp_albumbrowse_num_tracks (sp_albumbrowse *alb) |
sp_track * | sp_albumbrowse_track (sp_albumbrowse *alb, int index) |
const char * | sp_albumbrowse_review (sp_albumbrowse *alb) |
void | sp_albumbrowse_add_ref (sp_albumbrowse *alb) |
void | sp_albumbrowse_release (sp_albumbrowse *alb) |
typedef void albumbrowse_complete_cb(sp_albumbrowse *result, void *userdata) |
The type of a callback used in sp_albumbrowse_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 sp_artist of the album will also have been fully loaded.
[in] | result | The same pointer returned by sp_albumbrowse_create() |
[in] | userdata | The opaque pointer given to sp_albumbrowse_create() |
void sp_albumbrowse_add_ref | ( | sp_albumbrowse * | alb | ) |
Increase the reference count of an album browse result
[in] | alb | The album browse result object |
sp_album* sp_albumbrowse_album | ( | sp_albumbrowse * | alb | ) |
Given an album browse object, return the pointer to its album object
[in] | alb | Album browse object |
sp_artist* sp_albumbrowse_artist | ( | sp_albumbrowse * | alb | ) |
Given an album browse object, return the pointer to its artist object
[in] | alb | Album browse object |
const char* sp_albumbrowse_copyright | ( | sp_albumbrowse * | alb, | |
int | index | |||
) |
Given an album browse object, return one of its copyright strings
[in] | alb | Album browse object |
[in] | index | The index for the copyright string. Should be in the interval [0, sp_albumbrowse_num_copyrights() - 1] |
sp_albumbrowse* sp_albumbrowse_create | ( | sp_session * | session, | |
sp_album * | album, | |||
albumbrowse_complete_cb * | callback, | |||
void * | userdata | |||
) |
Initiate a request for browsing an album
The user is responsible for freeing the returned album browse using sp_albumbrowse_release(). This can be done in the callback.
Here is a snippet from browse.c:
g_albumbrowse = sp_albumbrowse_create(session, album, &album_complete, NULL); sp_link_release(link); if (!g_albumbrowse) { fprintf(stderr, "failed to start album browse\n"); g_exit_code = 10; return; }
[in] | session | Session object |
[in] | album | Album to be browsed. The album 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. |
sp_error sp_albumbrowse_error | ( | sp_albumbrowse * | alb | ) |
Check if browsing returned an error code.
[in] | alb | Album browse object |
bool sp_albumbrowse_is_loaded | ( | sp_albumbrowse * | alb | ) |
Check if an album browse request is completed
[in] | alb | Album browse object |
int sp_albumbrowse_num_copyrights | ( | sp_albumbrowse * | alb | ) |
Given an album browse object, return number of copyright strings
[in] | alb | Album browse object |
int sp_albumbrowse_num_tracks | ( | sp_albumbrowse * | alb | ) |
Given an album browse object, return number of tracks
[in] | alb | Album browse object |
void sp_albumbrowse_release | ( | sp_albumbrowse * | alb | ) |
Decrease the reference count of an album browse result
[in] | alb | The album browse result object |
const char* sp_albumbrowse_review | ( | sp_albumbrowse * | alb | ) |
Given an album browse object, return its review
[in] | alb | Album browse object |
sp_track* sp_albumbrowse_track | ( | sp_albumbrowse * | alb, | |
int | index | |||
) |
Given an album browse object, return a pointer to one of its tracks
[in] | alb | Album browse object |
[in] | index | The index for the track. Should be in the interval [0, sp_albumbrowse_num_tracks() - 1] |