apple.vision.protocol

Interface VNRequestProgressProviding

All Known Implementing Classes:

VNRecognizeTextRequest

public interface VNRequestProgressProviding

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	VNRequestProgressProviding.Block_progressHandler_ret
static interface	VNRequestProgressProviding.Block_setProgressHandler

Method Summary

Modifier and Type	Method and Description
boolean	indeterminate() If a request cannot determine its progress in fractions completed, this property will be set.
VNRequestProgressProviding.Block_progressHandler_ret	progressHandler() Requests that support the VNRequestProgressProviding protocol would periodically call the progressHandler to report progress on longer running tasks.
void	setProgressHandler(VNRequestProgressProviding.Block_setProgressHandler value) Requests that support the VNRequestProgressProviding protocol would periodically call the progressHandler to report progress on longer running tasks.

Method Detail

indeterminate

boolean indeterminate()

If a request cannot determine its progress in fractions completed, this property will be set.

If this is set, it doesn't mean that the request will run forever just that the nature of the request is not broken down into identifiable fractions on which progress can be reported in increments. The progressHandler will nonetheless be called at suitable intervals.

progressHandler

VNRequestProgressProviding.Block_progressHandler_ret progressHandler()

Requests that support the VNRequestProgressProviding protocol would periodically call the progressHandler to report progress on longer running tasks.

The progessHandler is optional allowing clients of the request to report progress to the user and/or display or process partial results when they become available. Note that the progressHandler can be called on a different dispatch queue than what the request was initiated from.

setProgressHandler

void setProgressHandler(VNRequestProgressProviding.Block_setProgressHandler value)

Requests that support the VNRequestProgressProviding protocol would periodically call the progressHandler to report progress on longer running tasks.

The progessHandler is optional allowing clients of the request to report progress to the user and/or display or process partial results when they become available. Note that the progressHandler can be called on a different dispatch queue than what the request was initiated from.