presentationThumbnailGet method

Future<Uint8List> presentationThumbnailGet(
  1. String uuid,
  2. int index, {
  3. int? quality,
})
inherited

presentationThumbnailGet -> /v1/presentation/{uuid}/thumbnail/{index}

Requests a thumbnail image of the specified cue inside the specified presentation at the given quality value.

PARAMETERS

uuid : The UUID of the presentation to look up.

  • Example (uuid): 3C39C433-5C18-4F51-B357-55BB870227C4

index : The index of the cue to use. Respects the selected arrangement of cues.

  • Example (index): 0

quality : The desired quality of the thumbnail. The value is the number of pixels in the largest dimension of the image, i.e. if the image is landscape (wider than it is tall), it is the width of the image. If the image is portrait (taller than it is wide), it is the height of the image.

Example: 400

RESPONSE 200:

The request was processed successfully.

content-type: image/jpeg

schema:

{
  "type": "string",
  "required": [],
  "format": "binary",
  "example": "image data here"
}

RESPONSE 403:

The request was not authorized.

content-type: ``

Implementation

Future<Uint8List> presentationThumbnailGet(String uuid, int index, {int? quality}) async {
  String url = '/v1/presentation/$uuid/thumbnail/$index';
  Map<String, dynamic> query = {'quality': quality.toString()};

  return await call('get', url, params: query, httpAccept: 'image/jpeg');
}