Class: CastReceiverContext

cast.framework.CastReceiverContext

class   static

Mengelola pemuatan library pokok dan menginisialisasi SDK penerima cast pokok.

Menampilkan

non-null Error Jika MediaElement tidak dibuat di isi dokumen. Jika beberapa elemen media dibuat, developer harus menetapkan class 'castMediaElement' ke salah satunya, yang akan digunakan oleh penerima CAF.

Metode

getInstance

statis

getInstance() menampilkan cast.framework.CastReceiverContext

Menampilkan instance singleton CastReceiverContext.

Hasil

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

Menyiapkan pemroses pesan untuk saluran pesan kustom. Lebih dari satu pemroses diizinkan untuk namespace.

Parameter

namespace

string

Namespace. Perhatikan bahwa namespace yang valid harus diawali dengan string 'urn:x-cast:'.

pemroses

function(non-null cast.framework.system.Message)
Menampilkan

Error Jika sistem belum siap atau namespace tidak didukung oleh aplikasi ini.

addEventListener

addEventListener(type, handler)

Menambahkan pemroses untuk mentransmisikan peristiwa sistem.

Parameter

jenis

cast.framework.system.EventType

Nilai tidak boleh null.

handler

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

canDisplayType

canDisplayType(mimeType, codecs, width, height, framerate) menampilkan boolean

Memeriksa apakah parameter media tertentu dari streaming video atau audio didukung oleh platform.

Parameter

mimeType

string

Jenis MIME media. Terdiri dari jenis dan subjenis yang dipisahkan oleh '/'. Dapat berupa jenis MIME video atau audio.

codec

Opsional

string

String yang dikutip berisi daftar format yang dipisahkan koma, dengan setiap format menentukan jenis sampel media yang ada dalam streaming.

lebar

Opsional

angka

Mendeskripsikan resolusi horizontal streaming dalam piksel.

tinggi

Opsional

angka

Menjelaskan resolusi vertikal streaming dalam piksel.

kecepatan frame

Opsional

angka

Mendeskripsikan kecepatan frame streaming.
Hasil

boolean Jika streaming dapat diputar di Chromecast.

getApplicationData

getApplicationData() menampilkan cast.framework.system.ApplicationData

Memberikan informasi aplikasi setelah sistem siap, jika tidak, nilainya akan null.

Hasil

nullable cast.framework.system.ApplicationData Informasi aplikasi atau null jika sistem belum siap.

getDeviceCapabilities

getDeviceCapabilities() mengembalikan cast.receiver.CastReceiverManager.DeviceCapabilitiesObj

Memberikan informasi kemampuan perangkat setelah sistem siap, jika tidak, nilainya akan berupa null. Jika objek kosong ditampilkan, perangkat tidak mengekspos informasi kemampuan apa pun.

Hasil

nullable cast.receiver.CastReceiverManager.DeviceCapabilitiesObj Informasi kemampuan perangkat (key-value pair). Nilainya akan berupa null jika sistem belum siap. Objek ini mungkin kosong jika platform tidak mengekspos informasi kemampuan perangkat apa pun.

getDeviceInformation

getDeviceInformation() menampilkan cast.receiver.CastReceiverManager.DeviceInformationObj

Memberikan informasi identifikasi perangkat yang tidak terkait dengan kemampuan setelah sistem siap, jika tidak, nilainya adalah 'null'. Jika objek kosong ditampilkan, perangkat tidak mengekspos informasi tersebut.

Hasil

nullable cast.receiver.CastReceiverManager.DeviceInformationObj Informasi perangkat (pasangan nilai kunci). Nilainya akan berupa null jika sistem belum siap. Objek ini mungkin kosong jika platform tidak mengekspos informasi ini.

getPlayerManager

getPlayerManager() menampilkan cast.framework.PlayerManager

Dapatkan instance Pemutar yang dapat mengontrol dan memantau pemutaran media.

Hasil

non-null cast.framework.PlayerManager 

getSender

getSender(senderId) menampilkan cast.framework.system.Sender

Mendapatkan pengirim berdasarkan ID pengirim

Parameter

senderId

string

ID pengirim yang akan ditampilkan.
Hasil

nullable cast.framework.system.Sender 

getSenders

getSenders() returns Array of non-null cast.framework.system.Sender

Mendapatkan daftar pengirim yang saat ini terhubung.

Hasil

non-null Array of non-null cast.framework.system.Sender 

getStandbyState

getStandbyState() menampilkan cast.framework.system.StandbyState

Melaporkan apakah input HDMI aplikasi transmisi dalam keadaan standby.

Hasil

non-null cast.framework.system.StandbyState Apakah input HDMI aplikasi dalam keadaan standby atau tidak. Jika tidak dapat ditentukan, karena TV tidak mendukung perintah CEC,misalnya, nilai yang ditampilkan adalah UNKNOWN.

getSystemState

getSystemState() menampilkan cast.framework.system.SystemState

Memberikan informasi aplikasi tentang status sistem.

Hasil

non-null cast.framework.system.SystemState Status sistem.

getVisibilityState

getVisibilityState() menampilkan cast.framework.system.VisibilityState

Melaporkan apakah aplikasi transmisi adalah input aktif HDMI.

Hasil

non-null cast.framework.system.VisibilityState Apakah aplikasi merupakan input aktif HDMI. Jika tidak dapat ditentukan, karena TV tidak mendukung perintah CEC,misalnya, nilai yang ditampilkan adalah UNKNOWN.

isSystemReady

isSystemReady() menampilkan boolean

Saat aplikasi memanggil start, sistem akan mengirim peristiwa siap untuk menunjukkan bahwa informasi aplikasi sudah siap dan aplikasi dapat mengirim pesan segera setelah ada satu pengirim yang terhubung.

Hasil

boolean Apakah sistem siap memproses pesan atau tidak.

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

Mulai memuat js pemutar. Ini dapat digunakan untuk mulai memuat kode JS pemutar pada tahap awal memulai penerima sebelum memanggil start. Fungsi ini tidak melakukan apa pun jika pemain sudah dimuat (start dipanggil).

Parameter

useLegacyDashSupport

Opsional

boolean

Menunjukkan bahwa MPL harus digunakan untuk konten DASH.

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

Menghapus pemroses pesan yang sebelumnya terdaftar dengan CastReceiverContext#addCustomMessageListener.

Parameter

namespace

string

Namespace. Perhatikan bahwa namespace yang valid harus diawali dengan string 'urn:x-cast:'.

pemroses

function(non-null cast.framework.system.Message)

Fungsi pemroses pesan yang akan dibatalkan pendaftarannya.
Menampilkan

Error Jika sistem belum siap atau namespace tidak didukung oleh aplikasi ini.

removeEventListener

removeEventListener(type, handler)

Menghapus pemroses untuk mentransmisikan peristiwa sistem.

Parameter

jenis

cast.framework.system.EventType

Nilai tidak boleh null.

handler

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

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

Mengirim pesan ke pengirim tertentu.

Parameter

namespace

string

Namespace. Perhatikan bahwa namespace yang valid harus diawali dengan string 'urn:x-cast:'.

senderId

(string atau undefined)

senderId, atau tidak ditentukan untuk siaran ke semua pengirim.

data

jenis apa pun

Payload pesan.

Nilai tidak boleh null.
Menampilkan

Error Jika terjadi error saat menyiapkan pesan.

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

Fungsi ini harus dipanggil sebagai respons terhadap peristiwa feedbackstarted jika aplikasi menambahkan informasi status debug untuk dicatat dalam laporan masukan. Fungsi ini menerima parameter 'message' yang merupakan string yang merepresentasikan informasi debug yang ingin dicatat oleh aplikasi.

Parameter

feedbackMessage

string
Tidak digunakan lagi
Gunakan cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

Menetapkan status aplikasi. Aplikasi harus memanggil ini saat statusnya berubah. Jika tidak ditentukan atau disetel ke string kosong, nilai Nama Aplikasi yang ditetapkan selama pendaftaran aplikasi akan digunakan untuk status aplikasi secara default.

Parameter

statusText

string

Teks status.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

Menetapkan pengendali untuk memberikan data tambahan ke laporan masukan. Handler akan dipanggil saat umpan balik yang dilaporkan dibuat dan harus menampilkan data tambahan sebagai string, atau promise string. Janji pengembalian harus diselesaikan dalam waktu 5 detik agar dapat disertakan dalam laporan.

Parameter

feedbackHandler

function()

Nilai dapat berupa null.

setInactivityTimeout

setInactivityTimeout(maxInactivity)

Menetapkan waktu tunggu tidak ada aktivitas penerima. Sebaiknya tetapkan nilai tidak aktif maksimum saat memanggil Start dan jangan mengubahnya. API ini hanya disediakan untuk tujuan pengembangan/pen-debug-an.

Parameter

maxInactivity

angka

Interval dalam detik sebelum menutup koneksi yang tidak responsif.

setLoggerLevel

setLoggerLevel(level)

Menetapkan tingkat kejelasan log.

Parameter

yaitu tingkat klik

cast.framework.LoggerLevel

Level logging.

Nilai tidak boleh null.

mulai

start(options) menampilkan cast.framework.CastReceiverContext

Melakukan inisialisasi pengelola sistem dan pengelola media, sehingga aplikasi penerima dapat menerima permintaan dari pengirim.

Parameter

opsi

(cast.framework.CastReceiverOptions non-null atau Object non-null opsional)
Hasil

non-null cast.framework.CastReceiverContext 

berhenti

stop()

Menonaktifkan aplikasi penerima.