#include <api.h>
Data Fields | |
int | api_version |
The version of the Spotify API your application is compiled with. Set to SPOTIFY_API_VERSION. | |
const char * | cache_location |
const char * | settings_location |
const void * | application_key |
Your application key. | |
size_t | application_key_size |
The size of the application key in bytes. | |
const char * | user_agent |
const sp_session_callbacks * | callbacks |
Delivery callbacks for session events, or NULL if you are not interested in any callbacks (not recommended!). | |
void * | userdata |
User supplied data for your application. | |
bool | compress_playlists |
bool | dont_save_metadata_for_playlists |
bool | initially_unload_playlists |
const char * | device_id |
const char * | proxy |
const char * | proxy_username |
const char * | proxy_password |
const char * | ca_certs_filename |
const char * | tracefile |
Session config
const char* sp_session_config::ca_certs_filename |
Path to a file containing the root ca certificates that the peer should be verified with. The file must be a concatenation of all certificates in PEM format. Provided with libspotify is a sample pem file in examples. It is recommended that the application export a similar file from the local certificate store.
const char* sp_session_config::cache_location |
The location where Spotify will write cache files. This cache include tracks, cached browse results and coverarts. Set to empty string ("") to disable cache
Compress local copy of playlists, reduces disk space usage
const char* sp_session_config::device_id |
Device ID for offline synchronization and logging purposes. The Device Id must be unique to the particular device instance, i.e. no two units must supply the same Device ID. The Device ID must not change between sessions or power cycles. Good examples is the device's MAC address or unique serial number.
Don't save metadata for local copies of playlists Reduces disk space usage at the expense of needing to request metadata from Spotify backend when loading list
Avoid loading playlists into RAM on startup. See sp_playlist_is_in_ram() for more details.
const char* sp_session_config::proxy |
Url to the proxy server that should be used. The format is protocol://<host>:port (where protocal is http/https/socks4/socks5)
const char* sp_session_config::proxy_password |
Password to authenticate with proxy server
const char* sp_session_config::proxy_username |
Username to authenticate with proxy server
const char* sp_session_config::settings_location |
The location where Spotify will write setting files and per-user cache items. This includes playlists, track metadata, etc. 'settings_location' may be the same path as 'cache_location'. 'settings_location' folder will not be created (unlike 'cache_location'), if you don't want to create the folder yourself, you can set 'settings_location' to 'cache_location'.
const char* sp_session_config::tracefile |
Path to API trace file
const char* sp_session_config::user_agent |
"User-Agent" for your application - max 255 characters long The User-Agent should be a relevant, customer facing identification of your application