کلاس: CastReceiverContext

cast.framework.CastReceiverContext

class   static

بارگیری کتابخانه‌های اساسی را مدیریت می‌کند و کیت توسعه نرم‌افزار گیرنده ارسال محتوای اساسی را مقداردهی اولیه می‌کند.

پرتاب‌ها

non-null Error اگر MediaElement در بدنه سند ایجاد نشده باشد. اگر چند عنصر رسانه ایجاد شده باشد، توسعه‌دهنده باید کلاس «castMediaElement» را برای یکی از آن‌ها تنظیم کند تا گیرنده CAF از آن استفاده کند.

روش‌ها

getInstance

ایستا

getInstance()‎ cast.framework.CastReceiverContext را برمی‌گرداند

نمونه یگانه CastReceiverContext را برمی‌گرداند.

بازگشتی‌ها

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

شنونده پیام را برای کانال پیام سفارشی راه‌اندازی می‌کند. بیش‌از یک شنونده برای فضای نام مجاز است.

پارامتر
فضای نام	رشته فضای نام. توجه داشته باشید که جایِ نام معتبر باید پیشوند رشته «urn:x-cast:‎» داشته باشد.
شنونده	function(non-null cast.framework.system.Message)

پرتاب‌ها

Error اگر سیستم آماده نباشد یا فضای نام توسط این برنامه پشتیبانی نشود.

addEventListener

addEventListener(type, handler)

افزودن شنونده به رویدادهای سیستم ارسال محتوا.

پارامتر
نوع	cast.framework.system.EventType مقدار نباید خالی باشد.
رسیدگی‌کننده	function(non-null cast.framework.system.Event)

canDisplayType

canDisplayType(mimeType, codecs, width, height, framerate) returns boolean

بررسی می‌کند که آیا پارامترهای رسانه داده‌شده از جاری‌سازی‌های ویدیو یا صدا توسط پلاتفرم پشتیبانی می‌شود یا نه.

پارامتر
mimeType	رشته نوع MIME رسانه. این نوع از یک نوع و زیرنوع تشکیل شده است که با «/» از هم جدا شده‌اند. این نوع می‌تواند نوع MIME ویدیو یا صدا باشد.
کدک‌ها	اختیاری رشته رشته نقل‌قول‌شده حاوی فهرستی از قالب‌ها است که با کاما از هم جدا شده‌اند و هر قالب نوع نمونه رسانه‌ای را که در جاری‌سازی وجود دارد مشخص می‌کند.
عرض	اختیاری شماره وضوح افقی جاری‌سازی را به پیکسل توصیف می‌کند.
ارتفاع	اختیاری شماره وضوح عمودی جاری‌سازی را به پیکسل توصیف می‌کند.
نرخ فریم	اختیاری شماره نرخ فریم جاری‌سازی را توصیف می‌کند.

بازگشتی‌ها

boolean اگر جاری‌سازی بتواند در chromecast پخش شود.

getApplicationData

getApplicationData() returns cast.framework.system.ApplicationData

وقتی سیستم آماده باشد، اطلاعات برنامه را ارائه می‌دهد، درغیراین‌صورت مقدار آن تهی خواهد بود.

بازگشتی‌ها

nullable cast.framework.system.ApplicationData اطلاعات برنامه یا null اگر سیستم آماده نباشد.

getDeviceCapabilities

getDeviceCapabilities() returns cast.framework.system.DeviceCapabilitiesObj

وقتی سیستم آماده باشد، اطلاعات قابلیت‌های دستگاه را ارائه می‌کند، درغیراین‌صورت مقدار آن تهی خواهد بود. اگر شیء خالی برگردانده شود، دستگاه هیچ اطلاعاتی درباره قابلیت‌ها ارائه نمی‌دهد.

بازگشتی‌ها

nullable cast.framework.system.DeviceCapabilitiesObj اطلاعات قابلیت‌های دستگاه (جفت‌های کلید/مقدار). اگر سیستم هنوز آماده نباشد، مقدار آن تهی خواهد بود. اگر پلاتفرم هیچ اطلاعاتی درباره قابلیت‌های دستگاه ارائه ندهد، ممکن است این شیء خالی باشد.

getDeviceInformation

getDeviceInformation() returns cast.framework.system.DeviceInformationObj

وقتی سیستم آماده باشد، اطلاعات شناسایی دستگاه را که مربوط به قابلیت نیست ارائه می‌دهد، درغیراین‌صورت «null» خواهد بود. اگر شیء خالی برگردانده شود، دستگاه چنین اطلاعاتی را نشان نمی‌دهد.

بازگشتی‌ها

nullable cast.framework.system.DeviceInformationObj اطلاعات دستگاه (جفت کلید/ارزش). اگر سیستم هنوز آماده نباشد، مقدار آن تهی خواهد بود. اگر پلاتفرم این اطلاعات را افشا نکند، ممکن است شیء خالی باشد.

getPlayerManager

getPlayerManager() returns cast.framework.PlayerManager

نمونه «پخش‌کننده» را دریافت کنید که می‌تواند بازپخش رسانه را کنترل و نظارت کند.

بازگشتی‌ها

non-null cast.framework.PlayerManager 

getSender

getSender(senderId) returns cast.framework.system.Sender

دریافت فرستنده با شناسه فرستنده

پارامتر
senderId	رشته شناسه فرستنده برای برگرداندن.

بازگشتی‌ها

nullable cast.framework.system.Sender 

getSenders

getSenders() returns Array of non-null cast.framework.system.Sender

فهرستی از فرستنده‌های متصل‌شده فعلی را دریافت می‌کند.

بازگشتی‌ها

non-null Array of non-null cast.framework.system.Sender 

getStandbyState

getStandbyState() returns cast.framework.system.StandbyState

گزارش می‌دهد که آیا ورودی HDMI برنامه پخش محتوا در حالت آماده‌به‌کار است یا نه.

بازگشتی‌ها

non-null cast.framework.system.StandbyState اینکه ورودی HDMI برنامه در حالت آماده‌به‌کار است یا نه. اگر قابل تعیین نباشد، مثلاً به‌دلیل اینکه تلویزیون از فرمان‌های CEC پشتیبانی نمی‌کند، مقدار UNKNOWN برگردانده می‌شود.

getSystemState

getSystemState() returns cast.framework.system.SystemState

اطلاعات برنامه را درباره وضعیت سیستم ارائه می‌دهد.

بازگشتی‌ها

non-null cast.framework.system.SystemState وضعیت سیستم.

getVisibilityState

‫()getVisibilityState‏ cast.framework.system.VisibilityState را برمی‌گرداند

گزارش می‌دهد که آیا برنامه ارسال محتوا ورودی فعال HDMI است یا نه.

بازگشتی‌ها

non-null cast.framework.system.VisibilityState اینکه آیا برنامه ورودی فعال HDMI است یا نه. اگر قابل‌تعیین نباشد، مثلاً به‌دلیل اینکه تلویزیون از فرمان‌های CEC پشتیبانی نمی‌کند، مقدار UNKNOWN (نامشخص) برگردانده می‌شود.

isSystemReady

isSystemReady() مقدار منطقی برمی‌گرداند

وقتی تماس‌های برنامه شروع می‌شود، سیستم رویداد آماده را ارسال می‌کند تا نشان دهد اطلاعات برنامه آماده است و برنامه می‌تواند به‌محض متصل شدن یک فرستنده، پیام ارسال کند.

بازگشتی‌ها

boolean اینکه سیستم برای پردازش پیام‌ها آماده است یا نه.

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

Start loading player js. این می‌تواند برای شروع بارگیری کد js پخش‌کننده‌ها در مرحله اولیه شروع گیرنده قبل‌از فراخوانی شروع استفاده شود. اگر پخش‌کننده‌ها ازقبل بار شده باشند (شروع فراخوانی شده باشد)، این تابع بدون‌عمل است.

پارامتر
useLegacyDashSupport	اختیاری بولی نشان می‌دهد که MPL باید برای محتوای DASH استفاده شود.

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

شنونده پیامی را که قبلاً با CastReceiverContext#addCustomMessageListener ثبت شده است برمی‌دارد.

پارامتر
فضای نام	رشته فضای نام. توجه داشته باشید که جایِ نام معتبر باید پیشوند رشته «urn:x-cast:‎» داشته باشد.
شنونده	function(non-null cast.framework.system.Message) تابع شنونده پیام برای لغو ثبت‌نام.

پرتاب‌ها

Error اگر سیستم آماده نباشد یا فضای نام توسط این برنامه پشتیبانی نشود.

removeEventListener

removeEventListener(type, handler)

برداشتن شنونده برای ارسال رویدادهای سیستم.

پارامتر
نوع	cast.framework.system.EventType مقدار نباید خالی باشد.
رسیدگی‌کننده	function(non-null cast.framework.system.Event)

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

پیامی را به فرستنده‌ای خاص ارسال می‌کند.

پارامتر
فضای نام	رشته فضای نام. توجه داشته باشید که جایِ نام معتبر باید پیشوند رشته «urn:x-cast:‎» داشته باشد.
senderId	(رشته یا تعریف‌نشده) ‫senderId، یا تعریف‌نشده برای همه‌فرستی به همه فرستندگان.
داده	هر نوع بار پیام. مقدار نباید خالی باشد.

پرتاب‌ها

Error اگر خطایی در آماده‌سازی پیام وجود داشته باشد.

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

اگر برنامه اطلاعات وضعیت اشکال‌زدایی را برای ورود به سیستم در گزارش بازخورد اضافه کند، این عملکرد باید در پاسخ به رویداد feedbackstarted فراخوانده شود. این تابع پارامتر «پیام» را دریافت می‌کند که رشته‌ای است که اطلاعات اشکال‌زدایی را که برنامه می‌خواهد ثبت کند نشان می‌دهد.

پارامتر
feedbackMessage	رشته

منسوخ

Use cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

وضعیت برنامه را تنظیم می‌کند. برنامه باید این را هنگام تغییر وضعیت خود فراخوانی کند. اگر تعریف نشده باشد یا روی رشته‌ای خالی تنظیم شده باشد، مقدار «نام برنامه» که درطول ثبت برنامه ایجاد شده است به‌طور پیش‌فرض برای وضعیت برنامه استفاده می‌شود.

پارامتر
statusText	رشته نوشتار وضعیت.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

گرداننده‌ای تنظیم کنید تا داده‌های بیشتری به گزارش بازخورد ارائه دهد. وقتی بازخورد گزارش‌شده‌ای ایجاد شود، گرداننده فراخوانده می‌شود و باید داده‌های اضافی را به‌صورت رشته یا رشته وعده برگرداند. برای اینکه وعده برگرداندن محصول در گزارش گنجانده شود، باید ظرف ۵ ثانیه حل‌وفصل شود.

پارامتر
feedbackHandler	تابع() مقدار ممکن است تهی باشد.

setInactivityTimeout

setInactivityTimeout(maxInactivity)

زمان اتمام فعالیت گیرنده را تنظیم می‌کند. توصیه می‌شود هنگام فراخوانی Start، حداکثر مقدار غیرفعال بودن را تنظیم کنید و آن را تغییر ندهید. این میانای برنامه‌سازی کاربردی فقط برای اهداف توسعه/اشکال‌زدایی ارائه شده است.

پارامتر
maxInactivity	شماره فاصله زمانی به ثانیه قبل‌از بستن اتصال غیرپاسخگو.

setLoggerLevel

setLoggerLevel(level)

سطح جزئیات گزارش را تنظیم می‌کند.

پارامتر
سطح	cast.framework.LoggerLevel سطح گزارش‌گیری. مقدار نباید خالی باشد.

شروع

start(options) returns cast.framework.CastReceiverContext

مدیر سیستم و مدیر رسانه را مقداردهی اولیه می‌کند تا برنامه گیرنده بتواند درخواست‌ها را از فرستندگان دریافت کند.

پارامتر
گزینه‌ها	(non-null cast.framework.CastReceiverOptions or optional non-null Object)

بازگشتی‌ها

non-null cast.framework.CastReceiverContext 

توقف

stop(closeReason)

برنامه گیرنده خاموش شد.

پارامتر

closeReason

اختیاری cast.framework.common.CloseReason دلیل اختیاری بستن که نشان می‌دهد چرا برنامه گیرنده متوقف می‌شود. اگر ارائه نشود، چارچوب دلیل را براساس رویدادهای اخیر پخش‌کننده رسانه استنباط می‌کند یا به APP_REQUEST برمی‌گردد. یکی از مقادیر عددی زیر را ارسال کنید: 13 (APP_CUSTOM_STOP): برای کنش‌های تجاری/میانای کاربر گیرنده سفارشی (مثلاً کاربر روی دکمه «خروج» یا «بستن» درون‌برنامه کلیک می‌کند، پیمایش گیرنده سفارشی از پخش محتوا دور می‌شود). 15 (APP_ERROR): خطاهای مهلک در سطح برنامه (برای مثال، خطاهای اصالت‌سنجی سفارشی، خطاهای بازیابی DRM/پروانه، ازکارافتادن میانای برنامه‌سازی کاربردی پس‌بخش) که خارج از رویدادهای خطای پخش‌کننده داخلی CAF اتفاق می‌افتند. 14 (APP_PLAYBACK_FINISHED): برنامه فهرست پخش/صف خود را مصرف کرده یا یک تجربه رسانه‌ای مستقل را تکمیل کرده است. 6 (APP_REQUEST): بازگشت عمومی / قدیمی وقتی برنامه‌ای بدون دلیل خاصی درخواست توقف می‌کند. مقدار نباید خالی باشد.