LiveBroadcasts: transition

وضعیت پخش زنده YouTube را تغییر می‌دهد و هر فرآیند مرتبط با وضعیت جدید را آغاز می‌کند. برای مثال، وقتی وضعیت پخش را به testing انتقال می‌دهید، YouTube شروع به انتقال ویدیو به جریان مانیتور آن پخش می‌کند. قبل از فراخوانی این روش، باید تأیید کنید که مقدار ویژگی status.streamStatus برای جریان محدود شده به پخش شما active است.

موارد استفاده رایج

درخواست کنید

درخواست HTTP 

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

مجوز

این درخواست نیاز به مجوز با حداقل یکی از حوزه های زیر دارد. برای مطالعه بیشتر درباره احراز هویت و مجوز، به اجرای احراز هویت OAuth 2.0 مراجعه کنید.

دامنه
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

پارامترها

جدول زیر پارامترهایی را که این کوئری پشتیبانی می کند فهرست می کند. تمام پارامترهای لیست شده پارامترهای پرس و جو هستند.

پارامترها
پارامترهای مورد نیاز
broadcastStatus string
پارامتر broadcastStatus وضعیتی را که پخش در حال تغییر است مشخص می کند. توجه داشته باشید که برای انتقال پخش به حالت testing یا live ، وضعیت status.streamStatus باید برای جریانی که پخش به آن محدود شده است active باشد.

مقادیر قابل قبول عبارتند از:
  • complete - پخش تمام شد. یوتیوب انتقال ویدیو را متوقف می کند.
  • live - پخش برای مخاطبان قابل مشاهده است. یوتیوب ویدیو را به جریان مانیتور پخش و جریان پخش آن منتقل می کند.
  • testing - شروع به آزمایش پخش کنید. یوتیوب ویدئو را به جریان مانیتور پخش منتقل می کند. توجه داشته باشید که تنها در صورتی می‌توانید یک پخش را به حالت testing انتقال دهید که ویژگی contentDetails.monitorStream.enableMonitorStream روی true تنظیم شده باشد.
id string
پارامتر id شناسه منحصر به فرد پخشی را که در حال انتقال به وضعیت دیگری است مشخص می کند.
part string
پارامتر part یک لیست جدا شده با کاما از یک یا چند ویژگی منبع liveBroadcast را مشخص می کند که پاسخ API شامل می شود. نام part که می توانید در مقدار پارامتر وارد کنید عبارتند از id , snippet , contentDetails و status .
پارامترهای اختیاری
onBehalfOfContentOwner string
این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است.

توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است.

پارامتر onBehalfOfContentOwner نشان می دهد که اعتبارنامه مجوز درخواست، کاربر YouTube CMS را شناسایی می کند که از طرف مالک محتوا مشخص شده در مقدار پارامتر عمل می کند. این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانال‌های مختلف YouTube را مالک و مدیریت می‌کنند. این به صاحبان محتوا امکان می‌دهد یک بار احراز هویت کنند و به تمام داده‌های ویدیویی و کانال خود دسترسی داشته باشند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه داشته باشند. حساب CMS که کاربر با آن احراز هویت می‌کند باید به مالک محتوای YouTube مشخص شده مرتبط باشد.
onBehalfOfContentOwnerChannel string
این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است.

توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است.

پارامتر onBehalfOfContentOwnerChannel شناسه کانال YouTube کانالی را که ویدیویی به آن اضافه می شود مشخص می کند. این پارامتر زمانی مورد نیاز است که یک درخواست مقداری را برای پارامتر onBehalfOfContentOwner مشخص می کند و فقط می تواند در ارتباط با آن پارامتر استفاده شود. علاوه بر این، درخواست باید با استفاده از یک حساب CMS که به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص می‌کند مرتبط است، مجاز باشد. در نهایت، کانالی که مقدار پارامتر onBehalfOfContentOwnerChannel مشخص می کند باید به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص می کند پیوند داده شود.

این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانال‌های مختلف YouTube را مالک و مدیریت می‌کنند. این به صاحبان محتوا اجازه می‌دهد تا یک بار احراز هویت کنند و اقداماتی را از طرف کانال مشخص‌شده در مقدار پارامتر انجام دهند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه باشد.

درخواست بدن

هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.

پاسخ

در صورت موفقیت آمیز بودن، این روش یک منبع پخش زنده را در بدنه پاسخ برمی گرداند.

خطاها

جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. برای جزئیات بیشتر، YouTube Live Streaming API - Errors را ببینید.

نوع خطا جزئیات خطا توضیحات
backendError errorExecutingTransition هنگام تغییر وضعیت پخش خطایی روی داد.
forbidden (403) errorStreamInactive زمانی که جریانی که به پخش متصل است غیرفعال است، انتقال درخواستی مجاز نیست.
forbidden (403) invalidTransition پخش زنده نمی تواند از وضعیت فعلی خود به وضعیت درخواستی منتقل شود.
forbidden (403) redundantTransition پخش زنده در حال حاضر در وضعیت درخواستی یا در حال پردازش به وضعیت درخواستی است.
insufficientPermissions insufficientLivePermissions درخواست مجاز به انتقال پخش زنده نیست.
insufficientPermissions livePermissionBlocked کاربری که این درخواست را مجاز کرده است در حال حاضر نمی تواند ویدیوی زنده را در YouTube پخش کند. برای جزئیات توضیح اینکه چرا کاربر نمی تواند یک ویدیوی زنده را پخش جریانی کند، تنظیمات کانال کاربر را در واجد شرایط بودن ویژگی ببینید.
insufficientPermissions liveStreamingNotEnabled کاربری که درخواست را مجاز کرده است، قادر به پخش جریانی ویدیوی زنده در YouTube نیست. برای اطلاعات بیشتر، واجد شرایط بودن ویژگی را ببینید.
notFound (404) liveBroadcastNotFound پخش مشخص شده توسط پارامتر id وجود ندارد.
rateLimitExceeded (403) userRequestsExceedRateLimit کاربر در یک بازه زمانی معین درخواست های زیادی ارسال کرده است.
required (400) idRequired پارامتر id مورد نیاز باید پخشی را که می خواهید وضعیت آن را انتقال دهید مشخص کند.
required (400) statusRequired درخواست API باید مقداری برای پارامتر status مشخص کند.

آن را امتحان کنید!

از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.