All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
true for the
cropMethod parameter of the ICAO.check() method.stripDataUrl() function to Common.js to strip the data URL
identifier from a given string.DATAURL_JSON constant to Common.jsDevice.stopFeed() would stop a live feed
but the the service would continue streaming a loading image to the client if
it was still connected. The connection will now be closed instead.Device.streamUrl() will now automatically include a
cache breaking parameter: x so that subsequent invocations will result in
a new URL. This makes it easier to re-use an existing img element with the
same device and plugin combination.summary property of errors would be set to
Unexpected error instead of the actual error from the server.cropEnlargement parameter to the ICAO.check() method.Minimal ICAO example to allow testing with local files.ImageSource class that prevented dataurl types from
loading.clear button to Topaz demo.info method to the TopazSigGem class.rotate=0 parameter to capture and stream endpoints
by default. Therefore you should no longer set a rotate parameter for
capture and stream related methods unless the user has explicitly requested
rotation (ensuring their site-specific configuration, if any, is honored.)CaptureBridge.config() method. The defaultPluginRotation config entry will
list any rotation configurations.info method to the CanonCamera class.config method to the CaptureBridge class.CaptureResponseFormat type to note support for
png file types.escape and style properties to Verifone Text objects and a text
formatting example.Verifone.readMagstripe() are now in the correct order.Verifone.readMagstripe() was previously returning a base64 encoded NULL
byte (e.g. the string "AA==") for empty tracks, it is now returning null
for empty tracks.ICAO.check(), IFace.icao(), and IFace.match() will now throw an
exception if the response from the server is an error (e.g. if an IFace
license is not present.)Verifone.info() method and device info SDK examples.Device.clear()BASE_URL will first be checked
in a capturebridge:url meta tag, followed by window.CAPTURE_BRIDGE_URL,
and finally window.location.origin. When running the SDK in Node.js a
CAPTURE_BRIDGE_URL environment variable will be checked.Verifone.cancel() method to gracefully cancel long-running
operations such as the Verifone.displayObjects() and
Verifone.readMagstripe() requests.Verifone.reset() method to reset a device's state.Verifone.displayObjects() and Verifone.readMagstripe() now accept an
additional requestOpt argument containing an optional
AbortSignal and
readyTimeout parameter. Verifone.cancel() should be typically be used
instead of the AbortSignal as it will block until the device is freed and
available for another request.Plugin.shutdown() now accepts a timeout argument.Plugin.hasMethod() method for checking if a plugin has a specific RPC
method.Verifone.readMagstripe() method for reading magstripe from Verifone.TopazSigGem.displayObjects() previously accepted a boolean parameter for
it's second argument, which if true, would clear the screen before displaying
the objects. This method now accepts a sceneOpt object which contains
clear and backlight boolean. A deprecation flag has been added to preserve
the original function signature such that, if a boolean is provided, the method
will fallback to the previous behavior of clearing the screen and emit a console
warning. If an object is provided it will utilize any clear or backlight
boolean properties.// Previous behavior, still works but will emit deprecation warning
await tablet.displayObjects([
new Text('My hovercraft is full of eels.', 100, 400),
], false)
// New behavior
const result = await tablet.displayObjects([
new Text('My hovercraft is full of eels.', 100, 400),
], {clear: false, backlight: true})
BASE_URL will default to window.location.origin if available, else
https://local.capturebridge.net:9001) will be used.background parameter to ICAO.check() and IFace.icao() that will
fill in any part of the cropped image that falls outside the source image.DeviceForms and ControlProperty classes for configuring forms for
Verifone.Verifone.renderForm()ICAO.check()ICAO class will default to use the capture_verify_iface plugin if no
plugin is provided to the constructor.ICAO.check() if a face
was found.format parameter to DEFAULT_CAPTURE_OPT (defaults to null which will
use the plugin's default image format.)CaptureResponseFormat type definition to documentation.null would be sent for some URL parameters.