الفئة: CastReceivedrContext

cast.إطار العمل.CastReceiverContext

class   ثابت

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

الرميات

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

الطُرق

getInstance

ثابت

getInstance() returns cast.framework.CastReceiverContext

لعرض مثيل CastReceivedrContext المفرد المفرد.

المرتجعات

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

إعداد أداة معالجة الرسائل لقناة رسائل مخصّصة ويُسمح باستخدام أكثر من أداة معالجة واحدة في مساحة الاسم.

المَعلمة

namespace

سلسلة

مساحة الاسم. يُرجى العِلم أنّه يجب أن تبدأ مساحة الاسم الصالحة بالسلسلة "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 للفيديو أو الصوت.

برامج الترميز

إجراء اختياري

سلسلة

تحتوي سلسلة ذات علامات اقتباس على قائمة تنسيقات مفصولة بفواصل، حيث يحدد كل تنسيق نوع نموذج الوسائط المتوفر في ساحة المشاركات.

width

إجراء اختياري

الرقم

لوصف درجة الدقة الأفقية للتدفق بالبكسل.

الطول

إجراء اختياري

الرقم

يصف هذا الإعداد درجة الدقة العمودية للبث بالبكسل.

عدد اللقطات في الثانية

إجراء اختياري

الرقم

لوصف عدد اللقطات في الثانية للبث.
المرتجعات

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

getApplicationData

تعرض الطريقة getApplicationData() cast.framework.system.ApplicationData

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

المرتجعات

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

getDeviceCapabilities

تعرض الطريقة getDeviceCapabilities() كائنًا.

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

المرتجعات

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

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() مصفوفة 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، على سبيل المثال، تكون القيمة المعروضة غير معروفة.

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، على سبيل المثال، تكون القيمة المعروضة هي "غير معروف".

isSystemReady

تعرض قيمة isSystemجاهز() القيمة المنطقية.

عند بدء طلبات البيانات في التطبيق، سيرسل النظام الحدث الجاهز للإشارة إلى أنّ معلومات التطبيق جاهزة ويمكن للتطبيق إرسال الرسائل حالما يتوفر مرسِل واحد متصل.

المرتجعات

boolean ما إذا كان النظام جاهزًا لمعالجة الرسائل أم لا.

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

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

المَعلمة

useLegacyDashSupport

إجراء اختياري

boolean

الإشارة إلى ضرورة استخدام MPL لمحتوى DASH.

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

يؤدي هذا الخيار إلى إزالة مستمع رسائل سبق تسجيله في CastReceiverContext#addCustomMessageListener.

المَعلمة

namespace

سلسلة

مساحة الاسم. يُرجى العِلم أنّه يجب أن تبدأ مساحة الاسم الصالحة بالسلسلة "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)

لإرسال رسالة إلى مُرسِل محدَّد.

المَعلمة

namespace

سلسلة

مساحة الاسم. يُرجى العِلم أنّه يجب أن تبدأ مساحة الاسم الصالحة بالسلسلة "urn:x-cast:".

senderId

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

معرف المرسِل أو غير محدّد للبث إلى جميع المرسِلين.

البيانات

أي نوع

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

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

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

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

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

المَعلمة

feedbackMessage

سلسلة
منهي العمل به
استخدام Cast.framework.Cast للبدءContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

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

المَعلمة

statusText

سلسلة

نص الحالة.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

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

المَعلمة

feedbackHandler

function()

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

setInactivityTimeout

setInactivityTimeout(maxInactivity)

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

المَعلمة

maxInactivity

الرقم

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

setLoggerLevel

setLoggerLevel(level)

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

المَعلمة

المستوى

cast.framework.LoggerLevel

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

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

بدء

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

إعداد مدير النظام ومدير الوسائط بحيث يمكن لتطبيق المستلِم تلقّي الطلبات من المرسِلين.

المَعلمة

الخيارات

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

non-null cast.framework.CastReceiverContext 

محطة توقّف

()stop

إيقاف تطبيق جهاز الاستقبال.