الفئة: PlayerManager

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

class   ثابت

تتحكّم هذه السياسة في تشغيل الوسائط وتراقبها.

الرميات

non-null Error في حال استخدام الدالة الإنشائية مباشرةً. يجب الوصول إلى PlayerManager فقط من خلال طلب cast.framework.CastReceiverContext#getPlayerManager.

الطُرق

addEventListener

addEventListener(eventType, eventListener)

إضافة أداة معالجة حدث تستمع إلى أحداث التشغيل.

المَعلمة

eventType

(cast.framework.events.EventType غير فارغة أو مصفوفة غير فارغة cast.framework.events.EventType)

نوع الحدث أو مصفوفة من أنواع الأحداث

eventListener

function(non-null cast.framework.events.Event)
الرميات

non-null Error إذا كانت الوسيطات المعطاة غير صالحة.

addSupportedMediaCommands

addSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

تعمل هذه الميزة على إضافة أوامر متوافقة جديدة إلى القائمة الحالية لأوامر الوسائط المتوافقة.

المَعلمة

supportedMediaCommands

الرقم

قناع بت لأوامر الوسائط المتوافقة مع التطبيق.

broadcastStatus

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

boolean

تشير السمة true إلى أنّه يجب إبلاغ المرسِلين بالتغيير (إذا لم يتم توفير هذه الرسالة، سيتم إشعار المُرسِلين).
يمكن أيضًا مراجعة
cast.framework.messages.Command

broadcastStatus

broadcastStatus(includeMedia, requestId, customData, includeQueueItems)

لإرسال رسالة حالة الوسائط إلى جميع المُرسِلين (البث). تستخدم التطبيقات هذا الإذن لإرسال تغيير حالة مخصّص.

المَعلمة

includeMedia

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

boolean

يشير true إلى أن الرسالة يجب أن تتضمن معلومات وسائط.

requestId

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

الرقم

تمثّل هذه السمة معرّف الطلب الوارد الذي تسبّب في هذا الاستجابة.

customData

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

الكائن

البيانات المخصّصة الخاصة بالتطبيقات في رسالة الحالة.

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

includeQueueItems

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

boolean

يمكنك اختيار ما إذا كان سيتم تضمين عناصر قائمة الانتظار في رسالة الحالة أم لا. ولا يتم تضمينها تلقائيًا.

getAbsoluteTimeForMediaTime

تعرض getAbsoluteTimeForMediaTime(mediaTime) رقمًا

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

المَعلمة

mediaTime

الرقم

وقت الوسائط
المرتجعات

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

لعرض نطاق البث المباشر القابل للبحث مع وقت البدء ووقت الانتهاء بالثواني. تستند القيم إلى وقت الوسائط.

المرتجعات

nullable cast.framework.messages.LiveSeekableRange 

getMediaInformation

تعرض الدالة getMediaInformation() cast.framework.messages.MediaInformation

الحصول على معلومات الوسائط الخاصة بالوسائط الحالية

المرتجعات

nullable cast.framework.messages.MediaInformation 

getMediaTimeForAbsoluteTime

تعرض getMediaTimeForAbsoluteTime(absoluteTime) رقمًا

لتحويل الوقت المطلق للوسائط إلى وقت وسائط. ينطبق الوقت المطلق على أحداث البث المباشر فقط.

المَعلمة

absoluteTime

الرقم

الوقت المطلق لوسائل الإعلام، حسب وقت حقبة يونكس (بالثانية من حقبة يونكس).
المرتجعات

nullable number وقت الوسائط أو null إذا لم تكن متوفّرة.

getPlaybackConfig

تعرض واجهة برمجة التطبيقات getPlaybackConfig() cast.framework.PlaybackConfig

تعرض هذه الدالة إعدادات التشغيل أو null إذا لم يتم إلغاء الإعدادات التلقائية.

المرتجعات

nullable cast.framework.PlaybackConfig 

getPlaybackRate

تعرض طريقة التشغيل getPlaybackRate() رقمًا.

لعرض معدّل التشغيل الحالي إرجاع 1 قبل طلب جهاز الاستقبال CastReceiverContext#start

المرتجعات

number معدّل التشغيل الحالي

getPlayerState

تعرض الطريقة getPlayerState() cast.framework.messages.PlayerState

يحصل على الحالة Player.

المرتجعات

non-null cast.framework.messages.PlayerState حالة Player الحالية:

getPreferredPlaybackRate

تعرض طريقة getPreferredPlaybackRate() رقمًا.

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

المرتجعات

number 

getPreferredTextLanguage

تعرض طريقة getPreferredTextLanguage() سلسلة.

اختيار لغة مسار النص المفضّلة

المرتجعات

nullable string 

getPreferredTextStyle

تعرض الطريقة getPreferredTextStyle() cast.framework.messages.TextTrackStyle

يحصل على نمط مسار النص المفضل.

المرتجعات

nullable cast.framework.messages.TextTrackStyle 

getQueueManager

getQueueManager() returns (cast.framework.QueueManager or undefined)

يتم الحصول على المثيل QueueManager.

المرتجعات

(non-null cast.framework.QueueManager or undefined) 

getRawCurrentTimeSec

تعرض getRawCurrentTimeSec() رقمًا.

للحصول على وقت التشغيل المنقضي للوسائط الحالية، بدون طرح وقت الفاصل الإعلاني

المرتجعات

number الوقت المنقضي بالثواني. سيكون هذا الرقم 0 إذا لم تكن هناك وسائط قيد التشغيل.

getStartAbsoluteTime

تعرض getStartAbsoluteTime() رقمًا

للحصول على وقت بدء الوسائط المطلق، كوقت حقبة UNIX (بالثواني منذ حقبة Unix). ينطبق الوقت المطلق على أحداث البث المباشر فقط.

المرتجعات

nullable number 

getStats

getStats() returns cast.framework.stats.Stats

لعرض إحصاءات التشغيل. ويتم تجميع الإحصاءات خلال جلسة التشغيل بأكملها عند اللزوم.

المرتجعات

non-null cast.framework.stats.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 

حمولة

تحميل(loadRequest) يعرض الوعد الذي يحتوي على إلغاء

لبدء طلب لتحميل الوسائط.

المَعلمة

loadRequest

cast.framework.messages.LoadRequestData

طلب لتحميل وسائط.

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

non-null Promise containing void التعهد بحلّ المشكلة عند نجاح العملية أو رفضها في حال تعذّر إتمامها

pause

cache()

يؤدي هذا الخيار إلى إيقاف الوسائط التي يتم تشغيلها حاليًا مؤقتًا.

تشغيل

play()

لتشغيل الوسائط المتوقفة مؤقتًا حاليًا.

removeEventListener

removeEventListener(eventType, eventListener)

لإزالة أداة معالجة الحدث التي تمت إضافتها لحدث تشغيل معيّن. في حال عدم توفُّر أداة معالجة حدث مطابقة، يتم تجاهل هذه المكالمة.

المَعلمة

eventType

(cast.framework.events.EventType غير فارغة أو مصفوفة غير فارغة cast.framework.events.EventType)

eventType أو مصفوفة من أنواع الأحداث

eventListener

function(non-null cast.framework.events.Event)

removeSupportedMediaCommands

removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

إزالة الأوامر من قائمة أوامر الوسائط المتوافقة.

المَعلمة

supportedMediaCommands

الرقم

قناع بت لأوامر الوسائط المتوافقة مع التطبيق.

broadcastStatus

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

boolean

تشير السمة true إلى أنّه يجب إبلاغ المرسِلين بالتغيير (إذا لم يتم توفير هذه الرسالة، سيتم إشعار المُرسِلين).
يمكن أيضًا مراجعة
cast.framework.messages.Command

تقديم/ترجيع

SeekTime(تقديم طلب)

البحث في الوسائط الحالية

المَعلمة

seekTime

الرقم

sendCustomState

sendCustomState(state)

لإرسال حالة مُخصَّصة من منطق تشغيل التطبيق إلى منطق واجهة المستخدم. تساعد هذه الطريقة على فصل منطق التشغيل وواجهة المستخدم. عند الحفاظ على الفصل بين المنطق وواجهة المستخدم، يصبح بإمكان المستخدم استخدام منطق واجهة المستخدم نفسه في كل من التشغيل المحلي والتحكّم عن بُعد. إنّ الحالة المخصّصة التي ترسلها هذه الطريقة متاحة لواجهة المستخدم من خلال PlayerData.

المَعلمة

state

الكائن

كائن الحالة المخصصة.

يجب ألا تكون القيمة فارغة.
يمكن أيضًا مراجعة
cast.framework.ui.PlayerData#customState

sendError

sendError(senderId, requestId, type, reason, customData)

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

المَعلمة

senderId

سلسلة

معرِّف المُرسِل.

requestId

الرقم

معرّف الطلب الوارد الذي تسبّب في حدوث هذا الخطأ.

كتابة

cast.framework.messages.ErrorType

نوع الخطأ

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

السبب

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

cast.framework.messages.ErrorReason

سبب الخطأ

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

customData

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

الكائن

البيانات المخصّصة الخاصة بالتطبيقات في رسالة الخطأ.

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

sendLocalMediaRequest

sendLocalMediaRequest(request)

إرسال طلب من وسائل الإعلام المحلية

المَعلمة

طلب

cast.framework.messages.RequestData

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

sendStatus

sendStatus(senderId, requestId, includeMedia, customData, includeQueueItems)

لإرسال رسالة حالة الوسائط إلى مرسل محدد.

المَعلمة

senderId

سلسلة

معرِّف المُرسِل.

requestId

الرقم

تمثّل هذه السمة معرّف الطلب الوارد الذي تسبّب في هذا الاستجابة.

includeMedia

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

boolean

يشير true إلى أن الرسالة يجب أن تتضمن مثيل MediaInformation.

customData

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

الكائن

البيانات المخصّصة الخاصة بالتطبيقات في رسالة الحالة.

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

includeQueueItems

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

boolean

يمكنك اختيار ما إذا كان سيتم تضمين عناصر قائمة الانتظار في رسالة الحالة أم لا. ولا يتم تضمينها تلقائيًا.

setIdleReason

setIdleReason(idleReason)

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

المَعلمة

idleReason

cast.framework.messages.IdleReason

السبب في أن يكون في حالة IDLE.

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

setMediaElement

setMediaElement(mediaElement)

لضبط HTMLMediaElement على الاستخدام. إذا تم ضبط Promise في HTMLMediaElement، سيبدأ تشغيل الوسائط بعد حلّ Promise.

المَعلمة

mediaElement

(HTMLMediaElement غير فارغة أو وعد غير خالٍ يتضمن HTMLMediaElement غير فارغ)

MediaElement التي سيستخدمها Player.

setMediaInformation

setMediaInformation(mediaInformation, opt_broadcast)

تحدِّد هذه السياسة معلومات الوسائط.

المَعلمة

mediaInformation

cast.framework.messages.MediaInformation

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

opt_broadcast

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

boolean

setMediaPlaybackInfoHandler

setMediaPlaybackInfoHandler(handler)

لضبط معالج لعرض cast.framework.PlaybackConfig أو تعديله لطلب تحميل محدد معالِج المعالِج هو LoadRequestData وPlaybackConfig التلقائي للمستلم (متوفّرة في CastReceiverOptions). ومن المفترض أن يعرض المعالج إعدادات تشغيل معدّلة أو null لمنع تشغيل الوسائط. وقد تكون القيمة المعروضة أيضًا Promise للسماح بانتظار البيانات من الخادم.

المَعلمة

المعالج

function(non-null cast.framework.messages.LoadRequestData, non-null cast.framework.PlaybackConfig)

دالة لتقديم طلب إعداد تشغيل محدد.

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

setMediaUrlResolver

setMediaUrlResolver(resolver)

تضبط هذه السياسة معالجًا لعرض عنوان URL للوسائط لطلب LOAD. يمكن استخدام هذا المعالج لتجنّب نشر عنوان URL لمحتوى الوسائط كجزء من حالة الوسائط. يتم تلقائيًا استخدام الوسائط contentId كعنوان URL للمحتوى.

المَعلمة

برنامج تعيين

function(non-null cast.framework.messages.LoadRequestData)

دالة لحل عنوان URL لمحتوى الوسائط.

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

setMessageInterceptor

setMessageInterceptor(type, interceptor)

لضبط اعتراض الرسائل الواردة والصادرة. ويمكن لأداة الاعتراض تعديل بيانات الطلب، ومن المفترض أن تعرض إما البيانات المعدّلة أو Promise مع البيانات المعدّلة (في حال تعذّر عرض البيانات فورًا) أو null إذا لم تتم معالجة الطلب. ملاحظة: في حال توفير أداة اعتراض الرسائل LOAD بدون توفير أداة اعتراض PRELOAD منفصلة، سيتم استدعاء أداة اعتراض LOAD لرسائل PRELOAD.

المَعلمة

كتابة

cast.framework.messages.MessageType

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

جهاز اعتراض

function(non-null cast.framework.messages.RequestData)

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

setPlaybackConfig

setPlaybackConfig(playbackConfig)

لضبط إعدادات التشغيل على PlayerManager

المَعلمة

playbackConfig

cast.framework.PlaybackConfig

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

setSupportedMediaCommands

setSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

تتيح هذه السياسة ضبط أوامر الوسائط التي يتيحها المستلِم.

المَعلمة

supportedMediaCommands

الرقم

قناع بت لأوامر الوسائط المتوافقة مع التطبيق.

broadcastStatus

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

boolean

تشير السمة true إلى أنّه يجب إبلاغ المرسِلين بالتغيير (إذا لم يتم توفير هذه الرسالة، سيتم إشعار المُرسِلين).
يمكن أيضًا مراجعة
cast.framework.messages.Command

محطة توقّف

()stop

لإيقاف الوسائط التي يتم تشغيلها حاليًا.