DSSDK logo Document Scanner SDK

//scanning/com.pixelnetica.scanning

Package-level declarations

Types

Name Summary
Device [androidJvm]
enum Device : Enum<Device>
Specify device or platform
FlashMode [androidJvm]
enum FlashMode : Enum<FlashMode>
Specify camera flash mode
FrameObserver [androidJvm]
class FrameObserver : ScanningSdkLibrary.Instance
Analyze camera frame(s) and compute characteristics All methods of this class can be called from different threads
ImageFileWriter [androidJvm]
interface ImageFileWriter
Using by ImageWriter to write an image already stored in the file
ImageWriter [androidJvm]
abstract class ImageWriter : ScanningSdkLibrary.Instance, Closeable
Writes ScanPicture in the different formats
ImageWriterPdf [androidJvm]
class ImageWriterPdf(file: File) : ImageWriter, ImageFileWriter
Write images to PDF
ImageWriterPng [androidJvm]
class ImageWriterPng(file: File) : ImageWriter
Write images to PNG
ImageWriterTiff [androidJvm]
class ImageWriterTiff(file: File) : ImageWriter
Write images to black-white TIFF. All colors will be binarized.
RefineFeature [androidJvm]
sealed class RefineFeature
Values for ScanPicture.refine must be collect to list by one each type
ScanCutout [androidJvm]
class ScanCutout : ScanningSdkLibrary.Instance, Parcelable
Represents document or another area in the picture Cutout means array of linked clockwise arranged points. Usually 4 points for a document but in the future cutout will may contains more points to represents more complex area
ScanDetector [androidJvm]
class ScanDetector : ScanningSdkLibrary.Instance
ScanLayout [androidJvm]
class ScanLayout : ScanningSdkLibrary.Instance
Represent layout of text for recognize
ScanningSdkException [androidJvm]
class ScanningSdkException : RuntimeException
Scanning SDK exception
ScanningSdkLibrary [androidJvm]
object ScanningSdkLibrary : Tag
Scanning SDK root
ScanOrientation [androidJvm]
enum ScanOrientation : Enum<ScanOrientation>
EXIF orientation values
ScanPicture [androidJvm]
class ScanPicture : ScanningSdkLibrary.Instance
Represents a picture
ScanReader [androidJvm]
class ScanReader : ScanningSdkLibrary.Instance
Recognize text on a picture
ScanText [androidJvm]
class ScanText : ScanningSdkLibrary.Instance, Parcelable
Contains text with layout as recognition result

Properties

Name Summary
hasText [androidJvm]
val ScanPicture.hasText: Boolean
Check ScanPicture contains valid text
profileType [androidJvm]
var MutableSet<RefineFeature>.profileType: RefineFeature.Profile.Type
Access profile-only values from RefineFeature
shadows [androidJvm]
var MutableSet<RefineFeature>.shadows: Boolean
Access RefineFeature.Shadows flag from RefineFeature

Functions

Name Summary
copy [androidJvm]
fun ScanCutout?.copy(): ScanCutout?
Safe copy cutout.
display [androidJvm]
fun ScanPicture.display()
getOrientation [androidJvm]
fun Bundle.getOrientation(name: String, default: ScanOrientation = ScanOrientation.Undefined): ScanOrientation
getOrientationExtra [androidJvm]
fun Intent.getOrientationExtra(name: String, default: ScanOrientation = ScanOrientation.Undefined): ScanOrientation
makeRefineProfile [androidJvm]
fun Int.makeRefineProfile(): RefineFeature.Profile
Parse kotlin.Int to RefineFeature.Profile set
makeTransform [androidJvm]
fun Bitmap.makeTransform(orientation: ScanOrientation): Matrix
Helper function to make exif matrix for any bitmap Used with scaled bitmaps
or [androidJvm]
infix fun EnumSet<ScanReader.Flag>.or(other: ScanReader.Flag): EnumSet<ScanReader.Flag>
Operator function to combine recognize flags
orUndefined [androidJvm]
fun ScanOrientation?.orUndefined(): ScanOrientation
Convert null ScanOrientation to non-null ScanOrientation.Undefined
putOrientation [androidJvm]
fun Bundle.putOrientation(name: String, orientation: ScanOrientation)
putOrientationExtra [androidJvm]
fun Intent.putOrientationExtra(name: String, orientation: ScanOrientation): Intent
rectify [androidJvm]
fun ScanCutout?.rectify(): RefineFeature
Safe define RefineFeature for nullable cutout
[androidJvm]
fun ScanPicture.rectify(cutout: ScanCutout)
A shortcut to call ScanPicture.refine to perform only crop Crop picture without color processing
resize [androidJvm]
fun ScanPicture.resize(size: Size, uniform: Boolean = false)
Resize picture to specified android.util.Size
safeMakeTransform [androidJvm]
fun Bitmap?.safeMakeTransform(orientation: ScanOrientation?): Matrix
toScanOrientation [androidJvm]
fun Int.toScanOrientation(): ScanOrientation
Parse kotlin.Int
withOrientation [androidJvm]
fun ScanPicture.withOrientation(newOrientation: ScanOrientation): ScanPicture
Create new picture with specified
Top