chrome.documentScan

Beschrijving

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

Machtigingen

documentScan

Beschikbaarheid

AlleenChrome 44+ ChromeOS

Documentscan-API

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

Soorten

CancelScanResponse

Chroom 125+

Eigenschappen

  • functie

    snaar

    Biedt dezelfde taakingang die is doorgegeven aan cancelScan() .

  • Het annuleerscanresultaat 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, verwerkt de scanner nog steeds de aangevraagde annulering; de beller moet een korte tijd wachten en het verzoek opnieuw proberen. Andere resultaatwaarden duiden op een permanente fout die niet opnieuw mag worden geprobeerd.

CloseScannerResponse

Chroom 125+

Eigenschappen

  • 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.

  • scannerHandvat

    snaar

    Dezelfde scannerhandle als werd doorgegeven aan closeScanner .

Configurability

Chroom 125+

Hoe een optie kan worden gewijzigd.

Enum

"NIET_CONFIGUREERBAAR"
De optie is alleen-lezen.

"SOFTWARE_CONFIGURABLE"
De optie kan softwarematig worden ingesteld.

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

ConnectionType

Chroom 125+

Geeft aan hoe de scanner op de computer is aangesloten.

Enum

"ONGESPECIFICEERD"

"USB"

"NETWERK"

ConstraintType

Chroom 125+

Het gegevenstype van de beperking dat wordt vertegenwoordigd door een OptionConstraint .

Enum

"INT_RANGE"
De beperking voor een bereik van OptionType.INT -waarden. De min , max en quant eigenschappen van OptionConstraint zullen long zijn, en de list zal niet ingesteld zijn.

"FIXED_RANGE"
De beperking voor een bereik van OptionType.FIXED -waarden. De eigenschappen min , max en quant van OptionConstraint zijn double en de eigenschap list ervan wordt uitgeschakeld.

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

"FIXED_LIST"
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_LIST"
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

    Booleaans optioneel

    Retourneer alleen scanners die rechtstreeks op de computer zijn aangesloten.

  • zeker

    Booleaans 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 die door het scannerstuurprogramma wordt opgegeven.

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

  • scannerHandvat

    snaar

    Dezelfde scannerhandle als werd doorgegeven aan getOptionGroups .

GetScannerListResponse

Chroom 125+

Eigenschappen

  • Het opsommingsresultaat. Houd er rekening mee dat gedeeltelijke resultaten kunnen worden geretourneerd, zelfs als dit op een fout duidt.

  • scanners

    Scannerinfo []

    Een mogelijk lege lijst met scanners die overeenkomen met de meegeleverde DeviceFilter .

OpenScannerResponse

Chroom 125+

Eigenschappen

  • opties

    object optioneel

    Als result SUCCESS is, wordt een sleutel-waarde-toewijzing weergegeven waarbij de sleutel een apparaatspecifieke optie is en de waarde een exemplaar van ScannerOption is.

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

  • scannerHandvat

    tekenreeks optioneel

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

  • scannerId

    snaar

    De scanner-ID doorgegeven aan openScanner() .

OperationResult

Chroom 125+

Een opsomming die het resultaat van elke bewerking aangeeft.

Enum

"ONBEKEND"
Er heeft zich een onbekende of algemene fout voorgedaan.

"SUCCES"
De operatie is gelukt.

"NIET ONDERSTEUND"
De bewerking wordt niet ondersteund.

"GEANNULEERD"
De operatie werd geannuleerd.

"DEVICE_BUSY"
Het apparaat is bezet.

"ONGELDIG"
De gegevens of een argument dat aan de methode wordt doorgegeven, zijn niet geldig.

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

"EOF"
Er zijn geen gegevens meer beschikbaar.

"ADF_JAMMED"
De documentinvoer is vastgelopen.

"ADF_EMPTY"
De documentinvoer is leeg.

"COVER_OPEN"
De klep van de flatbed is open.

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

"ACCESS_DENIED"
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.

"ONTBREKEN"
Het apparaat is losgekoppeld.

"INTERNAL_ERROR"
Er is ergens anders een fout opgetreden dan in de aanroepende toepassing.

OptionConstraint

Chroom 125+

Eigenschappen

  • lijst

    tekenreeks[] | nummer[] optioneel

  • maximaal

    nummer optioneel

  • min

    nummer optioneel

  • kwantitatief

    nummer optioneel

OptionGroup

Chroom 125+

Eigenschappen

  • leden

    snaar[]

    Een array met optienamen in de door het stuurprogramma opgegeven volgorde.

  • titel

    snaar

    Biedt een afdrukbare titel, bijvoorbeeld 'Geometrie-opties'.

OptionSetting

Chroom 125+

Eigenschappen

  • naam

    snaar

    Geeft de naam aan van de in te stellen optie.

  • type

    OptieType

    Geeft het gegevenstype van de optie aan. Het gevraagde datatype moet overeenkomen met het echte datatype van de onderliggende optie.

  • waarde

    tekenreeks | nummer | booleaans | nummer[] optioneel

    Geeft de in te stellen waarde aan. Laat deze instelling uitgeschakeld om automatische instelling aan te vragen voor opties waarvoor autoSettable is ingeschakeld. Het gegevenstype dat voor value wordt opgegeven, 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 uitgeschakeld.

"BOEL"
De value -eigenschap is true false.

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

"VAST"
Een dubbelganger 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. Dubbele waarden die niet exact kunnen worden weergegeven, worden afgerond op het beschikbare bereik en de beschikbare nauwkeurigheid.

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

"KNOP"
Een dergelijke optie heeft geen waarde. In plaats daarvan veroorzaakt het instellen van een optie van dit type een optiespecifiek 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 vertellen dat hij door moet gaan naar het volgende vel papier.

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

OptionUnit

Chroom 125+

Geeft het gegevenstype voor ScannerOption.unit aan.

Enum

"EENHEDEN"
De waarde is een eenheidloos getal. Het kan bijvoorbeeld een drempel zijn.

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

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

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

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

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

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

ReadScanDataResponse

Chroom 125+

Eigenschappen

  • gegevens

    ArrayBuffer optioneel

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

  • geschatteVoltooiing

    nummer optioneel

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

  • functie

    snaar

    Biedt de taakingang die wordt doorgegeven aan readScanData() .

  • Het resultaat van het lezen van gegevens. Als de waarde SUCCESS is, bevatten data het volgende (mogelijk lengte nul) deel van de afbeeldingsgegevens dat klaar is om te worden gelezen. Als de waarde ervan EOF is, bevatten de data het laatste deel van de afbeeldingsgegevens.

ScannerInfo

Chroom 125+

Eigenschappen

  • verbindingstype

    Verbindingstype

    Geeft aan hoe de scanner op de computer is aangesloten.

  • apparaatUuid

    snaar

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

  • afbeeldingformaten

    snaar[]

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

  • fabrikant

    snaar

    De scannerfabrikant.

  • model

    snaar

    Het scannermodel, indien beschikbaar, of een algemene beschrijving.

  • naam

    snaar

    Een voor mensen leesbare naam die de scanner in de gebruikersinterface moet weergeven.

  • protocolType

    snaar

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

  • scannerId

    snaar

    De ID van een specifieke scanner.

  • zeker

    Booleaans

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

ScannerOption

Chroom 125+

Eigenschappen

  • configureerbaarheid

    Configureerbaarheid

    Geeft aan of en hoe de optie gewijzigd kan worden.

  • beperking

    OptionConstraint optioneel

    Definieert OptionConstraint voor de huidige scanneroptie.

  • beschrijving

    snaar

    Een langere beschrijving van de optie.

  • isActief

    Booleaans

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

  • is geavanceerd

    Booleaans

    Geeft aan dat de gebruikersinterface deze optie standaard niet mag weergeven.

  • isAutoSettable

    Booleaans

    Kan automatisch worden ingesteld door het scannerstuurprogramma.

  • isdetecteerbaar

    Booleaans

    Geeft aan dat deze optie door software kan worden gedetecteerd.

  • is geëmuleerd

    Booleaans

    Geëmuleerd door het scannerstuurprogramma indien waar.

  • naam

    snaar

    De optienaam met 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 value eigenschap, dat nodig is voor het instellen van deze optie.

  • eenheid

    OptieEenheid

    De maateenheid voor deze optie.

  • waarde

    tekenreeks | nummer | booleaans | nummer[] optioneel

    De huidige waarde van de optie, indien relevant. Houd er rekening mee dat 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.

  • mimeTypen

    tekenreeks[] optioneel

    De MIME-typen die door de aanroeper worden geaccepteerd.

ScanResults

Eigenschappen

  • dataUrls

    snaar[]

    Een array van gegevensafbeeldings-URL's in een vorm die kan worden doorgegeven als de 'src'-waarde aan een afbeeldingstag.

  • mimeType

    snaar

    Het MIME-type van dataUrls .

SetOptionResult

Chroom 125+

Eigenschappen

  • naam

    snaar

    Geeft de naam aan van de optie die is ingesteld.

  • Geeft het resultaat aan van het instellen van de optie.

SetOptionsResponse

Chroom 125+

Eigenschappen

  • opties

    object optioneel

    Een bijgewerkte sleutelwaardetoewijzing van optienamen naar ScannerOption waarden die de nieuwe configuratie bevatten na een poging om alle opgegeven opties in te stellen. Dit heeft dezelfde structuur als de eigenschap options in OpenScannerResponse .

    Deze eigenschap wordt ingesteld, zelfs als sommige opties niet succesvol zijn ingesteld, maar wordt uitgeschakeld als het ophalen van de bijgewerkte configuratie mislukt (bijvoorbeeld als de scanner tijdens het scannen wordt losgekoppeld).

  • resultaten

    SetOptionResultaat []

    Een array met resultaten, één voor elke doorgegeven OptionSetting .

  • scannerHandvat

    snaar

    Biedt de scannerhandle die wordt doorgegeven aan setOptions() .

StartScanOptions

Chroom 125+

Eigenschappen

  • formaat

    snaar

    Specificeert het MIME-type waarin gescande gegevens moeten worden geretourneerd.

  • maxReadSize

    nummer optioneel

    Als er een waarde anders dan nul is opgegeven, worden de maximale gescande bytes beperkt die in een enkel readScanData antwoord op die waarde worden geretourneerd. De kleinste toegestane waarde is 32768 (32 KB). Als deze eigenschap niet is opgegeven, kan de grootte van een geretourneerd stuk even groot zijn als de gehele gescande afbeelding.

StartScanResponse

Chroom 125+

Eigenschappen

  • functie

    tekenreeks optioneel

    Als result SUCCESS is, wordt er een handvat geboden dat kan worden gebruikt om scangegevens te lezen of de taak te annuleren.

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

  • scannerHandvat

    snaar

    Biedt dezelfde scannerhandle die is doorgegeven aan startScan() .

Methoden

cancelScan()

BeloofChrome 125+
chrome.documentScan.cancelScan(
  job: string,
  callback?: function,
)

Annuleert een gestarte scan en retourneert een belofte die wordt opgelost met een CancelScanResponse object. Als er een callback wordt gebruikt, wordt het object eraan doorgegeven.

Parameters

  • functie

    snaar

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

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (response: CancelScanResponse) => void

Retouren

  • Beloof <CancelResponse>

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

closeScanner()

BeloofChrome 125+
chrome.documentScan.closeScanner(
  scannerHandle: string,
  callback?: function,
)

Sluit de scanner met de doorgegeven ingang en retourneert een Promise die wordt opgelost met een CloseScannerResponse -object. Als er een callback wordt gebruikt, wordt het object eraan doorgegeven. Zelfs als het antwoord geen succes is, wordt de opgegeven handle ongeldig en mag deze niet voor verdere bewerkingen worden gebruikt.

Parameters

  • scannerHandvat

    snaar

    Specificeert de handle van een open scanner die eerder is geretourneerd door een aanroep van openScanner .

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (response: CloseScannerResponse) => void

Retouren

  • Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getOptionGroups()

BeloofChrome 125+
chrome.documentScan.getOptionGroups(
  scannerHandle: string,
  callback?: function,
)

Haalt de groepsnamen en ledenopties op van een scanner die eerder door openScanner werd geopend. Deze methode retourneert een Promise die wordt opgelost met een GetOptionGroupsResponse -object. Als er een callback wordt doorgegeven aan deze functie, worden de geretourneerde gegevens daaraan doorgegeven.

Parameters

Retouren

  • Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getScannerList()

BeloofChrome 125+
chrome.documentScan.getScannerList(
  filter: DeviceFilter,
  callback?: function,
)

Haalt de lijst met beschikbare scanners op en retourneert een belofte die wordt opgelost met een GetScannerListResponse object. Als er een callback wordt doorgegeven aan deze functie, worden de geretourneerde gegevens daaraan doorgegeven.

Parameters

Retouren

  • Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

openScanner()

BeloofChrome 125+
chrome.documentScan.openScanner(
  scannerId: string,
  callback?: function,
)

Opent een scanner voor exclusieve toegang en retourneert een belofte die wordt opgelost met een OpenScannerResponse object. Als er een callback wordt doorgegeven aan deze functie, worden de geretourneerde gegevens daaraan doorgegeven.

Parameters

  • scannerId

    snaar

    De ID van een scanner die moet worden geopend. Deze waarde is de waarde die wordt geretourneerd door een eerdere aanroep van getScannerList .

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (response: OpenScannerResponse) => void

Retouren

  • Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

readScanData()

BeloofChrome 125+
chrome.documentScan.readScanData(
  job: string,
  callback?: function,
)

Leest het volgende deel van de beschikbare afbeeldingsgegevens van een actieve taakafhandeling en retourneert een Promise die wordt opgelost met een ReadScanDataResponse -object. Als er een callback wordt gebruikt, wordt het object eraan doorgegeven.

**Opmerking:**Het is geldig dat een antwoordresultaat SUCCESS is met een data met lengte nul. Dit betekent dat de scanner nog steeds werkt, maar nog geen extra gegevens gereed heeft. De beller moet even wachten en het opnieuw proberen.

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

Parameters

Retouren

  • Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

scan()

Belofte
chrome.documentScan.scan(
  options: ScanOptions,
  callback?: function,
)

Voert een documentscan uit en retourneert een belofte die wordt opgelost met een ScanResults -object. Als er een callback naar deze functie wordt doorgegeven, worden de geretourneerde gegevens daaraan doorgegeven.

Parameters

  • opties

    Scanopties

    Een object dat scanparameters bevat.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: ScanResults) => void

Retouren

  • Beloof < Scanresultaten >

    Chroom 96+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

setOptions()

BeloofChrome 125+
chrome.documentScan.setOptions(
  scannerHandle: string,
  options: OptionSetting[],
  callback?: function,
)

Stelt opties in op de opgegeven scanner en retourneert een belofte die wordt opgelost met een SetOptionsResponse object dat het resultaat bevat 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 eraan doorgegeven.

Parameters

  • scannerHandvat

    snaar

    Het handvat van de scanner om opties op in te stellen. Dit moet een waarde zijn die eerder is geretourneerd door een aanroep van openScanner .

  • opties

    OptieInstelling []

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

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (response: SetOptionsResponse) => void

Retouren

  • Beloof < SetOptionsResponse >

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

startScan()

BeloofChrome 125+
chrome.documentScan.startScan(
  scannerHandle: string,
  options: StartScanOptions,
  callback?: function,
)

Start een scan op de opgegeven scanner en retourneert een belofte die wordt opgelost met een StartScanResponse . Als er een callback wordt gebruikt, wordt het object eraan doorgegeven. Als de oproep succesvol was, bevat het antwoord een taakafhandeling die bij volgende oproepen kan worden gebruikt om scangegevens te lezen of een scan te annuleren.

Parameters

  • scannerHandvat

    snaar

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

  • Een StartScanOptions object dat de opties aangeeft die voor de scan moeten worden gebruikt. De eigenschap StartScanOptions.format moet overeenkomen met een van de items die worden geretourneerd in ScannerInfo van de scanner.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (response: StartScanResponse) => void

Retouren

  • Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.