قالب. چارچوب . (cast. framework) CastReceiverContext
بارگذاری کتابخانه‌های زیربنایی را مدیریت کرده و SDK گیرنده‌ی تبدیل (cast receiver SDK) زیربنایی را مقداردهی اولیه می‌کند.
- پرتاب‌ها
non-null Errorاگر MediaElement در بدنه سند ایجاد نشده باشد. اگر چندین عنصر رسانه‌ای ایجاد شده باشد، توسعه‌دهنده باید کلاس 'castMediaElement' را روی یکی از آنها تنظیم کند، که گیرنده CAF از آن استفاده خواهد کرد.
روش‌ها
دریافت نمونه
تابع ()getInstance، تابع cast.framework.CastReceiverContext را برمی‌گرداند.
نمونه‌ی تک‌لایه CastReceiverContext را برمی‌گرداند.
- بازگشت‌ها
non-null cast.framework.CastReceiverContext
addCustomMesageListener
addCustomMessageListener(فضای نام، شنونده)
یک شنونده پیام برای یک کانال پیام سفارشی تنظیم می‌کند. بیش از یک شنونده برای یک فضای نام مجاز است.
پارامتر | |
|---|---|
فضای نام | رشته فضای نام. توجه داشته باشید که یک فضای نام معتبر باید با پیشوند رشته 'urn:x-cast:' شروع شود. |
شنونده | تابع ( cast.framework.system.Message غیر تهی) |
- پرتاب‌ها
Errorاگر سیستم آماده نباشد یا فضای نام توسط این برنامه پشتیبانی نشود.
addEventListener
addEventListener (نوع، کنترل کننده)
شنونده را به رویدادهای سیستم cast اضافه کنید.
پارامتر | |
|---|---|
نوع | نوع رویداد سیستم.چارچوب.ریخته‌گری مقدار نباید تهی (null) باشد. |
رسیدگی کننده | تابع ( cast.framework.system.Event غیر تهی) |
canDisplayType
canDisplayType(mimeType, codecs, width, height, framerate) مقدار بولی را برمی‌گرداند.
بررسی می‌کند که آیا پارامترهای رسانه‌ای داده شده برای جریان‌های ویدیویی یا صوتی توسط پلتفرم پشتیبانی می‌شوند یا خیر.
پارامتر | |
|---|---|
نوع مایم | رشته نوع MIME رسانه. این نوع شامل یک نوع و زیرنوع است که با علامت '/' از هم جدا شده‌اند. می‌تواند از نوع MIME ویدیویی یا صوتی باشد. |
کدک‌ها | اختیاری رشته رشته‌ی نقل‌قولی شامل فهرستی از فرمت‌ها است که با کاما از هم جدا شده‌اند، که در آن هر فرمت نوع نمونه‌ی رسانه‌ای موجود در جریان را مشخص می‌کند. |
عرض | اختیاری شماره وضوح افقی جریان را بر حسب پیکسل توصیف می‌کند. |
ارتفاع | اختیاری شماره وضوح عمودی جریان را بر حسب پیکسل توصیف می‌کند. |
نرخ فریم | اختیاری شماره نرخ فریم جریان را توصیف می‌کند. |
- بازگشت‌ها
اگر پخش زنده روی کروم‌کست امکان‌پذیر باشد،
booleanمی‌شود.
دریافت داده‌های برنامه
تابع ()getApplicationData، تابع cast.framework.system.ApplicationData را برمی‌گرداند.
اطلاعات برنامه را پس از آماده شدن سیستم ارائه می‌دهد، در غیر این صورت تهی خواهد بود.
- بازگشت‌ها
nullable cast.framework.system.ApplicationDataاطلاعات برنامه یا null در صورتی که سیستم آماده نباشد.
قابلیت‌های دستگاه را دریافت کنید
تابع ()getDeviceCapabilities یک تابع cast.framework.system.DeviceCapabilitiesObj برمی‌گرداند.
اطلاعات قابلیت‌های دستگاه را پس از آماده شدن سیستم ارائه می‌دهد، در غیر این صورت null خواهد بود. اگر یک شیء خالی برگردانده شود، دستگاه هیچ اطلاعاتی از قابلیت‌های آن را نمایش نمی‌دهد.
- بازگشت‌ها
nullable cast.framework.system.DeviceCapabilitiesObjاطلاعات قابلیت‌های دستگاه (جفت‌های کلید/مقدار). اگر سیستم هنوز آماده نباشد، مقدار آن null خواهد بود. اگر پلتفرم هیچ اطلاعاتی از قابلیت‌های دستگاه را نمایش ندهد، ممکن است یک شیء خالی باشد.
دریافت اطلاعات دستگاه
تابع ()getDeviceInformation تابع () cast.framework.system.DeviceInformationObj را برمی‌گرداند.
اطلاعات شناسایی دستگاه غیرمرتبط با قابلیت‌ها را پس از آماده شدن سیستم ارائه می‌دهد، در غیر این صورت «تهی» خواهد بود. اگر یک شیء خالی برگردانده شود، دستگاه هیچ اطلاعاتی از این دست را افشا نمی‌کند.
- بازگشت‌ها
nullable cast.framework.system.DeviceInformationObjاطلاعات دستگاه (جفت‌های کلید/مقدار). اگر سیستم هنوز آماده نباشد، مقدار آن null خواهد بود. اگر پلتفرم این اطلاعات را نمایش ندهد، ممکن است یک شیء خالی باشد.
دریافت‌کننده‌ی مدیر
تابع ()getPlayerManager ، تابع cast.framework.PlayerManager را برمی‌گرداند.
نمونه‌ای از Player دریافت کنید که بتواند پخش رسانه را کنترل و نظارت کند.
- بازگشت‌ها
non-null cast.framework.PlayerManager
دریافت‌کننده
getSender(senderId) cast.framework.system.Sender را برمی گرداند
دریافت فرستنده بر اساس شناسه فرستنده
پارامتر | |
|---|---|
شناسه فرستنده | رشته شناسه فرستنده برای بازگرداندن. |
- بازگشت‌ها
nullable cast.framework.system.Sender
دریافت‌کنندگان
تابع ()getSenders آرایه‌ای از نوع cast.framework.system.Sender غیر تهی را برمی‌گرداند.
لیستی از فرستندگان متصل فعلی را دریافت می‌کند.
- بازگشت‌ها
non-null Array of non-null cast.framework.system.Sender
دریافت وضعیت آماده به کار
تابع ()getStandbyState مقدار cast.framework.system.StandbyState را برمی‌گرداند.
اگر ورودی HDMI برنامه‌ی پخش در حالت آماده به کار باشد، گزارش می‌دهد.
- بازگشت‌ها
non-null cast.framework.system.StandbyStateمشخص می‌کند که آیا ورودی HDMI برنامه در حالت آماده به کار است یا خیر. اگر به دلیل پشتیبانی نکردن تلویزیون از دستورات CEC، قابل تشخیص نباشد، مقدار برگردانده شده نامشخص است.
دریافت وضعیت سیستم
تابع ()getSystemState مقدار cast.framework.system.SystemState را برمی‌گرداند.
اطلاعات برنامه در مورد وضعیت سیستم را ارائه می‌دهد.
- بازگشت‌ها
non-null cast.framework.system.SystemStateوضعیت سیستم.
دریافت وضعیت دید
تابع ()getVisibilityState مقدار cast.framework.system.VisibilityState را برمی‌گرداند.
گزارش می‌دهد که آیا برنامه‌ی پخش، ورودی فعال HDMI است یا خیر.
- بازگشت‌ها
non-null cast.framework.system.VisibilityStateمشخص می‌کند که آیا برنامه ورودی فعال HDMI است یا خیر. اگر نتوان آن را تعیین کرد، مثلاً به این دلیل که تلویزیون از دستورات CEC پشتیبانی نمی‌کند، مقدار برگشتی نامشخص است.
isSystemReady
تابع ()isSystemReady مقدار بولی برمی‌گرداند.
وقتی فراخوانی‌های برنامه شروع می‌شوند، سیستم رویداد آماده بودن را ارسال می‌کند تا نشان دهد که اطلاعات برنامه آماده است و برنامه می‌تواند به محض اتصال یک فرستنده، پیام‌ها را ارسال کند.
- بازگشت‌ها
booleanمشخص می‌کند که آیا سیستم آماده پردازش پیام‌ها هست یا خیر.
بارگذاری کتابخانه‌های پخش‌کننده
بارگذاری کتابخانه‌های پخش‌کننده (useLegacyDashSupport)
شروع بارگذاری بازیکن js. این می‌تواند برای شروع بارگذاری کد js بازیکنان در مراحل اولیه شروع گیرنده قبل از فراخوانی start استفاده شود. اگر بازیکنان قبلاً بارگذاری شده باشند (start فراخوانی شده باشد)، این تابع بدون عملیات است.
پارامتر | |
|---|---|
پشتیبانی از useLegacyDash | اختیاری بولی مشخص کنید که MPL باید برای محتوای DASH استفاده شود. |
حذف کننده پیام سفارشی
removeCustomMessageListener(فضای نام، شنونده)
شنونده پیامی را که قبلاً با CastReceiverContext#addCustomMessageListener ثبت شده است، حذف می‌کند.
پارامتر | |
|---|---|
فضای نام | رشته فضای نام. توجه داشته باشید که یک فضای نام معتبر باید با پیشوند رشته 'urn:x-cast:' شروع شود. |
شنونده | تابع ( cast.framework.system.Message غیر تهی) تابع شنونده پیام، لغو ثبت‌نام را انجام می‌دهد. |
- پرتاب‌ها
Errorاگر سیستم آماده نباشد یا فضای نام توسط این برنامه پشتیبانی نشود.
حذف رویدادشن (removeEventListener)
removeEventListener (نوع، کنترل کننده)
شنونده را برای تبدیل رویدادهای سیستم حذف کنید.
پارامتر | |
|---|---|
نوع | نوع رویداد سیستم.چارچوب.ریخته‌گری مقدار نباید تهی (null) باشد. |
رسیدگی کننده | تابع ( cast.framework.system.Event غیر تهی) |
ارسال پیام سفارشی
sendCustomMessage(فضای نام، senderId، داده)
پیامی را به فرستنده خاصی ارسال می‌کند.
پارامتر | |
|---|---|
فضای نام | رشته فضای نام. توجه داشته باشید که یک فضای نام معتبر باید با پیشوند رشته 'urn:x-cast:' شروع شود. |
شناسه فرستنده | (رشته یا تعریف نشده) senderId یا undefined برای پخش به همه فرستندگان. |
داده‌ها | هر نوع بار مفید پیام. مقدار نباید تهی (null) باشد. |
- پرتاب‌ها
Errorاگر در آماده‌سازی پیام خطایی رخ داده باشد.
ارسالبازخوردپیام
ارسال پیام بازخورد(پیام بازخورد)
این تابع باید در پاسخ به رویداد feedbackstarted فراخوانی شود اگر برنامه اطلاعات وضعیت اشکال‌زدایی را برای ثبت گزارش بازخورد اضافه کند. این تابع یک پارامتر 'message' می‌گیرد که رشته‌ای است که اطلاعات اشکال‌زدایی را که برنامه می‌خواهد ثبت کند، نشان می‌دهد.
پارامتر | |
|---|---|
بازخوردپیام | رشته |
- منسوخ شده
- از cast.framework.CastReceiverContext#setFeedbackHandler استفاده کنید
تنظیم وضعیت برنامه
تنظیم وضعیت برنامه (متن وضعیت)
وضعیت برنامه را تنظیم می‌کند. برنامه باید این را هنگام تغییر وضعیتش فراخوانی کند. اگر تعریف نشده باشد یا روی یک رشته خالی تنظیم شده باشد، مقدار نام برنامه که هنگام ثبت برنامه ایجاد شده است، به طور پیش‌فرض برای وضعیت برنامه استفاده می‌شود.
پارامتر | |
|---|---|
متن وضعیت | رشته متن وضعیت. |
setFeedbackHandler
setFeedbackHandler(مدیریت بازخورد)
یک کنترل‌کننده تنظیم کنید تا داده‌های اضافی را به گزارش بازخورد ارائه دهد. این کنترل‌کننده هنگام ایجاد یک گزارش بازخورد فراخوانی می‌شود و باید داده‌های اضافی را به صورت رشته یا یک promise رشته‌ای برگرداند. promise برگشتی باید ظرف ۵ ثانیه حل شود تا در گزارش گنجانده شود.
پارامتر | |
|---|---|
بازخورد هندلر | تابع () مقدار ممکن است تهی (null) باشد. |
setInactivityTimeout
setInactivityTimeout(maxInactivity)
زمان غیرفعال بودن گیرنده را تنظیم می‌کند. توصیه می‌شود هنگام فراخوانی Start حداکثر مقدار غیرفعال بودن را تنظیم کنید و آن را تغییر ندهید. این API فقط برای اهداف توسعه/اشکال‌زدایی ارائه شده است.
پارامتر | |
|---|---|
حداکثرعدم فعالیت | شماره فاصله زمانی (بر حسب ثانیه) قبل از بستن یک اتصال بی‌پاسخ. |
تنظیم سطح Logger
تنظیم سطح LoggerLevel (سطح)
سطح جزئیات گزارش را تنظیم می‌کند.
پارامتر | |
|---|---|
سطح | سطح ثبت وقایع. مقدار نباید تهی (null) باشد. |
شروع
تابع start(options) مقدار cast.framework.CastReceiverContext را برمی‌گرداند.
مدیر سیستم و مدیر رسانه را مقداردهی اولیه می‌کند، به طوری که برنامه گیرنده بتواند درخواست‌ها را از فرستندگان دریافت کند.
پارامتر | |
|---|---|
گزینه‌ها | ( cast.framework.CastReceiverOptions غیر تهی یا شیء غیر تهی اختیاری) |
- بازگشت‌ها
non-null cast.framework.CastReceiverContext
متوقف کردن
توقف ()
برنامه گیرنده را خاموش کنید.