NIMDocTranscodingInfo Class Reference

Inherits from NSObject
Declared in NIMDocTranscodingInfo.h

Overview

Conversion info

  docId

Document ID

@property (nonatomic, copy, readonly) NSString *docId

Discussion

Document ID

Declared In

NIMDocTranscodingInfo.h

  docName

Document name

@property (nonatomic, copy, readonly) NSString *docName

Discussion

Document name

Declared In

NIMDocTranscodingInfo.h

  sourceType

File type of the source file

@property (nonatomic, assign, readonly) NIMDocTranscodingFileType sourceType

Discussion

File type of the source file

Declared In

NIMDocTranscodingInfo.h

  sourceSize

Size of the source file

@property (nonatomic, assign, readonly) UInt64 sourceSize

Discussion

Size of the source file

Declared In

NIMDocTranscodingInfo.h

  targetType

Target file type

@property (nonatomic, assign, readonly) NIMDocTranscodingImageType targetType

Discussion

Target file type

Declared In

NIMDocTranscodingInfo.h

  state

Conversion state

@property (nonatomic, assign, readonly) NIMDocTranscodingState state

Discussion

Conversion state

Declared In

NIMDocTranscodingInfo.h

  sourceFileUrl

URL of a source file

@property (nonatomic, copy, readonly) NSString *sourceFileUrl

Discussion

URL of a source file

Declared In

NIMDocTranscodingInfo.h

  numberOfPages

Total number of pages of a document

@property (nonatomic, assign, readonly) NSUInteger numberOfPages

Discussion

Total number of pages of a document

Declared In

NIMDocTranscodingInfo.h

  ext

Additional info for conversion

@property (nullable, nonatomic, copy, readonly) NSString *ext

Discussion

Additional info for conversion

Declared In

NIMDocTranscodingInfo.h

  transcodingFlag

Internal state codes. 0: success. Used to identify the failure reason when conversion fails Some known failure reasons 2: file not found; 3: file type error; 4: An exception occurred in the converting request; 5: Server connection error 6: Server internal error; 7: Doc to image error; 8: Image quality processing error; 9: Number of pages exceeded; 10: NOS callback error; 11: An error occurred while parsing a document (For example, unable to parse an encrypted PDF file; 100: Unknown error

@property (nonatomic, assign, readonly) NSInteger transcodingFlag

Discussion

Internal state codes. 0: success. Used to identify the failure reason when conversion fails Some known failure reasons 2: file not found; 3: file type error; 4: An exception occurred in the converting request; 5: Server connection error 6: Server internal error; 7: Doc to image error; 8: Image quality processing error; 9: Number of pages exceeded; 10: NOS callback error; 11: An error occurred while parsing a document (For example, unable to parse an encrypted PDF file; 100: Unknown error

Declared In

NIMDocTranscodingInfo.h

– transcodedTotalSize:

Size of a file with a specified quality

- (UInt64)transcodedTotalSize:(NIMDocTranscodingQuality)quality

Parameters

quality

file quality

Return Value

size of a converted file

Discussion

Size of a file with a specified quality

Declared In

NIMDocTranscodingInfo.h

– transcodedImagesSize:

Aspect ratio of a converted image

- (CGSize)transcodedImagesSize:(NIMDocTranscodingQuality)quality

Parameters

quality

file quality

Return Value

Aspect ratio of a converted image

Discussion

Aspect ratio of a converted image

Declared In

NIMDocTranscodingInfo.h

– transcodedUrl:ofQuality:

Get the URLs of converted pages with a specified quality.

- (nullable NSString *)transcodedUrl:(NSUInteger)pageNumber ofQuality:(NIMDocTranscodingQuality)quality

Parameters

pageNumber

Page number

quality

image quality

Return Value

URL

Discussion

Get the URLs of converted pages with a specified quality.

Declared In

NIMDocTranscodingInfo.h