Play Asset Delivery

Native API for Play Asset Delivery.

Summary

Enumerations

AssetPackDownloadStatus{
  ASSET_PACK_UNKNOWN = 0,
  ASSET_PACK_DOWNLOAD_PENDING = 1,
  ASSET_PACK_DOWNLOADING = 2,
  ASSET_PACK_TRANSFERRING = 3,
  ASSET_PACK_DOWNLOAD_COMPLETED = 4,
  ASSET_PACK_DOWNLOAD_FAILED = 5,
  ASSET_PACK_DOWNLOAD_CANCELED = 6,
  ASSET_PACK_WAITING_FOR_WIFI = 7,
  ASSET_PACK_NOT_INSTALLED = 8,
  ASSET_PACK_INFO_PENDING = 100,
  ASSET_PACK_INFO_FAILED = 101,
  ASSET_PACK_REMOVAL_PENDING = 110,
  ASSET_PACK_REMOVAL_FAILED = 111
}
enum
The status associated with asset pack download operations.
AssetPackErrorCode{
  ASSET_PACK_APP_UNAVAILABLE = -1,
  ASSET_PACK_UNAVAILABLE = -2,
  ASSET_PACK_INVALID_REQUEST = -3,
  ASSET_PACK_DOWNLOAD_NOT_FOUND = -4,
  ASSET_PACK_API_NOT_AVAILABLE = -5,
  ASSET_PACK_NETWORK_ERROR = -6,
  ASSET_PACK_ACCESS_DENIED = -7,
  ASSET_PACK_INSUFFICIENT_STORAGE = -10,
  ASSET_PACK_PLAY_STORE_NOT_FOUND = -11,
  ASSET_PACK_NETWORK_UNRESTRICTED = -12,
  ASSET_PACK_APP_NOT_OWNED = -13,
  ASSET_PACK_INTERNAL_ERROR = -100,
  ASSET_PACK_INITIALIZATION_NEEDED = -101,
  ASSET_PACK_INITIALIZATION_FAILED = -102
}
enum
An error code associated with asset pack operations.
AssetPackStorageMethod{
  ASSET_PACK_STORAGE_FILES = 0,
  ASSET_PACK_STORAGE_APK = 1,
  ASSET_PACK_STORAGE_UNKNOWN = 100,
  ASSET_PACK_STORAGE_NOT_INSTALLED = 101
}
enum
The method used to store an asset pack on the device.
ShowCellularDataConfirmationStatus{
  ASSET_PACK_CONFIRM_UNKNOWN = 0,
  ASSET_PACK_CONFIRM_PENDING = 1,
  ASSET_PACK_CONFIRM_USER_APPROVED = 2,
  ASSET_PACK_CONFIRM_USER_CANCELED = 3
}
enum
The status associated with a request to display a cellular data confirmation dialog.

Typedefs

AssetPackDownloadState typedef
struct AssetPackDownloadState_
An opaque struct used to access the state of an individual asset pack including download status and download size.
AssetPackLocation typedef
struct AssetPackLocation_
An opaque struct used to access how and where an asset pack's assets are stored on the device.

Functions

AssetPackDownloadState_destroy(AssetPackDownloadState *state)
void
Releases the specified AssetPackDownloadState and any references it holds.
AssetPackDownloadState_getBytesDownloaded(AssetPackDownloadState *state)
uint64_t
Gets the total number of bytes already downloaded for the asset pack associated with the specified AssetPackDownloadState.
AssetPackDownloadState_getStatus(AssetPackDownloadState *state)
Gets the AssetPackDownloadStatus for the specified AssetPackDownloadState.
AssetPackDownloadState_getTotalBytesToDownload(AssetPackDownloadState *state)
uint64_t
Gets the total size in bytes for the asset pack associated with the specified AssetPackDownloadState.
AssetPackLocation_destroy(AssetPackLocation *location)
void
Releases the specified AssetPackLocation and any references it holds.
AssetPackLocation_getAssetsPath(AssetPackLocation *location)
const char *
Gets a file path to the directory containing the asset pack's unpackaged assets.
AssetPackLocation_getStorageMethod(AssetPackLocation *location)
Gets the AssetPackStorageMethod for the specified asset pack.
AssetPackManager_cancelDownload(const char **asset_packs, size_t num_asset_packs)
Cancels downloading the specified asset packs.
AssetPackManager_destroy()
void
Frees up memory allocated for the Asset Pack API.
AssetPackManager_getAssetPackLocation(const char *name, AssetPackLocation **out_location)
Obtains an AssetPackLocation for the specified asset pack that can be used to query how and where the asset pack's assets are stored on the device.
AssetPackManager_getDownloadState(const char *name, AssetPackDownloadState **out_state)
Gets the download state of the specified asset pack.
AssetPackManager_getShowCellularDataConfirmationStatus(ShowCellularDataConfirmationStatus *out_status)
AssetPackManager_init(JavaVM *jvm, jobject android_context)
Initialize the Asset Pack API, making the other functions available to call.
AssetPackManager_onPause()
Should be called in ANativeActivity ANativeActivityCallbacks's onPause.
AssetPackManager_onResume()
Should be called in ANativeActivity ANativeActivityCallbacks's onResume.
AssetPackManager_requestDownload(const char **asset_packs, size_t num_asset_packs)
Asynchronously requests to start downloading the specified asset packs.
AssetPackManager_requestInfo(const char **asset_packs, size_t num_asset_packs)
Asynchronously requests download info about the specified asset packs.
AssetPackManager_requestRemoval(const char *name)
Asynchronously requests to delete the specified asset pack from internal storage.
AssetPackManager_showCellularDataConfirmation(jobject android_activity)
Shows a confirmation dialog to resume all asset pack downloads that are currently in the ASSET_PACK_WAITING_FOR_WIFI state.

Enumerations

AssetPackDownloadStatus

 AssetPackDownloadStatus

The status associated with asset pack download operations.

Properties
ASSET_PACK_DOWNLOADING

The asset pack download is in progress.

ASSET_PACK_DOWNLOAD_CANCELED

Asset pack download has been canceled.

ASSET_PACK_DOWNLOAD_COMPLETED

Download and transfer are complete; the assets are available to the app.

ASSET_PACK_DOWNLOAD_FAILED

An AssetPackManager_requestDownload() has failed.

AssetPackErrorCode will be the corresponding error, never ASSET_PACK_NO_ERROR. The bytes_downloaded and total_bytes_to_download fields are unreliable given this status.

ASSET_PACK_DOWNLOAD_PENDING

An AssetPackManager_requestDownload() async request is pending.

ASSET_PACK_INFO_FAILED

An AssetPackManager_requestInfo() async request has failed.

AssetPackErrorCode will be the corresponding error, never ASSET_PACK_NO_ERROR. The bytes_downloaded and total_bytes_to_download fields are unreliable given this status.

ASSET_PACK_INFO_PENDING

An AssetPackManager_requestInfo() async request started, but the result isn't known yet.

ASSET_PACK_NOT_INSTALLED

The asset pack isn't installed.

ASSET_PACK_REMOVAL_FAILED

An AssetPackManager_requestRemoval() async request has failed.

ASSET_PACK_REMOVAL_PENDING

An AssetPackManager_requestRemoval() async request started.

ASSET_PACK_TRANSFERRING

The asset pack is being transferred to the app.

ASSET_PACK_UNKNOWN

Nothing is known about the asset pack.

Call AssetPackManager_requestInfo() to check its size or AssetPackManager_requestDownload() start a download.

ASSET_PACK_WAITING_FOR_WIFI

The asset pack download is waiting for Wi-Fi to proceed.

Optionally, call AssetPackManager_showCellularDataConfirmation() to ask the user to confirm downloading over cellular data.

AssetPackErrorCode

 AssetPackErrorCode

An error code associated with asset pack operations.

Properties
ASSET_PACK_ACCESS_DENIED

Download not permitted under current device circumstances, e.g.

app in background or device not signed into a Google account.

ASSET_PACK_API_NOT_AVAILABLE

The Asset Pack API is unavailable.

ASSET_PACK_APP_NOT_OWNED

The app is not owned by any user on this device.

An app is "owned" if it has been acquired from Play.

ASSET_PACK_APP_UNAVAILABLE

The requesting app is unavailable.

This could be caused by multiple reasons:

  • The app isn't published in the Play Store.
  • The app version code isn't published in the Play Store. Note: an older version may exist.
  • The user doesn't own the app, i.e. hasn't installed it in the Play Store.
  • The user doesn't have access to the app, e.g. alpha track.

ASSET_PACK_DOWNLOAD_NOT_FOUND

The requested download isn't found.

ASSET_PACK_INITIALIZATION_FAILED

There was an error initializing the Asset Pack API.

ASSET_PACK_INITIALIZATION_NEEDED

The requested operation failed: need to call AssetPackManager_init() first.

ASSET_PACK_INSUFFICIENT_STORAGE

Asset packs download failed due to insufficient storage.

ASSET_PACK_INTERNAL_ERROR

Unknown error downloading asset pack.

ASSET_PACK_INVALID_REQUEST

The request is invalid.

ASSET_PACK_NETWORK_ERROR

Network error. Unable to obtain asset pack details.

ASSET_PACK_NETWORK_UNRESTRICTED

Returned if showCellularDataConfirmation is called but no asset packs are waiting for Wi-Fi.

ASSET_PACK_PLAY_STORE_NOT_FOUND

The Play Store app is either not installed or not the official version.

ASSET_PACK_UNAVAILABLE

The requested asset pack isn't available for this app version.

This can happen if the asset pack wasn't included in the Android App Bundle that was published to the Play Store.

AssetPackStorageMethod

 AssetPackStorageMethod

The method used to store an asset pack on the device.

Properties
ASSET_PACK_STORAGE_APK

The asset pack is installed as an APK containing packed asset files.

Assets can be accessed via AAssetManager.

ASSET_PACK_STORAGE_FILES

The asset pack is unpacked into a folder containing individual asset files.

Assets can be accessed via standard File APIs.

ASSET_PACK_STORAGE_NOT_INSTALLED

The asset pack is not installed.

ASSET_PACK_STORAGE_UNKNOWN

Nothing is known, perhaps due to an error.

ShowCellularDataConfirmationStatus

 ShowCellularDataConfirmationStatus

The status associated with a request to display a cellular data confirmation dialog.

Properties
ASSET_PACK_CONFIRM_PENDING

AssetPackManager_showCellularDataConfirmation() has been called, but the user hasn't made a choice.

ASSET_PACK_CONFIRM_UNKNOWN

AssetPackManager_showCellularDataConfirmation() has not been called.

ASSET_PACK_CONFIRM_USER_APPROVED

The user approved of downloading asset packs over cellular data.

ASSET_PACK_CONFIRM_USER_CANCELED

The user declined to download asset packs over cellular data.

Typedefs

AssetPackDownloadState

struct AssetPackDownloadState_ AssetPackDownloadState

An opaque struct used to access the state of an individual asset pack including download status and download size.

AssetPackLocation

struct AssetPackLocation_ AssetPackLocation

An opaque struct used to access how and where an asset pack's assets are stored on the device.

Functions

AssetPackDownloadState_destroy

void AssetPackDownloadState_destroy(
  AssetPackDownloadState *state
)

Releases the specified AssetPackDownloadState and any references it holds.

Details
Parameters
state
The state to free.

AssetPackDownloadState_getBytesDownloaded

uint64_t AssetPackDownloadState_getBytesDownloaded(
  AssetPackDownloadState *state
)

Gets the total number of bytes already downloaded for the asset pack associated with the specified AssetPackDownloadState.

Details
Parameters
state
The state for which to get bytes downloaded.
Returns
The total number of bytes already downloaded.

AssetPackDownloadState_getStatus

AssetPackDownloadStatus AssetPackDownloadState_getStatus(
  AssetPackDownloadState *state
)

Gets the AssetPackDownloadStatus for the specified AssetPackDownloadState.

Details
Parameters
state
The state for which to get status.
Returns
The AssetPackDownloadStatus.

AssetPackDownloadState_getTotalBytesToDownload

uint64_t AssetPackDownloadState_getTotalBytesToDownload(
  AssetPackDownloadState *state
)

Gets the total size in bytes for the asset pack associated with the specified AssetPackDownloadState.

Details
Parameters
state
The state for which to get total bytes to download.
Returns
The total size in bytes for the asset pack.

AssetPackLocation_destroy

void AssetPackLocation_destroy(
  AssetPackLocation *location
)

Releases the specified AssetPackLocation and any references it holds.

Details
Parameters
location
The location to free.

AssetPackLocation_getAssetsPath

const char * AssetPackLocation_getAssetsPath(
  AssetPackLocation *location
)

Gets a file path to the directory containing the asset pack's unpackaged assets.

The files found in this path should not be modified.

The string returned here is owned by the AssetPackManager implementation and will be freed by calling AssetPackLocation_destroy().

Details
Parameters
location
The location from which to obtain the assets path.
Returns
A file path to the directory containing the asset pack's unpackaged assets, provided that the asset pack's storage method is ASSET_PACK_STORAGE_FILES. Otherwise, returns a null pointer.

AssetPackLocation_getStorageMethod

AssetPackStorageMethod AssetPackLocation_getStorageMethod(
  AssetPackLocation *location
)

Gets the AssetPackStorageMethod for the specified asset pack.

Details
Parameters
location
The location for which to get a storage method.
Returns
The AssetPackStorageMethod for the specified asset pack.

AssetPackManager_cancelDownload

AssetPackErrorCode AssetPackManager_cancelDownload(
  const char **asset_packs,
  size_t num_asset_packs
)

Cancels downloading the specified asset packs.

Note: Only active downloads will be canceled. Asset packs with a status of ASSET_PACK_DOWNLOAD_COMPLETED or ASSET_PACK_NOT_INSTALLED are unaffected by this method.

Details
Parameters
asset_packs
An array of asset pack names.
num_asset_packs
The length of the asset_packs array.
Returns
Always ASSET_PACK_NO_ERROR, except in the case of an invalid call, e.g. ASSET_PACK_INITIALIZATION_NEEDED or ASSET_PACK_INVALID_REQUEST.

AssetPackManager_destroy

void AssetPackManager_destroy()

Frees up memory allocated for the Asset Pack API.

Does nothing if AssetPackManager_init() hasn't been called.

AssetPackManager_getAssetPackLocation

AssetPackErrorCode AssetPackManager_getAssetPackLocation(
  const char *name,
  AssetPackLocation **out_location
)

Obtains an AssetPackLocation for the specified asset pack that can be used to query how and where the asset pack's assets are stored on the device.

See also: AssetPackLocation_destroy

Details
Parameters
name
An asset pack name.
out_location
An out parameter for receiving the result.
Returns
An AssetPackErrorCode, which if not ASSET_PACK_NO_ERROR indicates that the out parameter shouldn't be used.

AssetPackManager_getDownloadState

AssetPackErrorCode AssetPackManager_getDownloadState(
  const char *name,
  AssetPackDownloadState **out_state
)

Gets the download state of the specified asset pack.

The last known error code is returned directly, whereas other state can be obtained via the AssetPackDownloadState out parameter by using functions such as AssetPackDownloadState_getStatus().

This function can be used to monitor progress or get the final result of a call to AssetPackManager_requestInfo(), AssetPackManager_requestDownload(), or AssetPackManager_requestRemoval(). This method does not make any JNI calls and can be called every frame. See also:AssetPackDownloadState_destroy

Details
Parameters
name
An asset pack name.
out_state
An out parameter for receiving the result.
Returns
ASSET_PACK_NO_ERROR if the request started successfully.

AssetPackManager_getShowCellularDataConfirmationStatus

AssetPackErrorCode AssetPackManager_getShowCellularDataConfirmationStatus(
  ShowCellularDataConfirmationStatus *out_status
)

Gets the status of AssetPackManager_showCellularDataConfirmation() requests.

This function does not make any JNI calls and can be called every frame.

Details
Parameters
out_status
An out parameter for receiving the result.
Returns
An AssetPackErrorCode, which if not ASSET_PACK_NO_ERROR indicates that the out parameter should not be used.

AssetPackManager_init

AssetPackErrorCode AssetPackManager_init(
  JavaVM *jvm,
  jobject android_context
)

Initialize the Asset Pack API, making the other functions available to call.

In case of failure the Asset Pack API is unavailable, and there will be an error in logcat. The most common reason for failure is that the PlayCore AAR is missing or some of its classes/methods weren't retained by ProGuard. See also:AssetPackManager_destroy

Details
Parameters
jvm
The app's single JavaVM, e.g. from ANativeActivity's "vm" field.
android_context
An Android Context, e.g. from ANativeActivity's "clazz" field.
Returns
ASSET_PACK_NO_ERROR if initialization succeeded.

AssetPackManager_onPause

AssetPackErrorCode AssetPackManager_onPause()

Should be called in ANativeActivity ANativeActivityCallbacks's onPause.

Internally, this deregisters a state update listener.

Details
Returns
ASSET_PACK_NO_ERROR if the call is successful.

AssetPackManager_onResume

AssetPackErrorCode AssetPackManager_onResume()

Should be called in ANativeActivity ANativeActivityCallbacks's onResume.

Internally, this registers a state update listener.

Details
Returns
ASSET_PACK_NO_ERROR if the call is successful.

AssetPackManager_requestDownload

AssetPackErrorCode AssetPackManager_requestDownload(
  const char **asset_packs,
  size_t num_asset_packs
)

Asynchronously requests to start downloading the specified asset packs.

Use AssetPackManager_getDownloadState() to monitor download progress.

Details
Parameters
asset_packs
An array of asset pack names.
num_asset_packs
The length of the asset_packs array.
Returns
ASSET_PACK_NO_ERROR if the request started successfully.

AssetPackManager_requestInfo

AssetPackErrorCode AssetPackManager_requestInfo(
  const char **asset_packs,
  size_t num_asset_packs
)

Asynchronously requests download info about the specified asset packs.

Use AssetPackManager_getDownloadState() to monitor progress and get the result.

Details
Parameters
asset_packs
An array of asset pack names.
num_asset_packs
The length of the asset_packs array.
Returns
ASSET_PACK_NO_ERROR if the request started successfully.

AssetPackManager_requestRemoval

AssetPackErrorCode AssetPackManager_requestRemoval(
  const char *name
)

Asynchronously requests to delete the specified asset pack from internal storage.

Use AssetPackManager_getDownloadState() to check deletion progress.

Use this function to delete asset packs instead of deleting the files manually. This ensures that the asset pack won't be re-downloaded during an app update.

If the asset pack is currently being downloaded or installed, this function won't cancel that operation.

Details
Parameters
name
An asset pack name.
Returns
ASSET_PACK_NO_ERROR if the request started successfully.

AssetPackManager_showCellularDataConfirmation

AssetPackErrorCode AssetPackManager_showCellularDataConfirmation(
  jobject android_activity
)

Shows a confirmation dialog to resume all asset pack downloads that are currently in the ASSET_PACK_WAITING_FOR_WIFI state.

If the user agrees to the dialog prompt, asset packs are downloaded over cellular data. The status of an asset pack is set to ASSET_PACK_WAITING_FOR_WIFI if the user is currently not on a Wi-Fi connection and the asset pack is large or the user has set their download preference in the Play Store to only download apps over Wi-Fi. By showing this dialog, your app can ask the user if they accept downloading the asset pack over cellular data instead of waiting for Wi-Fi.

Details
Parameters
android_activity
An Android Activity, e.g. from ANativeActivity's "clazz" field.
Returns
ASSET_PACK_NO_ERROR if the dialog is shown. Call AssetPackManager_getShowCellularDataConfirmationStatus() to get the dialog result.