chrome.documentScan

Beschrijving

Gebruik de chrome.documentScan API om afbeeldingen van aangesloten documentscanners te detecteren en op te halen.

Machtigingen

documentScan

Beschikbaarheid

Chrome 44+ Alleen ChromeOS

Document Scan API

De Document Scan API is ontworpen om apps en extensies de mogelijkheid te geven de inhoud van papieren documenten te bekijken op een aangesloten documentscanner.

Typen

CancelScanResponse

Chroom 125+

Eigenschappen

  • functie

    snaar

    Biedt dezelfde taakafhandeling die werd doorgegeven aan cancelScan() .

  • resultaat

    OperationResult

    Het resultaat van de geannuleerde scan van de backend. Als het resultaat OperationResult.SUCCESS of OperationResult.CANCELLED is, is de scan geannuleerd en is de scanner klaar om een nieuwe scan te starten. Als het resultaat OperationResult.DEVICE_BUSY is, is de scanner nog bezig met het verwerken van de aangevraagde annulering; de aanroeper dient even te wachten en de aanvraag opnieuw te proberen. Andere resultaatwaarden geven een permanente fout aan die niet opnieuw mag worden geprobeerd.

CloseScannerResponse

Chroom 125+

Eigenschappen

  • resultaat

    OperationResult

    Het resultaat van het sluiten van de scanner. Zelfs als deze waarde niet SUCCESS is, is de handle ongeldig en mag deze niet voor verdere bewerkingen worden gebruikt.

  • scannerHandle

    snaar

    Dezelfde scanner-handle als werd doorgegeven aan closeScanner .

Configurability

Chroom 125+

Hoe een optie gewijzigd kan worden.

Enum

"NIET_CONFIGUREERBAAR"
Deze optie is alleen-lezen.

"SOFTWARE_CONFIGUREERBAAR"
Deze optie kan in de software worden ingesteld.

"HARDWARE_CONFIGUREERBAAR"
De optie kan door de gebruiker worden ingesteld door op een knop op de scanner te drukken of te klikken.

ConnectionType

Chroom 125+

Geeft aan hoe de scanner is verbonden met de computer.

Enum

"NIET GESPECIFICEERD"

"USB"

"NETWERK"

ConstraintType

Chroom 125+

Het gegevenstype van de beperking die wordt weergegeven door een OptionConstraint .

Enum

"INT_BEREIK"
De beperking voor een reeks OptionType.INT -waarden. De eigenschappen min , max en quant van OptionConstraint zijn long en de list is niet ingesteld.

"VAST_BEREIK"
De beperking voor een reeks OptionType.FIXED -waarden. De eigenschappen min , max en quant van OptionConstraint zijn double en de list is niet ingesteld.

"INT_LIJST"
De beperking voor een specifieke lijst met OptionType.INT -waarden. De eigenschap OptionConstraint.list bevat long waarden en de andere eigenschappen worden niet ingesteld.

"VASTE_LIJST"
De beperking voor een specifieke lijst met OptionType.FIXED -waarden. De eigenschap OptionConstraint.list bevat double waarden en de andere eigenschappen worden niet ingesteld.

"STRING_LIJST"
De beperking voor een specifieke lijst met OptionType.STRING -waarden. De eigenschap OptionConstraint.list bevat DOMString -waarden en de andere eigenschappen worden niet ingesteld.

DeviceFilter

Chroom 125+

Eigenschappen

  • lokaal

    boolean optioneel

    Retourneer alleen scanners die rechtstreeks op de computer zijn aangesloten.

  • zeker

    boolean optioneel

    Retourneer alleen scanners die gebruik maken van een beveiligd transport, zoals USB of TLS.

GetOptionGroupsResponse

Chroom 125+

Eigenschappen

  • groepen

    OptionGroup [] optioneel

    Als result SUCCESS is, wordt een lijst met optiegroepen weergegeven in de volgorde waarin deze door het scannerstuurprogramma zijn opgegeven.

  • resultaat

    OperationResult

    Het resultaat van het ophalen van de optiegroepen. Als de waarde hiervan SUCCESS is, wordt de eigenschap groups ingevuld.

  • scannerHandle

    snaar

    Dezelfde scanner-handle als werd doorgegeven aan getOptionGroups .

GetScannerListResponse

Chroom 125+

Eigenschappen

  • resultaat

    OperationResult

    Het resultaat van de opsomming. Let op: er kunnen gedeeltelijke resultaten worden geretourneerd, zelfs als dit een fout aangeeft.

  • scanners

    ScannerInfo []

    Een mogelijk lege lijst met scanners die overeenkomen met het opgegeven DeviceFilter .

OpenScannerResponse

Chroom 125+

Eigenschappen

  • opties

    object optioneel

    Als result SUCCESS is, wordt er een sleutel-waardetoewijzing verstrekt waarbij de sleutel een apparaatspecifieke optie is en de waarde een exemplaar van ScannerOption .

  • resultaat

    OperationResult

    Het resultaat van het openen van de scanner. Als de waarde hiervan SUCCESS is, worden de eigenschappen scannerHandle en options ingevuld.

  • scannerHandle

    string optioneel

    Als result SUCCESS is, wordt er een handvat naar de scanner gestuurd dat voor verdere handelingen kan worden gebruikt.

  • scanner-ID

    snaar

    De scanner-ID die aan openScanner() wordt doorgegeven.

OperationResult

Chroom 125+

Een opsomming die het resultaat van elke bewerking aangeeft.

Enum

"ONBEKEND"
Er is een onbekende of algemene fout opgetreden.

"SUCCES"
De operatie is geslaagd.

"NIET ONDERSTEUND"
Deze bewerking wordt niet ondersteund.

"GEANNULEERD"
De operatie is geannuleerd.

"APPARAAT_BEZET"
Het apparaat is bezet.

"ONGELDIG"
De gegevens of een argument dat aan de methode is doorgegeven, zijn ongeldig.

"VERKEERD_TYPE"
De opgegeven waarde is van het verkeerde gegevenstype voor de onderliggende optie.

"EOF"
Er zijn geen verdere gegevens beschikbaar.

"ADF_VASTGELOPEN"
De documentinvoer is vastgelopen.

"ADF_LEEG"
De documentinvoer is leeg.

"DEKSEL_OPEN"
Het deksel van de laadbak is open.

"IO_FOUT"
Er is een fout opgetreden tijdens de communicatie met het apparaat.

"TOEGANG_GEWEIGERD"
Het apparaat vereist authenticatie.

"GEEN_GEHEUGEN"
Er is niet voldoende geheugen beschikbaar op de Chromebook om de bewerking te voltooien.

"ONBEREIKBAAR"
Het apparaat is niet bereikbaar.

"VERMIST"
Het apparaat is losgekoppeld.

"INTERNE_FOUT"
Er is een fout opgetreden op een andere locatie dan in de aanroepende toepassing.

OptionConstraint

Chroom 125+

Eigenschappen

  • lijst

    string[] | number[] optioneel

  • maximaal

    nummer optioneel

  • mijn

    nummer optioneel

  • kwantiteit

    nummer optioneel

OptionGroup

Chroom 125+

Eigenschappen

  • leden

    snaar[]

    Een reeks optienamen in de door de driver opgegeven volgorde.

  • titel

    snaar

    Geeft een afdrukbare titel, bijvoorbeeld 'Geometrieopties'.

OptionSetting

Chroom 125+

Eigenschappen

  • naam

    snaar

    Geeft de naam aan van de optie die moet worden ingesteld.

  • type

    OptieType

    Geeft het gegevenstype van de optie aan. Het opgevraagde gegevenstype moet overeenkomen met het werkelijke gegevenstype van de onderliggende optie.

  • waarde

    string | getal | booleaans | getal[] optioneel

    Geeft de in te stellen waarde aan. Laat deze waarde uitgeschakeld om automatische instelling aan te vragen voor opties waarvoor autoSettable is ingeschakeld. Het opgegeven gegevenstype voor value moet overeenkomen met type .

OptionType

Chroom 125+

Het gegevenstype van een optie.

Enum

"ONBEKEND"
Het gegevenstype van de optie is onbekend. De value eigenschap wordt ongedaan gemaakt.

"BOOL"
De value eigenschap zal true false zijn.

"INT"
Een signed 32-bits integer. De value eigenschap is long of long[], afhankelijk van of de optie meer dan één waarde aanneemt.

"VAST"
Een double in het bereik -32768-32767,9999 met een resolutie van 1/65535. De value eigenschap is double of double[], afhankelijk van of de optie meer dan één waarde aanneemt. Double-waarden die niet exact kunnen worden weergegeven, worden afgerond op het beschikbare bereik en de beschikbare precisie.

"SNAAR"
Een reeks bytes, behalve NUL ('\0'). De value eigenschap is een DOMString.

"KNOP"
Een optie van dit type heeft geen waarde. In plaats daarvan veroorzaakt het instellen van een optie van dit type een optie-specifiek neveneffect in het scannerstuurprogramma. Een optie met een knoptype kan bijvoorbeeld door een scannerstuurprogramma worden gebruikt om standaardwaarden te selecteren of om een automatische documentinvoer te laten doorgaan naar het volgende vel papier.

"GROEP"
Groeperingsoptie. Geen waarde. Deze is opgenomen voor compatibiliteit, maar wordt normaal gesproken niet geretourneerd in ScannerOption -waarden. Gebruik getOptionGroups() om de lijst met groepen met hun lidopties op te halen.

OptionUnit

Chroom 125+

Geeft het gegevenstype voor ScannerOption.unit aan.

Enum

"EENHEIDLOOS"
De waarde is een getal zonder eenheid. Het kan bijvoorbeeld een drempelwaarde zijn.

"PIXEL"
De waarde is een aantal pixels, bijvoorbeeld scanafmetingen.

"BEETJE"
De waarde is het aantal bits, bijvoorbeeld kleurdiepte.

"MM"
De waarde wordt gemeten in millimeters, bijvoorbeeld scanafmetingen.

"DPI"
De waarde wordt gemeten in dots per inch, bijvoorbeeld resolutie.

"PERCENT"
De waarde is een percentage, bijvoorbeeld helderheid.

"MICROSECONDE"
De waarde wordt gemeten in microseconden, bijvoorbeeld belichtingstijd.

ReadScanDataResponse

Chroom 125+

Eigenschappen

  • gegevens

    ArrayBuffer optioneel

    Als result SUCCESS is, bevat het het volgende deel van de gescande beeldgegevens. Als result EOF is, bevat het het laatste deel van de gescande beeldgegevens.

  • geschatte voltooiing

    nummer optioneel

    Als result SUCCESS is, is dit een schatting van hoeveel van de totale scangegevens tot nu toe zijn afgeleverd, in het bereik van 0 tot 100.

  • functie

    snaar

    Geeft de taakhandle door die aan readScanData() wordt doorgegeven.

  • resultaat

    OperationResult

    Het resultaat van het lezen van de gegevens. Als de waarde SUCCESS is, bevat de data het volgende (mogelijk nullengte) stuk beeldgegevens dat klaar is om te lezen. Als de waarde EOF is, bevat de data het laatste stuk beeldgegevens.

ScannerInfo

Chroom 125+

Eigenschappen

  • verbindingstype

    Verbindingstype

    Geeft aan hoe de scanner is verbonden met de computer.

  • apparaatUuid

    snaar

    Voor het vergelijken met andere ScannerInfo vermeldingen die naar hetzelfde fysieke apparaat verwijzen.

  • beeldformaten

    snaar[]

    Een reeks MIME-typen die kunnen worden aangevraagd voor geretourneerde scans.

  • fabrikant

    snaar

    De fabrikant van de scanner.

  • model

    snaar

    Het scannermodel, indien beschikbaar, of een algemene beschrijving.

  • naam

    snaar

    Een voor mensen leesbare naam voor de scanner die in de gebruikersinterface wordt weergegeven.

  • protocolType

    snaar

    Een voor mensen leesbare beschrijving van het protocol of de driver die wordt gebruikt om toegang te krijgen tot de scanner, zoals Mopria, WSD of Epson Ds. Dit is vooral handig om een gebruiker te laten kiezen tussen protocollen als een apparaat meerdere protocollen ondersteunt.

  • scanner-ID

    snaar

    De ID van een specifieke scanner.

  • zeker

    Booleaanse

    Als dit het geval is, kan het transport van de scannerverbinding niet worden onderschept door een passieve listener, zoals TLS of USB.

ScannerOption

Chroom 125+

Eigenschappen

  • configureerbaarheid

    Configureerbaarheid

    Geeft aan of en hoe de optie kan worden gewijzigd.

  • beperking

    OptionConstraint optioneel

    Definieert OptionConstraint voor de huidige scanneroptie.

  • beschrijving

    snaar

    Een langere beschrijving van de optie.

  • isActief

    Booleaanse

    Geeft aan dat de optie actief is en kan worden ingesteld of opgehaald. Indien false, wordt de value eigenschap niet ingesteld.

  • isGeavanceerd

    Booleaanse

    Geeft aan dat deze optie standaard niet in de gebruikersinterface moet worden weergegeven.

  • isAutoSettable

    Booleaanse

    Kan automatisch worden ingesteld door het scannerstuurprogramma.

  • isDetecteerbaar

    Booleaanse

    Geeft aan dat deze optie door de software kan worden gedetecteerd.

  • isEmuleerd

    Booleaanse

    Geëmuleerd door de scannerdriver indien waar.

  • naam

    snaar

    De optienaam bestaat uit kleine ASCII-letters, cijfers en streepjes. Diakritische tekens zijn niet toegestaan.

  • titel

    snaar

    Een afdrukbare titel van één regel.

  • type

    OptieType

    Het gegevenstype in de eigenschap value ' dat nodig is om deze optie in te stellen.

  • eenheid

    Optie-eenheid

    De meeteenheid voor deze optie.

  • waarde

    string | getal | booleaans | getal[] optioneel

    De huidige waarde van de optie, indien van toepassing. Let op: het gegevenstype van deze eigenschap moet overeenkomen met het gegevenstype dat is opgegeven in type .

ScanOptions

Eigenschappen

  • maxAfbeeldingen

    nummer optioneel

    Het toegestane aantal gescande afbeeldingen. De standaardwaarde is 1.

  • mimeTypes

    string[] optioneel

    De MIME-typen die door de aanroeper worden geaccepteerd.

ScanResults

Eigenschappen

  • dataUrls

    snaar[]

    Een reeks URL's met gegevensafbeeldingen in een vorm die kan worden doorgegeven als de "src"-waarde aan een afbeeldingstag.

  • mimeType

    snaar

    Het MIME-type van de dataUrls .

SetOptionResult

Chroom 125+

Eigenschappen

  • naam

    snaar

    Geeft de naam van de ingestelde optie aan.

  • resultaat

    OperationResult

    Geeft het resultaat van het instellen van de optie aan.

SetOptionsResponse

Chroom 125+

Eigenschappen

  • opties

    object optioneel

    Een bijgewerkte sleutel-waardetoewijzing van optienamen naar ScannerOption -waarden met de nieuwe configuratie, nadat geprobeerd is alle opgegeven opties in te stellen. Deze heeft dezelfde structuur als de eigenschap options in OpenScannerResponse .

    Deze eigenschap blijft ingesteld, zelfs als sommige opties niet succesvol zijn ingesteld. De eigenschap wordt echter ongedaan gemaakt als het ophalen van de bijgewerkte configuratie mislukt (bijvoorbeeld als de scanner tijdens het scannen wordt losgekoppeld).

  • resultaten

    SetOptionResult []

    Een reeks resultaten, één voor elke doorgegeven OptionSetting .

  • scannerHandle

    snaar

    Geeft de scannerhandle door die aan setOptions() wordt doorgegeven.

StartScanOptions

Chroom 125+

Eigenschappen

  • formaat

    snaar

    Geeft het MIME-type op waarin gescande gegevens moeten worden geretourneerd.

  • maximale leesgrootte

    nummer optioneel

    Als een waarde ongelijk aan nul wordt opgegeven, wordt het maximale aantal gescande bytes dat in één readScanData respons wordt geretourneerd, beperkt tot die waarde. De kleinst toegestane waarde is 32768 (32 KB). Als deze eigenschap niet wordt opgegeven, kan de grootte van een geretourneerd fragment even groot zijn als de volledige gescande afbeelding.

StartScanResponse

Chroom 125+

Eigenschappen

  • functie

    string optioneel

    Als result SUCCESS is, wordt er een handvat verstrekt waarmee scangegevens kunnen worden gelezen of de taak kan worden geannuleerd.

  • resultaat

    OperationResult

    Het resultaat van het starten van een scan. Als de waarde hiervan SUCCESS is, wordt de job ingevuld.

  • scannerHandle

    snaar

    Biedt dezelfde scanner-handle die werd doorgegeven aan startScan() .

Methoden

cancelScan()

BelofteChrome 125+
chrome.documentScan.cancelScan(
  job: string,
  callback?: function,
): Promise<CancelScanResponse>

Annuleert een gestarte scan en retourneert een Promise die wordt omgezet in een CancelScanResponse -object. Als er een callback wordt gebruikt, wordt het object hieraan doorgegeven.

Parameters

  • functie

    snaar

    De handle van een actieve scantaak die eerder is geretourneerd vanuit een aanroep van startScan .

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (response: CancelScanResponse) =& gt;void

Retourneren

  • Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

closeScanner()

BelofteChrome 125+
chrome.documentScan.closeScanner(
  scannerHandle: string,
  callback?: function,
): Promise<CloseScannerResponse>

Sluit de scanner met de meegegeven handle en retourneert een Promise die wordt omgezet in een CloseScannerResponse -object. Als een callback wordt gebruikt, wordt het object hieraan doorgegeven. Zelfs als de respons niet succesvol is, wordt de meegegeven handle ongeldig en mag deze niet worden gebruikt voor verdere bewerkingen.

Parameters

  • scannerHandle

    snaar

    Geeft de handle op van een open scanner die eerder is geretourneerd vanuit een aanroep van openScanner .

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (response: CloseScannerResponse) =& gt;void

Retourneren

  • Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getOptionGroups()

BelofteChrome 125+
chrome.documentScan.getOptionGroups(
  scannerHandle: string,
  callback?: function,
): Promise<GetOptionGroupsResponse>

Haalt de groepsnamen en lidopties op van een scanner die eerder is geopend door openScanner . Deze methode retourneert een Promise die wordt omgezet in een GetOptionGroupsResponse -object. Als er een callback aan deze functie wordt doorgegeven, worden de geretourneerde gegevens hieraan doorgegeven.

Parameters

Retourneren

  • Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getScannerList()

BelofteChrome 125+
chrome.documentScan.getScannerList(
  filter: DeviceFilter,
  callback?: function,
): Promise<GetScannerListResponse>

Haalt de lijst met beschikbare scanners op en retourneert een Promise die wordt omgezet in een GetScannerListResponse -object. Als er een callback aan deze functie wordt doorgegeven, worden de geretourneerde gegevens in plaats daarvan aan de functie doorgegeven.

Parameters

Retourneren

  • Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

openScanner()

BelofteChrome 125+
chrome.documentScan.openScanner(
  scannerId: string,
  callback?: function,
): Promise<OpenScannerResponse>

Opent een scanner voor exclusieve toegang en retourneert een Promise die wordt omgezet in een OpenScannerResponse -object. Als er een callback aan deze functie wordt doorgegeven, worden de geretourneerde gegevens hieraan doorgegeven.

Parameters

  • scanner-ID

    snaar

    De ID van een te openen scanner. Deze waarde is een waarde die is geretourneerd door een eerdere aanroep van getScannerList .

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (response: OpenScannerResponse) =& gt;void

Retourneren

  • Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

readScanData()

BelofteChrome 125+
chrome.documentScan.readScanData(
  job: string,
  callback?: function,
): Promise<ReadScanDataResponse>

Leest het volgende deel van de beschikbare afbeeldingsgegevens van een actieve taakhandle en retourneert een Promise die wordt omgezet in een ReadScanDataResponse -object. Als er een callback wordt gebruikt, wordt het object hieraan doorgegeven.

**Opmerking:** Een responsresultaat is geldig als SUCCESS met een data element met lengte nul. Dit betekent dat de scanner nog steeds werkt, maar nog geen aanvullende gegevens beschikbaar heeft. De aanroeper moet even wachten en het opnieuw proberen.

Wanneer de scantaak is voltooid, heeft het antwoord de resultaatwaarde EOF . Dit antwoord kan een laatste data element bevatten dat niet nul is.

Parameters

Retourneren

  • Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

scan()

Belofte
chrome.documentScan.scan(
  options: ScanOptions,
  callback?: function,
): Promise<ScanResults>

Voert een documentscan uit en retourneert een Promise die resulteert in een ScanResults object. Als er een callback aan deze functie wordt doorgegeven, worden de geretourneerde gegevens in plaats daarvan aan deze functie doorgegeven.

Parameters

  • opties

    Scanopties

    Een object dat scanparameters bevat.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (result: ScanResults) =& gt;void

Retourneren

  • Belofte< ScanResultaten >

    Chroom 96+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

setOptions()

BelofteChrome 125+
chrome.documentScan.setOptions(
  scannerHandle: string,
  options: OptionSetting[],
  callback?: function,
): Promise<SetOptionsResponse>

Stelt opties in op de opgegeven scanner en retourneert een Promise die resulteert in een SetOptionsResponse object met het resultaat van een poging om elke waarde in te stellen in de volgorde van het doorgegeven OptionSetting -object. Als er een callback wordt gebruikt, wordt het object hieraan doorgegeven.

Parameters

  • scannerHandle

    snaar

    De handle van de scanner waarvoor opties moeten worden ingesteld. Dit moet een waarde zijn die eerder is geretourneerd na een aanroep van openScanner .

  • opties

    Optie -instelling []

    Een lijst met OptionSetting -objecten die op de scanner moeten worden toegepast.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (response: SetOptionsResponse) =& gt;void

Retourneren

  • Belofte< SetOptionsResponse >

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

startScan()

BelofteChrome 125+
chrome.documentScan.startScan(
  scannerHandle: string,
  options: StartScanOptions,
  callback?: function,
): Promise<StartScanResponse>

Start een scan op de opgegeven scanner en retourneert een Promise die resulteert in een StartScanResponse . Als een callback wordt gebruikt, wordt het object hieraan doorgegeven. Als de aanroep succesvol was, bevat de respons een taakhandle die in volgende aanroepen kan worden gebruikt om scangegevens te lezen of een scan te annuleren.

Parameters

  • scannerHandle

    snaar

    De handle van een open scanner. Dit moet een waarde zijn die eerder is geretourneerd door een aanroep van openScanner .

  • Een StartScanOptions -object dat de te gebruiken opties voor de scan aangeeft. De eigenschap StartScanOptions.format moet overeenkomen met een van de waarden die worden geretourneerd in de ScannerInfo van de scanner.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (response: StartScanResponse) =& gt;void

Retourneren

  • Belofte< StartScanResponse >

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.