onDemandResources.setDownloadPriority()

Type Function
Return value none
Revision Release 2025.3721
Keywords on-demand resources, onDemandResources, setDownloadPriority
See also onDemandResources.request()
onDemandResources.getDownloadPriority()
onDemandResources.*

Overview

If you want to download several resources (tags) at once, you can use this function to set the priority for which should be downloaded first.

Syntax

onDemandResources.setDownloadPriority( tag, priority )
tag (required)

String. Tag for which to set the download priority.

priority (required)

Number or String. If passing a number, use a value in the range of 0.0 to 1.0 where 1.0 is the highest download priority (following "urgent"). Passing the string "urgent" indicates the maximum download priority.

Gotchas

Using a priority of "urgent" may cause a drop in frame rate. Generally, you should not set an urgent download priority during time-critical points.