GetImages

Dukungan terkelola untuk gambar menyediakan cara yang dikelola sepenuhnya untuk mendapatkan gambar dari data video yang dialirkan dan disimpan di Kinesis Video Streams. Anda dapat menggunakan gambar untuk menjalankan beban kerja machine learning (ML) seperti deteksi orang, hewan peliharaan, atau kendaraan. Gambar juga dapat digunakan untuk menambahkan elemen interaktif ke pemutaran, seperti pratinjau gambar untuk acara gerak dan menggosok untuk klip video.

GetImages juga mengambil daftar gambar yang sesuai dengan setiap stempel waktu untuk rentang waktu tertentu, interval pengambilan sampel, dan konfigurasi format gambar.

catatan

Anda harus terlebih dahulu memanggil GetDataEndpoint API untuk mendapatkan titik akhir. Kemudian kirim GetImages permintaan ke titik akhir ini menggunakan parameter --endpoint-url.

Persyaratan trek pemutaran video.

Sintaks Permintaan

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
}

URIParameter Permintaan

Permintaan tidak menggunakan URI parameter apa pun.

Isi Permintaan

Permintaan menerima data berikut dalam JSON format.

EndTimestamp

Stempel waktu akhir untuk rentang gambar yang akan dihasilkan. Jika rentang waktu antara StartTimestamp dan EndTimestamp lebih dari 300 detik di atasStartTimestamp, Anda akan menerimaIllegalArgumentException.

Tipe: Timestamp

Wajib: Ya

Format

Format yang akan digunakan untuk menyandikan gambar.

Tipe: String

Nilai yang Valid: JPEG | PNG

Wajib: Ya

FormatConfig

Daftar struktur pasangan kunci-nilai yang berisi parameter tambahan yang dapat diterapkan saat gambar dihasilkan. FormatConfigKuncinya adalahJPEGQuality, yang menunjukkan kunci JPEG kualitas yang akan digunakan untuk menghasilkan gambar. FormatConfigNilai menerima int dari 1 hingga 100. Jika nilainya 1, gambar akan dihasilkan dengan kualitas kurang dan kompresi terbaik. Jika nilainya 100, gambar akan dihasilkan dengan kualitas terbaik dan kompresi yang lebih sedikit. Jika tidak ada nilai yang diberikan, nilai default JPEGQuality kunci akan diatur ke 80.

Tipe: Peta string ke string

Entri Peta: Jumlah maksimum 1 item.

Kunci yang Valid: JPEGQuality

Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.

Pola nilai: ^[a-zA-Z_0-9]+

Wajib: Tidak

HeightPixels

Ketinggian gambar output yang digunakan bersamaan dengan WidthPixels parameter. Ketika keduanya HeightPixels dan WidthPixels parameter disediakan, gambar akan diregangkan agar sesuai dengan rasio aspek yang ditentukan. Jika hanya HeightPixels parameter yang disediakan, rasio aspek aslinya akan digunakan untuk menghitung WidthPixels rasio. Jika tidak ada parameter yang disediakan, ukuran gambar asli akan dikembalikan.

Jenis: Integer

Rentang yang Valid: Nilai minimum 1. Nilai maksimum 2160.

Wajib: Tidak

ImageSelectorType

Asal usul stempel waktu Server atau Produser yang digunakan untuk menghasilkan gambar.

Tipe: String

Nilai yang Valid: PRODUCER_TIMESTAMP | SERVER_TIMESTAMP

Wajib: Ya

MaxResults

Jumlah maksimum gambar yang akan dikembalikan oleh fileAPI.

catatan

Batas default adalah 25 gambar per API respons. Memberikan nilai yang MaxResults lebih besar dari nilai ini akan menghasilkan ukuran halaman 25. Setiap hasil tambahan akan diberi paginasi.

Tipe: Long

Rentang yang Valid: Nilai minimum 1. Nilai maksimum 100.

Wajib: Tidak

NextToken

Token yang menentukan di mana harus memulai paginasi set Gambar berikutnya. Ini adalah GetImages:NextToken dari respons yang sebelumnya terpotong.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 4096.

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

Wajib: Tidak

SamplingInterval

Interval waktu dalam milidetik (ms) di mana gambar perlu dihasilkan dari aliran. Nilai minimum yang dapat diberikan adalah 200 ms (5 gambar per detik). Jika rentang timestamp kurang dari interval pengambilan sampel, gambar dari startTimestamp akan dikembalikan jika tersedia.

Jenis: Integer

Wajib: Ya

StartTimestamp

Titik awal dari mana gambar harus dihasilkan. Ini StartTimestamp harus berada dalam rentang waktu yang inklusif agar gambar dikembalikan.

Tipe: Timestamp

Wajib: Ya

StreamARN

Amazon Resource Name (ARN) dari aliran untuk mengambil gambar. Anda harus menentukan salah satu StreamName atauStreamARN.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 1024.

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

Wajib: Tidak

StreamName

Nama aliran dari mana untuk mengambil gambar. Anda harus menentukan salah satu StreamName atauStreamARN.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.

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

Wajib: Tidak

WidthPixels

Lebar gambar output yang digunakan bersamaan dengan HeightPixels parameter. Ketika keduanya WidthPixels dan HeightPixels parameter disediakan, gambar akan diregangkan agar sesuai dengan rasio aspek yang ditentukan. Jika hanya WidthPixels parameter yang disediakan atau jika hanya HeightPixels disediakan, a ValidationException akan dilemparkan. Jika tidak ada parameter yang disediakan, ukuran gambar asli dari aliran akan dikembalikan.

Jenis: Integer

Rentang yang Valid: Nilai minimum 1. Nilai maksimum 3840.

Wajib: Tidak

Sintaksis Respons

HTTP/1.1 200
Content-type: application/json

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

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Data berikut dikembalikan dalam JSON format oleh layanan.

Images

Daftar gambar yang dihasilkan dari aliran video. Jika tidak ada media yang tersedia untuk stempel waktu yang diberikan, NO_MEDIA kesalahan akan tercantum dalam output. Jika terjadi kesalahan saat gambar sedang dihasilkan, MEDIA_ERROR akan terdaftar dalam output sebagai penyebab gambar yang hilang.

Tipe: Array objek Image

NextToken

Token terenkripsi yang digunakan dalam permintaan untuk mendapatkan lebih banyak gambar.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 4096.

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

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

ClientLimitExceededException

Kinesis Video Streams telah membatasi permintaan karena Anda telah melampaui batas. Coba buat panggilan nanti. Untuk informasi tentang batasan, lihat Kuota Kinesis Video Streams.

HTTPKode Status: 400

InvalidArgumentException

Parameter yang ditentukan melebihi batasannya, tidak didukung, atau tidak dapat digunakan.

HTTPKode Status: 400

NotAuthorizedException

Kode Status: 403, Penelepon tidak berwenang untuk melakukan operasi pada aliran yang diberikan, atau token telah kedaluwarsa.

HTTPKode Status: 401

ResourceNotFoundException

GetImagesakan memunculkan kesalahan ini ketika Kinesis Video Streams tidak dapat menemukan aliran yang Anda tentukan.

GetHLSStreamingSessionURLdan GetDASHStreamingSessionURL membuang kesalahan ini jika sesi dengan PlaybackMode dari ON_DEMAND atau LIVE_REPLAY diminta untuk aliran yang tidak memiliki fragmen dalam rentang waktu yang diminta, atau jika sesi dengan PlaybackMode of LIVE diminta untuk aliran yang tidak memiliki fragmen dalam 30 detik terakhir.

HTTPKode Status: 404

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan ini API di salah satu bahasa khusus AWS SDKs, lihat berikut ini:

• AWS Antarmuka Baris Perintah

• AWS SDKuntuk. NET

• AWS SDKuntuk C ++

• AWS SDKuntuk Go v2

• AWS SDKuntuk Java V2

• AWS SDKuntuk JavaScript V3

• AWS SDKuntuk PHP V3

• AWS SDKuntuk Python

• AWS SDKpara Ruby V3