captureDocument()

Description

Captures a document from the camera to a specified image viewer.

Syntax

DCSObject.camera.captureDocument(string imageContainerId);

Parameters

<string> imageContainerId: The id of an image viewer container.

Return value

bool

true indicates success. false indicates failure.

Remarks

If the id of an image viewer doesn't exist, you will get an error "The object [object name] does not exist.".

When there is no document detected and the return value of getAllowCaptureUndetectedDocument() is false, no document will be imported into the image viewer.

When the image viewer is full, that is to say, count equals capacity, the newly acquired document will not be imported into the image viewer.

Example

function CaptureDocument() {
    if (DCSObject) {
      DCSObject.camera.selectCamera("Integrated Camera");
      DCSObject.camera.playVideo();
      DCSObject.camera.captureDocument("ImageViewerContainer"); //Captures a document to a specified image viewer.
    }
}

See Also

.camera.selectCamera()
.camera.playVideo()
.videoviewer.setAllowCaptureUndetectedDocument()

Is this page helpful?

Leave a Reply

Your email address will not be published.