الفئة: CastReceivedrContext

cast.framework.CastReceiverContext

class   static

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

عمليات الطرح

non-null Error في حال عدم إنشاء MediaElement في نص المستند. إذا تم إنشاء عناصر وسائط متعددة، على المطوّر ضبط فئة "castMediaElement" على أحدها، وسيستخدمها جهاز استقبال CAF.

الطُرق

getInstance

static

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) تعرض قيمة منطقية

يتحقّق هذا الإجراء مما إذا كانت مَعلمات الوسائط المحدّدة لعمليات البث الصوتي أو بث الفيديو متوافقة مع المنصة.

المَعلمة
mimeType	سلسلة نوع MIME للوسائط ويتألف من نوع ونوع فرعي يفصل بينهما الرمز "/". ويمكن أن يكون نوع MIME للفيديو أو الصوت.
برامج الترميز	اختياري سلسلة تحتوي السلسلة المقتبسة على قائمة قيم مفصولة بفاصلة للتنسيقات، حيث يحدّد كل تنسيق نوع عيّنة وسائط موجودة في البث.
العرض	اختياري الرقم تصف الدقة الأفقية للبث بالبكسل.
الارتفاع	اختياري الرقم يصف الدقة الرأسية للبث بالبكسل.
معدل عرض الإطارات	اختياري الرقم تصف هذه السمة عدد اللقطات في الثانية للبث.

المرتجعات

boolean إذا كان من الممكن تشغيل البث على Chromecast

getApplicationData

تعرض الدالة getApplicationData()‎ cast.framework.system.ApplicationData

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

المرتجعات

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

getDeviceCapabilities

تعرض الدالة getDeviceCapabilities()‎ cast.framework.system.DeviceCapabilitiesObj

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

المرتجعات

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

getDeviceInformation

تعرض الدالة getDeviceInformation()‎ cast.framework.system.DeviceInformationObj

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

المرتجعات

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

getPlayerManager

تعرض الدالة getPlayerManager()‎ السمة cast.framework.PlayerManager

الحصول على مثيل Player يمكنه التحكّم في تشغيل الوسائط ومراقبته

المرتجعات

non-null cast.framework.PlayerManager 

getSender

getSender(senderId) تعرض 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)

بدء تحميل ملف js الخاص بالمشغّل ويمكن استخدام هذه الطريقة لبدء تحميل رمز 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	(سلسلة أو غير محدّد) ‫senderId أو غير محدّد للبث إلى جميع المُرسِلين
البيانات	أي نوع حمولة الرسالة يجب ألا تكون القيمة فارغة.

عمليات الطرح

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

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

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

المَعلمة
feedbackMessage	سلسلة

منهي العمل به

استخدِم cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

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

المَعلمة
statusText	سلسلة نص الحالة

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

يمكنك ضبط معالج لتوفير بيانات إضافية لتقرير الملاحظات. سيتم استدعاء المعالج عند إنشاء تقرير ملاحظات ويجب أن يعرض بيانات إضافية كسلسلة أو كعنصر Promise لسلسلة. يجب أن يتم حلّ الوعد المعروض في غضون 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(closeReason)‎

إيقاف تطبيق الاستقبال

المَعلمة

closeReason

اختياري cast.framework.common.CloseReason سبب الإغلاق الاختياري الذي يشير إلى سبب إيقاف تطبيق المُستلِم. وفي حال عدم توفيره، سيستنتج إطار العمل السبب استنادًا إلى أحداث مشغّل الوسائط الأخيرة، أو سيعود إلى APP_REQUEST. أدخِل إحدى القيم الرقمية التالية: ‫13 (APP_CUSTOM_STOP): لإجراءات واجهة المستخدم أو الإجراءات التجارية المخصّصة للتطبيق المُستقبِل (على سبيل المثال، ينقر المستخدم على زر "خروج" أو "إغلاق" داخل التطبيق، أو ينتقل التطبيق المُستقبِل المخصّص بعيدًا عن البث). ‫15 (APP_ERROR): أخطاء فادحة على مستوى التطبيق (مثل حالات تعذُّر المصادقة المخصّصة، أو تعذُّر استرداد إدارة الحقوق الرقمية/التراخيص، أو تعطُّل واجهة برمجة التطبيقات في الخلفية) تحدث خارج أحداث أخطاء المشغّل المضمّنة في CAF. ‫14 (APP_PLAYBACK_FINISHED): انتهى التطبيق من تشغيل قائمة التشغيل أو قائمة المحتوى التالي أو أكمل تجربة وسائط مستقلة. ‫6 (APP_REQUEST): يشير هذا الرمز إلى إجراء احتياطي عام أو قديم عندما يطلب أحد التطبيقات إنهاء الاتصال بدون سبب محدّد. يجب ألا تكون القيمة فارغة.