scandit-sdk

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Scandit Barcode Scanner SDK for the Web</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base="."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="index.html" class="title">Scandit Barcode Scanner SDK for the Web</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="globals.html">Globals</a> </li> </ul> <h1> Scandit Barcode Scanner SDK for the Web</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Modules</h3> <ul class="tsd-index-list"> <li class="tsd-kind-module"><a href="modules/barcode.html" class="tsd-kind-icon">Barcode</a></li> <li class="tsd-kind-module"><a href="modules/browsercompatibility.html" class="tsd-kind-icon">Browser<wbr>Compatibility</a></li> <li class="tsd-kind-module"><a href="modules/browserhelper.html" class="tsd-kind-icon">Browser<wbr>Helper</a></li> <li class="tsd-kind-module"><a href="modules/camera.html" class="tsd-kind-icon">Camera</a></li> <li class="tsd-kind-module"><a href="modules/cameraaccess.html" class="tsd-kind-icon">Camera<wbr>Access</a></li> <li class="tsd-kind-module"><a href="modules/camerasettings.html" class="tsd-kind-icon">Camera<wbr>Settings</a></li> <li class="tsd-kind-module"><a href="modules/imagesettings.html" class="tsd-kind-icon">Image<wbr>Settings</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Classes</h3> <ul class="tsd-index-list"> <li class="tsd-kind-class"><a href="classes/barcodepicker.html" class="tsd-kind-icon">Barcode<wbr>Picker</a></li> <li class="tsd-kind-class"><a href="classes/parser.html" class="tsd-kind-icon">Parser</a></li> <li class="tsd-kind-class"><a href="classes/scanresult.html" class="tsd-kind-icon">Scan<wbr>Result</a></li> <li class="tsd-kind-class"><a href="classes/scansettings.html" class="tsd-kind-icon">Scan<wbr>Settings</a></li> <li class="tsd-kind-class"><a href="classes/scanner.html" class="tsd-kind-icon">Scanner</a></li> <li class="tsd-kind-class"><a href="classes/symbologysettings.html" class="tsd-kind-icon">Symbology<wbr>Settings</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface"><a href="interfaces/barcodeencodingrange.html" class="tsd-kind-icon">Barcode<wbr>Encoding<wbr>Range</a></li> <li class="tsd-kind-interface"><a href="interfaces/parserfield.html" class="tsd-kind-icon">Parser<wbr>Field</a></li> <li class="tsd-kind-interface"><a href="interfaces/parserresult.html" class="tsd-kind-icon">Parser<wbr>Result</a></li> <li class="tsd-kind-interface"><a href="interfaces/point.html" class="tsd-kind-icon">Point</a></li> <li class="tsd-kind-interface"><a href="interfaces/quadrilateral.html" class="tsd-kind-icon">Quadrilateral</a></li> <li class="tsd-kind-interface"><a href="interfaces/searcharea.html" class="tsd-kind-icon">Search<wbr>Area</a></li> </ul> </section> <section class="tsd-index-section tsd-is-not-exported"> <h3>Variables</h3> <ul class="tsd-index-list"> <li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#resizeobserver" class="tsd-kind-icon">Resize<wbr>Observer</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function"><a href="globals.html#configure" class="tsd-kind-icon">configure</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Variables</h2> <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported" > <a name="resizeobserver" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Resize<wbr>Observer</h3> <div class="tsd-signature tsd-kind-icon">Resize<wbr>Observer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ResizeObserver</span><span class="tsd-signature-symbol"> = // tslint:disable-next-line: no-any"ResizeObserver" in window ? /* istanbul ignore next */ (<any>window).ResizeObserver : ResizeObserverPolyfill</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/barcodePickerGui.ts:4</li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function" > <a name="configure" class="tsd-anchor"></a> <h3>configure</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">configure<span class="tsd-signature-symbol">(</span>licenseKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, __namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in index.ts:93</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Initialize and configure the Scandit Barcode Scanner SDK library. This function must be called as first thing before using any other function of the library.</p> </div> <p>Depending on parameters and device features, any of the following errors could be the rejected result of the returned promise:</p> <ul> <li><code>NoLicenseKeyError</code></li> <li><code>UnsupportedBrowserError</code></li> </ul> <p>Camera access requests and external Scandit Engine library loads are done lazily only when needed by a <a href="classes/barcodepicker.html">BarcodePicker</a> (or <a href="classes/scanner.html">Scanner</a>) object. To make the loading process faster when scanning is actually needed, it is recommended depending on the use case to create in advance a (hidden and paused) <a href="classes/barcodepicker.html">BarcodePicker</a> or <a href="classes/scanner.html">Scanner</a> object, to later simply show and unpause it when needed. You can also eagerly ask only for camera access permissions by calling the <a href="modules/cameraaccess.html#getcameras">CameraAccess.getCameras</a> function.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>licenseKey: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The Scandit license key to be used by the library.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> __namedParameters: <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> = {}</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>engine<wbr>Location<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <div class="tsd-signature-symbol">Default = "/"</div> The location of the folder containing the external scandit-engine-sdk.min.js and scandit-engine-sdk.wasm files (external Scandit Engine library). By default they are retrieved from the root of the web application. Can be a full URL to folder or an absolute folder path. </div> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <p>A promise resolving when the library has been configured.</p> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals current "> <a href="globals.html"><em>Globals</em></a> </li> <li class=" tsd-kind-module"> <a href="modules/barcode.html">Barcode</a> </li> <li class=" tsd-kind-module"> <a href="modules/browsercompatibility.html">Browser<wbr>Compatibility</a> </li> <li class=" tsd-kind-module"> <a href="modules/browserhelper.html">Browser<wbr>Helper</a> </li> <li class=" tsd-kind-module"> <a href="modules/camera.html">Camera</a> </li> <li class=" tsd-kind-module"> <a href="modules/cameraaccess.html">Camera<wbr>Access</a> </li> <li class=" tsd-kind-module"> <a href="modules/camerasettings.html">Camera<wbr>Settings</a> </li> <li class=" tsd-kind-module"> <a href="modules/imagesettings.html">Image<wbr>Settings</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class"> <a href="classes/barcodepicker.html" class="tsd-kind-icon">Barcode<wbr>Picker</a> </li> <li class=" tsd-kind-class"> <a href="classes/parser.html" class="tsd-kind-icon">Parser</a> </li> <li class=" tsd-kind-class"> <a href="classes/scanresult.html" class="tsd-kind-icon">Scan<wbr>Result</a> </li> <li class=" tsd-kind-class"> <a href="classes/scansettings.html" class="tsd-kind-icon">Scan<wbr>Settings</a> </li> <li class=" tsd-kind-class"> <a href="classes/scanner.html" class="tsd-kind-icon">Scanner</a> </li> <li class=" tsd-kind-class"> <a href="classes/symbologysettings.html" class="tsd-kind-icon">Symbology<wbr>Settings</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/barcodeencodingrange.html" class="tsd-kind-icon">Barcode<wbr>Encoding<wbr>Range</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/parserfield.html" class="tsd-kind-icon">Parser<wbr>Field</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/parserresult.html" class="tsd-kind-icon">Parser<wbr>Result</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/point.html" class="tsd-kind-icon">Point</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/quadrilateral.html" class="tsd-kind-icon">Quadrilateral</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/searcharea.html" class="tsd-kind-icon">Search<wbr>Area</a> </li> <li class=" tsd-kind-variable tsd-is-not-exported"> <a href="globals.html#resizeobserver" class="tsd-kind-icon">Resize<wbr>Observer</a> </li> <li class=" tsd-kind-function"> <a href="globals.html#configure" class="tsd-kind-icon">configure</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script> </body> </html>