AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the GetImages operation. Retrieves a list of images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.KinesisVideoArchivedMedia.AmazonKinesisVideoArchivedMediaRequest
      Amazon.KinesisVideoArchivedMedia.Model.GetImagesRequest

Namespace: Amazon.KinesisVideoArchivedMedia.Model
Assembly: AWSSDK.KinesisVideoArchivedMedia.dll
Version: 3.x.y.z

Syntax

C#
public class GetImagesRequest : AmazonKinesisVideoArchivedMediaRequest
         IAmazonWebServiceRequest

The GetImagesRequest type exposes the following members

Constructors

NameDescription
Public Method GetImagesRequest()

Properties

NameTypeDescription
Public Property EndTimestamp System.DateTime

Gets and sets the property EndTimestamp.

The end timestamp for the range of images to be generated. If the time range between StartTimestamp and EndTimestamp is more than 300 seconds above StartTimestamp, you will receive an IllegalArgumentException.

Public Property Format Amazon.KinesisVideoArchivedMedia.Format

Gets and sets the property Format.

The format that will be used to encode the image.

Public Property FormatConfig System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property FormatConfig.

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.

Public Property HeightPixels System.Int32

Gets and sets the property HeightPixels.

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.

Public Property ImageSelectorType Amazon.KinesisVideoArchivedMedia.ImageSelectorType

Gets and sets the property ImageSelectorType.

The origin of the Server or Producer timestamps to use to generate the images.

Public Property MaxResults System.Int64

Gets and sets the property MaxResults.

The maximum number of images to be returned by the API.

The default limit is 25 images per API response. Providing a MaxResults greater than this value will result in a page size of 25. Any additional results will be paginated.

Public Property NextToken System.String

Gets and sets the property NextToken.

A token that specifies where to start paginating the next set of Images. This is the GetImages:NextToken from a previously truncated response.

Public Property SamplingInterval System.Int32

Gets and sets the property SamplingInterval.

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 200 ms (5 images per second). If the timestamp range is less than the sampling interval, the image from the startTimestamp will be returned if available.

Public Property StartTimestamp System.DateTime

Gets and sets the property StartTimestamp.

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.

Public Property StreamARN System.String

Gets and sets the property StreamARN.

The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

Public Property StreamName System.String

Gets and sets the property StreamName.

The name of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

Public Property WidthPixels System.Int32

Gets and sets the property WidthPixels.

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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5