ConnectAsViewer

Terhubung sebagai penampil ke saluran pensinyalan yang ditentukan oleh titik akhir. Pustaka WebSocket yang sesuai dapat digunakan untuk terhubung ke titik akhir websocket (WSS) aman yang diperoleh dari panggilan API. GetSignalingEndpoint Nama Sumber Daya Amazon (ARN) dari saluran pensinyalan dan ID klien harus disediakan sebagai parameter string kueri. Ada titik akhir terpisah untuk menghubungkan sebagai master dan sebagai penampil. Jika ada koneksi yang ada dengan sama ClientId seperti yang ditentukan dalam permintaan, koneksi baru diutamakan. Metadata koneksi ditimpa dengan informasi baru.

Permintaan

"X-Amz-ChannelARN": "string",
"X-Amz-ClientId": "string"

• X-AMZ-channelarn - ARN dari saluran pensinyalan.

  • Jenis: string

  • Panjang batasan: Panjang minimum 1. Panjang maksimal 1024

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

  • Wajib: Ya

• X-Amz- ClientId - Pengidentifikasi unik untuk klien.

  • Jenis: string

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

  • Pola: ^(?!(?i)AWS_.*)[a-zA-Z0-9_.-]

    catatan

    X-Amz-ClientIdTidak bisa mulai denganAWS_.

  • Wajib: Ya

Respons

200 OK kode status HTTP dengan badan kosong.

Kesalahan

• InvalidArgumentException

  Parameter yang ditentukan melebihi batasannya, tidak didukung, atau tidak dapat digunakan. Untuk informasi selengkapnya, lihat pesan yang dikembalikan.

  Kode Status HTTP: 400

• AccessDeniedException

  Penelepon tidak berwenang untuk mengakses saluran yang diberikan atau token telah kedaluwarsa.

  Kode Status HTTP: 403

• ResourceNotFoundException

  Saluran itu tidak ada.

  Kode Status HTTP: 404

• ClientLimitExceededException

  Ketika API dipanggil pada tingkat yang terlalu tinggi atau ketika ada lebih dari jumlah maksimum pemirsa yang didukung yang terhubung ke saluran. Untuk informasi selengkapnya, lihat Amazon Kinesis Video Streams dengan kuota layanan WebRTC dan Error Retries dan Exponential Backoff di. AWS

  Kode Status HTTP: 400

Batas/Pelambatan

API ini dibatasi pada tingkat akun jika API dipanggil pada tingkat yang terlalu tinggi atau ketika jumlah maksimum penonton yang didukung terhubung ke saluran lebih dari jumlah maksimum yang didukung. Kesalahan kembali saat dibatasi dengan. ClientLimitExceededException

Idempoten

Jika koneksi sudah ada untuk yang ditentukan ClientId dan saluran, metadata koneksi diperbarui dengan informasi baru.

Coba lagi perilaku

Ini dihitung sebagai panggilan API baru.

Panggilan bersamaan

Panggilan bersamaan diizinkan, metadata koneksi diperbarui untuk setiap panggilan.