download
Declaration
@Deprecated( "Use downloadByAsset instead. Site IDs and asset IDs are the preferred mechanisms for " + "identifying maps in NSDK. This function is deprecated and does not support maps created " + "from 360 camera captures." ) suspend fun download( payload: String, getTexture: Boolean, maxDownloadSizeKb: Int? = null, timeoutMillis: Long = TIMEOUT_MS ): AsyncResult<Array<MeshDownloaderData>, MeshDownloaderError>
Summary
Returns
An AsyncResult which will be either AsyncResult.Success containing the mesh data, AsyncResult.Error detailing the failure reason, or AsyncResult.Timeout indicating a timeout in the download process.
Parameters
| Name | Type | Summary |
|---|---|---|
| payload | String | The VPS anchor payload string for the desired location. |
| getTexture | Boolean | If true, the response will include the mesh textures. If false, image data and UVs will be empty, and a color field will be added to each vertex in the mesh. |
| maxDownloadSizeKb | Int? | (Optional) Sets a maximum size for the meshes to be downloaded, in kilobytes. Meshes above this size will not be downloaded. The default value, null, does not set a size limit. |
| timeoutMillis | Long | The maximum time in milliseconds to wait for the download to complete. |
DeprecatedAsynchronously downloads a mesh for a given location payload.This function suspends execution until the download operation is complete,
has failed, or has timed out.