本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # GetImages 对图像的托管支持提供了一种完全托管的方式，可以从流式传输并存储在 Kinesis Video Streams 中的视频数据中获取图像。您可以使用图像来运行机器学习 (ML) 工作负载，例如人、宠物或车辆检测。图像还可用于在播放中添加交互元素，例如动作事件的图像预览和视频片段的拖动。 GetImages 还会检索与给定时间范围、采样间隔和图像格式配置的每个时间戳对应的图像列表。 **注意** 您必须先调用 `GetDataEndpoint` API 才能获取终端节点。然后使用 [--endpoint-url 参数将`GetImages`请求发送到此端点](https://docs.aws.amazon.com/cli/latest/reference/)。 [视频播放曲目要求](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html)。 ## 请求语法 ``` POST /getImages HTTP/1.1 Content-type: application/json { "EndTimestamp": number, "Format": "string", "FormatConfig": { "string" : "string" }, "HeightPixels": number, "ImageSelectorType": "string", "MaxResults": number, "NextToken": "string", "SamplingInterval": number, "StartTimestamp": number, "StreamARN": "string", "StreamName": "string", "WidthPixels": number } ``` ## URI 请求参数该请求不使用任何 URI 参数。 ## 请求正文请求接受采用 JSON 格式的以下数据。 ** [EndTimestamp](#API_reader_GetImages_RequestSyntax) ** 要生成的图像范围的结束时间戳。如果介于`StartTimestamp`和之间的时间范围大`EndTimestamp`于 300 秒`StartTimestamp`，您将收到`IllegalArgumentException`。类型：时间戳是否必需：是 ** [Format](#API_reader_GetImages_RequestSyntax) ** 将用于对图像进行编码的格式。类型：字符串有效值：`JPEG | PNG` 是否必需：是 ** [FormatConfig](#API_reader_GetImages_RequestSyntax) ** 键值对结构的列表，其中包含可在生成图像时应用的额外参数。`FormatConfig`密钥是`JPEGQuality`，它表示用于生成图像的 JPEG 质量密钥。该`FormatConfig`值接受介于 1 到 100 之间的整数。如果该值为 1，则将生成质量较低且压缩效果最佳的图像。如果该值为 100，则将生成质量最好、压缩率更低的图像。如果未提供任何值，则`JPEGQuality`密钥的默认值将设置为 80。类型：字符串到字符串映射映射条目：最多 1 个物品。有效密钥：`JPEGQuality` 值长度限制：最小长度为 0。最大长度为 256。价值模式：`^[a-zA-Z_0-9]+` 必需：否 ** [HeightPixels](#API_reader_GetImages_RequestSyntax) ** 与`WidthPixels`参数一起使用的输出图像的高度。当同时提供`HeightPixels`和`WidthPixels`参数时，图像将被拉伸以适合指定的纵横比。如果仅提供了`HeightPixels`参数，则将使用其原始纵横比来计算该`WidthPixels`比率。如果两个参数均未提供，则将返回原始图像尺寸。类型：整数有效范围：最小值为 1。最大值为 2160。必需：否 ** [ImageSelectorType](#API_reader_GetImages_RequestSyntax) ** 用于生成图像的服务器或制作者时间戳的来源。类型：字符串有效值：`PRODUCER_TIMESTAMP | SERVER_TIMESTAMP` 是否必需：是 ** [MaxResults](#API_reader_GetImages_RequestSyntax) ** API 返回的最大图像数。每个 API 响应的默认限制为 25 张图片。如果提供的值`MaxResults`大于此值，则页面大小将为 25。任何其他结果都将进行分页。类型：长整型有效范围：最小值为 1。最大值为 100。必需：否 ** [NextToken](#API_reader_GetImages_RequestSyntax) ** 一种标记，用于指定从何处开始对下一组图像进行分页。这是先前截断的响应中的 `GetImages:NextToken`。类型：字符串长度限制：最小长度为 1。最大长度为 4096。模式：`[a-zA-Z0-9+/]+={0,2}` 必需：否 ** [SamplingInterval](#API_reader_GetImages_RequestSyntax) ** 需要从流中生成图像的时间间隔，以毫秒 (ms) 为单位。可以提供的最小值为 200 ms（每秒 5 张图像）。如果时间戳范围小于采样间隔，则`startTimestamp`将返回的图像（如果有）。类型：整数必需：否 ** [StartTimestamp](#API_reader_GetImages_RequestSyntax) ** 应从中生成图像的起点。这`StartTimestamp`必须在包含的时间戳范围内，才能返回图像。类型：时间戳是否必需：是 ** [StreamARN](#API_reader_GetImages_RequestSyntax) ** 要从中检索图像的直播的 Amazon 资源名称 (ARN)。必须指定`StreamName`或`StreamARN`。类型：字符串长度限制：最小长度为 1。长度上限为 1024。模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` 必需：否 ** [StreamName](#API_reader_GetImages_RequestSyntax) ** 要从中检索图像的流的名称。必须指定`StreamName`或`StreamARN`。类型：字符串长度限制：最小长度为 1。最大长度为 256。模式：`[a-zA-Z0-9_.-]+` 必需：否 ** [WidthPixels](#API_reader_GetImages_RequestSyntax) ** 与`HeightPixels`参数一起使用的输出图像的宽度。当同时提供`WidthPixels`和`HeightPixels`参数时，图像将被拉伸以适合指定的纵横比。如果只提供了`WidthPixels`参数或者只提供了参数，则`ValidationException`会抛出 a。`HeightPixels`如果两个参数都未提供，则将返回流中的原始图像大小。类型：整数有效范围：最小值为 1。最大值为 3840。必需：否 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "Images": [ { "Error": "string", "ImageContent": "string", "TimeStamp": number } ], "NextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Images](#API_reader_GetImages_ResponseSyntax) ** 从视频流生成的图像列表。如果在给定时间戳内没有可用的媒体，则`NO_MEDIA`错误将在输出中列出。如果在生成图像时出现错误，则`MEDIA_ERROR`将在输出中列为图像丢失的原因。类型：[Image](API_reader_Image.md) 对象数组 ** [NextToken](#API_reader_GetImages_ResponseSyntax) ** 请求中用于获取更多图像的加密令牌。类型：字符串长度限制：最小长度为 1。最大长度为 4096。模式：`[a-zA-Z0-9+/]+={0,2}` ## 错误有关所有操作的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。 ** ClientLimitExceededException ** Kinesis Video Streams 已限制该请求，因为你已超过限制。稍后再尝试拨打电话。有关限制的信息，请参阅 [Kinesis Video Streams](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html) 配额。 HTTP 状态代码：400 ** InvalidArgumentException ** 指定参数超出其限制、不受支持或无法使用。 HTTP 状态代码：400 ** NoDataRetentionException ** `GetImages`请求的直播不保留数据（即 a `DataRetentionInHours` 为 0）。 HTTP 状态代码：400 ** NotAuthorizedException ** 状态码：403，调用者无权对给定直播执行操作，或者令牌已过期。 HTTP 状态代码：401 ** ResourceNotFoundException ** `GetImages`当 Kinesis Video Streams 找不到你指定的直播时，将引发此错误。 `GetHLSStreamingSessionURL`如果请求`PlaybackMode`的会话在请求的时间范围内`LIVE_REPLAY`没有片段，`ON_DEMAND`或者在过去 30 秒内没有片段的流请求`PlaybackMode`的`LIVE`会话为或时，则会`GetDASHStreamingSessionURL`抛出此错误。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetImages)