chrome.documentScan

Önemli: Bu API yalnızca ChromeOS'te çalışır.

Açıklama

Ekli belge tarayıcılardan resim keşfetmek ve almak için chrome.documentScan API'yi kullanın.

Document Scan API, uygulamaların ve uzantıların ekli belge tarayıcıda kağıt doküman içeriği.

İzinler

documentScan

Kullanılabilirlik

Chrome 44 ve sonraki sürümler Yalnızca ChromeOS

Daha sonra eklenen API üyelerinin müsaitlik durumu bu üyelerle birlikte gösterilir.

Kavramlar ve kullanım

Bu API, belgelerin taranması için iki yöntemi destekler. Kullanım alanınız işe yaradıysa veya yapılandırma denetimini gerektirmeden çalışır duruma getirmek için scan() yöntemini çağırın. Daha karmaşık kullanım alanları için yöntemlerin, yalnızca Chrome 124 ve sonraki sürümlerde desteklenir.

Basit tarama

Basit kullanım alanları için, yani herhangi bir tarayıcıyla çalışabilen ve çalışmayanlar yapılandırmanın denetiminin zorunlu olmasını gerektiriyor, scan() çağrısı yap. Bu yöntemde ScanOptions nesnesini ifade eder ve ScanResults ile çözümlenen bir Vaat döndürür. nesnesini tanımlayın. Bu seçeneğin özellikleri tarama sayısı ve arayan tarafından kabul edilecek MIME türlerini belirtir. Taramalar, URL olarak döndürülür kullanıcı arayüzüne yönelik <img> etiketinde gösterilir.

Karmaşık tarama

Karmaşık taramalar, bu bölümde açıklanan üç aşamada gerçekleştirilir. Bu özet, her yöntem bağımsız değişkenini veya döndürülen her özelliği açıklamaz yanıt olarak gönderebilirsiniz. Yalnızca yazma tarayıcısı konusunda genel bir rehber sunmak amacıyla hazırlanmıştır. girin.

Not: openScanner() aranıyor, getScannerList() veya startScan() birden fazla kez yapıldığında işlemler iptal edilir bu yöntemlere yapılan önceki çağrılarla başlatılır. Bu öğrenin.

Discovery

1. getScannerList() numaralı telefonu arayın. Mevcut tarayıcılar: tekrar GetScannerListResponse.

   • Yanıt nesnesi, ScannerInfo dizisi içeriyor nesneler'i tıklayın.
   • Dizi, tek bir tarayıcı için birden fazla giriş içerebilir. birden çok protokolü veya bağlantı yöntemini destekler.

2. Döndürülen diziden bir tarayıcı seçin ve scannerId mülk.

   Bağımsız ScannerInfo nesnelerinin özelliklerini kullanın aynı tarayıcıda birden çok nesneyi ayırt etmek için kullanılır. Nesneler: aynı tarayıcı, deviceUuid özelliği için aynı değere sahip olur. ScannerInfo,imageFormats desteklenen resim türleri.

Tarayıcı yapılandırması

1. openScanner() numaralı telefonu arayarak kayıtlı tarayıcı kimliğini iletin. OpenScannerResponse ile çözümlenen bir Vaat döndürür. Yanıt nesnesi şunları içerir:

   • Kaydetmeniz gereken bir scannerHandle özelliği.

   • Tarayıcıya özgü özellikler içeren bir seçenek özelliği belirlemeniz gerekir. Daha fazla bilgi için Tarayıcı seçeneklerini alma konusuna bakın.

2. (İsteğe bağlı) Kullanıcının tarayıcı seçenekleri için değer sağlaması gerekiyorsa, kullanıcı arayüzü oluşturma. Google Etiket Yöneticisi tarafından sağlanan tarayıcı seçeneklerine ve tarayıcı. Daha fazla bilgi için Kullanıcı arayüzü oluşturma başlıklı makaleye bakın.

3. Şunu kullanarak bir OptionSetting nesne dizisi oluşturma: programatik veya kullanıcı tarafından sağlanan değerlerdir. Daha fazla bilgi için Tarayıcı seçeneklerini ayarlama konusuna bakın ekleyebilirsiniz.

4. OptionSetting nesne dizisini şuraya geçirin: Tarayıcı seçeneklerini ayarlamak için setOptions(). Google şöyle bir Vaat döndürür: SetOptionsResponse. Bu nesne bir içeriyor tarayıcının 1. adımında alınan tarayıcı seçeneklerinin güncellenmiş sürümü yapılandırma.

   Birini değiştirdiğinizden bu yana başka bir seçenekteki kısıtlamaları değiştirebilir. Bunları tekrarlamak için birkaç kez deneyin.

Tarama

1. Bir StartScanOptions nesnesi oluşturup iletin Hedef: startScan(). Şuna dair bir Vaat döndürür: StartScanResponse kullanın. Bu job mülkü tarama verilerini okumak veya taramayı iptal etmek için kullanacağınız bir herkese açık kullanıcı adı.

2. İş herkese açık kullanıcı adını readScanData() adlı kullanıcıya iletin. Bir ReadScanDataResponse nesnesini tanımlayın. Veriler okunduysa başarılı bir şekilde, result özelliği SUCCESS ile data mülküne eşittir şunu içerir: ArrayBuffer elde edilir. estimatedCompletion değerinin tahmini bir değer içerdiğini unutmayın şimdiye kadar teslim edilen toplam verinin yüzdesi.

   Not: result SUCCESS ise ancak data boşsa readScanData() öğesini tekrar çağırmadan önce kısa bir süre bekleyin.

3. result özelliği, EOF değerine eşit veya bir hata döndürene kadar önceki adımı tekrarlayın.

Taramanın sonuna gelindiğinde Adımda kayıtlı tarayıcı tutma yeriyle closeScanner() 3. CloseScannerResponse. Telefon etme cancelScan(), iş oluşturulduktan sonra şu işlemleri yapar: taramayı sonlandırın.

Yanıt nesneleri

Tüm yöntemler bir tür yanıt nesnesiyle çözümlenen bir Vaat döndürür. Bunların çoğu, değeri şöyle bir result özelliği içerir: OperationResult Yanıt nesnelerinin bazı özellikleri dizesi, result değeri belirli bir değere sahip olmadığı sürece değer içermez. Bu ilişkilerinin her bir yanıt nesnesinin referansında açıklanması gerekir.

Örneğin, OpenScannerResponse.scannerHandle yalnızca şu durumlarda bir değere sahip olur: OpenScannerResponse.result eşittir SUCCESS.

Tarayıcı seçenekleri

Tarayıcı seçenekleri cihaza göre önemli ölçüde farklılık gösterir. Sonuç olarak, tarayıcı seçeneklerini doğrudan DocumentScan API'sinde yansıtıyor. Gezinmek için bu, OpenScannerResponse ( openScanner()) ve SetOptionsResponse ( setOptions()) şunu içeren bir options mülkü içerir: Tarayıcıya özgü seçenekler içeren nesnel. Her seçenek bir anahtar/değer eşlemesidir Burada anahtar, cihaza özel bir seçenek, değer de ScannerOption.

Yapı genellikle aşağıdaki gibi görünür:

{
  "key1": { scannerOptionInstance }
  "key2": { scannerOptionInstance }
}

Örneğin, "source" adlı seçenekleri döndüren bir tarayıcı düşünün ve "çözüm". Döndürülen options nesnesinin yapısı, aşağıdaki örnekteki gibidir. Kolaylık sağlaması için yalnızca bir kısmı ScannerOption yanıt gösteriliyor.

{
  "source": {
    "name": "source",
    "type": OptionType.STRING,
...
},
  "resolution": {
    "name": "resolution",
    "type": OptionType.INT,
...
  },
...
}

Kullanıcı arayüzü oluşturma

Bu API'yi kullanmak zorunlu olmasa da, bir kullanıcının tercih edebilirsiniz. Bunun için kullanıcı arayüzü gerekir. Şunu kullanın: OpenScannerResponse (açan: openScanner()) tıklayın önceki bölümde anlatıldığı gibi.

Bazı tarayıcılar, seçenekleri cihaza özel şekilde gruplandırır. Seçeneği etkilemez. olabilir, ancak tarayıcının ürününde bu gruplardan bahsedilebileceği için bu tür gruplar kullanıcıya gösterilmelidir. Bunları geri alabilirsiniz: grupları getOptionGroups() numaralı telefondan arayabilirsiniz. Bu, GetOptionGroupsResponse nesnesini tanımlayın. Saat: groups mülkündeki kod, tarayıcıya özgü bir grup dizisi içerir. Şuradaki bilgileri kullanın: seçenekleri düzenlemek için bu grupları Görüntülü reklam için OpenScannerResponse.

{
  scannerHandle: "123456",
  result: SUCCESS,
  groups: [
    {
      title: "Standard",
      members: [ "resolution", "mode", "source" ]
    }
  ]
}

Tarayıcı yapılandırmasında belirtildiği gibi, bir seçeneğin değiştirilmesi kısıtlamaları değiştirebilir başka bir seçenekte. İşte bu nedenle setOptionsResponse (şunun yanıt nesnesi: setOptions()), başka bir options mülkü içeriyor. Tekliflerinizi otomatikleştirmek ve optimize etmek için kullanıcı arayüzünü güncellemek için bunu tıklayın. Daha sonra, tüm seçenekler mevcut olana kadar işlemi gerektiği kadar tekrarlayın ayarlandı.

Tarayıcı seçeneklerini ayarlayın

Tarayıcı seçeneklerini ayarlamak için OptionSetting nesne setOptions(). Örnek için aşağıdaki Harf boyutunda bir sayfa tarama bölümüne bakın.

Örnekler

Bir sayfayı blob olarak alma

Bu örnekte, bir sayfayı tarayıcıdan blob olarak almanın bir yolu ve , startScan() ve readScanData() OperationResult.

async function pageAsBlob(handle) {
  let response = await chrome.documentScan.startScan(
      handle, {format: "image/jpeg"});
  if (response.result != chrome.documentScan.OperationResult.SUCCESS) {
    return null;
  }
  const job = response.job;

  let imgParts = [];
  response = await chrome.documentScan.readScanData(job);
  while (response.result == chrome.documentScan.OperationResult.SUCCESS) {
    if (response.data && response.data.byteLength > 0) {
        imgParts.push(response.data);
    } else {
      // Delay so hardware can make progress.
      await new Promise(r => setTimeout(r, 100));
    }
    response = await chrome.documentScan.readScanData(job);
  }
  if (response.result != chrome.documentScan.OperationResult.EOF) {
    return null;
  }
  if (response.data && response.data.byteLength > 0) {
    imgParts.push(response.data);
  }
  return new Blob(imgParts, { type: "image/jpeg" });
}

Harf boyutunda bir sayfayı tarayın

Bu örnekte bir tarayıcının nasıl seçileceği, seçeneklerinin nasıl ayarlanacağı ve açılacağı gösterilmektedir. Google daha sonra tek bir sayfanın içeriğini alır ve tarayıcıyı kapatır. Bu işlem getScannerList(), openScanner(), setOptions() ve bunların kullanımını gösterir closeScanner(). Sayfa içeriğinin pageAsBlob() işlevine gidin.

async function scan() {
    let response = await chrome.documentScan.getScannerList({ secure: true });
    let scanner = await chrome.documentScan.openScanner(
        response.scanners[0].scannerId);
    const handle = scanner.scannerHandle;

    let options = [];
    for (source of scanner.options["source"].constraint.list) {
        if (source.includes("ADF")) {
            options.push({
                name: "source",
                type: chrome.documentScan.OptionType.STRING,
                value: { value: source }
            });
            break;
        }
    }
    options.push({
        name: "tl-x",
        type: chrome.documentScan.OptionType.FIXED,
        value: 0.0
    });
    options.push({
        name: "br-x",
        type: chrome.documentScan.OptionType.FIXED,
        value: 215.9  // 8.5" in mm
    });
    options.push({
        name: "tl-y",
        type: chrome.documentScan.OptionType.FIXED,
        value: 0.0
    });
    options.push({
        name: "br-y",
        type: chrome.documentScan.OptionType.FIXED,
        value: 279.4  // 11" in mm
    });
    response = await chrome.documentScan.setOptions(handle, options);

    let imgBlob = await pageAsBlob(handle);
    if (imgBlob != null) {
        // Insert imgBlob into DOM, save to disk, etc
    }
    await chrome.documentScan.closeScanner(handle);
}

Yapılandırmayı göster

Başka bir yerde belirtildiği gibi, tarayıcının yapılandırma seçeneklerini kullanıcıya göstermek için web sitesinden döndürülen tarayıcı seçeneklerine ek olarak getOptionGroups() openScanner() numaralı telefona sesli arama yapın. Böylece seçenekler, belirli bir bölgedeki kullanıcılara ürün grupları oluşturabilirsiniz. Bu örnekte, bunun nasıl yapılacağı gösterilmektedir.

async function showConfig() {
  let response = await chrome.documentScan.getScannerList({ secure: true });
  let scanner = await chrome.documentScan.openScanner(
      response.scanners[0].scannerId);
  let groups = await chrome.documentScan.getOptionGroups(scanner.scannerHandle);

  for (const group of groups.groups) {
    console.log("=== " + group.title + " ===");
    for (const member of group.members) {
      const option = scanner.options[member];
      if (option.isActive) {
        console.log("  " + option.name + " = " + option.value);
      } else {
        console.log("  " + option.name + " is inactive");
      }
    }
  }
}

Türler

CancelScanResponse

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Özellikler

• iş

  dize

  cancelScan() adlı iş ortağına geçirilen işin aynısını sağlar.

• sonuç

  OperationResult

  Arka ucun tarama iptali sonucu. Sonuç OperationResult.SUCCESS veya OperationResult.CANCELLED ise tarama iptal edilmiştir ve tarayıcı yeni bir tarama başlatmaya hazırdır. Sonuç OperationResult.DEVICE_BUSY ise tarayıcı , istenen iptal işlemini hâlâ gerçekleştiriyordur; arayanın kısa bir süre beklemesi ve isteği tekrar denemesi gerekir. Diğer sonuç değerleri, yeniden denenmemesi gereken kalıcı bir hatayı gösterir.

CloseScannerResponse

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Özellikler

• sonuç

  OperationResult

  Tarayıcının kapatılmasının sonucu. Bu değer SUCCESS olmasa bile, herkese açık kullanıcı adı geçersiz olur ve başka işlemler için kullanılmamalıdır.

• scannerHandle

  dize

  closeScanner içine geçirilen tarayıcı tutma yeri aynı.

Configurability

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Seçeneklerin nasıl değiştirilebileceği

Enum

"NOT_CONFIGURABLE"
Bu seçenek salt okunurdur.

"SOFTWARE_CONFIGURABLE"
Bu seçenek, yazılımın içinden ayarlanabilir.

"HARDWARE_CONFIGURABLE"
Bu seçenek, kullanıcının tarayıcıdaki bir düğmeyi açıp kapatarak veya düğmeye basarak ayarlanabilir.

ConnectionType

Chrome 125 ve sonraki sürümler 'nı inceleyin.

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

Enum

"BELİRTİLMEMİŞ"

"USB"

"AĞ"

ConstraintType

Chrome 125 ve sonraki sürümler 'nı inceleyin.

OptionConstraint ile temsil edilen kısıtlama veri türü.

Enum

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

"FIXED_RANGE"
OptionType.FIXED değer aralığındaki bir kısıtlama. OptionConstraint öğesinin min, max ve quant özellikleri double olacak, list özelliği ayarlanacak.

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

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

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

DeviceFilter

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Özellikler

• local

  boole isteğe bağlı

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

• güvenli

  boole isteğe bağlı

  Yalnızca USB veya TLS gibi güvenli bir aktarım kullanan tarayıcıları döndürün.

GetOptionGroupsResponse

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Özellikler

• groups

  OptionGroup[] isteğe bağlı

  result değeri SUCCESS ise tarayıcı sürücüsü tarafından belirtilen sırada bir seçenek gruplarının listesini sağlar.

• sonuç

  OperationResult

  Seçenek gruplarının alınmasının sonucu. Bunun değeri SUCCESS ise groups özelliği doldurulur.

• scannerHandle

  dize

  getOptionGroups içine geçirilen tarayıcı tutma yeri aynı.

GetScannerListResponse

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Özellikler

• sonuç

  OperationResult

  Numaralandırma sonucu. Bu bir hata olduğunu belirtse bile kısmi sonuçların döndürülebileceğini unutmayın.

• Tarayıcılar

  ScannerInfo[]

  Sağlanan DeviceFilter ile eşleşen tarayıcıların listesi boş olabilir.

OpenScannerResponse

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Özellikler

• seçenekler

  nesne isteğe bağlı

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

• sonuç

  OperationResult

  Tarayıcının açılma sonucu. Bunun değeri SUCCESS ise scannerHandle ve options özellikleri doldurulur.

• scannerHandle

  dize isteğe bağlı

  result değeri SUCCESS ise tarayıcının gelecekteki işlemler için kullanılabilecek bir herkese açık kullanıcı adı.

• scannerId

  dize

  openScanner() adlı cihaza iletilen tarayıcı kimliği.

OperationResult

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Her işlemin sonucunu gösteren bir sıralama.

Enum

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

"BAŞARILI"
İşlem başarılı oldu.

"UNSUPPORTED"
İşlem desteklenmiyor.

"İPTAL EDİLDİ"
İşlem iptal edildi.

"DEVICE_BUSY"
Cihaz meşgul.

"GEÇERSİZ"
Yönteme iletilen veriler veya 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ü.

"EOF"
Başka veri yok.

"ADF_JAMMED"
Doküman besleyici sıkışmış.

"ADF_EMPTY"
Belge besleyici boş.

"COVER_OPEN"
Düz yatak kapağı açık.

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

"ACCESS_DENIED"
Cihaz kimlik doğrulama gerektiriyor.

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

"UNREACHABLE"
Cihaza erişilemiyor.

"MISSING"
Cihazın bağlantısı kesildi.

"INTERNAL_ERROR"
Çağrı yapan uygulamanın dışında bir hata oluştu.

OptionConstraint

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Özellikler

• list

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

• maks.

  sayı isteğe bağlı

• dk

  sayı isteğe bağlı

• miktar

  sayı isteğe bağlı

• tür

  ConstraintType

OptionGroup

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Özellikler

• üyeler

  dize[]

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

• title

  dize

  "Geometri seçenekleri" gibi yazdırılabilir bir başlık sağlar.

OptionSetting

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Özellikler

• ad

  dize

  Ayarlanacak seçeneğin adını belirtir.

• tür

  OptionType

  Seçeneğin veri türünü belirtir. İstenen veri türü, temel seçeneğin gerçek veri türüyle eşleşmelidir.

• value

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

  Ayarlanacak değeri gösterir. autoSettable öğesinin etkin olduğu seçenekler için otomatik ayar yapılmasını istemek için ayarlamadan bırakın. value için sağlanan veri türü, type ile eşleşmelidir.

OptionType

Chrome 125 ve sonraki sürümler 'nı inceleyin.

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

Enum

"UNKNOWN"
Seçeneğin veri türü bilinmiyor. value özelliği ayarlanmaz.

"BOOL"
value özelliği, truefalse değerlerinden biri olacaktır.

"INT"
İmzalı 32 bitlik bir tam sayı. value özelliği, seçeneğin birden fazla değer almasına bağlı olarak uzun veya uzun olur[].

"SABİTLENMİŞ"
-32768-32767,9999 aralığında 1/65535 çözünürlüğe sahip bir çift. value özelliği, seçeneğin birden fazla değer almasına bağlı olarak çift veya çift[] olur. Tam olarak temsil edilemeyen çift değerler, kullanılabilir aralığa ve hassasiyete yuvarlanır.

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

"Button"
Bu tür bir seçeneğin değer 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ü tarafından varsayılan değerleri seçmeye yönelik bir yöntem sağlamak veya otomatik belge besleyiciye sonraki kağıda ilerlemesini söylemek için düğmeyle yazılan bir seçenek kullanılabilir.

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

OptionUnit

Chrome 125 ve sonraki sürümler 'nı inceleyin.

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

Enum

"UNITLESS"
Değer, birimsiz bir sayıdır. Örneğin, bu 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 (ör. tarama boyutları).

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

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

"MİKRO İKİNCİ"
Değer, mikrosaniye cinsinden ölçülür (ör. pozlama süresi).

ReadScanDataResponse

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Özellikler

• veri

  ArrayBuffer isteğe bağlı

  result değeri SUCCESS ise taranan resim verilerinin sonraki parçasını içerir. result değeri EOF ise taranan resim verilerinin son parçasını içerir.

• estimatedCompletion

  sayı isteğe bağlı

  result değeri SUCCESS ise 0 ile 100 aralığında şu ana kadar toplam tarama verilerinin ne kadarının teslim edildiğine dair bir tahmin.

• iş

  dize

  readScanData() işlevine iletilen iş herkese açık kullanıcı adını sağlar.

• sonuç

  OperationResult

  Veri okuma işleminin sonucu. Değeri SUCCESS ise data, okunmaya hazır sonraki (muhtemelen sıfır uzunlukta) resim veri parçasını içerir. Değeri EOF ise data, resim verisinin son parçasını içerir.

ScannerInfo

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Ö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 yapmak için kullanılır.

• imageFormats

  dize[]

  Döndürülen taramalar için istenebilecek bir MIME türü 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örüntülemek üzere kullanıcılar tarafından okunabilen ad.

• protocolType

  dize

  Tarayıcıya erişmek için kullanılan protokolün veya sürücünün (ör. Mopria, WSD veya epsonds) kullanıcılar tarafından okunabilen açıklaması. Bu, cihaz birden fazla protokolü destekliyorsa kullanıcının protokoller arasında seçim yapmasına izin vermek için öncelikli olarak kullanışlıdır.

• scannerId

  dize

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

• güvenli

  boolean

  Doğru değerine ayarlanırsa, tarayıcı bağlantısının aktarımına TLS veya USB gibi pasif bir dinleyici tarafından müdahale edilemez.

ScannerOption

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Özellikler

• yapılandırılabilirlik

  Yapılandırılabilirlik

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

• 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 bir açıklaması.

• isActive

  boolean

  Seçeneğin etkin olduğunu ve ayarlanabileceğini veya alınabileceğini belirtir. Yanlış değerine ayarlanırsa value özelliği ayarlanmaz.

• isAdvanced

  boolean

  Kullanıcı arayüzünün bu seçeneği varsayılan olarak görüntülememesi 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 belirtir.

• isEmulated

  boolean

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

• ad

  dize

  Küçük ASCII harfleri, sayılar ve kısa çizgiler kullanan seçenek adı. Aksan işaretlerine izin verilmiyor.

• title

  dize

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

• tür

  OptionType

  value özelliğinde yer alan ve bu seçeneğin ayarlanması için gerekli olan veri türü.

• birim

  OptionUnit

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

• value

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

  Gerekiyorsa seçeneğin mevcut değeri. Bu mülkün veri türünün, type özelliğinde belirtilen veri türüyle eşleşmesi gerektiğini unutmayın.

ScanOptions

Özellikler

• maxImages

  sayı 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[]

  "src" olarak iletilebilecek bir formdaki veri görüntüsü URL'leri dizisi bir resim etiketine eklemeniz gerekir.

• mimeType

  dize

  dataUrls öğesinin MIME türü.

SetOptionResult

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Özellikler

• ad

  dize

  Ayarlanan seçeneğin adını belirtir.

• sonuç

  OperationResult

  Seçeneği ayarlamanın sonucunu gösterir.

SetOptionsResponse

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Özellikler

• seçenekler

  nesne isteğe bağlı

  Sağlanan tüm seçenekleri ayarlamaya çalıştıktan sonra seçenek adlarından yeni yapılandırmayı içeren ScannerOption değerlerine yönelik anahtar/değer eşlemesi güncellendi. Bu, OpenScannerResponse içindeki options mülküyle aynı yapıya sahiptir.

  Bu özellik, bazı seçenekler başarıyla ayarlanmamış olsa bile ayarlanır, ancak güncellenen yapılandırmanın alınması başarısız olursa (örneğin, tarama sırasında tarayıcının bağlantısı kesilirse) ayarlanmaz.

• sonuç

  SetOptionResult[]

  Geçilen her OptionSetting için bir sonuç dizisi.

• scannerHandle

  dize

  setOptions() işlevine geçirilen tarayıcı tutma yerini sağlar.

StartScanOptions

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Özellikler

• format

  dize

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

• maxReadSize

  sayı isteğe bağlı

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

StartScanResponse

Chrome 125 ve sonraki sürümler 'nı inceleyin.

Özellikler

• iş

  dize isteğe bağlı

  result değeri SUCCESS ise tarama verilerini okumak veya işi iptal etmek için kullanılabilecek bir herkese açık kullanıcı adı sağlar.

• sonuç

  OperationResult

  Tarama işleminin sonucu. Bunun değeri SUCCESS ise job özelliği doldurulur.

• scannerHandle

  dize

  startScan() içine geçirilen tarayıcı tutma yerini sağlar.

Yöntemler

cancelScan()

Söz Chrome 125 ve sonraki sürümler

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

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

Parametreler

• iş

  dize

  Daha önce startScan için yapılan bir çağrıdan döndürülen etkin bir tarama işinin herkese açık kullanıcı adı.

• geri çağırma

  işlev isteğe bağlı

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

  (response: CancelScanResponse) => void

  • yanıt

    CancelScanResponse

İadeler

• Promise<CancelScanResponse>

  Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

closeScanner()

Söz Chrome 125 ve sonraki sürümler

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

İletilen herkese açık kullanıcı adıyla tarayıcıyı kapatır ve CloseScannerResponse nesnesiyle çözümlenen bir Vaat döndürür. Geri çağırma kullanılırsa bunun yerine nesne ona iletilir. Yanıt başarılı olmasa bile, sağlanan herkese açık kullanıcı adı geçersiz hale gelir ve bundan sonraki işlemler için kullanılmamalıdır.

Parametreler

• scannerHandle

  dize

  Daha önce openScanner için yapılan bir çağrıdan döndürülen açık bir tarayıcının herkese açık kullanıcı adını belirtir.

• geri çağırma

  işlev isteğe bağlı

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

  (response: CloseScannerResponse) => void

  • yanıt

    CloseScannerResponse

İadeler

• Promise<CloseScannerResponse>

  Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

getOptionGroups()

Söz Chrome 125 ve sonraki sürümler

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

Daha önce openScanner tarafından açılmış bir tarayıcıdan grup adlarını ve üye seçeneklerini 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 ona iletilir.

Parametreler

• scannerHandle

  dize

  openScanner'e yapılan bir aramadan döndürülen açık tarayıcının herkese açık kullanıcı adı.

• geri çağırma

  işlev isteğe bağlı

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

  (response: GetOptionGroupsResponse) => void

  • yanıt

    GetOptionGroupsResponse

İadeler

• Promise<GetOptionGroupsResponse>

  Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

getScannerList()

Söz Chrome 125 ve sonraki sürümler

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

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 ona iletilir.

Parametreler

• filtrele

  DeviceFilter

  Hangi tarayıcı türlerinin döndürülmesi gerektiğini gösteren bir DeviceFilter.

• geri çağırma

  işlev isteğe bağlı

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

  (response: GetScannerListResponse) => void

  • yanıt

    GetScannerListResponse

İadeler

• Promise<GetScannerListResponse>

  Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

openScanner()

Söz Chrome 125 ve sonraki sürümler

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

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

Parametreler

• scannerId

  dize

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

• geri çağırma

  işlev isteğe bağlı

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

  (response: OpenScannerResponse) => void

  • yanıt

    OpenScannerResponse

İadeler

• Promise<OpenScannerResponse>

  Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

readScanData()

Söz Chrome 125 ve sonraki sürümler

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

Etkin bir iş işleyiciden bir sonraki kullanılabilir görüntü verisi parçasını okur ve ReadScanDataResponse nesnesiyle çözümlenen bir Vaat döndürür. Geri çağırma kullanılırsa bunun yerine nesne ona iletilir.

**Not:**Sıfır uzunluklu data üyesine sahip bir yanıt sonucunun SUCCESS olması için geçerlidir. Bu, tarayıcının hâlâ çalıştığı ancak henüz ek verilerin hazır olmadığı anlamına gelir. Arayanın kısa bir süre bekleyip tekrar denemesi gerekir.

Tarama işi tamamlandığında yanıtın sonuç değeri EOF olur. Bu yanıt, değeri sıfır olmayan nihai bir data üye içerebilir.

Parametreler

• iş

  dize

  Daha önce startScan kaynağından döndürülen etkin iş herkese açık kullanıcı adı.

• geri çağırma

  işlev isteğe bağlı

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

  (response: ReadScanDataResponse) => void

  • yanıt

    ReadScanDataResponse

İadeler

• Promise<ReadScanDataResponse>

  Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

scan()

Söz 'nı inceleyin.

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

Bir doküman taraması gerçekleştirir ve ScanResults nesnesiyle çözümlenen bir Promise (Vaat) döndürür. Bu işleve bir geri çağırma iletilirse döndürülen veriler bunun yerine ona iletilir.

Parametreler

• seçenekler

  ScanOptions

  Tarama parametreleri içeren bir nesne.

• geri çağırma

  işlev isteğe bağlı

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

  (result: ScanResults) => void

  • sonuç

    ScanResults

İadeler

• Promise<ScanResults>

  Chrome 96 ve sonraki sürümler 'nı inceleyin.

  Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

setOptions()

Söz Chrome 125 ve sonraki sürümler

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

Belirtilen tarayıcıdaki seçenekleri ayarlar ve her değeri iletilen OptionSetting nesnesinin sırasına göre ayarlamaya çalışmanın sonucunu içeren SetOptionsResponse nesnesiyle çözümlenen bir Promise (Vadet) döndürür. Geri çağırma kullanılırsa bunun yerine nesne ona iletilir.

Parametreler

• scannerHandle

  dize

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

• seçenekler

  OptionSetting[]

  Tarayıcıya uygulanacak OptionSetting nesne listesi.

• geri çağırma

  işlev isteğe bağlı

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

  (response: SetOptionsResponse) => void

  • yanıt

    SetOptionsResponse

İadeler

• Promise<SetOptionsResponse>

  Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

startScan()

Söz Chrome 125 ve sonraki sürümler

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

Belirtilen tarayıcıda bir tarama başlatır ve StartScanResponse ile çözülen bir Vaat döndürür. Geri çağırma kullanılırsa bunun yerine nesne ona iletilir. Çağrı başarılı olduysa yanıtta, tarama verilerini okumak veya bir taramayı iptal etmek için sonraki çağrılarda 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 için yapılan bir çağrıdan döndürülen bir değer olmalıdır.

• seçenekler

  StartScanOptions

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

• geri çağırma

  işlev isteğe bağlı

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

  (response: StartScanResponse) => void

  • yanıt

    StartScanResponse

İadeler

• Promise<StartScanResponse>

  Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.