Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra. # GetImages Le support géré pour les images fournit un moyen entièrement géré d'obtenir des images à partir des données vidéo diffusées et stockées dans Kinesis Video Streams. Vous pouvez utiliser des images pour exécuter des charges de travail d'apprentissage automatique (ML) telles que la détection de personnes, d'animaux de compagnie ou de véhicules. Les images peuvent également être utilisées pour ajouter des éléments interactifs à la lecture, tels que des aperçus d'images pour des événements animés ou le nettoyage d'un clip vidéo. GetImages récupère également une liste d'images correspondant à chaque horodatage pour une plage de temps, un intervalle d'échantillonnage et une configuration de format d'image donnés. **Note** Vous devez d'abord appeler l'`GetDataEndpoint`API pour obtenir un point de terminaison. Envoyez ensuite les `GetImages` demandes à ce point de terminaison à l'aide du paramètre [--endpoint-url](https://docs.aws.amazon.com/cli/latest/reference/). [Exigences relatives aux pistes de lecture vidéo](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html). ## Syntaxe de la demande ``` 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 } ``` ## Paramètres de demande URI La demande n’utilise pas de paramètres URI. ## Corps de la demande Cette demande accepte les données suivantes au format JSON. ** [EndTimestamp](#API_reader_GetImages_RequestSyntax) ** Horodatage de fin de la plage d'images à générer. Si l'intervalle de temps entre `StartTimestamp` et `EndTimestamp` est supérieur à 300 secondes`StartTimestamp`, vous recevrez un`IllegalArgumentException`. Type : Timestamp Obligatoire : oui ** [Format](#API_reader_GetImages_RequestSyntax) ** Format qui sera utilisé pour encoder l'image. Type : Chaîne Valeurs valides : `JPEG | PNG` Obligatoire : oui ** [FormatConfig](#API_reader_GetImages_RequestSyntax) ** Liste d'une structure de paire clé-valeur contenant des paramètres supplémentaires pouvant être appliqués lors de la génération de l'image. La `FormatConfig` clé est le`JPEGQuality`, qui indique la clé de qualité JPEG à utiliser pour générer l'image. La `FormatConfig` valeur accepte des entiers compris entre 1 et 100. Si la valeur est 1, l'image sera générée avec une qualité inférieure et une compression optimale. Si la valeur est 100, l'image sera générée avec la meilleure qualité et avec moins de compression. Si aucune valeur n'est fournie, la valeur par défaut de la `JPEGQuality` clé sera fixée à 80. Type : mappage chaîne/chaîne Entrées cartographiques : nombre maximum d'un élément. Clés valides : `JPEGQuality` Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256. Modèle de valeur : `^[a-zA-Z_0-9]+` Obligatoire : non ** [HeightPixels](#API_reader_GetImages_RequestSyntax) ** Hauteur de l'image de sortie utilisée conjointement avec le `WidthPixels` paramètre. Lorsque les deux `WidthPixels` paramètres `HeightPixels` et sont fournis, l'image est étirée pour s'adapter au rapport hauteur/largeur spécifié. Si seul le `HeightPixels` paramètre est fourni, son rapport hauteur/largeur d'origine sera utilisé pour calculer le `WidthPixels` rapport. Si aucun paramètre n'est fourni, la taille de l'image d'origine sera renvoyée. Type : entier Plage valide : valeur minimum de 1. Valeur maximale de 2160. Obligatoire : non ** [ImageSelectorType](#API_reader_GetImages_RequestSyntax) ** Origine des horodatages du serveur ou du producteur à utiliser pour générer les images. Type : Chaîne Valeurs valides : `PRODUCER_TIMESTAMP | SERVER_TIMESTAMP` Obligatoire : oui ** [MaxResults](#API_reader_GetImages_RequestSyntax) ** Le nombre maximum d'images à renvoyer par l'API. La limite par défaut est de 25 images par réponse d'API. Si vous fournissez une valeur `MaxResults` supérieure à cette valeur, le format de page sera de 25. Tous les résultats supplémentaires seront paginés. Type : Long Plage valide : valeur minimum de 1. Valeur maximale fixée à 100. Obligatoire : non ** [NextToken](#API_reader_GetImages_RequestSyntax) ** Un jeton qui indique où commencer à paginer le prochain ensemble d'images. C'est le résultat `GetImages:NextToken` d'une réponse tronquée précédemment. Type : Chaîne Contraintes de longueur : longueur minimum de 1. Longueur maximum de 4096. Modèle : `[a-zA-Z0-9+/]+={0,2}` Obligatoire : non ** [SamplingInterval](#API_reader_GetImages_RequestSyntax) ** Intervalle de temps en millisecondes (ms) auquel les images doivent être générées à partir du flux. La valeur minimale pouvant être fournie est de 200 ms (5 images par seconde). Si la plage d'horodatage est inférieure à l'intervalle d'échantillonnage, l'image provenant du `startTimestamp` sera renvoyée si elle est disponible. Type : Integer Obligatoire : non ** [StartTimestamp](#API_reader_GetImages_RequestSyntax) ** Point de départ à partir duquel les images doivent être générées. Cela `StartTimestamp` doit être compris dans une plage d'horodatages incluse pour qu'une image soit renvoyée. Type : Timestamp Obligatoire : oui ** [StreamARN](#API_reader_GetImages_RequestSyntax) ** Le nom de ressource Amazon (ARN) du flux à partir duquel récupérer les images. Vous devez spécifier le `StreamName` ou le`StreamARN`. Type : Chaîne Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 1024. Modèle : `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Obligatoire : non ** [StreamName](#API_reader_GetImages_RequestSyntax) ** Nom du flux à partir duquel récupérer les images. Vous devez spécifier le `StreamName` ou le`StreamARN`. Type : Chaîne Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256. Modèle : `[a-zA-Z0-9_.-]+` Obligatoire : non ** [WidthPixels](#API_reader_GetImages_RequestSyntax) ** Largeur de l'image de sortie utilisée conjointement avec le `HeightPixels` paramètre. Lorsque les deux `HeightPixels` paramètres `WidthPixels` et sont fournis, l'image est étirée pour s'adapter au rapport hauteur/largeur spécifié. Si seul le `WidthPixels` paramètre est fourni ou si seul le paramètre `HeightPixels` est fourni, un `ValidationException` sera émis. Si aucun paramètre n'est fourni, la taille d'image d'origine du flux sera renvoyée. Type : entier Plage valide : valeur minimum de 1. Valeur maximale de 3840. Obligatoire : non ## Syntaxe de la réponse ``` HTTP/1.1 200 Content-type: application/json { "Images": [ { "Error": "string", "ImageContent": "string", "TimeStamp": number } ], "NextToken": "string" } ``` ## Eléments de réponse Si l’action aboutit, le service renvoie une réponse HTTP 200. Les données suivantes sont renvoyées au format JSON par le service. ** [Images](#API_reader_GetImages_ResponseSyntax) ** Liste des images générées à partir du flux vidéo. Si aucun média n'est disponible pour l'horodatage donné, l'`NO_MEDIA`erreur sera répertoriée dans la sortie. Si une erreur survient lors de la génération de l'image, elle `MEDIA_ERROR` sera répertoriée dans la sortie comme cause de l'image manquante. Type : tableau d’objets [Image](API_reader_Image.md) ** [NextToken](#API_reader_GetImages_ResponseSyntax) ** Le jeton crypté qui a été utilisé dans la demande pour obtenir plus d'images. Type : Chaîne Contraintes de longueur : longueur minimum de 1. Longueur maximum de 4096. Modèle : `[a-zA-Z0-9+/]+={0,2}` ## Erreurs Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Types d'erreurs courants](CommonErrors.md). ** ClientLimitExceededException ** Kinesis Video Streams a limité la demande car vous avez dépassé une limite. Essayez de passer l'appel plus tard. Pour plus d'informations sur les limites, consultez la section [Quotas Kinesis Video Streams](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html). Code d’état HTTP : 400 ** InvalidArgumentException ** Un paramètre spécifié dépasse ses restrictions, n'est pas pris en charge ou ne peut pas être utilisé. Code d’état HTTP : 400 ** NoDataRetentionException ** `GetImages`a été demandé pour un flux qui ne conserve pas de données (c'est-à-dire qui a une `DataRetentionInHours` valeur de 0). Code d’état HTTP : 400 ** NotAuthorizedException ** Code d'état : 403, l'appelant n'est pas autorisé à effectuer une opération sur le flux donné, ou le jeton a expiré. Code d'état HTTP : 401 ** ResourceNotFoundException ** `GetImages`génère cette erreur lorsque Kinesis Video Streams ne trouve pas le flux que vous avez spécifié. `GetHLSStreamingSessionURL`et `GetDASHStreamingSessionURL` génère cette erreur si une session avec un `PlaybackMode` de `ON_DEMAND` ou `LIVE_REPLAY` est demandée pour un flux qui ne contient aucun fragment dans la plage de temps demandée, ou si une session avec un `PlaybackMode` of `LIVE` est demandée pour un flux qui ne contient aucun fragment au cours des 30 dernières secondes. Code d’état HTTP :404 ## Voir aussi Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit : + [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetImages)