GetImages - Amazon Kinesis Video Streams

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 immagine.

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 finale per la gamma di immagini da generare.

Type: Time stamp

Campo obbligatorio: Sì

Format

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

Type: Stringa

Valori validi: JPEG | PNG

Campo obbligatorio: Sì

FormatConfig

L'elenco di una struttura di coppia chiave-valore che contiene parametri aggiuntivi che possono essere applicati quando viene generata l'immagine. LaFormatConfigkey è ilJPEGQuality, che indica la chiave di qualità JPEG da utilizzare per generare l'immagine. LaFormatConfigil valore accetta ints da 1 a 100. Se il valore è 1, l'immagine verrà generata con minore qualità e con la migliore compressione. Se il valore è 100, l'immagine verrà generata con la migliore qualità e meno compressione. Se non viene fornito alcun valore, il valore predefinito delJPEGQualityla chiave sarà impostata su 80.

Type: mappatura stringa a stringa

Voci mappa: Numero massimo di 1 elemento.

Chiavi valide: JPEGQuality

Vincoli della lunghezza valore: Lunghezza minima pari a 0. La lunghezza massima è 256 caratteri.

Pattern valore:^[a-zA-Z_0-9]+

Campo obbligatorio: No

HeightPixels

L'altezza dell'immagine di output utilizzata in combinazione con ilWidthPixelsParametro . Quando entrambiHeightPixelseWidthPixelsvengono forniti parametri, l'immagine verrà allungata per adattarsi alle proporzioni specificate. Se soloHeightPixelsviene fornito il parametro, le proporzioni originali verranno utilizzate per calcolare ilWidthPixelsrapporto. Se non viene fornito alcun parametro, verrà restituita la dimensione originale dell'immagine.

Type: Numero intero

Intervallo valido: Valore minimo di 1. Valore massimo pari a 2160.

Campo obbligatorio: No

ImageSelectorType

Origine dei timestamp di Server o Producer da utilizzare per generare le immagini.

Type: 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 100 immagini per risposta API. I risultati aggiuntivi saranno impaginati.

Type: Lungo

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

Campo obbligatorio: No

NextToken

Un token che specifica dove iniziare a impaginare il prossimo set di Immagini. Questo è ilGetImages:NextTokenda una risposta troncata in precedenza.

Type: Stringa

Vincoli 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) al quale le immagini devono essere generate dal flusso. Il valore minimo che può essere fornito è 3000 ms. Se l'intervallo di timestamp è inferiore all'intervallo di campionamento, l'immagine dalstartTimestampverrà restituito se disponibile.

Nota

Il valore minimo di 3000 ms è un limite morbido. Se necessario, è possibile richiedere una frequenza di campionamento inferiore.

Type: Numero intero

Intervallo valido: Valore minimo pari a 3000. Valore massimo pari a 20000.

Campo obbligatorio: Sì

StartTimestamp

Il punto di partenza da cui devono essere generate le immagini. QuestoStartTimestampdeve rientrare in un intervallo di timestamp inclusivo per la restituzione di un'immagine.

Type: Time stamp

Campo obbligatorio: Sì

StreamARN

L'ARN del flusso dal quale recuperare le immagini. È necessario specificare ilStreamNameo ilStreamARN.

Type: Stringa

Vincoli 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 del flusso dal quale recuperare le immagini. È necessario specificare ilStreamNameo ilStreamARN.

Type: Stringa

Vincoli 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 in combinazione con ilHeightPixelsParametro . Quando entrambiWidthPixelseHeightPixelsvengono forniti parametri, l'immagine verrà allungata per adattarsi alle proporzioni specificate. Se soloWidthPixelsviene fornito il parametro o se solo ilHeightPixelsviene fornito, aValidationExceptionverrà gettato. Se non viene fornito alcun parametro, verrà restituita la dimensione originale dell'immagine dello stream.

Type: Numero intero

Intervallo valido: Valore minimo di 1. Valore massimo pari a 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,NO_MEDIAl'errore verrà elencato nell'output. Se si verifica un errore durante la generazione dell'immagine,MEDIA_ERRORverrà elencato nell'output come causa dell'immagine mancante.

Type: Intervallo diImageoggetti

NextToken

Il token crittografato utilizzato nella richiesta per ottenere più immagini.

Type: Stringa

Vincoli 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 di, consultaLimiti per Kinesis Video Streams.

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 sul flusso 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.

GetHLSStreamingSessionURLeGetDASHStreamingSessionURLgenera questo errore se una sessione con unPlaybackModediON_DEMANDoLIVE_REPLAYè richiesto per uno stream che non ha frammenti nell'intervallo di tempo richiesto o se una sessione con unPlaybackModediLIVEè richiesto per uno stream che non ha frammenti negli ultimi 30 secondi.

Codice di stato HTTP: 404

Vedi anche

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