ImageSdkLibrary (Pixelnetica DSSDK Documentation)

java.lang.Object
- com.pixelnetica.imagesdk.ImageSdkLibrary

```
public class ImageSdkLibrary
extends Object
```
Pixelnetica Document Imaging SDK used to create and configure various SDK objects

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ImageSdkLibrary.ImageWriterType
ImageWriterImpl instance type

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ImageSdkLibrary.ImageWriterType` `ImageWriterImpl` instance type

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`IMAGE_WRITER_JPEG` Create an Android's JPEG writer.
`static int`	`IMAGE_WRITER_PDF` Create writer to save images in a PDFs That writer supports interface `ImageFileWriter`
`static int`	`IMAGE_WRITER_PNG` Create an Android's PNG writer
`static int`	`IMAGE_WRITER_PNG_EXT` Create writer to save images as PNG using DI SDK.
`static int`	`IMAGE_WRITER_TIFF` Create writer for monochrome TIFF (G4 compression) images.
`static int`	`IMAGE_WRITER_UNKNOWN` Some invalid value to use as "nothing"
`static int`	`IMAGE_WRITER_WEBM` Create an Android's WEBM writer
`static String`	`SDK_CHECK_DOCUMENT_GEOMETRY` Constant string to perform an additional Effective Document Area (the area Document occupies in viewfinder by itself without surrounding space) check.
`static String`	`SDK_DOCUMENT_DISTORTION_CHECKED` Constant string to get Document distortion check result
`static String`	`SDK_DOCUMENT_DISTORTION_RATE` Deprecated.
`static String`	`SDK_DOCUMENT_FULLNESS_CHECKED` Constant string to get Document area check result
`static String`	`SDK_DOCUMENT_FULLNESS_RATE` Internal use
`static String`	`SDK_IS_SMART_CROP` Constant string to get detection quality
`static String`	`TAG`
`static String`	`version`

Constructor Summary

Constructors
Constructor and Description
`ImageSdkLibrary()` Create `ImageSdkLibrary` instance with `Application` instance and licence stored with `load(Application, String)` call.
`ImageSdkLibrary(android.app.Application application)` Create `ImageSdkLibrary` instance with specified `Application` context License key will read from assets
`ImageSdkLibrary(android.app.Application application, int resId)` Deprecated.
`ImageSdkLibrary(android.app.Application application, String licenseKey)` Create `ImageSdkLibrary` instance with specified `Application` context and license

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static android.content.Context`	`getContext()` Deprecated.
`static File`	`getImageFile(android.content.Context context, android.net.Uri contentUri)` Useful helper method.
`static boolean`	`load(android.app.Application application)` Initialize library by Application instance.
`static boolean`	`load(android.app.Application application, int resId)` Using resources to read license key
`static boolean`	`load(android.app.Application application, String licenseKey)` Initialize library by Application instance.
`AutoShotDetector`	`newAutoShotDetectorInstance()` Creates `AutoShotDetector`
`CutoutAverageF`	`newCutoutAverageInstance(int slidingLength)` Creates a `CutoutAverage`
`DocumentCutout`	`newDocumentCutoutInstance()` Creates a `DocumentCutout`
`ImageWriter`	`newImageWriterInstance(int type)` Create a new image writer instance
`ImageProcessing`	`newProcessingInstance()` Create a new processing instance
`ImageSdkLibrary`	`usingSdk(int type)` Deprecated.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - version
```
public static final String version
```
    See Also:
    
    Constant Field Values
  - TAG
```
public static final String TAG
```
    See Also:
    
    Constant Field Values
  - IMAGE_WRITER_UNKNOWN
```
public static final int IMAGE_WRITER_UNKNOWN
```
    Some invalid value to use as "nothing"
    
    See Also:
    
    Constant Field Values
  - IMAGE_WRITER_JPEG
```
public static final int IMAGE_WRITER_JPEG
```
    Create an Android's JPEG writer.
    
    See Also:
    
    Constant Field Values
  - IMAGE_WRITER_PNG
```
public static final int IMAGE_WRITER_PNG
```
    Create an Android's PNG writer
    
    See Also:
    
    Constant Field Values
  - IMAGE_WRITER_WEBM
```
public static final int IMAGE_WRITER_WEBM
```
    Create an Android's WEBM writer
    
    See Also:
    
    Constant Field Values
  - IMAGE_WRITER_TIFF
```
public static final int IMAGE_WRITER_TIFF
```
    Create writer for monochrome TIFF (G4 compression) images.
    
    See Also:
    
    Constant Field Values
  - IMAGE_WRITER_PDF
```
public static final int IMAGE_WRITER_PDF
```
    Create writer to save images in a PDFs That writer supports interface ImageFileWriter
    
    See Also:
    
    Constant Field Values
  - IMAGE_WRITER_PNG_EXT
```
public static final int IMAGE_WRITER_PNG_EXT
```
    Create writer to save images as PNG using DI SDK. In comparison with IMAGE_WRITER_PNG creates more compact PNG, especially in case of Black & White images.
    
    See Also:
    
    Constant Field Values
  - SDK_IS_SMART_CROP
```
public static final String SDK_IS_SMART_CROP
```
    Constant string to get detection quality
    
    See Also:
    
    Constant Field Values
  - SDK_CHECK_DOCUMENT_GEOMETRY
```
public static final String SDK_CHECK_DOCUMENT_GEOMETRY
```
    Constant string to perform an additional Effective Document Area (the area Document occupies in viewfinder by itself without surrounding space) check.
    
    See Also:
    
    Constant Field Values
  - SDK_DOCUMENT_FULLNESS_CHECKED
```
public static final String SDK_DOCUMENT_FULLNESS_CHECKED
```
    Constant string to get Document area check result
    
    See Also:
    
    Constant Field Values
  - SDK_DOCUMENT_FULLNESS_RATE
```
public static final String SDK_DOCUMENT_FULLNESS_RATE
```
    Internal use
    
    See Also:
    
    Constant Field Values
  - SDK_DOCUMENT_DISTORTION_CHECKED
```
public static final String SDK_DOCUMENT_DISTORTION_CHECKED
```
    Constant string to get Document distortion check result
    
    See Also:
    
    Constant Field Values
  - SDK_DOCUMENT_DISTORTION_RATE
```
@Deprecated
public static final String SDK_DOCUMENT_DISTORTION_RATE
```
    Deprecated.
    
    Internal use
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ImageSdkLibrary
```
public ImageSdkLibrary()
```
    Create ImageSdkLibrary instance with Application instance and licence stored with load(Application, String) call.
  - ImageSdkLibrary
```
public ImageSdkLibrary(@NonNull
                       android.app.Application application)
```
    Create ImageSdkLibrary instance with specified Application context License key will read from assets
    
    Parameters:
    
    application - Application instance
  - ImageSdkLibrary
```
public ImageSdkLibrary(@NonNull
                       android.app.Application application,
                       @Nullable
                       String licenseKey)
```
    Create ImageSdkLibrary instance with specified Application context and license
    
    Parameters:
    
    application - an Application instance
    
    licenseKey - licence key string
  - ImageSdkLibrary
```
@Deprecated
public ImageSdkLibrary(@NonNull
                                    android.app.Application application,
                                    @StringRes
                                    int resId)
```
    Deprecated.
- Method Detail
  - load
```
public static boolean load(@NonNull
                           android.app.Application application)
```
    Initialize library by Application instance. License key read from assets "pixelnetica/scanning/(file)" (file) must be one of
    - Application package Id with ".key" suffix e.g. "com.pixelnetica.cropdemo.key"
    - Application package Id e.g. "com.pixelnetica.cropdemo"
    - "license.key"
    - "license"
    - "key"
    That will possible to call newProcessingInstance() ()} without Application argument. You can see an example in the demo application in file "SdkFactory.java" al line 107 (method getLibrary())
    Parameters:
    
    application - Application instance
    
    Returns:
    
    true if library was loaded successfully.
  - load
```
public static boolean load(@NonNull
                           android.app.Application application,
                           @Nullable
                           String licenseKey)
```
    Initialize library by Application instance. That will possible to call newProcessingInstance() ()} without Application and license arguments.
    
    Parameters:
    
    application - an Application instance
    
    licenseKey - licence key string
    
    Returns:
    
    true if library was loaded successfully.
  - load
```
public static boolean load(@NonNull
                           android.app.Application application,
                           @StringRes
                           int resId)
```
    Using resources to read license key
    
    Parameters:
    
    application - application an Application instance
    
    resId - license key string resource id.
    
    Returns:
    
    true if successfully
  - getContext
```
@Deprecated
public static android.content.Context getContext()
```
    Deprecated.
  - newProcessingInstance
```
public ImageProcessing newProcessingInstance()
```
    Create a new processing instance
    
    Returns:
    
    ImageProcessing instance
  - newImageWriterInstance
```
public ImageWriter newImageWriterInstance(int type)
                                   throws ImageWriterException
```
    Create a new image writer instance
    
    Parameters:
    
    type - ImageSdkLibrary.ImageWriterType
    
    Returns:
    
    ImageWriterImpl instance
    
    Throws:
    
    ImageWriterException - if an error occurs
  - usingSdk
```
@Deprecated
public ImageSdkLibrary usingSdk(int type)
```
    Deprecated.
  - newDocumentCutoutInstance
```
public DocumentCutout newDocumentCutoutInstance()
```
    Creates a DocumentCutout
    
    Returns:
    
    DocumentCutout instance
  - newCutoutAverageInstance
```
public CutoutAverageF newCutoutAverageInstance(int slidingLength)
```
    Creates a CutoutAverage
    
    Parameters:
    
    slidingLength - average size
    
    Returns:
    
    CutoutAverage instance
  - newAutoShotDetectorInstance
```
public AutoShotDetector newAutoShotDetectorInstance()
```
    Creates AutoShotDetector
    
    Returns:
    
    AutoShotDetector instance
  - getImageFile
```
public static File getImageFile(@NonNull
                                android.content.Context context,
                                @NonNull
                                android.net.Uri contentUri)
```
    Useful helper method. Retrieve image file path from specified Uri
    
    Parameters:
    
    context - Context
    
    contentUri - uri to load
    
    Returns:
    
    file path for specified Uri or null

Class ImageSdkLibrary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

TAG

IMAGE_WRITER_UNKNOWN

IMAGE_WRITER_JPEG

IMAGE_WRITER_PNG

IMAGE_WRITER_WEBM

IMAGE_WRITER_TIFF

IMAGE_WRITER_PDF

IMAGE_WRITER_PNG_EXT

SDK_IS_SMART_CROP

SDK_CHECK_DOCUMENT_GEOMETRY

SDK_DOCUMENT_FULLNESS_CHECKED

SDK_DOCUMENT_FULLNESS_RATE

SDK_DOCUMENT_DISTORTION_CHECKED

SDK_DOCUMENT_DISTORTION_RATE

Constructor Detail

ImageSdkLibrary

ImageSdkLibrary

ImageSdkLibrary

ImageSdkLibrary

Method Detail

load

load

load

getContext

newProcessingInstance

newImageWriterInstance

usingSdk

newDocumentCutoutInstance

newCutoutAverageInstance

newAutoShotDetectorInstance

getImageFile