PxImageWriter Class Reference

Inheritance diagram for PxImageWriter:

Instance Methods
(BOOL)	- open:
	Start to write a new picture sequence. More...
(PxImageWriter_CfgResult)	- configure:withInt:
	Change configuration option with integer value. More...
(PxImageWriter_CfgResult)	- configure:withFloat:
	Change configuration option with float value. More...
(PxImageWriter_CfgResult)	- configure:withString:
	Change configuration option with string value. More...
(NSString *)	- write:
	Write an image to the current sequence. More...
(NSString *)	- writeFile:::
	Write to the specified file. Currently supported for PDFs only. More...
(BOOL)	- close
	Close current sequence. More...

Class Methods
(PxImageWriter *)	+ newWithType:
	Creates PxImageWriter of the specifed type. More...

Method Documentation

close()

- (BOOL) close

Close current sequence.

Returns

YES on success, NO otherwise.

configure:withFloat:()

- (PxImageWriter_CfgResult) configure:		(PxImageWriter_Cfg)	key
withFloat:		(float)	value

Change configuration option with float value.

Parameters

key	configuration key
value	configuration value

Returns

The result of the operation.

configure:withInt:()

- (PxImageWriter_CfgResult) configure:		(PxImageWriter_Cfg)	key
withInt:		(int)	value

Change configuration option with integer value.

Parameters

key	configuration key
value	configuration value

Returns

The result of the operation.

configure:withString:()

- (PxImageWriter_CfgResult) configure:		(PxImageWriter_Cfg)	key
withString:		(NSString *)	value

Change configuration option with string value.

Parameters

key	configuration key
value	configuration value

Returns

The result of the operation.

newWithType:()

+ (PxImageWriter*) newWithType:

(PxImageWriter_Type)

type

Creates PxImageWriter of the specifed type.

Parameters

type	requested image writer type

Returns

Created object.

open:()

- (BOOL) open:

(NSString *)

fileName

Start to write a new picture sequence.

Parameters

fileName

path to file

Returns

YES on success, NO otherwise.

write:()

- (NSString*) write:

(PxMetaImage *)

image

Write an image to the current sequence.

Parameters

image

PxMetaImage to write

Returns

path to saved image or nil on error. File name may be different from one passed to open:.

Exceptions

PxException

if feature is not enabled by the license

writeFile:::()

- (NSString*) writeFile:		(NSString *)	imageFile
:		(PxImageWriter_FileType)	imageType
:		(PxMetaImage_Orientation)	orientation

Write to the specified file. Currently supported for PDFs only.

Parameters

imageFile	file to write
imageType	file type
orientation	EXIF orientation value

Returns

same as write:

Exceptions

PxException

if feature is not enabled by the license