GetImages

Horodatage de fin de la plage d'images à générer. Si l'intervalle de temps entre StartTimestamp et EndTimestamp est supérieur à 300 secondesStartTimestamp, vous recevrez unIllegalArgumentException.

Type : Timestamp

Obligatoire : oui

Format qui sera utilisé pour encoder l'image.

Type : chaîne

Valeurs valides : JPEG | PNG

Obligatoire : oui

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 leJPEGQuality, 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

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

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

Le nombre maximum d'images à renvoyer par l'API.

Type : long

Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.

Obligatoire : non

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

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 : entier

Obligatoire : oui

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

Le nom de ressource Amazon (ARN) du flux à partir duquel récupérer les images. Vous devez spécifier le StreamName ou leStreamARN.

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

Nom du flux à partir duquel récupérer les images. Vous devez spécifier le StreamName ou leStreamARN.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.

Modèle : [a-zA-Z0-9_.-]+

Obligatoire : non

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

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_MEDIAerreur 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

Le jeton crypté 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}

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 Kinesis Video Streams Limits.

Code d’état HTTP : 400

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

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

GetImagesgénère cette erreur lorsque Kinesis Video Streams ne trouve pas le flux que vous avez spécifié.

GetHLSStreamingSessionURLet 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