Skip to main content
API Reference com.nianticspatial.nsdk.vps VPSCoverageSession

getHintImage

Asynchronously downloads a hint image from a given URL. This function encapsulates the entire request-and-poll loop, suspending execution until the download is complete, has failed, or has timed out.

Declaration

suspend fun getHintImage( hintUrl: String, timeoutMillis: Long = TIMEOUT_MS ): AsyncResult<ByteArray, VpsCoverageError>

Summary

Asynchronously downloads a hint image from a given URL. This function encapsulates the entire request-and-poll loop, suspending execution until the download is complete, has failed, or has timed out.

Returns

An [AsyncResult] which will be either [AsyncResult.Success] containing the image [ByteArray], [AsyncResult.Error] detailing the failure reason, or [AsyncResult.Timeout] indicating a timeout in the process.


ON THIS PAGE