مرجع API

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

انواع منابع

LiveBroadcasts

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

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

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

LiveChatBans

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

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

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

LiveChatMessages

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

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

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

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

LiveChatModerators

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

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

روش درخواست 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 یک جریان ویدیویی ایجاد می کند. این استریم به شما امکان می‌دهد ویدیوی خود را به YouTube ارسال کنید، که سپس می‌تواند ویدیو را برای مخاطبان شما پخش کند.
list GET /liveStreams فهرستی از جریان‌های ویدیویی را برمی‌گرداند که با پارامترهای درخواست API مطابقت دارند.
update PUT /liveStreams یک جریان ویدیویی را به روز می کند. اگر ویژگی هایی که می خواهید تغییر دهید نمی توانند به روز شوند، باید یک جریان جدید با تنظیمات مناسب ایجاد کنید.

SuperChatEvents

منبع superChatEvent نشان دهنده پیام Super Chat است که توسط یکی از طرفداران در جریان پخش زنده YouTube خریداری شده است. در جریان چت زنده YouTube، Super Chats از دو جهت از پیام‌های دیگر متمایز است:

  • سوپر چت ها با یک رنگ برجسته می شوند.
  • Super Chat برای مدت زمان معینی در تیک تیک پین می ماند.

رنگ Super Chat، مدت زمانی که پین ​​می‌شود و حداکثر طول پیام، همگی با مقدار خرید تعیین می‌شوند. برای کسب اطلاعات بیشتر درباره Super Chats، به مرکز راهنمایی YouTube مراجعه کنید.

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

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

انواع منابع منسوخ شده

FanFundingEvents

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

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/youtube/v3
list GET /fanFundingEvents رویدادهای تأمین مالی طرفداران را برای یک کانال فهرست می کند. درخواست API باید توسط مالک کانال مجاز باشد.

LiveCuepoints

یک منبع liveCuepoint یک وقفه تبلیغاتی را در جریان ویدیوی پخش شده شروع می کند.

توجه: دستور API برای کنترل نقاط نشانه در واقع بخشی از API Content ID YouTube است و دارای الزامات مجوز متفاوتی نسبت به درخواست‌های مدیریت liveBroadcast و منابع liveStream است.

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/
insert POST /liveCuepoints یک نقطه نشانه را در پخش زنده درج می کند. در حال حاضر، درخواست‌های این روش باید توسط حساب مرتبط با مالک محتوای YouTube مجاز باشد.

Sponsors

یک منبع sponsor نشان دهنده یک حامی برای یک کانال YouTube است. اسپانسر پشتیبانی پولی مکرر مانند اشتراک یا حق عضویت را برای پدیدآورنده ارائه می‌کند و مزایای ویژه‌ای دریافت می‌کند. به عنوان مثال، هنگامی که سازنده حالت فقط حامیان مالی را برای چت روشن می کند، حامیان مالی می توانند چت کنند.

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

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/youtube/v3
list GET /sponsors حامیان مالی یک کانال را فهرست می کند. درخواست API باید توسط مالک کانال مجاز باشد.