Note: This function requires an API license.

Grabs an image from the live image stream and puts it in the license plate engine buffer. The image is scanned asynchroniously for a licenseplate. If one is found, a CarRLicensePlateEvent is fired.

If the CarR option is not available this function returns ‘not implemented’.


parameter type remarks
cameraid [UID] unique camera id.
serverid [UID] unique server id.


See chapter Results for result syntax and result codes.

error code description remarks
0 Ok Ok, no error
-1 Not implemented Function not implemented.
-2 No device No device found for the supplied cameraid
-21 Device not active The device is not active in the current profile and cannot produce results

See also

Event result values


  • 1.10.0 – added