LiveBroadcasts: transition

Mengubah status siaran langsung YouTube dan memulai proses apa pun yang terkait dengan status baru. Misalnya, saat Anda mengubah status siaran menjadi testing, YouTube akan mulai mengirimkan video ke aliran monitor siaran tersebut. Sebelum memanggil metode ini, Anda harus mengonfirmasi bahwa nilai properti status.streamStatus untuk streaming yang terikat ke siaran Anda adalah active.

Kasus penggunaan umum

Permintaan

Permintaan HTTP

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/transition

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut. Untuk membaca lebih lanjut tentang autentikasi dan otorisasi, lihat Menerapkan autentikasi OAuth 2.0.

Cakupan
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parameter

Tabel berikut mencantumkan parameter yang didukung kueri ini. Semua parameter yang tercantum adalah parameter kueri.

Parameter
Parameter yang diperlukan
broadcastStatus string
Parameter broadcastStatus mengidentifikasi status yang akan diubah untuk siaran. Perhatikan bahwa untuk mengubah status siaran menjadi testing atau live, status.streamStatus harus active untuk streaming yang terikat ke siaran.

Nilai yang dapat diterima adalah:
  • complete – Siaran telah selesai. YouTube berhenti mengirimkan video.
  • live – Siaran terlihat oleh audiensnya. YouTube mengirimkan video ke aliran monitor siaran dan aliran siarannya.
  • testing – Mulai uji siaran. YouTube mengirimkan video ke aliran monitor siaran. Perhatikan bahwa Anda hanya dapat mengubah status siaran menjadi testing jika properti contentDetails.monitorStream.enableMonitorStream ditetapkan ke true.
id string
Parameter id menentukan ID unik siaran yang statusnya akan diubah.
part string
Parameter part menentukan daftar yang dipisahkan koma untuk satu atau beberapa properti resource liveBroadcast yang akan disertakan dalam respons API. Nama part yang dapat Anda sertakan dalam nilai parameter adalah id, snippet, contentDetails, dan status.
Parameter opsional
onBehalfOfContentOwner string
Parameter ini hanya dapat digunakan dalam permintaan yang diotorisasi dengan benar.

Catatan: Parameter ini ditujukan khusus untuk partner konten YouTube.

Parameter onBehalfOfContentOwner menunjukkan bahwa kredensial otorisasi permintaan mengidentifikasi pengguna YouTube CMS yang bertindak atas nama pemilik konten yang ditentukan dalam parameter value. Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola banyak channel YouTube yang berbeda. Parameter ini memungkinkan pemilik konten melakukan autentikasi satu kali dan mendapatkan akses ke semua data video dan channel mereka, tanpa harus memberikan kredensial autentikasi untuk setiap channel. Akun CMS yang digunakan pengguna untuk melakukan autentikasi harus ditautkan ke pemilik konten YouTube yang ditentukan.
onBehalfOfContentOwnerChannel string
Parameter ini hanya dapat digunakan dalam permintaan yang diotorisasi dengan benar.

Catatan: Parameter ini ditujukan khusus untuk partner konten YouTube.

Parameter onBehalfOfContentOwnerChannel menentukan ID channel YouTube dari channel yang akan ditambahkan video. Parameter ini diperlukan saat permintaan menentukan nilai untuk parameter onBehalfOfContentOwner, dan hanya dapat digunakan bersama dengan parameter tersebut. Selain itu, permintaan harus diotorisasi menggunakan akun CMS yang ditautkan ke pemilik konten yang ditentukan oleh parameter onBehalfOfContentOwner. Terakhir, channel yang ditentukan oleh nilai parameter onBehalfOfContentOwnerChannel harus ditautkan ke pemilik konten yang ditentukan oleh parameter onBehalfOfContentOwner.

Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola banyak channel YouTube yang berbeda. Parameter ini memungkinkan pemilik konten melakukan autentikasi satu kali dan melakukan tindakan atas nama channel yang ditentukan dalam nilai parameter, tanpa harus memberikan kredensial autentikasi untuk setiap channel terpisah.

Isi permintaan

Jangan berikan isi permintaan saat memanggil metode ini.

Respons

Jika berhasil, metode ini akan menampilkan resource liveBroadcast dalam isi respons.

Error

Tabel berikut mengidentifikasi pesan error yang dapat ditampilkan API sebagai respons terhadap panggilan ke metode ini. Untuk mengetahui detail selengkapnya, lihat YouTube Live Streaming API - Error.

Jenis error Detail error Deskripsi
backendError errorExecutingTransition Terjadi error saat mengubah status siaran.
forbidden (403) errorStreamInactive Transisi yang diminta tidak diizinkan saat streaming yang terikat ke siaran tidak aktif.
forbidden (403) invalidTransition Live streaming tidak dapat bertransisi dari status saat ini ke status yang diminta.
forbidden (403) redundantTransition Live streaming sudah dalam status yang diminta atau sedang diproses ke status yang diminta.
insufficientPermissions insufficientLivePermissions Permintaan tidak diotorisasi untuk mengubah status live streaming.
insufficientPermissions livePermissionBlocked Pengguna yang mengotorisasi permintaan tidak dapat melakukan streaming video live di YouTube saat ini. Untuk mengetahui detail yang menjelaskan alasan pengguna tidak dapat melakukan streaming video live, lihat setelan channel pengguna di Kelayakan fitur.
insufficientPermissions liveStreamingNotEnabled Pengguna yang mengotorisasi permintaan tidak diizinkan untuk melakukan streaming video langsung di YouTube. Untuk mengetahui informasi selengkapnya, lihat Kelayakan fitur.
notFound (404) liveBroadcastNotFound Siaran yang ditentukan oleh parameter id tidak ada.
rateLimitExceeded (403) userRequestsExceedRateLimit Pengguna telah mengirimkan terlalu banyak permintaan dalam jangka waktu tertentu.
rateLimitExceeded (403) concurrentBroadcastsExceedLimit Saluran sudah memiliki jumlah maksimum live streaming serentak. Satu atau beberapa siaran yang sudah live harus dihentikan sebelum siaran lain dapat dimulai di channel.
rateLimitExceeded (403) sharedIngestionBroadcastsExceedLimit Saluran sudah memiliki jumlah maksimum live streaming yang berbagi sumber penyerapan. Satu atau beberapa siaran tersebut harus dihentikan untuk memulai siaran yang diminta.
required (400) idRequired Parameter id yang diperlukan harus mengidentifikasi siaran yang statusnya ingin Anda ubah.
required (400) statusRequired Permintaan API harus menentukan nilai untuk parameter status.

Cobalah!

Gunakan APIs Explorer untuk memanggil API ini dan melihat permintaan API serta respons API.