All Implemented Interfaces:: android.os.Parcelable


public final class TiffGeneratorParameters
 implements Parcelable

TIFF generator parameters.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`TiffGeneratorParameters.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private CompressionMode`	`compression`
`private Integer`	`jpegQuality`
`private Integer`	`zipCompressionLevel`
`private Integer`	`dpi`
`private List<UserField>`	`userFields`
`private ParametricFilter`	`binarizationFilter`
`public final static TiffGeneratorParameters.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`TiffGeneratorParameters(Map<String, Object> source)`
`TiffGeneratorParameters(JSONObject json)`
`TiffGeneratorParameters(CompressionMode compression, Integer jpegQuality, Integer zipCompressionLevel, Integer dpi, List<UserField> userFields, ParametricFilter binarizationFilter)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final CompressionMode`	`getCompression()`	Compression.
`final Unit`	`setCompression(CompressionMode compression)`	Compression.
`final Integer`	`getJpegQuality()`	JPEG quality (TIFFTAG_JPEGQUALITY).
`final Unit`	`setJpegQuality(Integer jpegQuality)`	JPEG quality (TIFFTAG_JPEGQUALITY).
`final Integer`	`getZipCompressionLevel()`	ZIP/Deflate compression level (TIFFTAG_ZIPQUALITY).
`final Unit`	`setZipCompressionLevel(Integer zipCompressionLevel)`	ZIP/Deflate compression level (TIFFTAG_ZIPQUALITY).
`final Integer`	`getDpi()`	DPI value.
`final Unit`	`setDpi(Integer dpi)`	DPI value.
`final List<UserField>`	`getUserFields()`	User-defined fields.
`final Unit`	`setUserFields(List<UserField> userFields)`	User-defined fields.
`final ParametricFilter`	`getBinarizationFilter()`	Filter to apply to the input image when adding pages with binarization.
`final Unit`	`setBinarizationFilter(ParametricFilter binarizationFilter)`	Filter to apply to the input image when adding pages with binarization.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final TiffGeneratorParameters`	`clone()`
`final static TiffGeneratorParameters`	`default()`

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

- Constructor Detail
  - TiffGeneratorParameters
```
TiffGeneratorParameters(Map<String, Object> source)
```
  - TiffGeneratorParameters
```
TiffGeneratorParameters(JSONObject json)
```
  - TiffGeneratorParameters
```
TiffGeneratorParameters(CompressionMode compression, Integer jpegQuality, Integer zipCompressionLevel, Integer dpi, List<UserField> userFields, ParametricFilter binarizationFilter)
```
- Method Detail
  - getCompression
```
 final CompressionMode getCompression()
```
    Compression.
    Default is LZW
  - setCompression
```
 final Unit setCompression(CompressionMode compression)
```
    Compression.
    Default is LZW
  - getJpegQuality
```
 final Integer getJpegQuality()
```
    JPEG quality (TIFFTAG_JPEGQUALITY). Values range from 0 to 100.
    Default is 80
  - setJpegQuality
```
 final Unit setJpegQuality(Integer jpegQuality)
```
    JPEG quality (TIFFTAG_JPEGQUALITY). Values range from 0 to 100.
    Default is 80
  - getZipCompressionLevel
```
 final Integer getZipCompressionLevel()
```
    ZIP/Deflate compression level (TIFFTAG_ZIPQUALITY). Values range from 1 to 9.
    Default is 6
  - setZipCompressionLevel
```
 final Unit setZipCompressionLevel(Integer zipCompressionLevel)
```
    ZIP/Deflate compression level (TIFFTAG_ZIPQUALITY). Values range from 1 to 9.
    Default is 6
  - getDpi
```
 final Integer getDpi()
```
    DPI value.
    Default is 72
  - setDpi
```
 final Unit setDpi(Integer dpi)
```
    DPI value.
    Default is 72
  - getUserFields
```
 final List<UserField> getUserFields()
```
    User-defined fields.
  - setUserFields
```
 final Unit setUserFields(List<UserField> userFields)
```
    User-defined fields.
  - getBinarizationFilter
```
 final ParametricFilter getBinarizationFilter()
```
    Filter to apply to the input image when adding pages with binarization. If set, the filter is applied to the input image and the resulting image is stored as a 1-bit TIFF. When storing documents it's typically best to use the BINARY_DOCUMENT_OPTIMIZED_COMPRESSION compression mode (CCITT_T6) instead of the default, as it tends to produce the smallest file sizes. If not set, simple thresholding is applied to the image, instead.
  - setBinarizationFilter
```
 final Unit setBinarizationFilter(ParametricFilter binarizationFilter)
```
    Filter to apply to the input image when adding pages with binarization. If set, the filter is applied to the input image and the resulting image is stored as a 1-bit TIFF. When storing documents it's typically best to use the BINARY_DOCUMENT_OPTIMIZED_COMPRESSION compression mode (CCITT_T6) instead of the default, as it tends to produce the smallest file sizes. If not set, simple thresholding is applied to the image, instead.
  - toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 final TiffGeneratorParameters clone()
```
  - default
```
 final static TiffGeneratorParameters default()
```

Class TiffGeneratorParameters

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TiffGeneratorParameters

TiffGeneratorParameters

TiffGeneratorParameters

Method Detail

getCompression

setCompression

getJpegQuality

setJpegQuality

getZipCompressionLevel

setZipCompressionLevel

getDpi

setDpi

getUserFields

setUserFields

getBinarizationFilter

setBinarizationFilter

toJson

clone

default