CaptureVisionRouter Instantiate
Name | Description |
---|---|
static preLoadModule() |
Loads the specified module to speed up the initialization. |
static isModuleLoaded() |
Returns whether the specified module has been loaded. |
static createInstance() |
Initializes a new instance of the CaptureVisionRouter class. |
dispose() | Releases all resources used by the CaptureVisionRouter object. |
disposed | Returns whether the CaptureVisionRouter object has been disposed of. |
detectEnvironment
Detect the current device environment.
detectEnvironment(): Promise<any>
Return Value
Promise<any>
Code snippet
Dynamsoft.CVR.CaptureVisionRouter.detectEnvironment();
preLoadModule
Loads the specified module to speed up the initialization.
Syntax
preLoadModule(moduleName: string | Array<string>): void
Parameter
moduleNameIt
: It takes a string or an array of strings representing the module or modules to preload. Valid values for moduleName are ‘DBR’ (Dynamsoft Barcode Reader), ‘DLR’ (Dynamsoft Label Recognizer), ‘DDN’ (Dynamsoft Document Normalizer), and ‘DCP’ (Dynamsoft Code Parser).
Return value
None.
Code snippet
Dynamsoft.CVR.CaptureVisionRouter.preloadModule(["DBR"]);
isModuleLoaded
Returns whether the specified module has been loaded.
Syntax
isModuleLoaded(moduleName: string): boolean;
Parameter
moduleName
: It takes a string representing the module to preload. Valid values for moduleName are ‘DBR’ (Dynamsoft Barcode Reader), ‘DLR’ (Dynamsoft Label Recognizer), ‘DDN’ (Dynamsoft Document Normalizer), and ‘DCP’ (Dynamsoft Code Parser).
Return value
A boolean value that indicates whether the required module has been loaded.
Code snippet
if(Dynamsoft.CVR.CaptureVisionRouter.isModuleLoaded('dbr')){
// Use the router to perform a DBR job.
} else {
console.log("DBR module is not preloaded.");
}
createInstance
Initializes a new instance of the CaptureVisionRouter
class.
Syntax
createInstance(): Promise<CaptureVisionRouter>;
Parameter
None.
Return value
A promise that resolves with the initialized CaptureVisionRouter
object.
Code snippet
let router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
dispose
Releases all resources used by the CaptureVisionRouter
object.
Syntax
dispose(): Promise<void>;
Parameter
None.
Return value
Returns a promise that resolves when the resources have been successfully released.
Code snippet
let router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
// Use the router to perform a job.
// ...
// Release the resources after the job is finished.
router.dispose();
disposed
Returns whether the CaptureVisionRouter
object has been disposed of.
Syntax
disposed: boolean;
Parameter
None.
Return value
A boolean value that indicates whether the CaptureVisionRouter
object has been disposed of.
Code snippet
if(router.disposed){
console.log("The router has been disposed of.");
} else {
// Use the router to perform a job.
}