libcoverart  1.0.0
caa_c.h File Reference
Include dependency graph for caa_c.h:

Go to the source code of this file.

Typedefs

typedef void * CaaCoverArt
 
typedef void * CaaImage
 
typedef void * CaaReleaseInfo
 
typedef void * CaaThumbnails
 
typedef void * CaaType
 
typedef void * CaaImageList
 
typedef void * CaaTypeList
 
typedef void * CaaImageData
 

Enumerations

enum  tImageSize { eSize_Full =0, eSize_250 =250, eSize_500 =500 }
 
enum  tCoverArtResult {
  eCoverArt_Success =0, eCoverArt_ConnectionError, eCoverArt_Timeout, eCoverArt_AuthenticationError,
  eCoverArt_FetchError, eCoverArt_RequestError, eCoverArt_ResourceNotFound
}
 

Functions

void caa_coverart_delete (CaaCoverArt CoverArt)
 Delete a CaaCoverArt object. More...
 
CaaCoverArt caa_coverart_clone (CaaCoverArt CoverArt)
 Clone a CaaCoverArt object. More...
 
int caa_coverart_get_lasthttpcode (CaaCoverArt CoverArt)
 
int caa_coverart_get_lasterrormessage (CaaCoverArt CoverArt, char *str, int len)
 
int caa_coverart_get_version (CaaCoverArt CoverArt, char *str, int len)
 
CaaCoverArt caa_coverart_new (const char *UserAgent)
 Create a new instance of CaaCoverArt. More...
 
void caa_coverart_set_proxyhost (CaaCoverArt CoverArt, const char *ProxyHost)
 Set the proxy server. More...
 
void caa_coverart_set_proxyport (CaaCoverArt CoverArt, int ProxyPort)
 Set the port to use on the proxy server. More...
 
void caa_coverart_set_proxyusername (CaaCoverArt CoverArt, const char *ProxyUserName)
 Set the username to use to authenticate to the proxy server. More...
 
void caa_coverart_set_proxypassword (CaaCoverArt CoverArt, const char *ProxyPassword)
 Set the password to use to authenticate to the proxy server. More...
 
CaaImageData caa_coverart_fetch_front (CaaCoverArt CoverArt, const char *ReleaseID)
 Request the front image for a release. More...
 
CaaImageData caa_coverart_fetch_back (CaaCoverArt CoverArt, const char *ReleaseID)
 Request the back image for a release. More...
 
CaaImageData caa_coverart_fetch_image (CaaCoverArt CoverArt, const char *ReleaseID, const char *ImageID, tImageSize ImageSize)
 Request a specific image for a release. More...
 
CaaReleaseInfo caa_coverart_releaseinfo (CaaCoverArt CoverArt, const char *ReleaseID)
 Request all information about a release. More...
 
tCoverArtResult caa_coverart_get_lastresult (CaaCoverArt CoverArt)
 
void caa_image_delete (CaaImage Image)
 Delete a CaaImage object. More...
 
CaaImage caa_image_clone (CaaImage Image)
 Clone a CaaImage object. More...
 
int caa_image_get_approved (CaaImage Image)
 
int caa_image_get_back (CaaImage Image)
 
int caa_image_get_comment (CaaImage Image, char *str, int len)
 
int caa_image_get_edit (CaaImage Image)
 
int caa_image_get_front (CaaImage Image)
 
int caa_image_get_id (CaaImage Image, char *str, int len)
 
int caa_image_get_image (CaaImage Image, char *str, int len)
 
CaaThumbnails caa_image_get_thumbnails (CaaImage Image)
 
CaaTypeList caa_image_get_typelist (CaaImage Image)
 
void caa_imagedata_delete (CaaImageData ImageData)
 Delete a CaaImageData object. More...
 
CaaImageData caa_imagedata_clone (CaaImageData ImageData)
 Clone a CaaImageData object. More...
 
int caa_imagedata_size (CaaImageData ImageData)
 Return the number of bytes in a CaaImageData object. More...
 
unsigned char * caa_imagedata_data (CaaImageData ImageData)
 Return the data in a CaaImageData object. More...
 
void caa_releaseinfo_delete (CaaReleaseInfo ReleaseInfo)
 Delete a CaaReleaseInfo object. More...
 
CaaReleaseInfo caa_releaseinfo_clone (CaaReleaseInfo ReleaseInfo)
 Clone a CaaReleaseInfo object. More...
 
int caa_releaseinfo_get_release (CaaReleaseInfo ReleaseInfo, char *str, int len)
 
CaaImageList caa_releaseinfo_get_imagelist (CaaReleaseInfo ReleaseInfo)
 
void caa_thumbnails_delete (CaaThumbnails Thumbnails)
 Delete a CaaThumbnails object. More...
 
CaaThumbnails caa_thumbnails_clone (CaaThumbnails Thumbnails)
 Clone a CaaThumbnails object. More...
 
int caa_thumbnails_get_large (CaaThumbnails Thumbnails, char *str, int len)
 
int caa_thumbnails_get_small (CaaThumbnails Thumbnails, char *str, int len)
 
void caa_type_delete (CaaType Type)
 Delete a CaaType object. More...
 
CaaType caa_type_clone (CaaType Type)
 Clone a CaaType object. More...
 
int caa_type_get_type (CaaType Type, char *str, int len)
 
void caa_image_list_delete (CaaImageList List)
 Delete a CaaImageList. More...
 
int caa_image_list_size (CaaImageList List)
 Return the number of entries in a CaaImageList. More...
 
CaaImage caa_image_list_item (CaaImageList List, int Item)
 Returns an entry from a CaaImageList. More...
 
int caa_image_list_get_count (CaaImageList List)
 Return the count of entries in an CaaImageList. More...
 
int caa_image_list_get_offset (CaaImageList List)
 Return the offset of entries in an CaaImageList. More...
 
CaaImageList caa_image_list_clone (CaaImageList ImageList)
 Clone an CaaImageList object. More...
 
void caa_type_list_delete (CaaTypeList List)
 Delete a CaaTypeList. More...
 
int caa_type_list_size (CaaTypeList List)
 Return the number of entries in a CaaTypeList. More...
 
CaaType caa_type_list_item (CaaTypeList List, int Item)
 Returns an entry from a CaaTypeList. More...
 
int caa_type_list_get_count (CaaTypeList List)
 Return the count of entries in an CaaTypeList. More...
 
int caa_type_list_get_offset (CaaTypeList List)
 Return the offset of entries in an CaaTypeList. More...
 
CaaTypeList caa_type_list_clone (CaaTypeList TypeList)
 Clone an CaaTypeList object. More...
 

Typedef Documentation

typedef void* CaaCoverArt
typedef void* CaaImage
typedef void* CaaImageData
typedef void* CaaImageList
typedef void* CaaReleaseInfo
typedef void* CaaThumbnails
typedef void* CaaType
typedef void* CaaTypeList

Enumeration Type Documentation

See also
CoverArtArchive::CCoverArt::tCoverArtResult
Enumerator
eCoverArt_Success 
eCoverArt_ConnectionError 
eCoverArt_Timeout 
eCoverArt_AuthenticationError 
eCoverArt_FetchError 
eCoverArt_RequestError 
eCoverArt_ResourceNotFound 
enum tImageSize
Enumerator
eSize_Full 
eSize_250 
eSize_500 

Function Documentation

CaaCoverArt caa_coverart_clone ( CaaCoverArt  CoverArt)
Parameters
CoverArtObject to clone
Returns
Cloned object. This object must be deleted once finished with.
void caa_coverart_delete ( CaaCoverArt  CoverArt)
Parameters
CoverArtObject to delete
CaaImageData caa_coverart_fetch_back ( CaaCoverArt  CoverArt,
const char *  ReleaseID 
)
See also
CoverArtArchive::CCoverArt::FetchBack
Parameters
CoverArtCaaCoverArt object
ReleaseIDThe release ID
Returns
The downloaded image. This object must be deleted once finished with.
CaaImageData caa_coverart_fetch_front ( CaaCoverArt  CoverArt,
const char *  ReleaseID 
)
See also
CoverArtArchive::CCoverArt::FetchFront
Parameters
CoverArtCaaCoverArt object
ReleaseIDThe release ID
Returns
The downloaded image. This object must be deleted once finished with.
CaaImageData caa_coverart_fetch_image ( CaaCoverArt  CoverArt,
const char *  ReleaseID,
const char *  ImageID,
tImageSize  ImageSize 
)
See also
CoverArtArchive::CCoverArt::FetchImage
Parameters
CoverArtCaaCoverArt object
ReleaseIDThe release ID
ImageIDThe image ID
ImageSizeThe size of image to retrieve
Returns
The downloaded image. This object must be deleted once finished with.
int caa_coverart_get_lasterrormessage ( CaaCoverArt  CoverArt,
char *  str,
int  len 
)
See also
CoverArtArchive::CCoverArt::LastErrorMessage
Parameters
CoverArtCaaCoverArt object
strReturned string
lenNumber of characters available in return string
Returns
The number of characters in the string to copy (not including terminating NULL)
int caa_coverart_get_lasthttpcode ( CaaCoverArt  CoverArt)
See also
CoverArtArchive::CCoverArt::LastHTTPCode
Parameters
CoverArtCaaCoverArt object
Returns
Returned value
tCoverArtResult caa_coverart_get_lastresult ( CaaCoverArt  CoverArt)
See also
CoverArtArchive::CCoverArt::LastResult
Parameters
CoverArtCaaCoverArt object
Returns
Last CoverArt result code
int caa_coverart_get_version ( CaaCoverArt  CoverArt,
char *  str,
int  len 
)
See also
CoverArtArchive::CCoverArt::Version
Parameters
CoverArtCaaCoverArt object
strReturned string
lenNumber of characters available in return string
Returns
The number of characters in the string to copy (not including terminating NULL)
CaaCoverArt caa_coverart_new ( const char *  UserAgent)
See also
CoverArtArchive::CCoverArt::CCoverArt
Parameters
UserAgentUser agent to be passed to submissions
Returns
The newly created CaaCoverArt object. This object must be deleted once finished with.
CaaReleaseInfo caa_coverart_releaseinfo ( CaaCoverArt  CoverArt,
const char *  ReleaseID 
)
See also
CoverArtArchive::CCoverArt::ReleaseInfo
Parameters
CoverArtCaaCoverArt object
ReleaseIDThe release ID
Returns
Release information. This object must be deleted once finished with.
void caa_coverart_set_proxyhost ( CaaCoverArt  CoverArt,
const char *  ProxyHost 
)
See also
CoverArtArchive::CCoverArt::SetProxyHost
Parameters
CoverArtCaaCoverArt object
ProxyHostProxy server to use
void caa_coverart_set_proxypassword ( CaaCoverArt  CoverArt,
const char *  ProxyPassword 
)
See also
CoverArtArchive::CCoverArt::SetProxyPassword
Parameters
CoverArtCaaCoverArt object
ProxyPasswordPassword to use
void caa_coverart_set_proxyport ( CaaCoverArt  CoverArt,
int  ProxyPort 
)
See also
CoverArtArchive::CCoverArt::SetProxyPort
Parameters
CoverArtCaaCoverArt object
ProxyPortPort to use on proxy server
void caa_coverart_set_proxyusername ( CaaCoverArt  CoverArt,
const char *  ProxyUserName 
)
See also
CoverArtArchive::CCoverArt::SetProxyUserName
Parameters
CoverArtCaaCoverArt object
ProxyUserNameUser name to use
CaaImage caa_image_clone ( CaaImage  Image)
Parameters
ImageObject to clone
Returns
Cloned object. This object must be deleted once finished with.
void caa_image_delete ( CaaImage  Image)
Parameters
ImageObject to delete
int caa_image_get_approved ( CaaImage  Image)
See also
CoverArtArchive::CImage::Approved
Parameters
ImageCaaImage object
Returns
Returned value
int caa_image_get_back ( CaaImage  Image)
See also
CoverArtArchive::CImage::Back
Parameters
ImageCaaImage object
Returns
Returned value
int caa_image_get_comment ( CaaImage  Image,
char *  str,
int  len 
)
See also
CoverArtArchive::CImage::Comment
Parameters
ImageCaaImage object
strReturned string
lenNumber of characters available in return string
Returns
The number of characters in the string to copy (not including terminating NULL)
int caa_image_get_edit ( CaaImage  Image)
See also
CoverArtArchive::CImage::Edit
Parameters
ImageCaaImage object
Returns
Returned value
int caa_image_get_front ( CaaImage  Image)
See also
CoverArtArchive::CImage::Front
Parameters
ImageCaaImage object
Returns
Returned value
int caa_image_get_id ( CaaImage  Image,
char *  str,
int  len 
)
See also
CoverArtArchive::CImage::ID
Parameters
ImageCaaImage object
strReturned string
lenNumber of characters available in return string
Returns
The number of characters in the string to copy (not including terminating NULL)
int caa_image_get_image ( CaaImage  Image,
char *  str,
int  len 
)
See also
CoverArtArchive::CImage::Image
Parameters
ImageCaaImage object
strReturned string
lenNumber of characters available in return string
Returns
The number of characters in the string to copy (not including terminating NULL)
CaaThumbnails caa_image_get_thumbnails ( CaaImage  Image)
See also
CoverArtArchive::CImage::Thumbnails
Parameters
ImageCaaImage object
Returns
CaaThumbnails object
CaaTypeList caa_image_get_typelist ( CaaImage  Image)
See also
CoverArtArchive::CImage::TypeList
Parameters
ImageCaaImage object
Returns
CaaTypeList object
CaaImageList caa_image_list_clone ( CaaImageList  ImageList)
Parameters
ImageListObject to clone
Returns
Cloned list. This list must be deleted once finished with.
void caa_image_list_delete ( CaaImageList  List)
Parameters
ListList to delete
int caa_image_list_get_count ( CaaImageList  List)
Parameters
ListList to use
int caa_image_list_get_offset ( CaaImageList  List)
Parameters
ListList to use
CaaImage caa_image_list_item ( CaaImageList  List,
int  Item 
)
Parameters
ListList to use
ItemItem number to return
Returns
A CaaImage object.
int caa_image_list_size ( CaaImageList  List)
Parameters
ListList to use
CaaImageData caa_imagedata_clone ( CaaImageData  ImageData)
Parameters
ImageDataObject to clone
Returns
Cloned object. This object must be deleted once finished with.
unsigned char* caa_imagedata_data ( CaaImageData  ImageData)
Parameters
ImageDataCaaImageData object
Returns
The data in the object. This data must not be deleted.
void caa_imagedata_delete ( CaaImageData  ImageData)
Parameters
ImageDataObject to delete
int caa_imagedata_size ( CaaImageData  ImageData)
Parameters
ImageDataCaaImageData object
Returns
The number of bytes in the object
CaaReleaseInfo caa_releaseinfo_clone ( CaaReleaseInfo  ReleaseInfo)
Parameters
ReleaseInfoObject to clone
Returns
Cloned object. This object must be deleted once finished with.
void caa_releaseinfo_delete ( CaaReleaseInfo  ReleaseInfo)
Parameters
ReleaseInfoObject to delete
CaaImageList caa_releaseinfo_get_imagelist ( CaaReleaseInfo  ReleaseInfo)
See also
CoverArtArchive::CReleaseInfo::ImageList
Parameters
ReleaseInfoCaaReleaseInfo object
Returns
CaaImageList object
int caa_releaseinfo_get_release ( CaaReleaseInfo  ReleaseInfo,
char *  str,
int  len 
)
See also
CoverArtArchive::CReleaseInfo::Release
Parameters
ReleaseInfoCaaReleaseInfo object
strReturned string
lenNumber of characters available in return string
Returns
The number of characters in the string to copy (not including terminating NULL)
CaaThumbnails caa_thumbnails_clone ( CaaThumbnails  Thumbnails)
Parameters
ThumbnailsObject to clone
Returns
Cloned object. This object must be deleted once finished with.
void caa_thumbnails_delete ( CaaThumbnails  Thumbnails)
Parameters
ThumbnailsObject to delete
int caa_thumbnails_get_large ( CaaThumbnails  Thumbnails,
char *  str,
int  len 
)
See also
CoverArtArchive::CThumbnails::Large
Parameters
ThumbnailsCaaThumbnails object
strReturned string
lenNumber of characters available in return string
Returns
The number of characters in the string to copy (not including terminating NULL)
int caa_thumbnails_get_small ( CaaThumbnails  Thumbnails,
char *  str,
int  len 
)
See also
CoverArtArchive::CThumbnails::Small
Parameters
ThumbnailsCaaThumbnails object
strReturned string
lenNumber of characters available in return string
Returns
The number of characters in the string to copy (not including terminating NULL)
CaaType caa_type_clone ( CaaType  Type)
Parameters
TypeObject to clone
Returns
Cloned object. This object must be deleted once finished with.
void caa_type_delete ( CaaType  Type)
Parameters
TypeObject to delete
int caa_type_get_type ( CaaType  Type,
char *  str,
int  len 
)
See also
CoverArtArchive::CType::Type
Parameters
TypeCaaType object
strReturned string
lenNumber of characters available in return string
Returns
The number of characters in the string to copy (not including terminating NULL)
CaaTypeList caa_type_list_clone ( CaaTypeList  TypeList)
Parameters
TypeListObject to clone
Returns
Cloned list. This list must be deleted once finished with.
void caa_type_list_delete ( CaaTypeList  List)
Parameters
ListList to delete
int caa_type_list_get_count ( CaaTypeList  List)
Parameters
ListList to use
int caa_type_list_get_offset ( CaaTypeList  List)
Parameters
ListList to use
CaaType caa_type_list_item ( CaaTypeList  List,
int  Item 
)
Parameters
ListList to use
ItemItem number to return
Returns
A CaaType object.
int caa_type_list_size ( CaaTypeList  List)
Parameters
ListList to use