ThumbnailFormat Property

The thumbnail format.

Syntax

 box.getThumbnailFormat([callback])
 box.setThumbnailFormat( thumbnailFormat, [callback])

Possible Values

  0 (tfJPEG), 
  1 (tfPNG)

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getThumbnailFormat([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setThumbnailFormat([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property specifies the image format of the thumbnail. This is applicable when calling GetThumbnail. Possible values are:

0 (tfJPEG - default)
1 (tfPNG)

Data Type

Integer