یک جریان ویدیویی ایجاد می کند. این استریم به شما امکان میدهد ویدیوی خود را به YouTube ارسال کنید، که سپس میتواند ویدیو را برای مخاطبان شما پخش کند.
موارد استفاده رایج
درخواست
درخواست HTTP
POST https://www.googleapis.com/youtube/v3/liveStreams
مجوز
این درخواست به مجوز حداقل با یکی از حوزه های زیر نیاز دارد ( در مورد احراز هویت و مجوز بیشتر بخوانید ).
محدوده |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
مولفه های
جدول زیر پارامترهایی را که این کوئری پشتیبانی می کند فهرست می کند. تمام پارامترهای لیست شده پارامترهای پرس و جو هستند.
مولفه های | ||
---|---|---|
پارامترهای مورد نیاز | ||
part | string پارامتر part در این عملیات دو هدف را دنبال می کند. ویژگی هایی را که عملیات نوشتن تنظیم می کند و همچنین ویژگی هایی را که پاسخ API شامل می شود شناسایی می کند.ویژگی های part که می توانید در مقدار پارامتر قرار دهید عبارتند از id , snippet , cdn , contentDetails و status . | |
پارامترهای اختیاری | ||
onBehalfOfContentOwner | string این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است. پارامتر onBehalfOfContentOwner نشان می دهد که اعتبارنامه مجوز درخواست، کاربر YouTube CMS را شناسایی می کند که از طرف مالک محتوا مشخص شده در مقدار پارامتر عمل می کند. این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانالهای مختلف YouTube را مالک و مدیریت میکنند. این به صاحبان محتوا امکان میدهد یک بار احراز هویت کنند و به تمام دادههای ویدیویی و کانال خود دسترسی داشته باشند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه داشته باشند. حساب CMS که کاربر با آن احراز هویت میکند باید به مالک محتوای YouTube مشخص شده مرتبط باشد. | |
onBehalfOfContentOwnerChannel | string این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است. پارامتر onBehalfOfContentOwnerChannel شناسه کانال YouTube کانالی را که ویدیویی به آن اضافه می شود مشخص می کند. این پارامتر زمانی مورد نیاز است که یک درخواست مقداری را برای پارامتر onBehalfOfContentOwner مشخص می کند و فقط می تواند در ارتباط با آن پارامتر استفاده شود. علاوه بر این، درخواست باید با استفاده از یک حساب CMS که به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص میکند مرتبط است، مجاز باشد. در نهایت، کانالی که مقدار پارامتر onBehalfOfContentOwnerChannel مشخص می کند باید به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص می کند پیوند داده شود.این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانالهای مختلف YouTube را مالک و مدیریت میکنند. این به صاحبان محتوا اجازه میدهد تا یک بار احراز هویت کنند و اقداماتی را از طرف کانال مشخصشده در مقدار پارامتر انجام دهند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه باشد. |
درخواست بدن
یک منبع liveStream در بدنه درخواست ارائه دهید. برای آن منبع:
شما باید یک مقدار برای این ویژگی ها مشخص کنید:
-
snippet.title
-
cdn.frameRate
-
cdn.ingestionType
-
cdn.resolution
-
شما می توانید مقادیری را برای این ویژگی ها تنظیم کنید:
-
snippet.title
-
snippet.description
-
cdn.frameRate
-
cdn.ingestionType
-
cdn.resolution
-
contentDetails.isReusable
-
واکنش
در صورت موفقیت آمیز بودن، این روش یک منبع liveStream را در بدنه پاسخ برمی گرداند.
خطاها
جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. لطفاً برای جزئیات بیشتر به مستندات پیام خطا مراجعه کنید.
نوع خطا | جزئیات خطا | شرح |
---|---|---|
insufficientPermissions | insufficientLivePermissions | درخواست مجاز به ایجاد جریان مستقیم مشخص شده نیست. |
insufficientPermissions | livePermissionBlocked | کاربری که این درخواست را مجاز کرده است در حال حاضر نمی تواند ویدیوی زنده را در YouTube پخش کند. جزئیاتی که توضیح می دهد چرا کاربر نمی تواند ویدیوی زنده را پخش کند ممکن است در تنظیمات کانال کاربر در https://www.youtube.com/features موجود باشد. |
insufficientPermissions | liveStreamingNotEnabled | کاربری که درخواست را مجاز کرده است، قادر به پخش جریانی ویدیوی زنده در YouTube نیست. کاربر می تواند اطلاعات بیشتر را در https://www.youtube.com/features بیابد. |
invalidValue (400) | invalidDescription | مقدار ویژگی snippet.description در منبع liveStream می تواند حداکثر 10000 کاراکتر داشته باشد. |
invalidValue (400) | invalidFormat | مقدار ویژگی cdn.format در منبع liveStream نامعتبر است. |
invalidValue (400) | invalidFrameRate | مقدار ویژگی cdn.frameRate در منبع liveStream نامعتبر است. |
invalidValue (400) | invalidIngestionType | مقدار ویژگی cdn.ingestionType در منبع liveStream نامعتبر است. |
invalidValue (400) | invalidResolution | مقدار ویژگی cdn.resolution در منبع liveStream نامعتبر است. |
invalidValue (400) | invalidTitle | مقدار ویژگی snippet.title در منبع liveStream باید بین 1 تا 128 نویسه باشد. |
rateLimitExceeded | userRequestsExceedRateLimit | کاربر در یک بازه زمانی معین درخواست های زیادی ارسال کرده است. |
required (400) | cdnRequired | منبع liveStream باید حاوی شی cdn باشد. |
required (400) | frameRateRequired | اگر مقداری را برای ویژگی cdn.resolution و نه برای ویژگی cdn.frameRate مشخص کنید، API این خطا را برمیگرداند. |
required (400) | ingestionTypeRequired | منبع liveStream باید مقداری را برای ویژگی cdn.ingestionType > مشخص کند. |
required (400) | resolutionRequired | اگر مقداری را برای ویژگی cdn.frameRate مشخص کنید اما برای ویژگی cdn.resolution نه، API این خطا را برمی گرداند. |
required (400) | titleRequired | منبع liveStream باید مقداری را برای ویژگی snippet.title مشخص کند. |
آن را امتحان کنید!
از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.