جاریسازی ویدیویی را بهروز میکند. اگر ویژگیهایی که میخواهید تغییر دهید قابل بهروزرسانی نیستند، باید جاریسازی جدیدی با تنظیمات مناسب ایجاد کنید.
موارد استفاده رایج
درخواست
درخواست HTTP
PUT https://www.googleapis.com/youtube/v3/liveStreams
صدور مجوز
این درخواست به مجوز با حداقل یکی از دامنههای زیر نیاز دارد. برای کسب اطلاعات بیشتر درباره اصالتسنجی و صدور مجوز، به پیادهسازی مجوز OAuth 2.0 مراجعه کنید.
| حوزه |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
پارامترها
جدول زیر پارامترهایی را که این پُرسمان پشتیبانی میکند فهرست میکند. همه پارامترهای فهرستشده پارامترهای پُرسمان هستند.
| پارامترها | ||
|---|---|---|
| پارامترهای الزامی | ||
part |
stringپارامتر part در این عملیات دو هدف دارد. این پارامتر ویژگیهایی را که عملیات نوشتن تنظیم میکند و همچنین ویژگیهایی را که پاسخ میانای برنامهسازی کاربردی دربرمیگیرد شناسایی میکند.ویژگیهای part که میتوانید در مقدار پارامتر بگنجانید عبارتاند از id، snippet، cdn، و status.توجه داشته باشید که این روش مقادیر موجود را برای همه ویژگیهای تغییرپذیری که در هر بخشی که مقدار پارامتر مشخص میکند وجود دارد لغو میکند. اگر بدنه درخواست مقداری برای ویژگی تغییرپذیر مشخص نکند، مقدار موجود برای آن ویژگی برداشته خواهد شد. |
|
| پارامترهای اختیاری | ||
onBehalfOfContentOwner |
stringاین پارامتر فقط در درخواست مجاز مناسب میتواند استفاده شود. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube درنظر گرفته شده است. پارامتر onBehalfOfContentOwner نشان میدهد که اطلاعات اعتباری مجوز درخواست، کاربر YouTube CMS را که ازطرف مالک محتوای مشخصشده در مقدار پارامتر عمل میکند شناسایی میکند. این پارامتر برای شرکای محتوای YouTube است که مالک و مدیر کانالهای مختلف YouTube هستند. این ویژگی به مالکان محتوا امکان میدهد یکبار اصالتسنجی کنند و به تمام دادههای ویدیو و کانال خود دسترسی پیدا کنند، بدون اینکه نیاز باشد برای هر کانال جداگانه اطلاعات اصالتسنجی ارائه دهند. حساب CMS که کاربر با آن اصالتسنجی میکند باید به مالک محتوای YouTube مشخصشده پیوند داده شده باشد. |
|
onBehalfOfContentOwnerChannel |
stringاین پارامتر فقط در یک درخواست مجاز میتواند استفاده شود. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube درنظر گرفته شده است. پارامتر onBehalfOfContentOwnerChannel شناسه کانال YouTube کانالی را که ویدیو به آن اضافه میشود مشخص میکند. وقتی درخواست مقداری را برای پارامتر onBehalfOfContentOwner مشخص میکند، این پارامتر الزامی است و فقط میتواند همراه با آن پارامتر استفاده شود. علاوهبراین، درخواست باید بااستفاده از حساب CMS که به مالک محتوای مشخصشده توسط پارامتر onBehalfOfContentOwner پیوند داده شده است، مجاز شود. درنهایت، کانالی که مقدار پارامتر onBehalfOfContentOwnerChannel مشخص میکند باید به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص میکند پیوند داده شود.این پارامتر برای شرکای محتوای YouTube درنظر گرفته شده است که مالک کانالهای YouTube مختلفی هستند و آنها را مدیریت میکنند. این پارامتر به مالکان محتوا اجازه میدهد یکبار اصالتسنجی کنند و ازطرف کانال مشخصشده در مقدار پارامتر اقداماتی را انجام دهند، بدون اینکه نیاز باشد برای هر کانال جداگانه اعتبارنامههای اصالتسنجی ارائه دهند. |
|
متن درخواست
یک منبع liveStream در متن درخواست ارائه دهید. برای آن منبع:
-
باید مقداری برای این داراییها مشخص کنید:
idsnippet.titlecdn.frameRatecdn.ingestionTypecdn.resolution
-
میتوانید برای این مشخصات مقدار تنظیم کنید:
snippet.titlesnippet.description
اگر درخواست بهروزرسانی ارسال میکنید و درخواستتان مقدار داراییای را که ازقبل مقدار دارد مشخص نمیکند، مقدار موجود دارایی حذف خواهد شد.
پاسخ
اگر موفقیتآمیز باشد، این روش یک منبع جاریسازی زنده را در بدنه پاسخ برمیگرداند.
خطاها
جدول زیر پیامهای خطایی را که ممکن است API در پاسخ به فراخوانی این روش برگرداند، مشخص میکند. برای جزئیات بیشتر، به YouTube Live Streaming API - Errors مراجعه کنید.
| نوع خطا | جزئیات خطا | شرح |
|---|---|---|
forbidden (403) |
liveStreamModificationNotAllowed |
جاریسازی زنده مشخصشده را نمیتوان در وضعیت فعلیاش اصلاح کرد. برای اطلاعات بیشتر، به چرخه عمر همهفرستی مراجعه کنید. |
forbidden (403) |
liveStreamModificationNotAllowed |
این API به شما اجازه نمیدهد مقدار فیلدهای cdn.format، cdn.frameRate، cdn.ingestionType، یا cdn.resolution را پساز ایجاد جاریسازی تغییر دهید. |
forbidden (403) |
liveStreamModificationNotAllowed |
API به شما اجازه نمیدهد که یک پخش زنده قابلاستفاده مجدد را به غیرقابلاستفاده مجدد تغییر دهید یا برعکس. برای اطلاعات بیشتر، درک همهفرستیها و جاریسازیها را ببینید. |
insufficientPermissions |
insufficientLivePermissions |
درخواست برای بهروزرسانی جاریسازی زنده مشخصشده مجاز نیست. برای اطلاعات بیشتر، به پیادهسازی اصالتسنجی OAuth2 مراجعه کنید. |
insufficientPermissions |
liveStreamingNotEnabled |
کاربری که درخواست را مجاز کرده است برای جاریسازی ویدیو زنده در YouTube فعال نیست. کاربر میتواند اطلاعات بیشتر را در واجدشرایط بودن برای ویژگی پیدا کند. |
invalidValue (400) |
invalidDescription |
مقدار دارایی snippet.description در منبع liveStream میتواند حداکثر ۱۰۰۰۰ نویسه داشته باشد. |
invalidValue (400) |
invalidTitle |
مقدار ویژگی snippet.title در منبع جاریسازی زنده باید بین ۱ تا ۱۲۸ نویسه باشد. |
notFound (404) |
liveStreamNotFound |
جاریسازی زنده مشخصشده وجود ندارد. |
required (400) |
idRequired |
منبع liveStream باید مقداری را برای دارایی id مشخص کند. |
required (400) |
ingestionTypeRequired |
منبع liveStream باید مقداری را برای دارایی cdn.ingestionType مشخص کند. |
required (400) |
titleRequired |
منبع liveStream باید مقداری برای ویژگی snippet.title مشخص کند. |
امتحان کنید!
برای فراخوانی این API و دیدن درخواست و پاسخ API، از APIs Explorer استفاده کنید.