LiveBroadcasts: control

Catatan: Metode liveBroadcasts.control tidak digunakan lagi dan akan berhenti berfungsi pada atau setelah 1 Oktober 2020. Setelah tanggal tersebut, semua panggilan ke metode ini akan menampilkan error terlarang (403), dan metode tersebut nantinya akan dihapus sepenuhnya.

Klien masih dapat menerapkan slading mereka sendiri dengan menambahkan overlay ke video yang dikirim ke server penyerapan YouTube. Lihat pengumuman penghentian.

Mengontrol setelan untuk slate yang dapat ditampilkan di streaming siaran.

Kasus penggunaan umum

Permintaan

Permintaan HTTP

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

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya satu cakupan berikut (baca selengkapnya tentang autentikasi dan otorisasi).

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
id string
Parameter id menentukan ID live streaming YouTube yang secara unik mengidentifikasi siaran saat slate sedang diupdate.
part string
Parameter part menentukan daftar yang dipisahkan koma dari 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
displaySlate boolean
Parameter displaySlate menentukan apakah slate diaktifkan atau dinonaktifkan.
offsetTimeMs unsigned long
Parameter offsetTimeMs menentukan offset waktu positif saat perubahan slate yang ditentukan akan terjadi. Nilainya diukur dalam milidetik dari awal streaming monitor siaran, yang merupakan waktu fase pengujian untuk siaran dimulai. Meskipun ditentukan dalam milidetik, nilainya sebenarnya merupakan perkiraan, dan YouTube menyelesaikan tindakan yang diminta sedekat mungkin dengan waktu tersebut.

Jika Anda tidak menentukan nilai untuk parameter ini, YouTube akan melakukan tindakan sesegera mungkin. Lihat panduan Memulai untuk detail selengkapnya.

Penting: Anda hanya boleh menentukan nilai untuk parameter ini jika streaming siaran tertunda.
onBehalfOfContentOwner string
Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Catatan: Parameter ini ditujukan secara eksklusif untuk partner konten YouTube.

Parameter onBehalfOfContentOwner menunjukkan bahwa kredensial otorisasi permintaan mengidentifikasi pengguna CMS YouTube yang bertindak atas nama pemilik konten yang ditentukan dalam nilai parameter. Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola berbagai channel YouTube. Dengan kebijakan ini, pemilik konten dapat mengautentikasi sekali serta mendapatkan akses ke semua data video dan channel mereka, tanpa harus memberikan kredensial autentikasi untuk setiap channel. Akun CMS yang diautentikasi pengguna harus ditautkan dengan pemilik konten YouTube yang ditentukan.
onBehalfOfContentOwnerChannel string
Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Parameter ini hanya dapat digunakan dalam permintaan yang sah dengan benar. Catatan: Parameter ini ditujukan khusus untuk partner konten YouTube.

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

Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola berbagai channel YouTube. Dengan kebijakan ini, pemilik konten dapat mengautentikasi sekali dan melakukan tindakan atas nama saluran yang ditentukan dalam nilai parameter, tanpa harus memberikan kredensial autentikasi untuk setiap saluran terpisah.
walltime datetime
Parameter walltime menentukan waktu jam dinding tempat perubahan slate yang ditentukan akan terjadi. Nilai ditetapkan dalam format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).

Isi permintaan

Jangan berikan isi permintaan saat memanggil metode ini.

Tanggapan

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

Error

Tabel berikut mengidentifikasi pesan error yang dapat ditampilkan API sebagai respons terhadap panggilan ke metode ini. Lihat dokumentasi pesan error untuk mengetahui detail selengkapnya.

Jenis error Detail error Deskripsi
backendError errorDisplaySlate Terjadi error ketika mengeksekusi tindakan yang diminta.
forbidden (403) liveBroadcastControlNotAllowed Tindakan yang diminta hanya diizinkan jika status siaran adalah live.
insufficientPermissions insufficientLivePermissions Pengguna tidak diizinkan untuk melakukan operasi yang diminta, mungkin karena pengguna tidak memiliki izin untuk melakukan live streaming.
insufficientPermissions liveStreamingNotEnabled Pengguna yang mengizinkan permintaan tersebut tidak dapat melakukan streaming video live di YouTube. Pengguna dapat menemukan informasi selengkapnya di https://www.youtube.com/features.
invalidValue (400) conflictingTimeFields Hanya salah satu dari offsetTimeMs dan walltime yang dapat ditentukan.
invalidValue (400) invalidOffsetTimeMs Parameter value offsetTimeMs tidak valid. Nilai parameter harus positif, tetapi parameter hanya dapat ditentukan jika streaming monitor siaran diaktifkan.
invalidValue (400) invalidWalltime Parameter value walltime tidak valid.
notFound (404) liveBroadcastNotFound Siaran yang ditentukan oleh parameter id tidak ada.
required (400) actionRequired Permintaan API perlu menentukan setidaknya satu tindakan. Saat ini, satu-satunya tindakan yang didukung adalah kemampuan untuk mengaktifkan atau menonaktifkan slate.
required (400) idRequired Parameter id yang diperlukan harus mengidentifikasi siaran yang sedang diperbarui.

Cobalah!

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