GetImages - Amazon Kinesis Video Streams
Sintaxe da SolicitaçãoParâmetros da solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

GetImages

O suporte gerenciado para imagens fornece uma forma totalmente gerenciada de obter imagens dos dados de vídeo transmitidos e armazenados no Kinesis Video Streams. Você pode usar imagens para executar cargas de trabalho de aprendizado de máquina (ML), como detecção de pessoas, animais de estimação ou veículos. As imagens também podem ser usadas para adicionar elementos interativos à reprodução, como visualizações de imagens para eventos de movimento e depuração para um videoclipe.

GetImages também recupera uma lista de imagens correspondentes a cada registro de data e hora para um determinado intervalo de tempo, intervalo de amostragem e configuração de formato de imagem.

nota

Você deve primeiro chamar a GetDataEndpoint API para obter um endpoint. Em seguida, envie as GetImages solicitações para esse endpoint usando o parâmetro --endpoint-url.

Requisitos de faixa de reprodução de vídeo.

Sintaxe da Solicitação

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 da solicitação de URI

A solicitação não usa nenhum parâmetro de URI.

Corpo da Solicitação

A solicitação aceita os dados a seguir no formato JSON.

EndTimestamp

A data e hora de término da variedade de imagens a serem geradas. Se o intervalo de tempo entre StartTimestamp e EndTimestamp for superior a 300 segundosStartTimestamp, você receberá umIllegalArgumentException.

Tipo: Timestamp

Obrigatório: Sim

Format

O formato que será usado para codificar a imagem.

Tipo: String

Valores Válidos: JPEG | PNG

Obrigatório: Sim

FormatConfig

A lista de uma estrutura de pares de valores-chave que contém parâmetros extras que podem ser aplicados quando a imagem é gerada. A FormatConfig chave é aJPEGQuality, que indica a chave de qualidade JPEG a ser usada para gerar a imagem. O FormatConfig valor aceita ints de 1 a 100. Se o valor for 1, a imagem será gerada com menos qualidade e a melhor compressão. Se o valor for 100, a imagem será gerada com a melhor qualidade e menos compressão. Se nenhum valor for fornecido, o valor padrão da JPEGQuality chave será definido como 80.

Tipo: mapa de string para string

Entradas do mapa: número máximo de um item.

Chaves válidas: JPEGQuality

Restrições de comprimento do valor: comprimento mínimo de 0. Tamanho máximo de 256.

Padrão de valor: ^[a-zA-Z_0-9]+

Obrigatório: Não

HeightPixels

A altura da imagem de saída usada em conjunto com o WidthPixels parâmetro. Quando os WidthPixels parâmetros HeightPixels e parâmetros forem fornecidos, a imagem será esticada para se ajustar à proporção especificada. Se somente o HeightPixels parâmetro for fornecido, sua proporção original será usada para calcular a WidthPixels proporção. Se nenhum parâmetro for fornecido, o tamanho original da imagem será retornado.

Tipo: inteiro

Intervalo válido: valor mínimo de 1. Valor máximo de 2160.

Obrigatório: Não

ImageSelectorType

A origem dos registros de data e hora do servidor ou do produtor a serem usados para gerar as imagens.

Tipo: String

Valores Válidos: PRODUCER_TIMESTAMP | SERVER_TIMESTAMP

Obrigatório: Sim

MaxResults

O número máximo de imagens a serem retornadas pela API.

nota

O limite padrão é de 25 imagens por resposta da API. Fornecer um valor MaxResults maior que esse resultará em um tamanho de página de 25. Quaisquer resultados adicionais serão paginados.

Tipo: longo

Faixa válida: valor mínimo de 1. Valor máximo de 100.

Obrigatório: Não

NextToken

Um token que especifica por onde começar a paginar o próximo conjunto de imagens. Esse é o GetImages:NextToken de uma resposta truncada anteriormente.

Tipo: String

Restrições de comprimento: tamanho mínimo de 1. O tamanho máximo é 4.096.

Padrão: [a-zA-Z0-9+/]+={0,2}

Obrigatório: Não

SamplingInterval

O intervalo de tempo em milissegundos (ms) no qual as imagens precisam ser geradas a partir do fluxo. O valor mínimo que pode ser fornecido é 200 ms (5 imagens por segundo). Se o intervalo do timestamp for menor que o intervalo de amostragem, a imagem do startTimestamp será retornada, se disponível.

Tipo: inteiro

Obrigatório: não

StartTimestamp

O ponto de partida a partir do qual as imagens devem ser geradas. Isso StartTimestamp deve estar dentro de um intervalo inclusivo de registros de data e hora para que uma imagem seja retornada.

Tipo: Timestamp

Obrigatório: Sim

StreamARN

O Amazon Resource Name (ARN) do stream do qual recuperar as imagens. Você deve especificar o StreamName ou StreamARN o.

Tipo: String

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.024.

Padrão: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Obrigatório: Não

StreamName

O nome do fluxo do qual recuperar as imagens. Você deve especificar o StreamName ou StreamARN o.

Tipo: String

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.

Padrão: [a-zA-Z0-9_.-]+

Obrigatório: Não

WidthPixels

A largura da imagem de saída usada em conjunto com o HeightPixels parâmetro. Quando os HeightPixels parâmetros WidthPixels e parâmetros forem fornecidos, a imagem será esticada para se ajustar à proporção especificada. Se somente o WidthPixels parâmetro for fornecido ou se somente o HeightPixels for fornecido, um ValidationException será lançado. Se nenhum parâmetro for fornecido, o tamanho original da imagem do stream será retornado.

Tipo: inteiro

Intervalo válido: valor mínimo de 1. Valor máximo de 3840.

Obrigatório: Não

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "Images": [ 
      { 
         "Error": "string",
         "ImageContent": "string",
         "TimeStamp": number
      }
   ],
   "NextToken": "string"
}

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

Images

A lista de imagens geradas a partir do stream de vídeo. Se não houver mídia disponível para o carimbo de data/hora especificado, o NO_MEDIA erro será listado na saída. Se ocorrer um erro enquanto a imagem estiver sendo gerada, MEDIA_ERROR ele será listado na saída como a causa da imagem ausente.

Tipo: matriz de objetos Image

NextToken

O token criptografado usado na solicitação para obter mais imagens.

Tipo: String

Restrições de comprimento: tamanho mínimo de 1. O tamanho máximo é 4.096.

Padrão: [a-zA-Z0-9+/]+={0,2}

Erros

Para obter informações sobre os erros comuns retornados pelas ações, consulte Erros comuns.

ClientLimitExceededException

O Kinesis Video Streams limitou a solicitação porque você excedeu um limite. Tente fazer a ligação mais tarde. Para obter informações sobre limites, consulte Cotas do Kinesis Video Streams.

Código de status HTTP: 400

InvalidArgumentException

Um parâmetro especificado excede suas restrições, não é suportado ou não pode ser usado.

Código de status HTTP: 400

NoDataRetentionException

GetImagesfoi solicitado para um fluxo que não retém dados (ou seja, tem um DataRetentionInHours de 0).

Código de status HTTP: 400

NotAuthorizedException

Código de status: 403, O chamador não está autorizado a realizar uma operação no stream fornecido ou o token expirou.

Código de status HTTP: 401

ResourceNotFoundException

GetImagesgerará esse erro quando o Kinesis Video Streams não conseguir encontrar o stream que você especificou.

GetHLSStreamingSessionURLe GetDASHStreamingSessionURL gere esse erro se uma sessão com um PlaybackMode de ON_DEMAND ou LIVE_REPLAY for solicitada para um fluxo que não tem fragmentos dentro do intervalo de tempo solicitado, ou se uma sessão com um PlaybackMode of LIVE for solicitada para um fluxo que não tem fragmentos nos últimos 30 segundos.

Código de status HTTP: 404

Consulte também

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: