Cast. framework. PlayerManager
تتحكّم هذه السياسة في تشغيل الوسائط وتراقبه.
- الرميات
-
non-null Error
إذا تم استخدام المُنشئ مباشرةً. يجب الوصول إلىPlayerManager
فقط من خلال الاتصال بـ cast.framework.CastReceivedrContext#getPlayerManager.
الطُرق
إضافةEventListener
addEventListener(eventType, eventListener)
لإضافة أداة معالجة حدث تستمع إلى أحداث التشغيل.
المعلمة |
|
---|---|
نوع الحدث |
(لا توجد قيم فارغة cast.framework.events.EventType أو مصفوفة غير فارغة من cast.framework.events.EventType غير فارغة) نوع أو مصفوفة من أنواع الأحداث |
أداة معالجة الحدث |
function(non-null cast.framework.events.Event) |
- الرميات
-
non-null Error
إذا كانت الوسيطات المحدّدة غير صالحة.
إضافة أوامر متوفرة في الوسائط
addSupportedMediaCommands(supportedMediaCommands, BroadcastStatus)
لإضافة أوامر متوافقة جديدة إلى القائمة الحالية من أوامر الوسائط المتوافقة.
المعلمة |
|
---|---|
الأوامر المعتمدة للوسائط |
number قناع أوامر أوامر متوافق مع التطبيق. |
حالة البث |
اختياري منطقي يشير |
- يمكن أيضًا مراجعة
- cast.framework.messages.Command
حالة البث
BroadcastStatus(includeMedia, requestId, customData, includeQueueItems)
لإرسال رسالة حالة وسائط إلى جميع المرسلين (البث). تستخدم التطبيقات هذا لإرسال تغيير حالة مخصصة.
المعلمة |
|
---|---|
تضمين الوسائط |
اختياري منطقي تشير القيمة |
رقم تعريف الطلب |
اختياري number رقم تعريف الطلب الوارد الذي تسبب في هذه الاستجابة. |
بيانات مخصصة |
اختياري اعتراض البيانات المخصصة لتطبيق رسالة الحالة. قد تكون القيمة فارغة. |
includeQueueItems |
اختياري منطقي لتحديد ما إذا كنت تريد تضمين عناصر اللائحة في رسالة الحالة أم لا. ولا يتم تضمينها تلقائيًا. |
getDefaultTimeForMediaTime
get {3/}TimeTimeForMediaTime(mediaTime) returns number
لتحويل وقت الوسائط إلى وقت مطلق للوسائط. ينطبق الوقت المطلق فقط على أحداث البث المباشر.
المعلمة |
|
---|---|
وقت الوسائط |
number وقت الوسائط. |
- المرتجعات
-
nullable number
الوقت المطلق أوnull
إذا لم يكن متوفرًا.
getAudioTracksManager
getAudioTracksManager() تعرض cast.framework.AudioTracksManager
للحصول على مثيل AudioTracksManager
.
- المرتجعات
-
non-null cast.framework.AudioTracksManager
GetBreakClipCurrentTimeSec
getBreakClipCurrentTimeSec() تعرض رقمًا
لعرض الوقت الحالي لمقطع الفاصل الذي يتم تشغيله حاليًا بالثواني.
- المرتجعات
-
nullable number
الوقت الحالي بالثواني داخل مقطع الفاصل الحالي.null
عندما لا يتم تشغيل مقطع الفاصل بواسطةPlayer
.
getBreakClipDurationSec
getBreakClipDurationSec() يعرض رقمًا
يتم عرض مدة مقطع الفاصل الذي يتم تشغيله حاليًا بالثواني.
- المرتجعات
-
nullable number
مدة مقطع الفاصل الحالي.null
عندما لا يشغّلPlayer
مقطع فاصل.
GetBreakManager
تعرض getBreakManager() الدالة cast.framework.breaks.BreakManager
للحصول على مثيل BreakManager
.
- المرتجعات
-
non-null cast.framework.breaks.BreakManager
GetBreaks
تعرض getBreaks() مصفوفة من قيم cast.framework.messages.Break غير فارغة.
لعرض قائمة من الفواصل.
- المرتجعات
-
non-null Array of non-null cast.framework.messages.Break
getCurrentSupportedMediaCommands
getCurrentSupportedMediaCommands() يعرض رقمًا
للحصول على أوامر الوسائط المتوافقة مع جهاز الاستقبال الحالي.
على عكس getSupportedMediaCommands()
، تتغير القيمة الناتجة لهذه الطريقة ديناميكيًا استنادًا إلى حالة التشغيل الحالية. على سبيل المثال، قد لا يكون الطلب SEEK
متوافقًا أثناء تشغيل الإعلانات.
يجب عدم استدعاء هذه الطريقة إلا بعد الاتصال بالمستلم CastReceiverContext#start
، وإلا فإنها ستعرض 0
.
- يمكن أيضًا مراجعة
- cast.framework.messages.Command
- المرتجعات
-
number
قناع صغير لأوامر الوسائط المتوافقة مع التطبيق.
getCurrentTimeSec
getCurrentTimeSec() تعرض رقمًا
للحصول على وقت التشغيل المنقضي للوسائط الحالية.
- المرتجعات
-
number
الوقت المنقضي بالثواني. سيكون هذا0
إذا لم يتم تشغيل أي وسائط.
getDurationSec
getDurationSec() تعرض رقمًا
للحصول على مدة الوسائط التي يتم تشغيلها حاليًا، بالثواني.
- المرتجعات
-
number
مدة الوسائط.NaN
إذا لم يتم تشغيل أي وسائط.
getLiveSeekableRange
getLiveSeekableRange() تعرض cast.framework.messages.LiveSeekableRange
لعرض النطاق المباشر القابل للبحث مع وقت البدء ووقت الانتهاء بالثواني. وتستند القيم إلى وقت الوسائط.
- المرتجعات
getMediaInformation
getMediaInformation() تعرض cast.framework.messages.MediaInformation
الحصول على معلومات الوسائط للوسائط الحالية.
- المرتجعات
getMediaTimeFor المطلق
getMediaTimeForUltimateTime(absoluteTime) returns number
لتحويل وقت مطلق الوسائط إلى وقت الوسائط. ينطبق الوقت المطلق فقط على أحداث البث المباشر.
المعلمة |
|
---|---|
الوقت المطلق |
number تمثّل هذه السمة الوقت المطلق لوسائل الإعلام، بتوقيت حقبة UNIX (بالثانية منذ حقبة Unix). |
- المرتجعات
-
nullable number
وقت الوسائط أوnull
إذا لم يكن متاحًا.
الحصول على تهيئة التشغيل
تعرض getPlayConfig() cast.framework.PlayConfig
لعرض تهيئة التشغيل.
- المرتجعات
-
nullable cast.framework.PlaybackConfig
الحصول على معدل التشغيل
getPlayRate() لعرض عدد
لعرض معدل التشغيل الحالي.
لعرض 1
قبل استدعاء المتلقي CastRecevierContext#start
.
- المرتجعات
-
number
معدل التشغيل الحالي
GetPlayerState
تعرض الدالة getPlayerState() cast.framework.messages.PlayerState
تحصل على الحالة Player
.
- المرتجعات
-
non-null cast.framework.messages.PlayerState
حالةPlayer
الحالية.
الحصول على معدل التشغيل المفضل
getPreferencePlayRate() يعرض رقمًا
الحصول على معدل التشغيل المفضل. يمكن استخدامها عند إيقاف التشغيل لحفظ أحدث معدّل تشغيل مفضّل في مساحة التخزين الثابتة، وبذلك يمكن استخدامها في الجلسة التالية في خيارات الإرسال.
- المرتجعات
-
number
getPreferenceTextLanguage
getPreferenceTextLanguage() تعرض سلسلة
للحصول على لغة مسار النص المفضل.
- المرتجعات
-
nullable string
getPreferenceTextStyle
getpreferredTextStyle() تعرض cast.framework.messages.TextTrackStyle
للحصول على نمط المقطع الصوتي المفضل.
- المرتجعات
getQueueManager
getQueueManager() Returns (cast.framework.QueueManager or undefined)
للحصول على مثيل QueueManager
.
- المرتجعات
-
(non-null cast.framework.QueueManager or undefined)
getRawCurrentTimeSec
getRawCurrentTimeSec() تعرض رقمًا
للحصول على وقت التشغيل المنقضي للوسائط الحالية، بدون طرح وقت الفاصل الإعلاني.
- المرتجعات
-
number
الوقت المنقضي بالثواني. سيكون هذا0
إذا لم يتم تشغيل أي وسائط.
getStart المطلق
تعرض الدالة getStart المطلقة() رقمًا
للحصول على وقت بدء الوسائط المطلق، كوقت بداية حقبة UNIX (بالثواني منذ حقبة Unix). ينطبق الوقت المطلق فقط على أحداث البث المباشر.
- المرتجعات
-
nullable number
الحصول على الإحصاءات
تعرض getStats() cast.framework.Stats
لعرض إحصاءات التشغيل. ويتم تجميع الإحصاءات على مدار جلسة التشغيل بالكامل حيثما كان ذلك مناسبًا.
- المرتجعات
-
non-null cast.framework.Stats
getSupportedMediaCommands
getSupportedMediaCommands() تعرض رقمًا
للحصول على أوامر الوسائط المتوافقة مع أجهزة الاستقبال. يجب الاتصال بعد الاتصال بـ CastReceiverContext#start()
، وإلا سيتم إرجاع 0
. يتم التحكّم في قيمة أوامر الوسائط المتوافقة فقط من خلال تطبيق جهاز الاستقبال .
ولا يتم تعديله تلقائيًا استنادًا إلى MediaStatus
.
- يمكن أيضًا مراجعة
- cast.framework.messages.Command
- المرتجعات
-
number
قناع صغير لأوامر الوسائط المتوافقة مع التطبيق.
getTextTracksManager
getTextTracksManager() تعرض cast.framework.TextTracksManager
للحصول على مثيل TextTracksManager
.
- المرتجعات
-
non-null cast.framework.TextTracksManager
getTimedMetadata
تعرض الدالة GetTimedMetadata() مصفوفة من cast.framework.TimedMetadata غير فارغة.
لعرض البيانات الوصفية المحددة بوقت أثناء تحليل البيان. هذه #EXT-X-DATERANGE
في HLS وEventStream
في DASH.
- المرتجعات
-
non-null Array of non-null cast.framework.TimedMetadata
حمولة
load(loadRequest) returns promisecontains void
لبدء طلب لتحميل الوسائط.
المعلمة |
|
---|---|
طلب التحميل |
cast.framework.messages.LoadRequestData طلب لتحميل الوسائط. يجب ألا تكون القيمة فارغة. |
- المرتجعات
-
non-null Promise containing void
الوعد الذي يتم حلّه عند نجاح العملية أو رفضها في حال تعذُّر إجراء العملية
pause
الإيقاف المؤقت()
لإيقاف الوسائط قيد التشغيل مؤقتًا.
تشغيل
play()
لتشغيل الوسائط المتوقفة مؤقتًا حاليًا.
إزالةEventListener
removeEventListener(eventType, eventListener)
لإزالة أداة معالجة الحدث التي تمت إضافتها لحدث تشغيل معيّن. إذا لم تكن هناك أداة معالجة الحدث مطابقة، فسيتم تجاهل هذه المكالمة.
المعلمة |
|
---|---|
نوع الحدث |
(لا توجد قيم فارغة cast.framework.events.EventType أو مصفوفة غير فارغة من cast.framework.events.EventType غير فارغة) نوع حدث أو مصفوفة من أنواع الأحداث |
أداة معالجة الحدث |
function(non-null cast.framework.events.Event) |
إزالة الأوامر المدعومة بالوسائط
removeSupportedMediaCommands(supportedMediaCommands, BroadcastStatus)
إزالة الأوامر من قائمة أوامر الوسائط المتوافقة.
المعلمة |
|
---|---|
الأوامر المعتمدة للوسائط |
number قناع أوامر أوامر متوافق مع التطبيق. |
حالة البث |
اختياري منطقي يشير |
- يمكن أيضًا مراجعة
- cast.framework.messages.Command
تقديم/ترجيع
شريط تمرير(seekTime)
البحث في الوسائط الحالية.
المعلمة |
|
---|---|
الوقت المطلوب |
number |
SendCustomState
sendCustomState(state)
لإرسال حالة مخصصة من منطق تشغيل التطبيق إلى منطق واجهة المستخدم.
تساعد هذه الطريقة على تمكين فصل منطق التشغيل وواجهة المستخدم.
يتيح الحفاظ على الفصل بين المنطق وواجهة المستخدم استخدام واحدة من منطق واجهة المستخدم نفسه لكل من التشغيل المحلي ووحدة التحكم عن بُعد.
تتوفّر الحالة المخصّصة التي ترسلها هذه الطريقة لواجهة المستخدم من خلال
PlayerData
.
المعلمة |
|
---|---|
ولاية |
اعتراض عنصر مخصّص للحالة. يجب ألا تكون القيمة فارغة. |
- يمكن أيضًا مراجعة
- cast.framework.ui.PlayerData#customState
خطأ في الإرسال
sendError(senderId, requestId, type, reason, customData)
لإرسال خطأ إلى مرسل معين.
المعلمة |
|
---|---|
معرّف المرسل |
سلسلة معرّف المرسِل. |
رقم تعريف الطلب |
number رقم تعريف الطلب الوارد الذي تسبب في حدوث هذا الخطأ. |
كتابة |
cast.framework.messages.ErrorType نوع الخطأ. يجب ألا تكون القيمة فارغة. |
السبب |
اختياري cast.framework.messages.ErrorError سبب الخطأ. قد تكون القيمة فارغة. |
بيانات مخصصة |
اختياري اعتراض البيانات المخصصة لتطبيق رسالة الخطأ المخصصة. قد تكون القيمة فارغة. |
requestLocalMediaRequest
sendLocalMediaRequest(request)
لإرسال طلب وسائط محلية.
المعلمة |
|
---|---|
طلب |
cast.framework.messages.RequestData يجب ألا تكون القيمة فارغة. |
حالة الإرسال
sendStatus(senderId, requestId, includeMedia, customData, includeQueueItems)
لإرسال رسالة حالة الوسائط إلى مرسل معين.
المعلمة |
|
---|---|
معرّف المرسل |
سلسلة معرّف المرسِل. |
رقم تعريف الطلب |
number رقم تعريف الطلب الوارد الذي تسبب في هذه الاستجابة. |
تضمين الوسائط |
اختياري منطقي تشير القيمة |
بيانات مخصصة |
اختياري اعتراض البيانات المخصصة لتطبيق رسالة الحالة. قد تكون القيمة فارغة. |
includeQueueItems |
اختياري منطقي لتحديد ما إذا كنت تريد تضمين عناصر اللائحة في رسالة الحالة أم لا. ولا يتم تضمينها تلقائيًا. |
setIdleالسبب
setIdleREASON(idleREASON)
لتعيين سبب أن يكون اللاعب في حالة IDLE
.
ويسمح هذا الإجراء للتطبيقات التي تريد فرض حالة IDLE
بتوضيح سبب إجراء ذلك (مثل خطأ مخصص).
يتم إرسال سبب عدم النشاط في رسالة الحالة التالية.
ملاحظة لا تحتاج معظم التطبيقات إلى ضبط هذه القيمة. ويكون الأمر مطلوبًا
فقط إذا كان التطبيق يحتاج إلى انتقال Player
إلى حالة IDLE
في الحالات الخاصة
ولا يعكس وضع وضع عدم النشاط التلقائي السلوك
المقصود.
المعلمة |
|
---|---|
سبب عدم النشاط |
cast.framework.messages.IdleREASON سبب التواجد في حالة يجب ألا تكون القيمة فارغة. |
setMediaElement
setMediaElement(mediaElement)
لتعيين HTMLMediaElement
للاستخدام. إذا تم ضبط Promise
من
HTMLMediaElement
، سيبدأ تشغيل الوسائط بعد
حلّ Promise
.
المعلمة |
|
---|---|
عنصر الوسائط |
(عنصر HTMLMediaElement غير فارغ أو وعد غير خالٍ يحتوي على HTMLMediaElement غير فارغ)
|
setMediaInformation
setMediaInformation(mediaInformation, opt_broadcast)
لتعيين معلومات الوسائط.
المعلمة |
|
---|---|
معلومات الوسائط |
cast.framework.messages.MediaInformation يجب ألا تكون القيمة فارغة. |
Opt_broadcast |
اختياري منطقي |
تعيين معالجة الوسائط MediaHandler
setMediaPlayInfoHandler(handler)
تعيين معالج لعرض cast.framework.التشغيلConfig، أو تعديله، لطلب تحميل معين. إنّ معلَمات المعالج هي
LoadRequestData
والسمة PlaybackConfig
التلقائية لجهاز الاستقبال (المتوفّر
في CastReceiverOptions
). ويجب أن يعرض المعالج
إعداد تعديل معدّلاً للتشغيل، أو null
لمنع تشغيل الوسائط. قد تكون قيمة العرض أيضًا Promise
للسماح بانتظار البيانات من الخادم.
المعلمة |
|
---|---|
المعالج |
function(non-null cast.framework.messages.LoadRequestData, non-null cast.framework.التشغيلConfig) دالة لتقديم طلب ضبط تشغيل محدّد. قد تكون القيمة فارغة. |
setMediaUrlResolver
setMediaUrlResolver(محلل)
لضبط معالج لعرض عنوان URL للوسائط في طلب LOAD
.
يمكن استخدام هذا المعالج لتجنّب نشر عنوان URL لمحتوى الوسائط
كجزء من حالة الوسائط. بشكل تلقائي، يتم استخدام الوسائط contentId
كعنوان URL للمحتوى.
المعلمة |
|
---|---|
برنامج التعيين |
function(non-null cast.framework.messages.LoadRequestData) دالة لحل عنوان URL لمحتوى الوسائط. قد تكون القيمة فارغة. |
تعيين تطبيق MessageInterceptor
setMessageInterceptor(type, اعتراض)
تعيين اعتراض للرسائل الواردة والصادرة.
يمكن أن يعترض الاعتراض بيانات الطلب، ويجب أن يعرض إما البيانات المعدَّلة أو Promise
مع البيانات المعدّلة (إذا تعذّر عرض البيانات على الفور)، أو null
إذا لم تتم معالجة الطلب.
ملاحظة: إذا تم تقديم أداة اعتراض الرسائل LOAD
، ولكن لم يتم تقديم أداة اعتراض PRELOAD
منفصلة، سيتم استدعاء أداة اعتراض LOAD
في رسائل PRELOAD
.
المعلمة |
|
---|---|
كتابة |
cast.framework.messages.MessageType يجب ألا تكون القيمة فارغة. |
أداة الاعتراض |
function(non-null cast.framework.messages.RequestData) قد تكون القيمة فارغة. |
ضبط التشغيل
setPlayConfig(playbackConfig)
لضبط إعدادات التشغيل على PlayerManager
.
المعلمة |
|
---|---|
إعداد التهيئة |
يجب ألا تكون القيمة فارغة. |
setSupportedMediaCommands
setSupportedMediaCommands(supportedMediaCommands, BroadcastStatus)
لتعيين أوامر الوسائط التي يدعمها المتلقي.
المعلمة |
|
---|---|
الأوامر المعتمدة للوسائط |
number قناع أوامر أوامر متوافق مع التطبيق. |
حالة البث |
اختياري منطقي يشير |
- يمكن أيضًا مراجعة
- cast.framework.messages.Command
إيقاف
stop()
لإيقاف الوسائط التي يتم تشغيلها حاليًا.