Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
GetImages
Recupera una lista de imágenes correspondiente a cada marca de tiempo para un intervalo de tiempo, intervalo de muestreo y configuración de formato de imagen determinados.
Sintaxis de la solicitud
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
}Parámetros de solicitud del URI
La solicitud no utiliza ningún parámetro de URI.
Cuerpo de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- EndTimestamp
-
La marca de tiempo final del rango de imágenes que se va a generar. Si el intervalo de tiempo entre
StartTimestampyEndTimestampestá más de 300 segundos por encimaStartTimestamp, recibirás unIllegalArgumentException.Tipo: Timestamp
Obligatorio: sí
- Format
-
El formato que se utilizará para codificar la imagen.
Tipo: String
Valores válidos:
JPEG | PNGObligatorio: sí
- FormatConfig
-
La lista de una estructura de pares clave-valor que contiene parámetros adicionales que se pueden aplicar cuando se genera la imagen. El
FormatConfigla clave es laJPEGQuality, que indica la clave de calidad JPEG que se utilizará para generar la imagen. ElFormatConfigEl valor acepta entradas del 1 al 100. Si el valor es 1, la imagen se generará con menor calidad y la mejor compresión. Si el valor es 100, la imagen se generará con la mejor calidad y con menos compresión. Si no se proporciona ningún valor, el valor predeterminado delJPEGQualityla clave se establecerá en 80.Tipo: mapa de cadena a cadena
Entradas de mapa: número máximo de 1 elemento.
Claves válidas:
JPEGQualityRestricciones de longitud de valores: longitud mínima de 0. La longitud máxima es de 256 caracteres.
Patrón de valores:
^[a-zA-Z_0-9]+Obligatorio: no
- HeightPixels
-
La altura de la imagen de salida que se utiliza junto con la
WidthPixelsparámetro. Cuando ambosHeightPixelsyWidthPixelsse proporcionan los parámetros, la imagen se estirará para ajustarse a la relación de aspecto especificada. Si tan solo elHeightPixelsse proporciona el parámetro, su relación de aspecto original se utilizará para calcular laWidthPixelsproporción. Si no se proporciona ninguno de los parámetros, se devolverá el tamaño de la imagen original.Tipo: entero
Rango válido: valor mínimo de 1. Valor máximo de 2160.
Obligatorio: no
- ImageSelectorType
-
El origen de las marcas de tiempo del servidor o del productor que se utilizarán para generar las imágenes.
Tipo: String
Valores válidos:
PRODUCER_TIMESTAMP | SERVER_TIMESTAMPObligatorio: sí
- MaxResults
-
La cantidad máxima de imágenes que devolverá la API.
nota
El límite predeterminado es de 25 imágenes por respuesta de API. Proporcionar un
MaxResultssi es mayor que este valor, se obtendrá un tamaño de página de 25. Los resultados adicionales se paginarán.Tipo: largo
Rango válido: valor mínimo de 1. Valor máximo de 100.
Obligatorio: no
- NextToken
-
Un token que especifica dónde empezar a paginar el siguiente conjunto de imágenes. Este es el
GetImages:NextTokende una respuesta previamente truncada.Tipo: String
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 4 096 caracteres.
Patrón:
[a-zA-Z0-9+/]+={0,2}Obligatorio: no
- SamplingInterval
-
El intervalo de tiempo en milisegundos (ms) en el que se deben generar las imágenes a partir de la transmisión. El valor mínimo que se puede proporcionar es de 200 ms (5 imágenes por segundo). Si el rango de fecha y hora es inferior al intervalo de muestreo, la imagen del
startTimestampse devolverá si está disponible.Tipo: entero
Obligatorio: sí
- StartTimestamp
-
El punto de partida desde el que se deben generar las imágenes. Esto
StartTimestampdebe estar dentro de un rango inclusivo de marcas de tiempo para que se devuelva una imagen.Tipo: Timestamp
Obligatorio: sí
- StreamARN
-
El nombre del recurso de Amazon (ARN) de la transmisión desde la que se van a recuperar las imágenes. Debe especificar uno de los
StreamNameo elStreamARN.Tipo: String
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 1024 caracteres.
Patrón:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+Obligatorio: no
- StreamName
-
El nombre de la transmisión de la que se van a recuperar las imágenes. Debe especificar uno de los
StreamNameo elStreamARN.Tipo: String
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.
Patrón:
[a-zA-Z0-9_.-]+Obligatorio: no
- WidthPixels
-
El ancho de la imagen de salida que se utiliza junto con la
HeightPixelsparámetro. Cuando ambosWidthPixelsyHeightPixelsse proporcionan los parámetros, la imagen se estirará para ajustarse a la relación de aspecto especificada. Si tan solo elWidthPixelsse proporciona el parámetro o si solo se proporciona elHeightPixelsse proporciona, unValidationExceptionserá arrojado. Si no se proporciona ninguno de los parámetros, se devolverá el tamaño de la imagen original de la transmisión.Tipo: entero
Rango válido: valor mínimo de 1. Valor máximo de 3840.
Obligatorio: no
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"Images": [
{
"Error": "string",
"ImageContent": "string",
"TimeStamp": number
}
],
"NextToken": "string"
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- Images
-
La lista de imágenes generadas a partir de la transmisión de vídeo. Si no hay contenido multimedia disponible para la marca de tiempo indicada, el
NO_MEDIAel error aparecerá en la salida. Si se produce un error mientras se genera la imagen,MEDIA_ERRORaparecerá en la salida como la causa de la falta de imagen.Tipo: Matriz de objetos Image
- NextToken
-
El token cifrado que se usó en la solicitud para obtener más imágenes.
Tipo: String
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 4 096 caracteres.
Patrón:
[a-zA-Z0-9+/]+={0,2}
Errores
Para obtener información sobre los errores comunes a todas las acciones, consulteErrores comunes.
- ClientLimitExceededException
-
Kinesis Video Streams ha limitado la solicitud porque ha superado un límite. Intenta hacer la llamada más tarde. Para obtener información sobre los límites, consulteLímites de transmisiones de vídeo de Kinesis.
Código de estado HTTP: 400
- InvalidArgumentException
-
Un parámetro especificado supera sus restricciones, no se admite o no se puede utilizar.
Código de estado HTTP: 400
- NotAuthorizedException
-
Código de estado: 403, la persona que llama no está autorizada a realizar una operación en la transmisión dada o el token ha caducado.
Código de estado HTTP: 401
- ResourceNotFoundException
-
GetImagesgenerará este error cuando Kinesis Video Streams no pueda encontrar la transmisión que especificó.GetHLSStreamingSessionURLyGetDASHStreamingSessionURLarroja este error si una sesión con unPlaybackModedeON_DEMANDoLIVE_REPLAYse solicita para una transmisión que no tiene fragmentos dentro del intervalo de tiempo solicitado, o si se trata de una sesión con unPlaybackModedeLIVEse solicita para una transmisión que no tiene fragmentos en los últimos 30 segundos.Código de estado HTTP: 404
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte:
