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
El soporte gestionado para imágenes proporciona una forma totalmente gestionada de obtener imágenes de los datos de vídeo transmitidos y almacenados en Kinesis Video Streams. Puede usar imágenes para ejecutar cargas de trabajo de aprendizaje automático (ML), como la detección de personas, mascotas o vehículos. Las imágenes también se pueden utilizar para añadir elementos interactivos a la reproducción, como previsualizaciones de imágenes para eventos de movimiento o para barrer un videoclip.
GetImages también recupera una lista de imágenes correspondientes a cada marca de tiempo para un intervalo de tiempo, un intervalo de muestreo y una configuración de formato de imagen determinados.
nota
Primero debe llamar al GetDataEndpoint API para obtener un punto final. A continuación, envíe las GetImages solicitudes a este punto final mediante el parámetro --endpoint-url.
Requisitos de la pista de reproducción de vídeo.
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
}URIParámetros de solicitud
La solicitud no utiliza ningún URI parámetro.
Cuerpo de la solicitud
La solicitud acepta los siguientes datos en JSON formato.
- EndTimestamp
-
La marca de tiempo final del rango de imágenes que se va a generar. Si el intervalo de tiempo
StartTimestampcomprendido entre yEndTimestampsupera los 300 segundosStartTimestamp, recibirá un.IllegalArgumentExceptionTipo: marca temporal
Obligatorio: sí
- Format
-
El formato que se utilizará para codificar la imagen.
Tipo: cadena
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 al generar la imagen. La
FormatConfigclave es laJPEGQuality, que indica la clave JPEG de calidad que se utilizará para generar la imagen. ElFormatConfigvalor acepta enteros de 1 a 100. Si el valor es 1, la imagen se generará con menos calidad y con la mejor compresión. Si el valor es 100, la imagen se generará con la mejor calidad y menos compresión. Si no se proporciona ningún valor, el valor predeterminado de laJPEGQualityclave se establecerá en 80.Tipo: mapa de cadena a cadena
Entradas de mapa: número máximo de 1 elemento.
Claves válidas:
JPEGQualityLimitaciones de longitud de los 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 el
WidthPixelsparámetro. Cuando se proporcionan ambosHeightPixelsWidthPixelsparámetros, la imagen se estirará para ajustarse a la relación de aspecto especificada. Si solo se proporciona elHeightPixelsparámetro, se utilizará su relación de aspecto original paraWidthPixelscalcularla. Si no se proporciona ninguno de los parámetros, se devolverá el tamaño original de la imagen.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 van a utilizar para generar las imágenes.
Tipo: cadena
Valores válidos:
PRODUCER_TIMESTAMP | SERVER_TIMESTAMPObligatorio: sí
- MaxResults
-
El número máximo de imágenes que devolverá el. API
nota
El límite predeterminado es de 25 imágenes por API respuesta. Si se proporciona un valor
MaxResultssuperior a este valor, el tamaño de página será 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. Se trata
GetImages:NextTokende una respuesta previamente truncada.Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 4096 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 intervalo de marca temporal es inferior al intervalo de muestreo, se
startTimestampdevolverá la imagen del, si está disponible.Tipo: entero
Obligatorio: sí
- StartTimestamp
-
El punto de partida desde el que se deben generar las imágenes.
StartTimestampDebe estar dentro de un rango inclusivo de marcas de tiempo para que se devuelva una imagen.Tipo: marca temporal
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 el
StreamNameo elStreamARN.Tipo: cadena
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 secuencia de la que se van a recuperar las imágenes. Debe especificar el
StreamNameo elStreamARN.Tipo: cadena
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 el
HeightPixelsparámetro. Cuando se proporcionan ambosWidthPixelsHeightPixelsparámetros, la imagen se estirará para ajustarse a la relación de aspecto especificada. Si solo se proporciona elWidthPixelsparámetro o si soloHeightPixelsse proporciona el parámetro,ValidationExceptionaparecerá un. Si no se proporciona ninguno de los parámetros, se devolverá el tamaño de imagen original de la secuencia.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 de HTTP 200.
El servicio devuelve los siguientes datos en JSON formato.
- 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_MEDIAerror aparecerá en la salida. Si se produce un error durante la generación de la imagen,MEDIA_ERRORaparecerá en el resultado como la causa de la falta de imagen.Tipo: matriz de objetos Image
- NextToken
-
El token cifrado que se utilizó en la solicitud para obtener más imágenes.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 4096 caracteres.
Patrón:
[a-zA-Z0-9+/]+={0,2}
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- ClientLimitExceededException
-
Kinesis Video Streams ha limitado la solicitud porque ha superado un límite. Intente realizar la llamada más tarde. Para obtener información sobre los límites, consulte Cuotas de Kinesis Video Streams.
HTTPCódigo de estado: 400
- InvalidArgumentException
-
Un parámetro específico supera sus restricciones, no se admite o no se puede usar.
HTTPCódigo de estado: 400
- NotAuthorizedException
-
Código de estado: 403, la persona que llama no está autorizada a realizar ninguna operación en la transmisión determinada o el token ha caducado.
HTTPCódigo de estado: 401
- ResourceNotFoundException
-
GetImagesmostrará este error cuando Kinesis Video Streams no encuentre la transmisión que ha especificado.GetHLSStreamingSessionURLyGetDASHStreamingSessionURLarroja este error si una sesión con unPlaybackModedeON_DEMANDoLIVE_REPLAYse solicita una transmisión que no tiene fragmentos en el intervalo de tiempo solicitado, o siLIVEse solicita una sesión con unPlaybackModede o para una transmisión que no tiene fragmentos en los últimos 30 segundos.HTTPCódigo de estado: 404
Véase también
Para obtener más información sobre cómo usarlo API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
