SDK Open Developer Reference
SDK Open business methods are called through Command WS. The request envelope is always request_id, method, params, and client. Except for system.* and auth.create_session, business methods require a valid session and matching capability on the current Command WS connection.
Command Method Catalog
| Module | Methods |
|---|---|
| system | system.ping, system.info, system.capabilities |
| auth | auth.create_session, auth.get_context, auth.refresh_session, auth.activate_offline, auth.destroy_session |
| device | device.list, device.get, device.open, device.close |
| capture | capture.take, capture.get, capture.set_turn_detect |
| video | video.start, video.stop, video.set_format, video.set_profile |
| image | image.process, image.process_page, image.apply_color_mode |
| image enhance | image.enhance_capabilities, image.enhance, image.enhance_get, image.enhance_cancel, image.enhance_workflow_list, image.enhance_workflow_get, image.enhance_workflow_save, image.enhance_workflow_delete |
| OCR/recognition | ocr.recognize, ocr.get, ocr.cancel, ocr.extract_text, recognition.barcode_detect |
| file | file.convert |
| SANE | sane.status, sane.list, sane.watch_start, sane.watch_stop, sane.open, sane.close, sane.get_options, sane.set_options, sane.profile_list, sane.profile_save, sane.profile_apply, sane.profile_delete, sane.scan, sane.scan_get, sane.scan_cancel |