Documentation
Table of contents

Timeout

Parameter Timeout defines the maximum amount of time (in milliseconds) that should be spent processing each image or frame. It does not include the time taken to load/decode an image from disk into memory.

The timer starts when the library start processing the first task of the image. You may still receive processing results even if it times out:

  • If a part of the tasks are finished, the results of the finished tasks are output. You will receive an EC_TIMEOUT error code in your CapturedResult as well.
  • If all tasks are not finished:
    • If there exist results of the unfinished tasks, the existing results are output. You will receive an EC_TIMEOUT error code in your CapturedResult as well.
    • If none of the tasks has result, you still receive a CapturedResult with an empty array of CapturedResultItem and the error code EC_TIMEOUT.

Example

{
    "Timeout":10000
}

Parameter Summary

Timeout Parameter Summary
Type
int
Range
[0, 0x7fffffff]
Default Value
10000
Remarks
0: no limitation on the time cost.

This page is compatible for:

Is this page helpful?

YesYes NoNo

In this article: