ImageWriter (Pixelnetica DSSDK Documentation)

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

All Implemented Interfaces:

ImageFileWriter, Closeable, AutoCloseable
```
public class ImageWriter
extends Object
implements Closeable, ImageFileWriter
```
Writes MetaImage in different formats

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ImageWriter.Paper
Various paper format.

static interface ImageWriter.Units
- Nested classes/interfaces inherited from interface com.pixelnetica.imagesdk.ImageFileWriter
  ImageFileWriter.ImageFileType

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ImageWriter.Paper` Various paper format.
`static interface`	`ImageWriter.Units`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONFIG_COMPRESSION` A compression (quality) value for JPEG.
`static String`	`CONFIG_PAGE_HEIGHT` A page height for PDFs.
`static String`	`CONFIG_PAGE_PAPER` A page size preset for PRF, such an A4, Letter etc.
`static String`	`CONFIG_PAGE_UNITS` An units for page dimensions.
`static String`	`CONFIG_PAGE_WIDTH` A page width for PDFs.
`static float`	`Extensible` An "infinite" value for page dimensions.
`static int`	`Inches`
`static int`	`Millimeters`
`static int`	`PAPER_A4`
`static int`	`PAPER_A5`
`static int`	`PAPER_A6`
`static int`	`PAPER_BUSINESS_CARD`
`static int`	`PAPER_BUSINESS_CARD2`
`static int`	`PAPER_HALF_LETTER`
`static int`	`PAPER_JUNIOR_LEGAL`
`static int`	`PAPER_LEGAL`
`static int`	`PAPER_LEGER`
`static int`	`PAPER_LETTER`
`static int`	`PAPER_RECEIPT_KITCHEN`
`static int`	`PAPER_RECEIPT_MOBILE`
`static int`	`PAPER_RECEIPT_STATION`

Fields inherited from interface com.pixelnetica.imagesdk.ImageFileWriter
IMAGE_FILE_JPEG, IMAGE_FILE_PNG, IMAGE_FILE_UNKNOWN

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`close()` Close sequence
`void`	`configure(android.os.Bundle config)` Setup optional parameters
`void`	`destroy()` Deprecated.
`void`	`open(String fileName)` Start to write a new picture sequence
`String`	`write(MetaImage image)` Write one image to current sequence
`String`	`writeFile(String imageFile, int imageType, int orientation)` Write specified file.

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

- Field Detail
  - CONFIG_COMPRESSION
```
public static final String CONFIG_COMPRESSION
```
    A compression (quality) value for JPEG. Integer from 1 to 100 Must be set before call write() method
    
    See Also:
    
    Constant Field Values
  - PAPER_A4
```
public static final int PAPER_A4
```
    See Also:
    
    Constant Field Values
  - PAPER_A5
```
public static final int PAPER_A5
```
    See Also:
    
    Constant Field Values
  - PAPER_A6
```
public static final int PAPER_A6
```
    See Also:
    
    Constant Field Values
  - PAPER_HALF_LETTER
```
public static final int PAPER_HALF_LETTER
```
    See Also:
    
    Constant Field Values
  - PAPER_LETTER
```
public static final int PAPER_LETTER
```
    See Also:
    
    Constant Field Values
  - PAPER_LEGAL
```
public static final int PAPER_LEGAL
```
    See Also:
    
    Constant Field Values
  - PAPER_JUNIOR_LEGAL
```
public static final int PAPER_JUNIOR_LEGAL
```
    See Also:
    
    Constant Field Values
  - PAPER_LEGER
```
public static final int PAPER_LEGER
```
    See Also:
    
    Constant Field Values
  - PAPER_BUSINESS_CARD
```
public static final int PAPER_BUSINESS_CARD
```
    See Also:
    
    Constant Field Values
  - PAPER_BUSINESS_CARD2
```
public static final int PAPER_BUSINESS_CARD2
```
    See Also:
    
    Constant Field Values
  - PAPER_RECEIPT_MOBILE
```
public static final int PAPER_RECEIPT_MOBILE
```
    See Also:
    
    Constant Field Values
  - PAPER_RECEIPT_STATION
```
public static final int PAPER_RECEIPT_STATION
```
    See Also:
    
    Constant Field Values
  - PAPER_RECEIPT_KITCHEN
```
public static final int PAPER_RECEIPT_KITCHEN
```
    See Also:
    
    Constant Field Values
  - Millimeters
```
public static final int Millimeters
```
    See Also:
    
    Constant Field Values
  - Inches
```
public static final int Inches
```
    See Also:
    
    Constant Field Values
  - CONFIG_PAGE_PAPER
```
public static final String CONFIG_PAGE_PAPER
```
    A page size preset for PRF, such an A4, Letter etc. Integer value. ImageWriter.Paper NOTE: by specify CONFIG_PAGE_WIDTH or CONFIG_PAGE_HEIGHT you can override one or both paper dimensions.
    
    See Also:
    
    Constant Field Values
  - CONFIG_PAGE_UNITS
```
public static final String CONFIG_PAGE_UNITS
```
    An units for page dimensions. Integer value. Can be Millimeters or Inches
    
    See Also:
    
    Constant Field Values
  - Extensible
```
public static final float Extensible
```
    An "infinite" value for page dimensions. Can be used to calculate page dimension related image Both dimensions CONFIG_PAGE_WIDTH and CONFIG_PAGE_HEIGHT cannot be Extensible
    
    See Also:
    
    Constant Field Values
  - CONFIG_PAGE_WIDTH
```
public static final String CONFIG_PAGE_WIDTH
```
    A page width for PDFs. Float value in mm Or Extensible to make page proper width
    
    See Also:
    
    Constant Field Values
  - CONFIG_PAGE_HEIGHT
```
public static final String CONFIG_PAGE_HEIGHT
```
    A page height for PDFs. Float value in mm Or Extensible to make page proper height
    
    See Also:
    
    Constant Field Values
- Method Detail
  - open
```
public void open(@NonNull
                 String fileName)
          throws ImageWriterException
```
    Start to write a new picture sequence
    
    Parameters:
    
    fileName - path to file
    
    Throws:
    
    ImageWriterException - if an error occurs
  - configure
```
public void configure(@NonNull
                      android.os.Bundle config)
               throws ImageWriterException
```
    Setup optional parameters
    
    Parameters:
    
    config - a Bundle with named parameters
    
    Throws:
    
    ImageWriterException - if an error occurs
  - write
```
public String write(@NonNull
                    MetaImage image)
             throws ImageWriterException
```
    Write one image to current sequence
    
    Parameters:
    
    image - MetaImage to write
    
    Returns:
    
    path to saved image. File name may be different than was passed to open(String)
    
    Throws:
    
    ImageWriterException - if an error occurs
  - close
```
public void close()
           throws ImageWriterException
```
    Close sequence
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    ImageWriterException
  - destroy
```
@Deprecated
public void destroy()
                          throws ImageWriterException
```
    Deprecated.
    
    Finish working with SDK object instance No more need!
    
    Throws:
    
    ImageWriterException - if an error occurs
  - writeFile
```
public String writeFile(@NonNull
                        String imageFile,
                        int imageType,
                        int orientation)
                 throws ImageWriterException
```
    Description copied from interface: ImageFileWriter
    
    Write specified file. Currently used for PDF only
    
    Specified by:
    
    writeFile in interface ImageFileWriter
    
    Parameters:
    
    imageFile - file to write
    
    imageType - file type. One of ImageFileWriter.ImageFileType (but not -1
    
    orientation - optional EXIF orientation value
    
    Returns:
    
    same as write(MetaImage)
    
    Throws:
    
    ImageWriterException - if an error occurs

Class ImageWriter

Nested Class Summary

Nested classes/interfaces inherited from interface com.pixelnetica.imagesdk.ImageFileWriter

Field Summary

Fields inherited from interface com.pixelnetica.imagesdk.ImageFileWriter

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONFIG_COMPRESSION

PAPER_A4

PAPER_A5

PAPER_A6

PAPER_HALF_LETTER

PAPER_LETTER

PAPER_LEGAL

PAPER_JUNIOR_LEGAL

PAPER_LEGER

PAPER_BUSINESS_CARD

PAPER_BUSINESS_CARD2

PAPER_RECEIPT_MOBILE

PAPER_RECEIPT_STATION

PAPER_RECEIPT_KITCHEN

Millimeters

Inches

CONFIG_PAGE_PAPER

CONFIG_PAGE_UNITS

Extensible

CONFIG_PAGE_WIDTH

CONFIG_PAGE_HEIGHT

Method Detail

open

configure

write

close

destroy

writeFile