Interface: RetrieveStage
Retrieve stages are part of a retrieval of a set of image ids. Each retrieve stage defines which imageIds to include, as well as how that set should be handled. An imageID can be retrieved multiple times, done in order, one after the other, so that it is first retrieved as a lossy/low quality image, followed by higher qualities. The actual retrieve options used are abstracted out by the retrieve type, a simple string that defines what type of retrieve values are used.
See Progressive Loading in the overall docs for information on retrieval stages.
Properties
decimate?
optionaldecimate:number
Alternately to the positions, choose imageId's by decimating at the given interval decimate interval/offset.
Defined in
packages/core/src/types/IRetrieveConfiguration.ts:31
id
id:
string
An id for the stage for use in the stage completion events
Defined in
packages/core/src/types/IRetrieveConfiguration.ts:20
nearbyFrames?
optionalnearbyFrames:NearbyFrames[]
A set of frames which are nearby to replicate this frame to This allows defining how replication within the volume occurs.
Defined in
packages/core/src/types/IRetrieveConfiguration.ts:66
offset?
optionaloffset:number
Use the given offset. For example, a decimate of 4 and offset of 1 will
choose from the set [0...12] the values 1,5,9
Defined in
packages/core/src/types/IRetrieveConfiguration.ts:36
positions?
optionalpositions:number[]
Set of positions in a list of imageID's to select for this stage. Negative values are relative to the end, positive to the beginning, and fractional values between -1 and 1 are relative to frame count
Defined in
packages/core/src/types/IRetrieveConfiguration.ts:26
priority?
optionalpriority:number
The queue priority to use
Defined in
packages/core/src/types/IRetrieveConfiguration.ts:61
requestType?
optionalrequestType:RequestType
The queue request type to use.
Defined in
packages/core/src/types/IRetrieveConfiguration.ts:57
retrieveType?
optionalretrieveType:string
Use a specified retrieve type to specify the type of retrieve this stage uses. There are four standard retrieve types, but others can be defined as required. The four standard ones are:
- singleFast - for a fast/low quality single image
- singleFinal - for the final quality single image
- multipleFast - for a fast/low quality image for multiples
- multipleFinal - for a final image for multiple images
The single/multiple split is done so that the single retrieve can be a streaming type retrieve, which doesn't work well for multiple images where an entire set of lower quality images is desireable before starting with the high quality set, but the streaming retrieve does work very well for single images.