الفئة: CastReceivedrContext

cast.framework.CastReceiverContext

class   static

يدير عملية تحميل المكتبات الأساسية ويبدأ عملية إعداد حزمة تطوير البرامج (SDK) الأساسية لجهاز الاستقبال.

الرميات

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()‎ القيمة cast.framework.system.ApplicationData

تعرض هذه السمة معلومات التطبيق بعد أن يصبح النظام جاهزًا، وإلا ستكون قيمتها فارغة.

المرتجعات

nullable cast.framework.system.ApplicationData معلومات التطبيق أو قيمة فارغة إذا لم يكن النظام جاهزًا.

getDeviceCapabilities

تعرض الدالة getDeviceCapabilities() القيمة cast.receiver.CastReceiverManager.DeviceCapabilitiesObj

تعرض هذه السمة معلومات عن إمكانات الجهاز بعد أن يصبح النظام جاهزًا، وإلا ستكون قيمتها فارغة. إذا تم عرض عنصر فارغ، يعني ذلك أنّ الجهاز لا يعرض أي معلومات حول الإمكانات.

المرتجعات

nullable cast.receiver.CastReceiverManager.DeviceCapabilitiesObj معلومات إمكانات الجهاز (أزواج المفتاح/القيمة). ستكون القيمة فارغة إذا لم يكن النظام جاهزًا بعد. قد يكون كائنًا فارغًا إذا لم تعرض المنصة أي معلومات عن إمكانات الجهاز.

getDeviceInformation

تعرض الدالة getDeviceInformation()‎ cast.receiver.CastReceiverManager.DeviceInformationObj

يوفّر معلومات تعريفية للجهاز غير مرتبطة بالإمكانات بعد أن يصبح النظام جاهزًا، وإلا ستكون القيمة هي "null". في حال عرض عنصر فارغ، يعني ذلك أنّ الجهاز لا يعرض أي معلومات من هذا النوع.

المرتجعات

nullable cast.receiver.CastReceiverManager.DeviceInformationObj معلومات الجهاز (أزواج المفتاح/القيمة) ستكون القيمة فارغة إذا لم يكن النظام جاهزًا بعد. وقد يكون كائنًا فارغًا إذا كانت المنصة لا تعرض هذه المعلومات.

getPlayerManager

تعرض الدالة getPlayerManager() القيمة 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()‎ القيمة cast.framework.system.StandbyState

تعرض هذه السمة ما إذا كان مصدر إدخال HDMI لتطبيق البث في وضع الاستعداد.

المرتجعات

non-null cast.framework.system.StandbyState تُستخدَم لتحديد ما إذا كان إدخال HDMI للتطبيق في وضع الاستعداد أم لا. إذا تعذّر تحديدها لأنّ التلفزيون لا يتيح أوامر CEC، مثلاً، تكون القيمة المعروضة هي UNKNOWN.

getSystemState

تعرض الدالة getSystemState() القيمة 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)

بدء تحميل ملف JavaScript الخاص بالمشغّل يمكن استخدام هذا الخيار لبدء تحميل رمز JavaScript الخاص باللاعبين في مرحلة مبكرة من بدء جهاز الاستقبال قبل استدعاء start. لا تنفّذ هذه الدالة أي عملية إذا تم تحميل اللاعبين من قبل (تم استدعاء الدالة start).

المَعلمة

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

(سلسلة أو غير محدّد)

تمثّل هذه السمة معرّف المُرسِل أو قيمة غير محدّدة للبث إلى جميع المُرسِلين.

البيانات

أي نوع

حمولة الرسالة

يجب ألا تكون القيمة فارغة.
الرميات

Error في حال حدوث خطأ أثناء إعداد الرسالة

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

يجب استدعاء هذه الدالة استجابةً للحدث feedbackstarted إذا كان التطبيق يضيف معلومات حالة تصحيح الأخطاء إلى السجلّ في تقرير الملاحظات. تتلقّى هذه الدالة المَعلمة "message" التي تمثّل سلسلة تتضمّن معلومات تصحيح الأخطاء التي يريد التطبيق تسجيلها.

المَعلمة

feedbackMessage

سلسلة
منهي العمل به
استخدِم cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

تضبط هذه السمة حالة التطبيق. يجب أن يستدعي التطبيق هذا الإجراء عند تغيُّر حالته. إذا كانت القيمة غير محدّدة أو تم ضبطها على سلسلة فارغة، سيتم تلقائيًا استخدام قيمة "اسم التطبيق" التي تم تحديدها أثناء تسجيل التطبيق لحالة التطبيق.

المَعلمة

statusText

سلسلة

نص الحالة

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

اضبط معالجًا لتوفير بيانات إضافية لتقرير الملاحظات. سيتم استدعاء المعالج عند إنشاء تقرير ملاحظات ويجب أن يعرض بيانات إضافية كسلسلة أو وعد سلسلة. يجب أن يتم حلّ وعد الإرجاع في غضون 5 ثوانٍ ليتم تضمينه في التقرير.

المَعلمة

feedbackHandler

function()

قد تكون القيمة فارغة.

setInactivityTimeout

setInactivityTimeout(maxInactivity)

تضبط هذه السمة مهلة عدم النشاط في جهاز الاستقبال. يُنصح بضبط الحد الأقصى لقيمة عدم النشاط عند استدعاء Start وعدم تغييرها. يتم توفير واجهة برمجة التطبيقات هذه لأغراض التطوير/تصحيح الأخطاء فقط.

المَعلمة

maxInactivity

الرقم

الفاصل الزمني بالثواني قبل إغلاق اتصال غير مستجيب.

setLoggerLevel

setLoggerLevel(level)

تضبط هذه السمة مستوى الإسهاب في السجلّ.

المَعلمة

المستوى

cast.framework.LoggerLevel

مستوى التسجيل

يجب ألا تكون القيمة فارغة.

بدء

تعرض الدالة start(options) القيمة cast.framework.CastReceiverContext

تهيئة مدير النظام ومدير الوسائط، حتى يتمكّن تطبيق جهاز الاستقبال من تلقّي الطلبات من أجهزة الإرسال

المَعلمة

الخيارات

(cast.framework.CastReceiverOptions غير فارغ أو عنصر اختياري غير فارغ)
المرتجعات

non-null cast.framework.CastReceiverContext 

إيقاف

stop()

أغلِق تطبيق جهاز الاستقبال.