eSCLKt/io.github.chrisimx.esclkt

Package-level declarations

Types

@Serializable

data class Adf(val simplexCaps: InputSourceCaps, val duplexCaps: InputSourceCaps? = null, val feederCapacity: UInt? = null, val adfOptions: List<EnumOrRaw<AdfOption>>)

AdfOption

enum AdfOption : Enum<AdfOption>

AdfOptionListSerializer

object AdfOptionListSerializer : KSerializer<List<EnumOrRaw<AdfOption>>>

AdfState

enum AdfState : Enum<AdfState>

BinaryRendering

enum BinaryRendering : Enum<BinaryRendering>

CcdChannel

enum CcdChannel : Enum<CcdChannel>

CcdChannelListSerializer

object CcdChannelListSerializer : KSerializer<List<EnumOrRaw<CcdChannel>>>

CcdChannelSerializer

object CcdChannelSerializer : KSerializer<EnumOrRaw<CcdChannel>>

Certification

@Serializable

data class Certification(val name: String, val version: String)

ColorMode

enum ColorMode : Enum<ColorMode>

ColorModeListSerializer

object ColorModeListSerializer : KSerializer<List<EnumOrRaw<ColorMode>>>

CompressionFactorSupport

@Serializable

data class CompressionFactorSupport(val min: Int, val max: Int, val normal: Int, val step: Int)

ContentType

enum ContentType : Enum<ContentType>

ContentTypeDataListSerializer

object ContentTypeDataListSerializer : KSerializer<List<EnumOrRaw<ContentType>>>

ContentTypeDataSerializer

object ContentTypeDataSerializer : KSerializer<EnumOrRaw<ContentType>>

DiscreteResolution

@Serializable

data class DiscreteResolution(val xResolution: UInt, val yResolution: UInt)

DocumentFormats

@Serializable(with = DocumentFormatsSerializer::class)

data class DocumentFormats(val documentFormats: List<String>, val documentFormatExt: List<String>)

DocumentFormatsSerializer

object DocumentFormatsSerializer : KSerializer<DocumentFormats>

Edge

enum Edge : Enum<Edge>

EnumOrRaw

sealed class EnumOrRaw<E : Enum<E>>

EnumOrRawSerializer

class EnumOrRawSerializer<E : Enum<E>>(enumValues: Array<E>) : KSerializer<EnumOrRaw<E>>

ESCLHttpCallResult

sealed class ESCLHttpCallResult<out T>

ESCLQuirkFilteringReader

class ESCLQuirkFilteringReader(reader: XmlReader) : XmlDelegatingReader

An XMLReader that filters out scanner quirks

ESCLRequestClient

class ESCLRequestClient(val baseUrl: Url, val usedHttpClient: HttpClient = HttpClient { install(HttpTimeout) { requestTimeoutMillis = 100_000 connectTimeoutMillis = 100_000 socketTimeoutMillis = 100_000 } })

A client for the eSCL scanning protocol

ESCLXml

class ESCLXml

FeedDirection

enum FeedDirection : Enum<FeedDirection>

Inches

@Serializable

@JvmInline

value class Inches(val value: Double) : LengthUnit

InputSource

enum InputSource : Enum<InputSource>

InputSourceCaps

@Serializable

data class InputSourceCaps(val minWidth: ThreeHundredthsOfInch, val maxWidth: ThreeHundredthsOfInch, val minHeight: ThreeHundredthsOfInch, val maxHeight: ThreeHundredthsOfInch, val maxScanRegions: UInt?, val maxOpticalXResolution: UInt?, val maxOpticalYResolution: UInt?, val riskyLeftMargin: ThreeHundredthsOfInch?, val riskyRightMargin: ThreeHundredthsOfInch?, val riskyTopMargin: ThreeHundredthsOfInch?, val riskyBottomMargin: ThreeHundredthsOfInch?, val maxPhysicalWidth: ThreeHundredthsOfInch?, val maxPhysicalHeight: ThreeHundredthsOfInch?, val settingProfiles: List<SettingProfile>, val supportedIntents: List<EnumOrRaw<ScanIntent>>, val edgeAutoDetection: List<Edge>)

JobInfo

@Serializable

data class JobInfo(val jobURI: String, val jobUUID: String, val age: UInt, val imagesCompleted: UInt, val imagesToTransfer: UInt? = null, val transferRetryCount: UInt? = null, val jobState: JobState, val jobStateReasons: List<String>? = null)

JobState

enum JobState : Enum<JobState>

JsError

data class JsError(val message: String?, val cause: String?, val name: String?, val stack: String?)

LengthUnit

sealed interface LengthUnit

Millimeters

@Serializable

@JvmInline

value class Millimeters(val value: Double) : LengthUnit

Platen

@Serializable

data class Platen(val inputSourceCaps: InputSourceCaps)

Result

sealed class Result<T>

ScanImageInfo

@Serializable

data class ScanImageInfo(val jobURI: String, val jobUuid: Uuid, val actualWidth: UInt, val actualHeight: UInt, val actualBytesPerLine: UInt, val blankPageDetected: Boolean?)

ScanIntent

enum ScanIntent : Enum<ScanIntent>

ScanIntentDataListSerializer

object ScanIntentDataListSerializer : KSerializer<List<EnumOrRaw<ScanIntent>>>

ScanIntentDataSerializer

object ScanIntentDataSerializer : KSerializer<EnumOrRaw<ScanIntent>>

ScanJob

class ScanJob(val jobUri: String, val esclClient: ESCLRequestClient, val scanSettings: ScanSettings)

ScannerCapabilities

@Serializable

data class ScannerCapabilities(val interfaceVersion: String, val makeAndModel: String, val manufacturer: String? = null, val deviceUuid: Uuid? = null, val serialNumber: String, val adminURI: String? = null, val iconURI: String? = null, val certifications: List<Certification>? = null, val platen: Platen? = null, val adf: Adf? = null, val supportedMediaTypes: List<String>? = null, val sharpenSupport: SharpenSupport? = null, val compressionFactorSupport: CompressionFactorSupport? = null, val storedJobRequestSupport: StoredJobRequestSupport? = null)

ScannerState

enum ScannerState : Enum<ScannerState>

ScannerStatus

@Serializable

data class ScannerStatus(val version: String, val state: ScannerState, val jobs: List<JobInfo> = listOf(), val adfState: AdfState? = null)

ScanRegion

@Serializable

data class ScanRegion(val height: ThreeHundredthsOfInch, val width: ThreeHundredthsOfInch, val xOffset: ThreeHundredthsOfInch, val yOffset: ThreeHundredthsOfInch)

ScanRegions

@Serializable

data class ScanRegions(val regions: List<ScanRegion>, val mustHonor: Boolean = true)

ScanSettings

@Serializable

data class ScanSettings(val version: String, val intent: EnumOrRaw<ScanIntent>? = null, val scanRegions: ScanRegions? = null, val documentFormat: String? = null, val documentFormatExt: String? = null, val contentType: EnumOrRaw<ContentType>? = null, val inputSource: InputSource? = null, val xResolution: UInt? = null, val yResolution: UInt? = null, val colorMode: ColorMode? = null, val colorSpace: String? = null, val mediaType: String? = null, val ccdChannel: CcdChannel? = null, val binaryRendering: BinaryRendering? = null, val duplex: Boolean? = null, val numberOfPages: UInt? = null, val brightness: UInt? = null, val compressionFactor: UInt? = null, val contrast: UInt? = null, val gamma: UInt? = null, val highlight: UInt? = null, val noiseRemoval: UInt? = null, val shadow: UInt? = null, val sharpen: UInt? = null, val threshold: UInt? = null, val contextID: String? = null, val blankPageDetection: Boolean? = null, val feedDirection: FeedDirection? = null, val blankPageDetectionAndRemoval: Boolean? = null)

SettingProfile

@Serializable