مرجع API

این مرجع API نحوه‌ی زمان‌بندی پخش زنده و استریم ویدیو در یوتیوب را با استفاده از API استریم زنده‌ی یوتیوب توضیح می‌دهد.

انواع منابع

LiveBroadcasts

یک منبع liveBroadcast نشان‌دهنده رویدادی است که از طریق ویدیوی زنده در YouTube پخش خواهد شد.

برای اطلاعات بیشتر در مورد این منبع، به نمایش منبع و فهرست ویژگی‌های آن مراجعه کنید.

روش درخواست HTTP توضیحات
آدرس‌های اینترنتی (URI) مربوط به https://www.googleapis.com/youtube/v3
bind POST /liveBroadcasts/bind یک پخش یوتیوب را به یک جریان متصل می‌کند یا یک اتصال موجود بین یک پخش و یک جریان را حذف می‌کند. یک پخش فقط می‌تواند به یک جریان ویدیویی متصل شود، اگرچه یک جریان ویدیویی می‌تواند به بیش از یک پخش متصل شود.
delete DELETE /liveBroadcasts یک پخش را حذف می‌کند.
insert POST /liveBroadcasts یک پخش ایجاد می‌کند.
list GET /liveBroadcasts لیستی از پخش‌های یوتیوب که با پارامترهای درخواست API مطابقت دارند را برمی‌گرداند.
transition POST /liveBroadcasts/transition وضعیت پخش زنده یوتیوب را تغییر می‌دهد و هرگونه فرآیند مرتبط با وضعیت جدید را آغاز می‌کند. برای مثال، وقتی وضعیت یک پخش را به testing تغییر می‌دهید، یوتیوب شروع به ارسال ویدیو به جریان مانیتور آن پخش می‌کند. قبل از فراخوانی این متد، باید تأیید کنید که مقدار ویژگی status.streamStatus برای جریانی که به پخش شما متصل است، active است.
update PUT /liveBroadcasts یک پخش را به‌روزرسانی می‌کند. برای مثال، می‌توانید تنظیمات پخش تعریف‌شده در شیء contentDetails از منبع liveBroadcast را تغییر دهید.
cuepoint POST /liveBroadcasts/cuepoint یک نقطه شروع (cuepoint) را در پخش زنده وارد می‌کند. این نقطه شروع ممکن است باعث ایجاد یک وقفه تبلیغاتی شود.

LiveChatBans

یک منبع liveChatBan یک کاربر یوتیوب و یک چت زنده یوتیوب را که کاربر از شرکت در آن منع شده است، شناسایی می‌کند.

برای اطلاعات بیشتر در مورد این منبع، به نمایش منبع و فهرست ویژگی‌های آن مراجعه کنید.

روش درخواست HTTP توضیحات
آدرس‌های اینترنتی (URI) مربوط به https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/bans ممنوعیتی را که مانع از مشارکت یک کاربر خاص در یک گفتگوی زنده می‌شود، حذف می‌کند و در نتیجه کاربر را قادر می‌سازد دوباره به گفتگو بپیوندد. درخواست API باید توسط صاحب کانال یا مدیر گفتگوی زنده مرتبط با ممنوعیت تأیید شود.
insert POST /liveChat/bans یک کاربر خاص را از شرکت در چت زنده منع می‌کند. درخواست API باید توسط صاحب کانال یا مدیر چت زنده مرتبط با ممنوعیت، تأیید شود.

LiveChatMessages

یک منبع liveChatMessage نشان‌دهنده یک پیام چت در یک گفتگوی زنده یوتیوب است. این منبع می‌تواند شامل جزئیاتی در مورد انواع مختلف پیام‌ها، از جمله یک پیام متنی تازه منتشر شده یا یک رویداد تأمین مالی طرفداران باشد.

قابلیت چت زنده به طور پیش‌فرض برای پخش زنده فعال است و تا زمانی که رویداد زنده فعال باشد، در دسترس است. (پس از پایان رویداد، چت زنده دیگر برای آن رویداد در دسترس نیست.)

برای اطلاعات بیشتر در مورد این منبع، به نمایش منبع و فهرست ویژگی‌های آن مراجعه کنید.

روش درخواست HTTP توضیحات
آدرس‌های اینترنتی (URI) مربوط به https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/messages یک پیام چت را حذف می‌کند. درخواست API باید توسط صاحب کانال یا مدیر چت زنده مرتبط با مسدودیت تأیید شود.
insert POST /liveChat/messages پیامی را به گفتگوی زنده اضافه می‌کند.
list GET /liveChat/messages پیام‌های چت زنده را برای یک چت خاص فهرست می‌کند.
streamList اتصال استریمینگ سرور را برای دریافت پیام‌های چت زنده برای یک چت خاص با تأخیر کم فعال می‌کند.

LiveChatModerators

یک منبع liveChatModerator نشان دهنده یک مدیر برای یک چت زنده یوتیوب است. یک مدیر چت توانایی مسدود کردن یا لغو مسدود کردن کاربران از یک چت، حذف پیام‌ها و انجام سایر اقدامات مدیریتی برای چت زنده را دارد.

برای اطلاعات بیشتر در مورد این منبع، به نمایش منبع و فهرست ویژگی‌های آن مراجعه کنید.

روش درخواست HTTP توضیحات
آدرس‌های اینترنتی (URI) مربوط به https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/moderators مدیر چت را حذف می‌کند. این درخواست باید توسط صاحب کانال پخش زنده تأیید شود.
insert POST /liveChat/moderators یک مدیر جدید برای چت اضافه می‌کند. این درخواست باید توسط صاحب کانال پخش زنده تأیید شود.
list GET /liveChat/moderators فهرست مدیران برای گفتگوی زنده. این درخواست باید توسط صاحب کانال پخش زنده تأیید شود.

LiveStreams

یک منبع liveStream حاوی اطلاعاتی درباره جریان ویدیویی است که شما به YouTube ارسال می‌کنید. این جریان، محتوایی را که برای کاربران YouTube پخش خواهد شد، فراهم می‌کند. پس از ایجاد، یک منبع liveStream می‌تواند به یک یا چند منبع liveBroadcast متصل شود.

برای اطلاعات بیشتر در مورد این منبع، به نمایش منبع و فهرست ویژگی‌های آن مراجعه کنید.

روش درخواست HTTP توضیحات
آدرس‌های اینترنتی (URI) مربوط به https://www.googleapis.com/youtube/v3
delete DELETE /liveStreams یک جریان ویدیویی را حذف می‌کند.
insert POST /liveStreams یک جریان ویدیویی ایجاد می‌کند. این جریان به شما امکان می‌دهد ویدیوی خود را به یوتیوب ارسال کنید، که سپس می‌تواند ویدیو را برای مخاطبان شما پخش کند.
list GET /liveStreams لیستی از جریان‌های ویدیویی که با پارامترهای درخواست API مطابقت دارند را برمی‌گرداند.
update PUT /liveStreams یک جریان ویدیویی را به‌روزرسانی می‌کند. اگر ویژگی‌هایی که می‌خواهید تغییر دهید قابل به‌روزرسانی نیستند، باید یک جریان جدید با تنظیمات مناسب ایجاد کنید.

SuperChatEvents

یک منبع superChatEvent نشان دهنده یک پیام Super Chat است که توسط یک طرفدار در طول پخش زنده یوتیوب خریداری شده است. در پخش زنده یوتیوب، Super Chatها از دو طریق از سایر پیام‌ها متمایز می‌شوند:

  • سوپر چت‌ها با یک رنگ مشخص شده‌اند.
  • سوپر چت‌ها برای مدت زمان مشخصی در تیکت پین می‌شوند.

رنگ سوپر چت، مدت زمانی که در تیکت پین می‌شود و حداکثر طول پیام، همگی با توجه به مبلغ خرید تعیین می‌شوند. برای کسب اطلاعات بیشتر در مورد سوپر چت‌ها، به مرکز راهنمای یوتیوب مراجعه کنید.

برای اطلاعات بیشتر در مورد این منبع، به نمایش منبع و فهرست ویژگی‌های آن مراجعه کنید.

روش درخواست HTTP توضیحات
آدرس‌های اینترنتی (URI) مربوط به https://www.googleapis.com/youtube/v3
list GET /superChatEvents رویدادهای سوپر چت را از پخش زنده یک کانال در 30 روز گذشته فهرست کنید.