libimobiledevice/sbservices.h File Reference
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, uint16_t port, 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_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 |
Detailed Description
Manage SpringBoard icons and retrieve icon images.
Typedef Documentation
Represents an error code.
Function Documentation
Disconnects an sbservices client from the device and frees up the sbservices client data.
- Parameters:
-
| client | The sbservices client to disconnect and free. |
- Returns:
- SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client is NULL, or an SBSERVICES_E_* error code otherwise.
Connects to the springboardservices service on the specified device.
- Parameters:
-
| device | The device to connect to. - Parameters:
-
| port | Destination port (usually given by lockdownd_start_service). - Parameters:
-
| client | Pointer that will point to a newly allocated sbservices_client_t upon successful return. |
- Returns:
- SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client is NULL, or an SBSERVICES_E_* error code otherwise.
|
|
Get the home screen wallpaper as PNG data.
- Parameters:
-
| client | The connected sbservices client to use. - Parameters:
-
| 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. - Parameters:
-
| pngsize | Pointer to a uint64_t that will be set to the size of the buffer pngdata points to upon successful return. |
- Returns:
- SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client or pngdata are invalid, or an SBSERVICES_E_* error code otherwise.
|
|
Get the icon of the specified app as PNG data.
- Parameters:
-
| client | The connected sbservices client to use. - Parameters:
-
| bundleId | The bundle identifier of the app to retrieve the icon for. - Parameters:
-
| 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. - Parameters:
-
| pngsize | Pointer to a uint64_t that will be set to the size of the buffer pngdata points to upon successful return. |
- Returns:
- SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client, bundleId, or pngdata are invalid, or an SBSERVICES_E_* error code otherwise.
|
|
|
Gets the icon state of the connected device.
- Parameters:
-
| client | The connected sbservices client to use. - Parameters:
-
| 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. - Parameters:
-
| 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. |
- Returns:
- SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client or state is invalid, or an SBSERVICES_E_* error code otherwise.
|
|
Sets the icon state of the connected device.
- Parameters:
-
| client | The connected sbservices client to use. - Parameters:
-
| newstate | A plist containing the new iconstate. |
- Returns:
- SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client or newstate is NULL, or an SBSERVICES_E_* error code otherwise.
|