مساحة الاسم: إرسال

صفوف

مساحة الاسم

عمليات التعداد

AutoJoinPolicy

ثابت

سلسلة

تحدِّد سياسة الانضمام التلقائي الوقت الذي ستربط فيه حزمة تطوير البرامج (SDK) تلقائيًا تطبيق مُرسِل بجلسة حالية بعد إعداد واجهة برمجة التطبيقات.

القيمة

TAB_AND_ORIGIN_SCOPED

سلسلة

يتم الاتصال تلقائيًا عند بدء الجلسة برقم تعريف التطبيق نفسه، وفي علامة التبويب نفسها وأصل الصفحة.

ORIGIN_SCOPED

سلسلة

الاتصال تلقائيًا عند بدء الجلسة برقم تعريف التطبيق نفسه وأصل الصفحة نفسه (بغض النظر عن علامة التبويب).

PAGE_SCOPED

سلسلة

ما مِن اتصال تلقائي.

الإمكانية

ثابت

سلسلة

الإمكانات التي يوفرها جهاز الاستقبال.

القيمة

VIDEO_OUT

سلسلة

يدعم جهاز الاستقبال إخراج الفيديو.

AUDIO_OUT

سلسلة

يدعم جهاز الاستقبال إخراج الصوت.

VIDEO_IN

سلسلة

يدعم جهاز الاستقبال إدخال الفيديو (الكاميرا).

AUDIO_IN

سلسلة

يدعم جهاز الاستقبال إدخال الصوت (الميكروفون).

MULTIZONE_GROUP

سلسلة

يمثل المُستلِم مجموعة متعددة المناطق.

DefaultActionPolicy

ثابت

سلسلة

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

القيمة

CREATE_SESSION

سلسلة

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

CAST_THIS_TAB

سلسلة

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

DialAppState

ثابت

سلسلة

الحالات المحتملة لتطبيق DIAL.

القيمة

الركض

سلسلة

متوقّف

سلسلة

خطأ

سلسلة

ليس جزءًا من المواصفات، بل يُستخدم للإشارة إلى الأخطاء.

ErrorCode

ثابت

سلسلة

الأخطاء التي قد تعرضها حزمة تطوير البرامج (SDK).

القيمة

إلغاء

سلسلة

تم إلغاء العملية من قِبل المستخدم.

مغامرات

سلسلة

انتهت مهلة العملية.

API_NOT_INITIALIZED

سلسلة

لم يتم إعداد واجهة برمجة التطبيقات.

INVALID_PARAMETER

سلسلة

لم تكن مَعلمات العملية صالحة.

EXTENSION_NOT_COMPATIBLE

سلسلة

النص البرمجي لواجهة برمجة التطبيقات غير متوافق مع إضافة Cast المثبتة.

EXTENSION_MISSING

سلسلة

إضافة Cast غير متاحة.

RECEIVER_UNAVAILABLE

سلسلة

لم يكن هناك جهاز استقبال متوافق مع طلب الجلسة.

SESSION_ERROR

سلسلة

تعذَّر إنشاء جلسة أو كانت الجلسة غير صالحة.

CHANNEL_ERROR

سلسلة

لا تتوفّر قناة للمستلِم.

LOAD_MEDIA_FAILED

سلسلة

تعذّر تحميل الوسائط.

ReceiverAction

ثابت

سلسلة

الإجراءات التي يمكن للمستخدم اتخاذها على جهاز الاستقبال في الإضافة يمكن استخدامها لإظهار عملية انتقال في واجهة مستخدم تطبيق المُرسِل قبل اكتمال إجراء البث (أو تعذُّر ذلك).

القيمة

CAST

سلسلة

اختار المستخدم مستلِمًا بهدف البث إليه من خلال تطبيق المُرسِل. قد لا تكون هوية المستلِم معروفة.

إيقاف

سلسلة

طلب المستخدم إيقاف الجلسة التي تعمل على جهاز استقبال.

ReceiverAvailability

ثابت

سلسلة

يصف مدى توفّر جهاز استقبال البث.

القيمة

متوفّرة

سلسلة

يتوفّر جهاز استقبال واحد على الأقل متوافق مع طلب الجلسة.

غير متاح

سلسلة

لا تتوفّر أجهزة استقبال.

ReceiverType

ثابت

سلسلة

القيمة

CAST

سلسلة

جهاز استقبال البث، مثل Chromecast

الاتصال

سلسلة

جهاز الاتصال بالإنترنت، مثل التلفزيون الذكي

جلسة HANGOUT

سلسلة

تسكّع

مخصّصة

سلسلة

جهاز استقبال مخصّص يوفّره العميل

SenderPlatform

ثابت

سلسلة

يصف النظام الأساسي لتطبيق المرسِل.

القيمة

CHROME

سلسلة

IOS

سلسلة

ANDROID

سلسلة

SessionStatus

ثابت

سلسلة

تصف حالة جلسة البث لتطبيق جهاز الاستقبال.

القيمة

متصل

سلسلة

يتمّ ربط الجلسة بتطبيق الاستقبال.

غير متّصل

سلسلة

يتم فصل الجلسة عن تطبيق المُستلِم. قد يكون تطبيق المُستلِم قيد التشغيل أو لا يزال قيد التشغيل.

متوقّف

سلسلة

تم إيقاف تطبيق المُستلِم.

VolumeControlType

ثابت

سلسلة

لوصف أنواع التحكم في مستوى الصوت.

القيمة

الانتباه

سلسلة

يمكن تغيير مستوى صوت جهاز البث.

تم الإصلاح

سلسلة

مستوى صوت جهاز البث ثابت ولا يمكن تغييره.

ماستر

سلسلة

يتم تغيير مستوى الصوت في النظام الرئيسي، أي تغيير مستوى صوت التلفزيون أو الجهاز السماعي.

أماكن إقامة

AutoJoinPolicy

ثابت

سلسلة

تحدِّد سياسة الانضمام التلقائي الوقت الذي ستربط فيه حزمة تطوير البرامج (SDK) تلقائيًا تطبيق مُرسِل بجلسة حالية بعد إعداد واجهة برمجة التطبيقات.

القيمة

TAB_AND_ORIGIN_SCOPED

سلسلة

يتم الاتصال تلقائيًا عند بدء الجلسة برقم تعريف التطبيق نفسه، وفي علامة التبويب نفسها وأصل الصفحة.

ORIGIN_SCOPED

سلسلة

الاتصال تلقائيًا عند بدء الجلسة برقم تعريف التطبيق نفسه وأصل الصفحة نفسه (بغض النظر عن علامة التبويب).

PAGE_SCOPED

سلسلة

ما مِن اتصال تلقائي.

الإمكانية

ثابت

سلسلة

الإمكانات التي يوفرها جهاز الاستقبال.

القيمة

VIDEO_OUT

سلسلة

يدعم جهاز الاستقبال إخراج الفيديو.

AUDIO_OUT

سلسلة

يدعم جهاز الاستقبال إخراج الصوت.

VIDEO_IN

سلسلة

يدعم جهاز الاستقبال إدخال الفيديو (الكاميرا).

AUDIO_IN

سلسلة

يدعم جهاز الاستقبال إدخال الصوت (الميكروفون).

MULTIZONE_GROUP

سلسلة

يمثل المُستلِم مجموعة متعددة المناطق.

DefaultActionPolicy

ثابت

سلسلة

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

القيمة

CREATE_SESSION

سلسلة

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

CAST_THIS_TAB

سلسلة

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

DialAppState

ثابت

سلسلة

الحالات المحتملة لتطبيق DIAL.

القيمة

الركض

سلسلة

متوقّف

سلسلة

خطأ

سلسلة

ليس جزءًا من المواصفات، بل يُستخدم للإشارة إلى الأخطاء.

ErrorCode

ثابت

سلسلة

الأخطاء التي قد تعرضها حزمة تطوير البرامج (SDK).

القيمة

إلغاء

سلسلة

تم إلغاء العملية من قِبل المستخدم.

مغامرات

سلسلة

انتهت مهلة العملية.

API_NOT_INITIALIZED

سلسلة

لم يتم إعداد واجهة برمجة التطبيقات.

INVALID_PARAMETER

سلسلة

لم تكن مَعلمات العملية صالحة.

EXTENSION_NOT_COMPATIBLE

سلسلة

النص البرمجي لواجهة برمجة التطبيقات غير متوافق مع إضافة Cast المثبتة.

EXTENSION_MISSING

سلسلة

إضافة Cast غير متاحة.

RECEIVER_UNAVAILABLE

سلسلة

لم يكن هناك جهاز استقبال متوافق مع طلب الجلسة.

SESSION_ERROR

سلسلة

تعذَّر إنشاء جلسة أو كانت الجلسة غير صالحة.

CHANNEL_ERROR

سلسلة

لا تتوفّر قناة للمستلِم.

LOAD_MEDIA_FAILED

سلسلة

تعذّر تحميل الوسائط.

isAvailable

ثابت

boolean

ضَع علامة أمام العملاء ليتأكّدوا من تحميل واجهة برمجة التطبيقات.

ReceiverAction

ثابت

سلسلة

الإجراءات التي يمكن للمستخدم اتخاذها على جهاز الاستقبال في الإضافة يمكن استخدامها لإظهار عملية انتقال في واجهة مستخدم تطبيق المُرسِل قبل اكتمال إجراء البث (أو تعذُّر ذلك).

القيمة

CAST

سلسلة

اختار المستخدم مستلِمًا بهدف البث إليه من خلال تطبيق المُرسِل. قد لا تكون هوية المستلِم معروفة.

إيقاف

سلسلة

طلب المستخدم إيقاف الجلسة التي تعمل على جهاز استقبال.

ReceiverAvailability

ثابت

سلسلة

يصف مدى توفّر جهاز استقبال البث.

القيمة

متوفّرة

سلسلة

يتوفّر جهاز استقبال واحد على الأقل متوافق مع طلب الجلسة.

غير متاح

سلسلة

لا تتوفّر أجهزة استقبال.

ReceiverType

ثابت

سلسلة

القيمة

CAST

سلسلة

جهاز استقبال البث، مثل Chromecast

الاتصال

سلسلة

جهاز الاتصال بالإنترنت، مثل التلفزيون الذكي

جلسة HANGOUT

سلسلة

تسكّع

مخصّصة

سلسلة

جهاز استقبال مخصّص يوفّره العميل

SenderPlatform

ثابت

سلسلة

يصف النظام الأساسي لتطبيق المرسِل.

القيمة

CHROME

سلسلة

IOS

سلسلة

ANDROID

سلسلة

SessionStatus

ثابت

سلسلة

تصف حالة جلسة البث لتطبيق جهاز الاستقبال.

القيمة

متصل

سلسلة

يتمّ ربط الجلسة بتطبيق الاستقبال.

غير متّصل

سلسلة

يتم فصل الجلسة عن تطبيق المُستلِم. قد يكون تطبيق المُستلِم قيد التشغيل أو لا يزال قيد التشغيل.

متوقّف

سلسلة

تم إيقاف تطبيق المُستلِم.

وقت مستقطع

ثابت

قيمة chrome.cast.Timeout غير فارغة

قيم المهلة التلقائية بالملي ثانية لطرق واجهة برمجة التطبيقات

النسخة

ثابت   ثابت

مصفوفة أرقام غير فارغة

إصدار واجهة برمجة التطبيقات. يشير الرقم الأول إلى رقم الإصدار الرئيسي والثاني هو رقم الإصدار الثانوي.

VolumeControlType

ثابت

سلسلة

لوصف أنواع التحكم في مستوى الصوت.

القيمة

الانتباه

سلسلة

يمكن تغيير مستوى صوت جهاز البث.

تم الإصلاح

سلسلة

مستوى صوت جهاز البث ثابت ولا يمكن تغييره.

ماستر

سلسلة

يتم تغيير مستوى الصوت في النظام الرئيسي، أي تغيير مستوى صوت التلفزيون أو الجهاز السماعي.

الطُرق

addReceiverActionListener

ثابت

addReceiverActionListener(listener)

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

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

في حال استخدام واجهة برمجة التطبيقات الخاصة بإطار العمل، استخدِم cast.framework.CastContext#addEventListener بدلاً من ذلك واستمع إلى أحداث Cast.framework.CastContextEventType#CAST_STATE_CHANGED.

المَعلمة

أداة معالجة الحدث

chrome.cast.ReceiverActionListener

دالة المستمع المطلوب إضافتها. الوسيطة الأولى للمستمعين هي المتلقي الذي تم اتخاذ إجراء بناءً عليه. الوسيطة الثانية التي يتم إرسالها إلى المستمع هي الإجراء المطلوب (يمكنك الاطّلاع على chrome.cast.replyrAction).

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

initialize

ثابت

originize(apiConfig, maxCallback, errorCallback)

يقوم بتهيئة واجهة برمجة التطبيقات. تجدر الإشارة إلى أنّه سيتم استدعاء الإجراء userCallback و errorCallback بعد الانتهاء من إعداد واجهة برمجة التطبيقات. وقد يتم استدعاء sessionListener وreplyrListener في أي وقت بعد ذلك، وربما أكثر من مرة.

في حال استخدام واجهة برمجة التطبيقات Framework API، استخدِم cast.framework.CastContext#setOptions بدلاً من هذه الدالة.

المَعلمة

apiConfig

chrome.cast.ApiConfig

الكائن الذي يتضمن معلَمات لإعداد واجهة برمجة التطبيقات.

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

successCallback

function()

errorCallback

function(non-null chrome.cast.Error)

الأخطاء المحتملة هي PARAM وINVALID_PARAMETER وextension_MISSING.

logMessage

ثابت

logMessage(message)

لتسجيل رسالة تصحيح أخطاء من التطبيق. وقد يتم إرسال هذه الرسالة في تقرير الملاحظات إلى Google إذا اختار المستخدمون صراحةً تضمين السجلات الدقيقة.

المَعلمة

رسالة

سلسلة

الرسالة المطلوب تسجيلها.

منهي العمل به
غير متوافق مع حزمة تطوير البرامج (SDK) للإرسال المستندة إلى Presentation API.

ذاكرة التخزين المؤقت

ثابت

precache(data)

أرسل طلبًا للتخزين المؤقت للبيانات. إذا كانت الجلسة متصلة، سيتم إرسال طلب مباشر، وإلا سيتم إرسالها إلى جميع الأجهزة في الشبكة.

المَعلمة

البيانات

سلسلة

البيانات المراد تخزينها مؤقتًا بشكل مسبق

منهي العمل به
غير متاح.

removeReceiverActionListener

ثابت

removeReceiverActionListener(listener)

لإزالة دالة استماع سبق أن تمت إضافتها باستخدام addReceivedrActionListener.

المَعلمة

أداة معالجة الحدث

chrome.cast.ReceiverActionListener

دالة المستمع المطلوب إزالتها.

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

requestSession

ثابت

requestSession(successCallback, errorCallback, sessionRequest)

طلبات إنشاء جلسة تطبيق المُستلِم أو الانضمام إليها. بشكل تلقائي، يتم استخدام SessionRequest التي يتم تمريرها إلى واجهة برمجة التطبيقات عند وقت الإعداد، ويمكن إلغاء هذا من خلال تمرير طلب جلسة مختلف في sessionRequest.

في حال استخدام واجهة برمجة التطبيقات الخاصة بإطار العمل، استخدِم cast.framework.CastContext#requestSession بدلاً من هذه الدالة.

المَعلمة

successCallback

function(non-null chrome.cast.Session)

errorCallback

function(non-null chrome.cast.Error)

تجدر الإشارة إلى أن الأخطاء المحتملة هي INVALID_PARAMETER وAPI_NOT_INITIALIZED وCANCEL وCHANNEL_ERROR وSESSION_ERROR وRECEIVER_UNAVAILABLE وextension_MISSING. لاحظ أن موقت المهلة يبدأ بعد أن يختار المستخدمون مستلمًا. يتطلب اختيار متلقي اتخاذ إجراء من المستخدم لا يتضمن مهلة. إذا كان هناك طلب جلسة قيد التقدم، يتم استدعاء errorCallback مع رمز الخطأ INVALID_PARAMETER ووصف يوضح الخطأ.

sessionRequest

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

chrome.cast.SessionRequest

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

requestSessionById

ثابت

requestSessionById(sessionId)

طلبات الانضمام إلى جلسة حالية برقم التعريف المحدد. عند الانضمام، سيتم تمرير الجلسة إلى sessionListener التي يحددها chrome.cast.initialize.

إذا كانت الجلسة التي لها قيمة sessionId المحددة معروفة عند استدعاء هذه الدالة، يتم استدعاء sessionListener على الفور. وفي حال لم يتم رصد أي جلسة تتضمّن sessionId، سيتم استدعاء sessionListener.

المَعلمة

sessionId

سلسلة

رقم تعريف الجلسة المراد الانضمام إليها.

setCustomReceivers

ثابت

setCustomReceivers(receivers, successCallback, errorCallback)

ضبط قائمة مستلِمين مخصَّصة

المَعلمة

أجهزة الاستقبال

مصفوفة chrome.cast.Receiver غير فارغة

تمثّل هذه السمة القائمة الجديدة.

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

successCallback

function()

errorCallback

function(non-null chrome.cast.Error)

تشمل الأخطاء المحتملة TIMESTAMP وAPI_NOT_INITIALIZED وINVALID_PARAMETER وCHANNEL_ERROR و extension_MISSRING.

منهي العمل به
غير متوافق مع حزمة تطوير البرامج (SDK) للإرسال المستندة إلى Presentation API.

setPageContext

ثابت

setPageContext(win)

لإعداد وظيفة البث لإحدى الصفحات التي تحمِّل حزمة تطوير البرامج (SDK) للبث في إطار iframe. يجب طلبه بعد إعداد حزمة تطوير البرامج (SDK).

المَعلمة

الفوز

نافذة

كائن نافذة الصفحة.

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

setReceiverDisplayStatus

ثابت

setReceiverDisplayStatus(receiver, successCallback, errorCallback)

تعيِّن اسم المُستلِم وحالة العرض. لإظهار جهاز الاستقبال على أنّه غير نشِط لفترة قصيرة، اضبط displayStatus على "فارغ".

صالح فقط لأجهزة الاستقبال المخصصة. يتم تجاهل حالة DisplayStatus للمستلِم إذا كان جهاز الاستقبال هذا CAST، ويتم تعديل حالة جهاز Cast من خلال تطبيق الجهاز.

المَعلمة

المستلِم

chrome.cast.Receiver

المُستلِم.

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

successCallback

function()

معاودة الاتصال عند نجاح إعداد الحالة.

errorCallback

function(non-null chrome.cast.Error)

الأخطاء المحتملة هي مهلة وINVALID_PARAMETER وAPI_NOT_INITIALIZED وextension_MISSING.

منهي العمل به
غير متوافق مع حزمة تطوير البرامج (SDK) للإرسال المستندة إلى Presentation API.

unescape

ثابت

سلسلة إرجاع إلغاء(escaped)

الطريقة المساعدة لإلغاء السلاسل التي تحتوي على أحرف إلغاء URI. على سبيل المثال، يتم عرض الاسم المألوف للمستلم كسلسلة تتضمّن أحرف إلغاء معرّف موارد منتظم (URI). استخدِم هذه الطريقة لإلغاء السلسلة إذا لزم الأمر.

المَعلمة

هروب

سلسلة

سلسلة يجب عدم تخطيها

المرتجعات

string سلسلة لم يتم تجاوزها

نوع التجريد

ReceiverActionListener

ثابت

ReceiverActionListener()