Typedefs | |
typedef void | image_loaded_cb (sp_image *image, void *userdata) |
Enumerations | |
enum | sp_imageformat { SP_IMAGE_FORMAT_UNKNOWN = -1, SP_IMAGE_FORMAT_JPEG = 0 } |
Functions | |
sp_image * | sp_image_create (sp_session *session, const byte image_id[20]) |
sp_image * | sp_image_create_from_link (sp_session *session, sp_link *l) |
sp_error | sp_image_add_load_callback (sp_image *image, image_loaded_cb *callback, void *userdata) |
sp_error | sp_image_remove_load_callback (sp_image *image, image_loaded_cb *callback, void *userdata) |
bool | sp_image_is_loaded (sp_image *image) |
sp_error | sp_image_error (sp_image *image) |
sp_imageformat | sp_image_format (sp_image *image) |
const void * | sp_image_data (sp_image *image, size_t *data_size) |
const byte * | sp_image_image_id (sp_image *image) |
sp_error | sp_image_add_ref (sp_image *image) |
sp_error | sp_image_release (sp_image *image) |
typedef void image_loaded_cb(sp_image *image, void *userdata) |
The type of a callback used to notify the application that an image is done loading.
enum sp_imageformat |
sp_error sp_image_add_load_callback | ( | sp_image * | image, | |
image_loaded_cb * | callback, | |||
void * | userdata | |||
) |
Add a callback that will be invoked when the image is loaded
If an image is loaded, and loading fails, the image will behave like an empty image.
[in] | image | Image object |
[in] | callback | Callback that will be called when image has been fetched. |
[in] | userdata | Opaque pointer passed to callback |
Increase the reference count of an image
[in] | image | The image object |
sp_image* sp_image_create | ( | sp_session * | session, | |
const byte | image_id[20] | |||
) |
Create an image object
[in] | session | Session |
[in] | image_id | Spotify image ID |
sp_image* sp_image_create_from_link | ( | sp_session * | session, | |
sp_link * | l | |||
) |
Create an image object from a link
[in] | session | Session |
[in] | l | Spotify link object. This must be of SP_LINKTYPE_IMAGE type |
const void* sp_image_data | ( | sp_image * | image, | |
size_t * | data_size | |||
) |
Get image data
[in] | image | Image object |
[out] | data_size | Size of raw image data |
Check if image retrieval returned an error code.
[in] | image | Image object |
sp_imageformat sp_image_format | ( | sp_image * | image | ) |
Get image format
[in] | image | Image object |
const byte* sp_image_image_id | ( | sp_image * | image | ) |
Get image ID
[in] | image | Image object |
bool sp_image_is_loaded | ( | sp_image * | image | ) |
Check if an image is loaded. Before the image is loaded, the rest of the methods will behave as if the image is empty.
[in] | image | Image object |
Decrease the reference count of an image
[in] | image | The image object |
sp_error sp_image_remove_load_callback | ( | sp_image * | image, | |
image_loaded_cb * | callback, | |||
void * | userdata | |||
) |
Remove an image load callback previously added with sp_image_add_load_callback()
[in] | image | Image object |
[in] | callback | Callback that will not be called when image has been fetched. |
[in] | userdata | Opaque pointer passed to callback |