SendIceCandidate - Kinesis Video Streams

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

SendIceCandidate

Mengirim kandidat ICE ke penerima target. Prasyaratnya adalah klien harus sudah terhubung ke WebSocket titik akhir yang diperoleh dari API. GetSignalingChannelEndpoint

Jika jenis pengirim adalah penampil, maka ia mengirim kandidat ICE ke master. Juga, tidak perlu menentukan RecipientClientId dan nilai tertentu untuk RecipientClientId diabaikan. Jika jenis pengirim adalah master, kandidat ICE dikirim ke target yang ditentukan oleh. RecipientClientId RecipientClientIdadalah masukan yang diperlukan dalam kasus ini.

Aplikasi klien master diizinkan mengirim kandidat ICE ke penampil mana pun, sedangkan aplikasi klien penampil hanya diizinkan mengirim kandidat ICE ke aplikasi klien utama. Jika aplikasi klien penampil mencoba mengirim kandidat ICE ke aplikasi klien penampil lain, permintaan tersebut TIDAK akan dihormati.

Permintaan

{ "action": "ICE_CANDIDATE", "recipientClientId": "string", "messagePayload": "string", "correlationId": "string" }
  • action - Jenis pesan yang sedang dikirim.

    • Jenis: ENUM

    • Nilai valid: SDP_OFFER, SDP_ANSWER, ICE_CANDIDATE

    • Panjang batasan: Panjang minimum 1. Panjang maksimum 256.

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

    • Diperlukan: Ya

  • recipientClientId- Pengidentifikasi unik untuk penerima.

    • Jenis: String

    • Panjang batasan: Panjang minimum 1. Panjang maksimum 256.

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

    • Wajib: Tidak

  • MessagePayLoad - Konten pesan yang dikodekan base64.

    • Jenis: String

    • Panjang batasan: Panjang minimum 1. Panjang maksimum 10K.

    • Wajib: Ya

  • CorrelationID - Sebuah identifier unik untuk pesan.

    • Jenis: String

    • Panjang batasan: Panjang minimum 1. Panjang maksimum 256.

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

    • Wajib: Tidak

Response

Tidak ada respons yang dikembalikan jika pesan berhasil diterima oleh backend pensinyalan. Jika layanan mengalami kesalahan dan jika correlationId ditentukan dalam permintaan, rincian kesalahan dikembalikan sebagai STATUS_RESPONSE pesan. Untuk informasi selengkapnya, lihat Penerimaan Pesan Asinkron.

Kesalahan

Batas/Pelambatan

API ini dibatasi pada tingkat akun jika API dipanggil pada tingkat yang terlalu tinggi. Kesalahan kembali saat dibatasi dengan. ClientLimitExceededException

Idempoten

API ini tidak idempoten.

Coba lagi perilaku

Ini dihitung sebagai panggilan API baru.

Panggilan bersamaan

Panggilan bersamaan diizinkan. Penawaran dikirim satu kali per setiap panggilan.