GetImages - Flusso di video Amazon Kinesis
Sintassi della richiestaParametri della richiesta URI:Corpo della richiestaSintassi della rispostaElementi di rispostaErroriVedi anche

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

GetImages

Recupera un elenco di immagini corrispondenti a ciascun timestamp per un determinato intervallo di tempo, intervallo di campionamento e configurazione del formato dell'immagine.

Nota

Devi prima chiamare l'GetDataEndpointAPI per ottenere un endpoint. Quindi invia le GetImages richieste a questo endpoint utilizzando il parametro --endpoint-url.

Requisiti per la riproduzione dei brani video.

Sintassi della richiesta

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
}

Parametri della richiesta URI:

La richiesta non utilizza parametri URI.

Corpo della richiesta

La richiesta accetta i seguenti dati in formato JSON.

EndTimestamp

Il timestamp di fine dell'intervallo di immagini da generare. Se l'intervallo di tempo compreso tra StartTimestamp e EndTimestamp supera i 300 secondiStartTimestamp, riceverai un. IllegalArgumentException

Tipo: Timestamp

Campo obbligatorio: sì

Format

Il formato che verrà utilizzato per codificare l'immagine.

▬Tipo: stringa

Valori validi: JPEG | PNG

Campo obbligatorio: sì

FormatConfig

L'elenco di una struttura di coppie chiave-valore che contiene parametri aggiuntivi che possono essere applicati quando viene generata l'immagine. La FormatConfig chiave è laJPEGQuality, che indica la chiave di qualità JPEG da utilizzare per generare l'immagine. Il FormatConfig valore accetta int da 1 a 100. Se il valore è 1, l'immagine verrà generata con una qualità inferiore e la compressione migliore. Se il valore è 100, l'immagine verrà generata con la migliore qualità e una compressione inferiore. Se non viene fornito alcun valore, il valore predefinito della JPEGQuality chiave verrà impostato su 80.

Tipo: mappatura stringa a stringa

Voci sulla mappa: numero massimo di 1 elemento.

Chiavi valide: JPEGQuality

Limiti di lunghezza del valore: lunghezza minima di 0. La lunghezza massima è 256 caratteri.

Modello di valore: ^[a-zA-Z_0-9]+

Campo obbligatorio: no

HeightPixels

L'altezza dell'immagine di output utilizzata insieme al parametro. WidthPixels Quando vengono forniti entrambi HeightPixels i WidthPixels parametri, l'immagine verrà allungata per adattarsi alle proporzioni specificate. Se viene fornito solo il HeightPixels parametro, per calcolare il rapporto verranno utilizzate le WidthPixels proporzioni originali. Se non viene fornito alcun parametro, verrà restituita la dimensione originale dell'immagine.

Tipo: integer

Intervallo valido: valore minimo di 1. Valore massimo di 2160.

Campo obbligatorio: no

ImageSelectorType

L'origine dei timestamp del Server o del Produttore da utilizzare per generare le immagini.

▬Tipo: stringa

Valori validi: PRODUCER_TIMESTAMP | SERVER_TIMESTAMP

Campo obbligatorio: sì

MaxResults

Il numero massimo di immagini che devono essere restituite dall'API.

Nota

Il limite predefinito è di 25 immagini per risposta API. Fornendo un valore MaxResults superiore a questo si otterrà una dimensione della pagina di 25. Eventuali risultati aggiuntivi verranno suddivisi in pagine.

Tipo: long

Intervallo valido: valore minimo di 1. valore massimo pari a 100.

Campo obbligatorio: no

NextToken

Un token che specifica da dove iniziare a impaginare il prossimo set di immagini. Questo è il risultato di una GetImages:NextToken risposta precedentemente troncata.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. Lunghezza massima di 4096.

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

Campo obbligatorio: no

SamplingInterval

L'intervallo di tempo in millisecondi (ms) in cui le immagini devono essere generate dallo stream. Il valore minimo che può essere fornito è 200 ms (5 immagini al secondo). Se l'intervallo del timestamp è inferiore all'intervallo di campionamento, l'immagine da startTimestamp verrà restituita, se disponibile.

Tipo: integer

Campo obbligatorio: sì

StartTimestamp

Il punto di partenza da cui devono essere generate le immagini. Affinché un'immagine possa essere restituita, questo StartTimestamp deve rientrare in un intervallo completo di timestamp.

Tipo: Timestamp

Campo obbligatorio: sì

StreamARN

L'Amazon Resource Name (ARN) dello stream da cui recuperare le immagini. È necessario specificare il StreamName o il. StreamARN

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 1024 caratteri.

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

Campo obbligatorio: no

StreamName

Il nome dello stream da cui recuperare le immagini. È necessario specificare il StreamName o ilStreamARN.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 256 caratteri.

Modello: [a-zA-Z0-9_.-]+

Campo obbligatorio: no

WidthPixels

La larghezza dell'immagine di output utilizzata insieme al HeightPixels parametro. Quando vengono forniti entrambi WidthPixels i HeightPixels parametri, l'immagine verrà allungata per adattarsi alle proporzioni specificate. Se viene fornito solo il WidthPixels parametro o se HeightPixels viene fornito solo il, ValidationException verrà generato un. Se non viene fornito nessun parametro, verrà restituita la dimensione dell'immagine originale dello stream.

Tipo: integer

Intervallo valido: valore minimo di 1. Valore massimo di 3840.

Campo obbligatorio: no

Sintassi della risposta

HTTP/1.1 200
Content-type: application/json

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

Elementi di risposta

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

Images

L'elenco delle immagini generate dal flusso video. Se non è disponibile alcun supporto per il timestamp specificato, l'NO_MEDIAerrore verrà elencato nell'output. Se si verifica un errore durante la generazione dell'immagine, MEDIA_ERROR questo verrà elencato nell'output come causa dell'immagine mancante.

Tipo: matrice di oggetti Image

NextToken

Il token crittografato utilizzato nella richiesta per ottenere altre immagini.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. Lunghezza massima di 4096.

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

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

ClientLimitExceededException

Kinesis Video Streams ha limitato la richiesta perché hai superato un limite. Prova a effettuare la chiamata più tardi. Per informazioni sui limiti, consulta Kinesis Video Streams Limits.

Codice di stato HTTP: 400

InvalidArgumentException

Un parametro specificato supera le restrizioni, non è supportato o non può essere utilizzato.

Codice di stato HTTP: 400

NotAuthorizedException

Codice di stato: 403, il chiamante non è autorizzato a eseguire un'operazione sullo stream specificato o il token è scaduto.

Codice di stato HTTP: 401

ResourceNotFoundException

GetImagesgenererà questo errore quando Kinesis Video Streams non riesce a trovare lo stream specificato.

GetHLSStreamingSessionURLe GetDASHStreamingSessionURL genera questo errore se LIVE_REPLAY viene richiesta una sessione con un PlaybackMode of ON_DEMAND o per uno stream che non contiene frammenti nell'intervallo di tempo richiesto, o se LIVE viene richiesta una sessione con un PlaybackMode of per uno stream che non contiene frammenti negli ultimi 30 secondi.

Codice di stato HTTP: 404

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli AWS SDK specifici della lingua, consulta quanto segue: