GetImages - Amazon Kinesis Video Streams
請求語法URI請求參數請求主體回應語法回應元素錯誤另請參閱

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

GetImages

對映像的受管理支援提供完全受控的方式，可從 Kinesis Video Streams 中串流和儲存的視訊資料取得影像。您可以使用影像執行機器學習 (ML) 工作負載，例如人員、寵物或車輛偵測。影像也可用來新增互動元素以進行播放，例如動作事件的影像預覽和拖曳視訊片段。

GetImages 還檢索對應於給定時間範圍，採樣間隔和圖像格式配置的每個時間戳的圖像列表。

注意

您必須先呼叫GetDataEndpointAPI以取得端點。然後使用 --end 點 url 參數將GetImages請求發送到此端點。

視頻播放軌道要求。

請求語法

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
}

URI請求參數

請求不使用任何URI參數。

請求主體

請求接受以下JSON格式的數據。

EndTimestamp

要產生的影像範圍的結束時間戳記。如果StartTimestamp和EndTimestamp之間的時間範圍超過 300 秒以上StartTimestamp，您將收到一個IllegalArgumentException.

類型：Timestamp

必要：是

Format

將用於編碼圖像的格式。

類型：字串

有效值:JPEG | PNG

必要：是

FormatConfig

鍵值對結構的清單，其中包含可在產生影像時套用的額外參數。關FormatConfig鍵是JPEGQuality，它表示用於生成圖像的JPEG質量關鍵。該FormatConfig值接受從 1 到 100 的整數。如果值為 1，則會以較低的品質和最佳壓縮方式產生影像。如果值為 100，則會以最佳品質和較少的壓縮產生影像。如果未提供任何值，JPEGQuality金鑰的預設值將設定為 80。

類型：字串到字串映射

地圖項目：1 個項目的最大數量。

有效金鑰：JPEGQuality

值長度限制：最小長度為 0。長度上限為 256。

值模式：^[a-zA-Z_0-9]+

必要：否

HeightPixels

與WidthPixels參數搭配使用的輸出影像高度。當同時提供HeightPixels和WidthPixels參數時，圖像將被拉伸以適應指定的縱橫比。如果僅提供HeightPixels參數，則將使用其原始縱橫比來計算WidthPixels比例。如果兩個參數都沒有提供，原始圖像大小將被返回。

類型：整數

有效範圍：最小值為 1。最大值為 2160。

必要：否

ImageSelectorType

用來產生影像的伺服器或製作者時間戳記的來源。

類型：字串

有效值:PRODUCER_TIMESTAMP | SERVER_TIMESTAMP

必要：是

MaxResults

要傳回的影像數目上限API。

注意

預設限制為每個API回應 25 張影像。如果提供MaxResults大於此值，頁面大小將為 25。任何額外的結果將被分頁。

類型：Long

有效範圍：最小值為 1。最大值為 100。

必要：否

NextToken

指定從何處開始分頁下一組影像的權杖。這是先前截斷的GetImages:NextToken回應。

類型：字串

長度限制：長度下限為 1。長度上限為 4096。

模式：[a-zA-Z0-9+/]+={0,2}

必要：否

SamplingInterval

需要從串流產生影像的時間間隔 (毫秒)。可提供的最小值為 200 ms (每秒 5 張影像)。如果時間戳記範圍小於取樣間隔，則startTimestamp會傳回來自的影像 (如果可用)。

類型：整數

必要：是

StartTimestamp

應從中生成圖像的起點。這StartTimestamp必須在包含的時間戳記範圍內，才能傳回影像。

類型：Timestamp

必要：是

StreamARN

要從中擷取影像的資料流的 Amazon 資源名稱 (ARN)。您必須指定StreamName或StreamARN。

類型：字串

長度限制：長度下限為 1。長度上限為 1024。

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

必要：否

StreamName

要從中擷取影像的串流名稱。您必須指定StreamName或StreamARN。

類型：字串

長度限制：長度下限為 1。長度上限為 256。

模式：[a-zA-Z0-9_.-]+

必要：否

WidthPixels

與HeightPixels參數一起使用的輸出影像寬度。當同時提供WidthPixels和HeightPixels參數時，圖像將被拉伸以適應指定的縱橫比。如果僅提供了WidthPixels參數，或者只提HeightPixels供了參數，ValidationException將拋出一個。如果兩個參數都沒有提供，從流的原始圖像大小將被返回。

類型：整數

有效範圍：最小值為 1。最大值為 3840。

必要：否

回應語法

HTTP/1.1 200
Content-type: application/json

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

回應元素

如果動作成功，服務會傳回 HTTP 200 回應。

服務會以JSON格式傳回下列資料。

Images

從視訊串流產生的影像清單。如果給定的時間戳沒有可用的媒體，則NO_MEDIA錯誤將列在輸出中。如果在產生影像時發生錯誤，MEDIA_ERROR將會列在輸出中做為遺失影像的原因。

類型：Image 物件陣列

NextToken

要求中用來取得更多影像的加密權杖。

類型：字串

長度限制：長度下限為 1。長度上限為 4096。

模式：[a-zA-Z0-9+/]+={0,2}

錯誤

如需所有動作常見錯誤的資訊，請參閱常見錯誤。

ClientLimitExceededException

Kinesis Video Streams 已限制要求，因為您已超過限制。稍後再嘗試撥打電話。如需限制的相關資訊，請參閱 Kinesis Video Streams 配額。

HTTP狀態碼:

InvalidArgumentException

指定的參數超出其限制、不受支援或無法使用。

HTTP狀態碼:

NotAuthorizedException

狀態碼：403，調用者未授權在給定流上執行操作，或令牌已過期。

HTTP狀態碼:4

ResourceNotFoundException

GetImages當 Kinesis 影片串流找不到您指定的串流時，就會擲回此錯誤。

GetHLSStreamingSessionURL如果在請求的時間範圍內沒有片段PlaybackMode的流請求具有 ON_DEMAND or LIVE_REPLAY 的會話，或者如果在過去 30 秒內沒有片段PlaybackMode的LIVE流請求具有 a 的會話，則GetDASHStreamingSessionURL拋出此錯誤。

HTTP狀態碼:

另請參閱

如需有關API在其中一種特定語言中使用此功能的詳細資訊 AWS SDKs，請參閱下列內容：