CameraView
Create and Destroy Instances
| Name | Description |
|---|---|
static createInstance() |
Creates a CameraView instance. |
| dispose() | Releases all resources used by the CameraView instance. |
| disposed | A readonly boolean value indicating whether the CameraView instance has been disposed. |
| getUIElement() | Returns the HTML element that is used by the CameraView instance. |
| setUIElement() | Specifies an HTML element for the CameraView instance to use as its UI element. |
Drawing and UI
| Name | Description |
|---|---|
| createDrawingLayer() | Creates a DrawingLayer object and put it in an array of DrawingLayers. |
| getDrawingLayer() | Gets the DrawingLayer specified by its ID. |
| getAllDrawingLayers() | Returns an array of all DrawingLayer objects. |
| deleteUserDefinedDrawingLayer() | Deletes a DrawingLayer object specified by its ID. |
| clearUserDefinedDrawingLayers() | Removes all user-defined DrawingLayers. |
| setTipConfig() | Configures the tip feature. |
| getTipConfig() | Returns the configuration of the tip. |
| setTipVisible() | Sets whether to show the tip. |
| isTipVisible() | Returns whether the tip is visible. |
| updateTipMessage() | Updates the message shown in the tip. |
| getVisibleRegionOfVideo() | Returns a Region object which specifies which part of the original video is shown in the video element. |
| getVideoElement | Returns the video element used by the CameraView instance. |
| setScanRegionMaskStyle() | Sets the drawing style for the scan-region mask. |
| getScanRegionMaskStyle() | Returns the drawing style for the scan-region mask. |
| setScanRegionMaskVisible() | Sets whether to show the scan-region mask. |
| isScanRegionMaskVisible() | Returns whether the scan-region mask is visible. |
| setScanLaserVisible() | Sets whether to show the laser that indicates the scanning is going on. |
| isScanLaserVisible() | Returns whether the laser is visible. |
createInstance
Creates a CameraView instance.
dispose
Releases all resources used by the CameraView instance.
disposed
A readonly boolean value indicating whether the CameraView instance has been disposed.
getUIElement
Returns the HTML element that is used by the CameraView instance.
setUIElement
Specifies an HTML element for the CameraView instance to use as its UI element.
createDrawingLayer
Creates a DrawingLayer object and put it in an array of DrawingLayers
getDrawingLayer
Gets the DrawingLayer specified by its ID
getAllDrawingLayers
Returns an array of all DrawingLayer objects
deleteUserDefinedDrawingLayer
Deletes a DrawingLayer object specified by its ID
clearUserDefinedDrawingLayers
Removes all user-defined DrawingLayers
setTipConfig
Configures the tip feature
getTipConfig
Returns the configuration of the tip
setTipVisible
Sets whether to show the tip
isTipVisible
Returns whether the tip is visible
updateTipMessage
Updates the message shown in the tip
getVisibleRegionOfVideo
Returns a Region object which specifies which part of the original video is shown in the video element
getVideoElement
Returns the video element used by the CameraView instance
setScanRegionMaskStyle
Sets the drawing style for the scan-region mask
getScanRegionMaskStyle
Returns the drawing style for the scan-region mask
setScanRegionMaskVisible
Sets whether to show the scan-region mask
isScanRegionMaskVisible
Returns whether the scan-region mask is visible
setScanLaserVisible
Sets whether to show the laser that indicates the scanning is going on
isScanLaserVisible
Returns whether the laser is visible
Yes
No