ThumbnailSize Property

The size of the thumbnail in pixels.

Syntax

 box.getThumbnailSize([callback])
 box.setThumbnailSize( thumbnailSize, [callback])

Possible Values

  0 (bts32x32), 
  1 (bts94x94), 
  2 (bts160x160), 
  3 (bts320x320), 
  4 (bts64x64), 
  5 (bts128x128), 
  6 (bts256x256)

Default Value

0

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 getThumbnailSize([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 setThumbnailSize([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 defines the size of the thumbnail to be returned. The applicable sizes depend on the value of ThumbnailFormat.

Applicable values for PNG:

• 0 (bts32x32 - default)
• 4 (bts64x64)
• 5 (bts128x128)
• 6 (bts256x256)

Applicable values for JPG:

• 0 (bts32x32 - defalut)
• 1 (bts94x94)
• 2 (bts160x160)
• 3 (bts320x320)

Data Type

Integer