chrome.documentScan

Açıklama

Ekli belge tarayıcılardan görüntüleri keşfetmek ve almak için chrome.documentScan API'yi kullanın.

İzinler

documentScan

Kullanılabilirlik

Chrome 44 veya daha yeni bir sürüm Yalnızca ChromeOS

Document Scan API

Belge Tarama API'si, uygulama ve uzantıların ekli bir belge tarayıcıdaki kağıt belgelerin içeriğini görüntülemesine olanak tanımak için tasarlanmıştır.

Türler

CancelScanResponse

Chrome 125+

Özellikler

  • iş

    dize

    cancelScan()'ya iletilen iş kolunu sağlar.

  • Arka uçtaki tarama sonucunu iptal etme. Sonuç OperationResult.SUCCESS veya OperationResult.CANCELLED ise tarama iptal edilmiş ve tarayıcı yeni bir tarama başlatmaya hazırdır. Sonuç OperationResult.DEVICE_BUSY ise tarayıcı , istenen iptal işlemini hâlâ işliyor demektir. Arayan kişi kısa bir süre bekleyip isteği tekrar denemelidir. Diğer sonuç değerleri, yeniden denenmemesi gereken kalıcı bir hatayı gösterir.

CloseScannerResponse

Chrome 125+

Özellikler

  • Tarayıcıyı kapatmanın sonucu. Bu değer SUCCESS olmasa bile tanıtıcı geçersiz olur ve başka işlemler için kullanılmamalıdır.

  • scannerHandle

    dize

    closeScanner'a iletilen tarayıcı tutma yeriyle aynı.

Configurability

Chrome 125+

Bir seçeneğin nasıl değiştirilebileceği

Enum

"NOT_CONFIGURABLE"
Seçenek salt okunurdur.

"SOFTWARE_CONFIGURABLE"
Seçenek yazılımda ayarlanabilir.

"HARDWARE_CONFIGURABLE"
Seçenek, kullanıcının tarayıcıdaki bir düğmeyi açıp kapatması veya düğmeye basmasıyla ayarlanabilir.

ConnectionType

Chrome 125+

Tarayıcının bilgisayara nasıl bağlandığını gösterir.

Enum

"UNSPECIFIED"

"USB"

"NETWORK"

ConstraintType

Chrome 125+

OptionConstraint ile gösterilen kısıtlamanın veri türü.

Enum

"INT_RANGE"
OptionType.INT değer aralığındaki kısıtlama. OptionConstraint öğesinin min, max ve quant özellikleri long olacak, list özelliği ise ayarlanmamış olacak.

"FIXED_RANGE"
OptionType.FIXED değer aralığındaki kısıtlama. OptionConstraint için min, max ve quant özellikleri double olacak, list özelliği ise ayarlanmamış olacaktır.

"INT_LIST"
Belirli bir OptionType.INT değer listesindeki kısıtlama. OptionConstraint.list özelliği long değerlerini içerir ve diğer özellikler ayarlanmamış olur.

"FIXED_LIST"
Belirli bir OptionType.FIXED değer listesindeki kısıtlama. OptionConstraint.list özelliği double değerlerini içerir ve diğer özellikler ayarlanmamış olur.

"STRING_LIST"
Belirli bir OptionType.STRING değer listesindeki kısıtlama. OptionConstraint.list özelliği DOMString değerlerini içerir ve diğer özellikler ayarlanmamış olur.

DeviceFilter

Chrome 125+

Özellikler

  • local

    boolean isteğe bağlı

    Yalnızca doğrudan bilgisayara bağlı tarayıcıları iade edin.

  • güvenli

    boolean isteğe bağlı

    Yalnızca USB veya TLS gibi güvenli aktarım kullanan tarayıcıları iade edin.

GetOptionGroupsResponse

Chrome 125+

Özellikler

  • groups

    OptionGroup[] isteğe bağlı

    result SUCCESS ise tarayıcı sürücüsü tarafından sağlanan sırayla seçenek gruplarının listesini sağlar.

  • Seçenek gruplarını alma işleminin sonucu. Bu özelliğin değeri SUCCESS ise groups özelliği doldurulur.

  • scannerHandle

    dize

    getOptionGroups'a iletilen tarayıcı tutma yeriyle aynı.

GetScannerListResponse

Chrome 125+

Özellikler

  • Numaralandırma sonucu. Bu durum bir hataya işaret etse bile kısmi sonuçlar döndürülebileceğini unutmayın.

  • Tarayıcılar

    ScannerInfo[]

    Belirtilen DeviceFilter ile eşleşen tarayıcıların muhtemelen boş bir listesi.

OpenScannerResponse

Chrome 125+

Özellikler

  • seçenekler

    object isteğe bağlı

    result, SUCCESS ise anahtarın cihaza özel bir seçenek, değerin ise ScannerOption örneği olduğu bir anahtar/değer eşlemesi sağlar.

  • Tarayıcının açılmasının sonucu. Bu özelliğin değeri SUCCESS ise scannerHandle ve options özellikleri doldurulur.

  • scannerHandle

    dize isteğe bağlı

    result, SUCCESS ise tarayıcıya yönelik, başka işlemler için kullanılabilecek bir tutma yeri.

  • scannerId

    dize

    Tarayıcı kimliği openScanner()'ya iletildi.

OperationResult

Chrome 125+

Her işlemin sonucunu gösteren bir enum.

Enum

"UNKNOWN"
Bilinmeyen veya genel bir hata oluştu.

"SUCCESS"
İşlem başarılı oldu.

"UNSUPPORTED"
İşlem desteklenmiyor.

"CANCELLED"
İşlem iptal edildi.

"DEVICE_BUSY"
Cihaz meşgul.

"INVALID"
Veriler veya yönteme iletilen bir bağımsız değişken geçerli değil.

"WRONG_TYPE"
Sağlanan değer, temel seçenek için yanlış veri türüdür.

"EOF"
Başka veri yok.

"ADF_JAMMED"
Belge besleyici sıkıştı.

"ADF_EMPTY"
Belge besleyici boş.

"COVER_OPEN"
Düz yataklı tarayıcının kapağı açık.

"IO_ERROR"
Cihazla iletişim kurulurken bir hata oluştu.

"ACCESS_DENIED"
Cihaz için kimlik doğrulama gerekiyor.

"NO_MEMORY"
İşlemi tamamlamak için Chromebook'ta yeterli bellek yok.

"UNREACHABLE"
Cihaza ulaşılamıyor.

"MISSING"
Cihazın bağlantısı kesilmiştir.

"INTERNAL_ERROR"
Arama yapan uygulama dışında bir yerde hata oluştu.

OptionConstraint

Chrome 125+

Özellikler

  • list

    string[] | number[] isteğe bağlı

  • maks.

    number isteğe bağlı

  • dk

    number isteğe bağlı

  • quant

    number isteğe bağlı

OptionGroup

Chrome 125+

Özellikler

  • üyeler

    dize[]

    Sürücü tarafından sağlanan sıradaki seçenek adları dizisi.

  • title

    dize

    Yazdırılabilir bir başlık sağlar (ör. "Geometri seçenekleri").

OptionSetting

Chrome 125+

Özellikler

  • ad

    dize

    Ayarlanacak seçeneğin adını gösterir.

  • tür

    OptionType

    Seçeneğin veri türünü gösterir. İstenen veri türü, temel alınan seçeneğin gerçek veri türüyle eşleşmelidir.

  • value

    string | number | boolean | number[] isteğe bağlı

    Ayarlanacak değeri gösterir. autoSettable etkin olan seçenekler için otomatik ayar isteğinde bulunmak üzere ayarlanmamış olarak bırakın. value için sağlanan veri türü type ile eşleşmelidir.

OptionType

Chrome 125+

Bir seçeneğin veri türü.

Enum

"UNKNOWN"
Seçeneğin veri türü bilinmiyor. value özelliği ayarlanmamış olacak.

"BOOL"
value özelliği truefalse değerlerinden birini alır.

"INT"
İşaretli 32 bit tam sayı. Seçeneğin birden fazla değer alıp almadığına bağlı olarak value özelliği long veya long[] olacaktır.

"SABİT"
-32768-32767,9999 aralığında, 1/65535 çözünürlüğe sahip bir çift sayı. value özelliği, seçeneğin birden fazla değer alıp almamasına bağlı olarak double veya double[] olur. Tam olarak gösterilemeyen çift değerler, mevcut aralığa ve kesinliğe göre yuvarlanır.

"STRING"
NUL ('\0') hariç herhangi bir bayt dizisi. value özelliği bir DOMString olacaktır.

"BUTTON"
Bu türdeki bir seçeneğin değeri yoktur. Bunun yerine, bu tür bir seçeneğin ayarlanması tarayıcı sürücüsünde seçeneğe özgü bir yan etkiye neden olur. Örneğin, bir tarayıcı sürücüsü, varsayılan değerleri seçme veya otomatik belge besleyiciye bir sonraki kağıda geçmesini söyleme yöntemi sağlamak için düğme türünde bir seçenek kullanabilir.

"GROUP"
Gruplandırma seçeneği. Değer yok. Bu, uyumluluk için eklenir ancak normalde ScannerOption değerlerinde döndürülmez. Üye seçenekleriyle birlikte grupların listesini almak için getOptionGroups() kullanın.

OptionUnit

Chrome 125+

ScannerOption.unit için veri türünü belirtir.

Enum

"UNITLESS"
Değer, birimsiz bir sayıdır. Örneğin, bir eşik olabilir.

"PIXEL"
Değer, piksel sayısıdır (ör. tarama boyutları).

"BIT"
Değer, bit sayısıdır (ör. renk derinliği).

"MM"
Değer, milimetre cinsinden ölçülür (örneğin, tarama boyutları).

"DPI"
Değer, inç başına nokta sayısı cinsinden ölçülür (örneğin, çözünürlük).

"PERCENT"
Değer, yüzde cinsindendir (ör. parlaklık).

"MICROSECOND"
Değer, mikrosaniye cinsinden ölçülür (ör. pozlama süresi).

ReadScanDataResponse

Chrome 125+

Özellikler

  • aktarma

    ArrayBuffer isteğe bağlıdır.

    result, SUCCESS ise taranan resim verilerinin sonraki bölümünü içerir. result EOF ise taranan resim verilerinin son parçasını içerir.

  • estimatedCompletion

    number isteğe bağlı

    result, SUCCESS ise toplam tarama verilerinin ne kadarının şu ana kadar teslim edildiğine dair 0-100 aralığında bir tahmindir.

  • iş

    dize

    readScanData()'ya iletilen iş tanıtıcısını sağlar.

  • Veri okuma işleminin sonucu. Değeri SUCCESS ise data, okunmaya hazır olan sonraki (muhtemelen sıfır uzunluklu) görüntü verileri parçasını içerir. Değeri EOF ise data, resim verilerinin son parçasını içerir.

ScannerInfo

Chrome 125+

Özellikler

  • connectionType

    ConnectionType

    Tarayıcının bilgisayara nasıl bağlandığını gösterir.

  • deviceUuid

    dize

    Aynı fiziksel cihaza işaret eden diğer ScannerInfo girişleriyle eşleştirme için.

  • imageFormats

    dize[]

    Döndürülen taramalar için istenebilecek MIME türleri dizisi.

  • üretici

    dize

    Tarayıcı üreticisi.

  • model

    dize

    Varsa tarayıcı modeli veya genel bir açıklama.

  • ad

    dize

    Tarayıcının kullanıcı arayüzünde gösterilecek, kullanıcılar tarafından okunabilir adı.

  • protocolType

    dize

    Tarayıcıya erişmek için kullanılan protokolün veya sürücünün kullanıcılar tarafından okunabilir açıklaması (ör. Mopria, WSD veya epsonds). Bu özellik, bir cihaz birden fazla protokolü destekliyorsa kullanıcının protokoller arasında seçim yapmasına olanak tanımak için kullanılır.

  • scannerId

    dize

    Belirli bir tarayıcının kimliği.

  • güvenli

    boolean

    Doğruysa tarayıcı bağlantısının iletimi, TLS veya USB gibi pasif bir dinleyici tarafından engellenemez.

ScannerOption

Chrome 125+

Özellikler

  • yapılandırılabilirlik

    Yapılandırılabilirlik (Configurability)

    Seçeneğin değiştirilip değiştirilemeyeceğini ve nasıl değiştirilebileceğini gösterir.

  • kısıtlama

    OptionConstraint isteğe bağlı

    Geçerli tarayıcı seçeneğinde OptionConstraint tanımlar.

  • açıklama

    dize

    Seçeneğin daha uzun açıklaması.

  • isActive

    boolean

    Seçeneğin etkin olduğunu ve ayarlanabileceğini veya alınabileceğini gösterir. Yanlışsa value özelliği ayarlanmaz.

  • isAdvanced

    boolean

    Kullanıcı arayüzünün bu seçeneği varsayılan olarak göstermemesi gerektiğini belirtir.

  • isAutoSettable

    boolean

    Tarayıcı sürücüsü tarafından otomatik olarak ayarlanabilir.

  • isDetectable

    boolean

    Bu seçeneğin yazılımdan algılanabileceğini gösterir.

  • isEmulated

    boolean

    Doğruysa tarayıcı sürücüsü tarafından emüle edilir.

  • ad

    dize

    Küçük ASCII harfleri, rakamlar ve tireler kullanılarak oluşturulan seçenek adı. Aksan işaretlerine izin verilmez.

  • title

    dize

    Yazdırılabilir tek satırlık bir başlık.

  • tür

    OptionType

    Bu seçeneğin ayarlanması için gereken value özelliğinde bulunan veri türü.

  • birim

    OptionUnit

    Bu seçeneğin ölçü birimi.

  • value

    string | number | boolean | number[] isteğe bağlı

    Seçeneğin mevcut değeri (varsa). Bu özelliğin veri türünün, type içinde belirtilen veri türüyle eşleşmesi gerektiğini unutmayın.

ScanOptions

Özellikler

  • maxImages

    number isteğe bağlı

    İzin verilen taranmış resim sayısı. Varsayılan değer 1'dir.

  • mimeTypes

    string[] isteğe bağlı

    Arayan tarafından kabul edilen MIME türleri.

ScanResults

Özellikler

  • dataUrls

    dize[]

    Bir resim etiketine "src" değeri olarak iletilebilecek bir biçimde veri resmi URL'lerinin dizisi.

  • mimeType

    dize

    dataUrls öğesinin MIME türü.

SetOptionResult

Chrome 125+

Özellikler

  • ad

    dize

    Ayarlanan seçeneğin adını gösterir.

  • Seçeneğin ayarlanmasının sonucunu gösterir.

SetOptionsResponse

Chrome 125+

Özellikler

  • seçenekler

    object isteğe bağlı

    Tüm sağlanan seçenekler ayarlanmaya çalışıldıktan sonra yeni yapılandırmayı içeren, seçenek adlarından ScannerOption değerlerine güncellenmiş bir anahtar-değer eşlemesi. Bu, OpenScannerResponse içindeki options özelliğiyle aynı yapıya sahiptir.

    Bu özellik, bazı seçenekler başarıyla ayarlanmamış olsa bile ayarlanır. Ancak güncellenen yapılandırma alınamazsa (örneğin, tarayıcının tarama ortasında bağlantısı kesilirse) ayarlanmaz.

  • sonuç

    SetOptionResult[]

    Sonuç dizisi. Her bir iletilen OptionSetting için bir sonuç bulunur.

  • scannerHandle

    dize

    setOptions()'ya iletilen tarayıcı tutamacını sağlar.

StartScanOptions

Chrome 125+

Özellikler

  • biçim

    dize

    Taranan verilerin döndürüleceği MIME türünü belirtir.

  • maxReadSize

    number isteğe bağlı

    Sıfır olmayan bir değer belirtilirse tek bir readScanData yanıtında döndürülen maksimum taranan bayt sayısı bu değerle sınırlanır. İzin verilen en küçük değer 32768 (32 KB)'dir. Bu özellik belirtilmezse döndürülen bir parçanın boyutu, taranan resmin tamamı kadar büyük olabilir.

StartScanResponse

Chrome 125+

Özellikler

  • iş

    dize isteğe bağlı

    result, SUCCESS ise tarama verilerini okumak veya işi iptal etmek için kullanılabilecek bir işleyici sağlar.

  • Tarama başlatmanın sonucu. Bu özelliğin değeri SUCCESS ise job özelliği doldurulur.

  • scannerHandle

    dize

    startScan()'ya iletilen tarayıcı tutamacını sağlar.

Yöntemler

cancelScan()

Promise Chrome 125 ve sonraki sürümler 
chrome.documentScan.cancelScan(
  job: string,
  callback?: function,
): Promise<CancelScanResponse>

Başlatılan bir taramayı iptal eder ve CancelScanResponse nesnesiyle çözümlenen bir Promise döndürür. Geri çağırma kullanılırsa nesne bunun yerine geri çağırmaya iletilir.

Parametreler

  • iş

    dize

    Daha önce startScan işlevine yapılan bir çağrıdan döndürülen etkin bir tarama işinin tanıtıcısı.

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (response: CancelScanResponse) => void

İadeler

  • Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

closeScanner()

Promise Chrome 125 ve sonraki sürümler 
chrome.documentScan.closeScanner(
  scannerHandle: string,
  callback?: function,
): Promise<CloseScannerResponse>

Tarayıcıyı iletilen tutamaçla kapatır ve CloseScannerResponse nesnesiyle çözümlenen bir Promise döndürür. Geri çağırma kullanılırsa nesne bunun yerine geri çağırmaya iletilir. Yanıt başarılı olmasa bile sağlanan işleyici geçersiz hale gelir ve başka işlemler için kullanılmamalıdır.

Parametreler

  • scannerHandle

    dize

    Daha önce openScanner çağrısından döndürülen açık bir tarayıcının tanıtıcısını belirtir.

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (response: CloseScannerResponse) => void

İadeler

  • Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

getOptionGroups()

Promise Chrome 125 ve sonraki sürümler 
chrome.documentScan.getOptionGroups(
  scannerHandle: string,
  callback?: function,
): Promise<GetOptionGroupsResponse>

Grup adlarını ve üye seçeneklerini, daha önce openScanner tarafından açılmış bir tarayıcıdan alır. Bu yöntem, GetOptionGroupsResponse nesnesiyle çözümlenen bir Promise döndürür. Bu işleve bir geri çağırma iletilirse döndürülen veriler bunun yerine geri çağırmaya iletilir.

Parametreler

İadeler

  • Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

getScannerList()

Promise Chrome 125 ve sonraki sürümler 
chrome.documentScan.getScannerList(
  filter: DeviceFilter,
  callback?: function,
): Promise<GetScannerListResponse>

Kullanılabilir tarayıcıların listesini alır ve GetScannerListResponse nesnesiyle çözümlenen bir Promise döndürür. Bu işleve bir geri çağırma iletilirse döndürülen veriler bunun yerine geri çağırmaya iletilir.

Parametreler

İadeler

  • Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

openScanner()

Promise Chrome 125 ve sonraki sürümler 
chrome.documentScan.openScanner(
  scannerId: string,
  callback?: function,
): Promise<OpenScannerResponse>

Özel erişim için bir tarayıcı açar ve OpenScannerResponse nesnesiyle çözümlenen bir Promise döndürür. Bu işleve bir geri çağırma iletilirse döndürülen veriler bunun yerine geri çağırmaya iletilir.

Parametreler

  • scannerId

    dize

    Açılacak tarayıcının kimliği. Bu değer, getScannerList için yapılan önceki bir çağrıdan döndürülen değerdir.

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (response: OpenScannerResponse) => void

İadeler

  • Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

readScanData()

Promise Chrome 125 ve sonraki sürümler 
chrome.documentScan.readScanData(
  job: string,
  callback?: function,
): Promise<ReadScanDataResponse>

Etkin bir iş tanıtıcısından kullanılabilir görüntü verilerinin bir sonraki parçasını okur ve ReadScanDataResponse nesnesiyle çözümlenen bir Promise döndürür. Geri çağırma kullanılırsa nesne bunun yerine geri çağırmaya iletilir.

**Not:**Yanıt sonucunun, sıfır uzunlukta bir data üyesiyle SUCCESS olması geçerlidir. Bu, tarayıcının çalışmaya devam ettiği ancak henüz ek verilerin hazır olmadığı anlamına gelir. Arayan kişi kısa bir süre bekleyip tekrar denemelidir.

Tarama işi tamamlandığında yanıtta EOF sonuç değeri bulunur. Bu yanıtta, sıfır olmayan son bir data üyesi olabilir.

Parametreler

İadeler

  • Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

scan()

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

Belge taraması yapar ve ScanResults nesnesiyle çözümlenen bir Promise döndürür. Bu işleve bir geri çağırma iletilirse döndürülen veriler bunun yerine iletilir.

Parametreler

  • seçenekler

    ScanOptions

    Tarama parametrelerini içeren bir nesne.

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (result: ScanResults) => void

İadeler

  • Promise<ScanResults>

    Chrome 96 veya daha yeni bir sürüm

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

setOptions()

Promise Chrome 125 ve sonraki sürümler 
chrome.documentScan.setOptions(
  scannerHandle: string,
  options: OptionSetting[],
  callback?: function,
): Promise<SetOptionsResponse>

Belirtilen tarayıcıda seçenekleri ayarlar ve iletilen OptionSetting nesnesindeki her değeri sırayla ayarlama denemesinin sonucunu içeren bir SetOptionsResponse nesnesiyle çözümlenen bir Promise döndürür. Geri çağırma kullanılırsa nesne bunun yerine geri çağırmaya iletilir.

Parametreler

  • scannerHandle

    dize

    Seçenekleri ayarlamak için tarayıcının tutma yeri. Bu, daha önce openScanner çağrısından döndürülen bir değer olmalıdır.

  • seçenekler

    OptionSetting[]

    Tarayıcıya uygulanacak OptionSetting nesnelerinin listesi.

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (response: SetOptionsResponse) => void

İadeler

  • Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

startScan()

Promise Chrome 125 ve sonraki sürümler 
chrome.documentScan.startScan(
  scannerHandle: string,
  options: StartScanOptions,
  callback?: function,
): Promise<StartScanResponse>

Belirtilen tarayıcıda tarama başlatır ve StartScanResponse ile çözümlenen bir Promise döndürür. Geri çağırma kullanılırsa nesne bunun yerine geri çağırmaya iletilir. Arama başarılı olursa yanıtta, tarama verilerini okumak veya taramayı iptal etmek için sonraki aramalarda kullanılabilecek bir iş tanıtıcısı bulunur.

Parametreler

  • scannerHandle

    dize

    Açık bir tarayıcının tutma yeri. Bu, daha önce openScanner çağrısından döndürülen bir değer olmalıdır.

  • seçenekler

    StartScanOptions

    Tarama için kullanılacak seçenekleri belirten bir StartScanOptions nesnesi. StartScanOptions.format özelliği, tarayıcının ScannerInfo içinde döndürülen girişlerden biriyle eşleşmelidir.

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (response: StartScanResponse) => void

İadeler

  • Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.