LiveBroadcasts: control

Catatan: Metode liveBroadcasts.control sudah 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 ini nantinya akan dihapus sepenuhnya.

Klien masih dapat menerapkan prediksi mereka sendiri dengan menambahkan overlay ke video yang dikirimkan ke server proses transfer YouTube. Lihat pengumuman penghentian.

Mengontrol setelan 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 salah 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 di slate yang diperbarui.
part string
Parameter part menentukan daftar yang dipisahkan koma yang berisi 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 sejak awal streaming monitor siaran, yang merupakan waktu dimulainya fase pengujian untuk siaran. 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 tersebut sesegera mungkin. Lihat panduan Memulai untuk mengetahui 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 khusus 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 banyak channel YouTube yang berbeda. Pemilik konten dapat melakukan autentikasi sekali dan mendapatkan akses ke semua data channel serta video mereka, tanpa harus memberikan kredensial autentikasi untuk setiap channel. Akun CMS yang diautentikasi oleh pengguna harus ditautkan ke 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 diotorisasi dengan benar. Catatan: Parameter ini ditujukan khusus untuk partner konten YouTube.

Parameter onBehalfOfContentOwnerChannel menentukan ID channel YouTube dari channel yang ditambahi video. Parameter ini diperlukan saat permintaan menentukan nilai untuk parameter onBehalfOfContentOwner, dan hanya dapat digunakan bersama dengan parameter tersebut. Selain itu, permintaan tersebut harus diizinkan menggunakan akun CMS yang ditautkan ke pemilik konten yang ditentukan oleh parameter onBehalfOfContentOwner. Terakhir, channel yang telah 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 banyak channel YouTube yang berbeda. ID ini memungkinkan pemilik konten mengautentikasi satu kali dan melakukan tindakan atas nama channel yang ditentukan dalam nilai parameter, tanpa harus memberikan kredensial autentikasi untuk setiap channel yang terpisah.
walltime datetime
Parameter walltime menentukan waktu jam dinding saat perubahan slate yang ditentukan akan terjadi. Nilai ditentukan dalam format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).

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. Lihat dokumentasi pesan error untuk detail selengkapnya.

Jenis error Detail error Deskripsi
backendError errorDisplaySlate Terjadi error saat menjalankan tindakan yang diminta.
forbidden (403) liveBroadcastControlNotAllowed Tindakan yang diminta hanya diizinkan jika status siaran adalah live.
insufficientPermissions insufficientLivePermissions Pengguna tidak memiliki izin untuk melakukan operasi yang diminta, mungkin karena ia tidak memiliki izin untuk melakukan streaming secara live.
insufficientPermissions liveStreamingNotEnabled Pengguna yang mengizinkan permintaan tidak diizinkan untuk melakukan streaming video live di YouTube. Pengguna dapat menemukan informasi selengkapnya di https://www.youtube.com/features.
invalidValue (400) conflictingTimeFields Hanya offsetTimeMs dan walltime yang dapat ditentukan.
invalidValue (400) invalidOffsetTimeMs Nilai parameter offsetTimeMs tidak valid. Nilai parameter harus positif, tetapi parameter hanya dapat ditentukan jika streaming pemantauan siaran diaktifkan.
invalidValue (400) invalidWalltime Nilai parameter walltime tidak valid.
notFound (404) liveBroadcastNotFound Siaran yang ditentukan oleh parameter id tidak ada.
required (400) actionRequired Permintaan API perlu menentukan setidaknya satu tindakan. Untuk 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.