libimobiledevice
1.1.5
|
Manage SpringBoard icons and retrieve icon images. More...
Typedefs | |
typedef int16_t | sbservices_error_t |
Represents an error code. | |
typedef sbservices_client_private * | sbservices_client_t |
The client handle. |
Functions | |
sbservices_error_t | sbservices_client_new (idevice_t device, lockdownd_service_descriptor_t service, sbservices_client_t *client) |
Connects to the springboardservices service on the specified device. | |
sbservices_error_t | sbservices_client_free (sbservices_client_t client) |
Disconnects an sbservices client from the device and frees up the sbservices client data. | |
sbservices_error_t | sbservices_get_icon_state (sbservices_client_t client, plist_t *state, const char *format_version) |
Gets the icon state of the connected device. | |
sbservices_error_t | sbservices_set_icon_state (sbservices_client_t client, plist_t newstate) |
Sets the icon state of the connected device. | |
sbservices_error_t | sbservices_get_icon_pngdata (sbservices_client_t client, const char *bundleId, char **pngdata, uint64_t *pngsize) |
Get the icon of the specified app as PNG data. | |
sbservices_error_t | sbservices_get_interface_orientation (sbservices_client_t client, sbservices_interface_orientation_t *interface_orientation) |
Gets the interface orientation of the device. | |
sbservices_error_t | sbservices_get_home_screen_wallpaper_pngdata (sbservices_client_t client, char **pngdata, uint64_t *pngsize) |
Get the home screen wallpaper as PNG data. |
Error Codes | |
#define | SBSERVICES_E_SUCCESS 0 |
#define | SBSERVICES_E_INVALID_ARG -1 |
#define | SBSERVICES_E_PLIST_ERROR -2 |
#define | SBSERVICES_E_CONN_FAILED -3 |
#define | SBSERVICES_E_UNKNOWN_ERROR -256 |
Manage SpringBoard icons and retrieve icon images.
The client handle.
typedef int16_t sbservices_error_t |
Represents an error code.
sbservices_error_t sbservices_client_free | ( | sbservices_client_t | client | ) |
Disconnects an sbservices client from the device and frees up the sbservices client data.
client | The sbservices client to disconnect and free. |
sbservices_error_t sbservices_client_new | ( | idevice_t | device, |
lockdownd_service_descriptor_t | service, | ||
sbservices_client_t * | client | ||
) |
Connects to the springboardservices service on the specified device.
device | The device to connect to. |
service | The service descriptor returned by lockdownd_start_service. |
client | Pointer that will point to a newly allocated sbservices_client_t upon successful return. |
sbservices_error_t sbservices_get_home_screen_wallpaper_pngdata | ( | sbservices_client_t | client, |
char ** | pngdata, | ||
uint64_t * | pngsize | ||
) |
Get the home screen wallpaper as PNG data.
client | The connected sbservices client to use. |
pngdata | Pointer that will point to a newly allocated buffer containing the PNG data upon successful return. It is up to the caller to free the memory. |
pngsize | Pointer to a uint64_t that will be set to the size of the buffer pngdata points to upon successful return. |
sbservices_error_t sbservices_get_icon_pngdata | ( | sbservices_client_t | client, |
const char * | bundleId, | ||
char ** | pngdata, | ||
uint64_t * | pngsize | ||
) |
Get the icon of the specified app as PNG data.
client | The connected sbservices client to use. |
bundleId | The bundle identifier of the app to retrieve the icon for. |
pngdata | Pointer that will point to a newly allocated buffer containing the PNG data upon successful return. It is up to the caller to free the memory. |
pngsize | Pointer to a uint64_t that will be set to the size of the buffer pngdata points to upon successful return. |
sbservices_error_t sbservices_get_icon_state | ( | sbservices_client_t | client, |
plist_t * | state, | ||
const char * | format_version | ||
) |
Gets the icon state of the connected device.
client | The connected sbservices client to use. |
state | Pointer that will point to a newly allocated plist containing the current icon state. It is up to the caller to free the memory. |
format_version | A string to be passed as formatVersion along with the request, or NULL if no formatVersion should be passed. This is only supported since iOS 4.0 so for older firmware versions this must be set to NULL. |
sbservices_error_t sbservices_get_interface_orientation | ( | sbservices_client_t | client, |
sbservices_interface_orientation_t * | interface_orientation | ||
) |
Gets the interface orientation of the device.
client | The connected sbservices client to use. |
interface_orientation | The interface orientation upon successful return. |
sbservices_error_t sbservices_set_icon_state | ( | sbservices_client_t | client, |
plist_t | newstate | ||
) |
Sets the icon state of the connected device.
client | The connected sbservices client to use. |
newstate | A plist containing the new iconstate. |