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.
Namespace: Amazon.KinesisVideoArchivedMedia.Model
Assembly: AWSSDK.KinesisVideoArchivedMedia.dll
Version: 3.x.y.z
public class GetImagesRequest : AmazonKinesisVideoArchivedMediaRequest IAmazonWebServiceRequest
The GetImagesRequest type exposes the following members
Name | Description | |
---|---|---|
GetImagesRequest() |
Name | Type | Description | |
---|---|---|---|
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
|
|
Format | Amazon.KinesisVideoArchivedMedia.Format |
Gets and sets the property Format. The format that will be used to encode the image. |
|
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 |
|
HeightPixels | System.Int32 |
Gets and sets the property HeightPixels.
The height of the output image that is used in conjunction with the |
|
ImageSelectorType | Amazon.KinesisVideoArchivedMedia.ImageSelectorType |
Gets and sets the property ImageSelectorType. The origin of the Server or Producer timestamps to use to generate the images. |
|
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 |
|
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
|
|
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 | System.DateTime |
Gets and sets the property StartTimestamp.
The starting point from which the images should be generated. This |
|
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 | System.String |
Gets and sets the property StreamName.
The name of the stream from which to retrieve the images. You must specify either
the |
|
WidthPixels | System.Int32 |
Gets and sets the property WidthPixels.
The width of the output image that is used in conjunction with the |
.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