getCapacity()

Description

Gets how many images are allowed to be captured into the image buffer.

Syntax

ImageViewerObject.image.getCapacity();

Return value

<int>

If it fails to get the capacity, it returns null.

Remarks

The default value of this property is 1023.

If you set capacity to be smaller than count, the extra images in buffer will be removed.

When the image buffer is full, that is to say, the return value of getCount() equals the return value of getCapacity(), the newly grabbed image will not be imported into the image viewer.

When an error occurs, check getErrorCode() or getErrorString() for error information.

Example

             var imageviewer = DCSObject.getImageViewer("ImageViewerContainer");   // Get a specified image viewer
             imageviewer.image.getCapacity();
      

See also

.getImageViewer()
.image.setCapacity()
.image.getCount()
.image.getIndex()

Is this page helpful?

Leave a Reply

Your email address will not be published.