KinesisVideoArchivedMedia / Client / get_images

get_images#

KinesisVideoArchivedMedia.Client.get_images(**kwargs)#

Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.

Request Syntax

response = client.get_images(
    StreamName='string',
    StreamARN='string',
    ImageSelectorType='PRODUCER_TIMESTAMP'|'SERVER_TIMESTAMP',
    StartTimestamp=datetime(2015, 1, 1),
    EndTimestamp=datetime(2015, 1, 1),
    SamplingInterval=123,
    Format='JPEG'|'PNG',
    FormatConfig={
        'string': 'string'
    },
    WidthPixels=123,
    HeightPixels=123,
    MaxResults=123,
    NextToken='string'
)

Parameters:

StreamName (string) – The name of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.
StreamARN (string) – The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.
ImageSelectorType (string) –
[REQUIRED]

The origin of the Server or Producer timestamps to use to generate the images.
StartTimestamp (datetime) –
[REQUIRED]

The starting point from which the images should be generated. This StartTimestamp must be within an inclusive range of timestamps for an image to be returned.
EndTimestamp (datetime) –
[REQUIRED]

The end timestamp for the range of images to be generated.
SamplingInterval (integer) –
[REQUIRED]

The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 3000 ms. If the timestamp range is less than the sampling interval, the Image from the startTimestamp will be returned if available.

Note
The minimum value of 3000 ms is a soft limit. If needed, a lower sampling frequency can be requested.
Format (string) –
[REQUIRED]

The format that will be used to encode the image.
FormatConfig (dict) –
The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.
- (string) –
  - (string) –
WidthPixels (integer) – The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided or if only the HeightPixels is provided, a ValidationException will be thrown. If neither parameter is provided, the original image size from the stream will be returned.
HeightPixels (integer) – The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.
MaxResults (integer) –
The maximum number of images to be returned by the API.

Note
The default limit is 100 images per API response. The additional results will be paginated.
NextToken (string) – A token that specifies where to start paginating the next set of Images. This is the GetImages:NextToken from a previously truncated response.

Return type:

dict

Returns:

Response Syntax

{
    'Images': [
        {
            'TimeStamp': datetime(2015, 1, 1),
            'Error': 'NO_MEDIA'|'MEDIA_ERROR',
            'ImageContent': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Images (list) –
  
  The list of images generated from the video stream. If there is no media available for the given timestamp, the NO_MEDIA error will be listed in the output. If an error occurs while the image is being generated, the MEDIA_ERROR will be listed in the output as the cause of the missing image.
  - (dict) –
    
    A structure that contains the Timestamp, Error, and ImageContent.
    - TimeStamp (datetime) –
      
      An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.
    - Error (string) –
      
      The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:
      - There is no media that exists for the specified Timestamp.
      - The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.
    - ImageContent (string) –
      
      An attribute of the Image object that is Base64 encoded.
- NextToken (string) –
  
  The encrypted token that was used in the request to get more images.

Exceptions

KinesisVideoArchivedMedia.Client.exceptions.ResourceNotFoundException
KinesisVideoArchivedMedia.Client.exceptions.InvalidArgumentException
KinesisVideoArchivedMedia.Client.exceptions.ClientLimitExceededException
KinesisVideoArchivedMedia.Client.exceptions.NotAuthorizedException