Namespace: melakukan transmisi

chrome.cast

namespace   statis

Ini adalah namespace chrome.cast.

Class

ApiConfig

Menyimpan konfigurasi untuk API saat diinisialisasi.

CredentialsData

Data kredensial yang digunakan untuk mengidentifikasi kredensial pengirim.

DialRequest

Permintaan untuk memulai aplikasi DIAL.

Error

Menjelaskan error yang ditampilkan oleh API. Biasanya, objek ini tidak boleh dibuat oleh klien.

Image

Gambar yang menjelaskan aplikasi penerima atau item media. Dapat berupa ikon aplikasi, gambar sampul, atau thumbnail.

Penerima

Menjelaskan penerima yang menjalankan aplikasi. Biasanya, objek ini tidak boleh dibuat oleh klien.

ReceiverDisplayStatus

Status penerima yang ditampilkan kepada pengguna di UI ekstensi. Hanya berlaku untuk penerima KUSTOM.

SenderApplication

Menjelaskan aplikasi pengirim. Biasanya, objek ini tidak boleh dibuat oleh klien.

Sesi

Menjelaskan status aplikasi Cast yang sedang berjalan. Biasanya, objek ini tidak boleh dibuat oleh klien.

SessionRequest

Permintaan untuk memulai atau menghubungkan ke sesi.

Waktu tunggu

Menentukan nilai waktu tunggu default dalam milidetik untuk metode API.

Volume

Volume perangkat atau streaming media.

Namespace

media

Enumerasi

AutoJoinPolicy

statis

string

Kebijakan bergabung secara otomatis menentukan kapan SDK akan otomatis menghubungkan aplikasi pengirim ke sesi yang ada setelah inisialisasi API.

Nilai
TAB_AND_ORIGIN_SCOPED	string Otomatis terhubung saat sesi dimulai dengan appId yang sama, di tab dan asal halaman yang sama.
ORIGIN_SCOPED	string Otomatis menghubungkan saat sesi dimulai dengan appId dan asal halaman yang sama (terlepas dari tab).
PAGE_SCOPED	string Tidak ada koneksi otomatis.

Kemampuan

statis

string

Kemampuan yang didukung oleh perangkat penerima.

Nilai
VIDEO_OUT	string Penerima mendukung output video.
AUDIO_OUT	string Penerima mendukung output audio.
VIDEO_IN	string Penerima mendukung input video (kamera).
AUDIO_IN	string Penerima mendukung input audio (mikrofon).
MULTIZONE_GROUP	string Penerima mewakili grup multi-zona.

DefaultActionPolicy

statis

string

Kebijakan tindakan default menentukan kapan SDK akan otomatis membuat sesi setelah menginisialisasi API. Ini juga mengontrol tindakan default untuk tab di pop-up ekstensi.

Nilai
CREATE_SESSION	string Jika tab yang berisi aplikasi sedang ditransmisikan saat API melakukan inisialisasi, SDK akan menghentikan transmisi tab dan otomatis meluncurkan aplikasi. Pop-up ekstensi meminta pengguna untuk mentransmisikan aplikasi.
CAST_THIS_TAB	string Tidak ada peluncuran otomatis yang dilakukan setelah menginisialisasi API, meskipun tab sedang ditransmisikan. Pop-up ekstensi meminta pengguna untuk mentransmisikan tab.

DialAppState

statis

string

Kemungkinan status aplikasi DIAL.

Nilai
RUNNING	string
DIHENTIKAN	string
ERROR	string Bukan bagian dari spesifikasi, digunakan untuk menandakan error.

ErrorCode

statis

string

Error yang mungkin ditampilkan oleh SDK.

Nilai
BATAL	string Operasi dibatalkan oleh pengguna.
TIMEOUT	string Waktu operasi habis.
API_NOT_INITIALIZED	string API belum diinisialisasi.
INVALID_PARAMETER	string Parameter operasi tidak valid.
EXTENSION_NOT_COMPATIBLE	string Skrip API tidak kompatibel dengan ekstensi Cast yang terinstal.
EXTENSION_MISSING	string Ekstensi Cast tidak tersedia.
RECEIVER_UNAVAILABLE	string Tidak ada penerima yang kompatibel dengan permintaan sesi.
SESSION_ERROR	string Sesi tidak dapat dibuat atau sesi tidak valid.
CHANNEL_ERROR	string Saluran untuk penerima tidak tersedia.
LOAD_MEDIA_FAILED	string Gagal memuat media.

ReceiverAction

statis

string

Tindakan yang dapat dilakukan pengguna pada penerima dalam ekstensi. Ini dapat digunakan untuk menampilkan transisi di UI aplikasi pengirim sebelum tindakan transmisi selesai sepenuhnya (atau gagal).

Nilai
CAST	string Pengguna memilih penerima dengan tujuan melakukan transmisi ke penerima tersebut dengan aplikasi pengirim. Identitas persis penerima mungkin tidak diketahui.
HENTIKAN	string Pengguna meminta untuk menghentikan sesi yang berjalan di penerima.

ReceiverAvailability

statis

string

Menjelaskan ketersediaan penerima Cast.

Nilai
TERSEDIA	string Tersedia minimal satu penerima yang kompatibel dengan permintaan sesi.
TIDAK TERSEDIA	string Tidak ada penerima yang tersedia.

ReceiverType

statis

string

Nilai
CAST	string Penerima transmisi, misalnya Chromecast
DIAL	string Perangkat DIAL, misalnya smart TV
SURGA	string Hangout
KUSTOM	string Penerima kustom yang disediakan oleh klien

SenderPlatform

statis

string

Menjelaskan platform aplikasi pengirim.

Nilai
CHROME	string
iOS	string
ANDROID	string

SessionStatus

statis

string

Menjelaskan status sesi Cast ke aplikasi penerimanya.

Nilai
TERHUBUNG	string Sesi terhubung ke aplikasi penerima.
TERPUTUS	string Sesi terputus dari aplikasi penerima. Aplikasi penerima mungkin masih berjalan atau mungkin juga tidak.
DIHENTIKAN	string Aplikasi penerima telah dihentikan.

VolumeControlType

statis

string

Menjelaskan jenis-jenis kontrol volume.

Nilai
ATENUASI	string Volume perangkat transmisi dapat diubah.
TETAP	string Volume perangkat transmisi bersifat tetap dan tidak dapat diubah.
MASTER	string Kontrol volume sistem master, yaitu volume perangkat TV atau Audio yang diubah.

Properti

AutoJoinPolicy

statis

string

Kebijakan bergabung secara otomatis menentukan kapan SDK akan otomatis menghubungkan aplikasi pengirim ke sesi yang ada setelah inisialisasi API.

Nilai
TAB_AND_ORIGIN_SCOPED	string Otomatis terhubung saat sesi dimulai dengan appId yang sama, di tab dan asal halaman yang sama.
ORIGIN_SCOPED	string Otomatis menghubungkan saat sesi dimulai dengan appId dan asal halaman yang sama (terlepas dari tab).
PAGE_SCOPED	string Tidak ada koneksi otomatis.

Kemampuan

statis

string

Kemampuan yang didukung oleh perangkat penerima.

Nilai
VIDEO_OUT	string Penerima mendukung output video.
AUDIO_OUT	string Penerima mendukung output audio.
VIDEO_IN	string Penerima mendukung input video (kamera).
AUDIO_IN	string Penerima mendukung input audio (mikrofon).
MULTIZONE_GROUP	string Penerima mewakili grup multi-zona.

DefaultActionPolicy

statis

string

Kebijakan tindakan default menentukan kapan SDK akan otomatis membuat sesi setelah menginisialisasi API. Ini juga mengontrol tindakan default untuk tab di pop-up ekstensi.

Nilai
CREATE_SESSION	string Jika tab yang berisi aplikasi sedang ditransmisikan saat API melakukan inisialisasi, SDK akan menghentikan transmisi tab dan otomatis meluncurkan aplikasi. Pop-up ekstensi meminta pengguna untuk mentransmisikan aplikasi.
CAST_THIS_TAB	string Tidak ada peluncuran otomatis yang dilakukan setelah menginisialisasi API, meskipun tab sedang ditransmisikan. Pop-up ekstensi meminta pengguna untuk mentransmisikan tab.

DialAppState

statis

string

Kemungkinan status aplikasi DIAL.

Nilai
RUNNING	string
DIHENTIKAN	string
ERROR	string Bukan bagian dari spesifikasi, digunakan untuk menandakan error.

ErrorCode

statis

string

Error yang mungkin ditampilkan oleh SDK.

Nilai
BATAL	string Operasi dibatalkan oleh pengguna.
TIMEOUT	string Waktu operasi habis.
API_NOT_INITIALIZED	string API belum diinisialisasi.
INVALID_PARAMETER	string Parameter operasi tidak valid.
EXTENSION_NOT_COMPATIBLE	string Skrip API tidak kompatibel dengan ekstensi Cast yang terinstal.
EXTENSION_MISSING	string Ekstensi Cast tidak tersedia.
RECEIVER_UNAVAILABLE	string Tidak ada penerima yang kompatibel dengan permintaan sesi.
SESSION_ERROR	string Sesi tidak dapat dibuat atau sesi tidak valid.
CHANNEL_ERROR	string Saluran untuk penerima tidak tersedia.
LOAD_MEDIA_FAILED	string Gagal memuat media.

isAvailable

statis

boolean

Flag untuk klien guna memeriksa apakah API telah dimuat.

ReceiverAction

statis

string

Tindakan yang dapat dilakukan pengguna pada penerima dalam ekstensi. Ini dapat digunakan untuk menampilkan transisi di UI aplikasi pengirim sebelum tindakan transmisi selesai sepenuhnya (atau gagal).

Nilai
CAST	string Pengguna memilih penerima dengan tujuan melakukan transmisi ke penerima tersebut dengan aplikasi pengirim. Identitas persis penerima mungkin tidak diketahui.
HENTIKAN	string Pengguna meminta untuk menghentikan sesi yang berjalan di penerima.

ReceiverAvailability

statis

string

Menjelaskan ketersediaan penerima Cast.

Nilai
TERSEDIA	string Tersedia minimal satu penerima yang kompatibel dengan permintaan sesi.
TIDAK TERSEDIA	string Tidak ada penerima yang tersedia.

ReceiverType

statis

string

Nilai
CAST	string Penerima transmisi, misalnya Chromecast
DIAL	string Perangkat DIAL, misalnya smart TV
SURGA	string Hangout
KUSTOM	string Penerima kustom yang disediakan oleh klien

SenderPlatform

statis

string

Menjelaskan platform aplikasi pengirim.

Nilai
CHROME	string
iOS	string
ANDROID	string

SessionStatus

statis

string

Menjelaskan status sesi Cast ke aplikasi penerimanya.

Nilai
TERHUBUNG	string Sesi terhubung ke aplikasi penerima.
TERPUTUS	string Sesi terputus dari aplikasi penerima. Aplikasi penerima mungkin masih berjalan atau mungkin juga tidak.
DIHENTIKAN	string Aplikasi penerima telah dihentikan.

timeout

statis

chrome.cast.Timeout bukan null

Nilai waktu tunggu default dalam milidetik untuk metode API.

VERSI

konstan   statis

Array angka non-null

Versi API. Nomor pertama adalah versi utama, dan nomor kedua adalah versi minor.

VolumeControlType

statis

string

Menjelaskan jenis-jenis kontrol volume.

Nilai
ATENUASI	string Volume perangkat transmisi dapat diubah.
TETAP	string Volume perangkat transmisi bersifat tetap dan tidak dapat diubah.
MASTER	string Kontrol volume sistem master, yaitu volume perangkat TV atau Audio yang diubah.

Metode

addReceiverActionListener

statis

addReceiverActionListener(listener)

Menambahkan fungsi pemroses yang akan dipanggil saat pengguna telah bertindak melalui UI untuk memulai atau menghentikan transmisi. Aplikasi pengirim dapat menggunakan ini untuk menampilkan transisi di antarmuka penggunanya (yaitu menjeda media yang diputar secara lokal) sebelum tindakan transmisi selesai atau gagal.

• Pemroses tidak dijamin akan dipanggil dan aplikasi tidak boleh mengandalkannya agar dapat berfungsi dengan benar.
• Pemroses akan diteruskan penerima yang ditindaklanjuti, jika tersedia. Namun, penerima mungkin tidak diketahui dan null akan diteruskan.
• Pemroses akan dipanggil sesegera mungkin setelah pengguna mengambil tindakan. Fungsi ini harus dipanggil sebelum aplikasi diberi tahu tentang perubahan status yang dihasilkan melalui API.

Jika menggunakan Framework API, gunakan cast.framework.CastContext#addEventListener dan proses peristiwa cast.framework.CastContextEventType#CAST_STATE_ringan.

Parameter
pemroses	chrome.cast.ReceiverActionListener Fungsi pemroses yang akan ditambahkan. Argumen pertama bagi pemroses adalah penerima yang ditindaklanjuti. Argumen kedua untuk pemroses adalah tindakan yang diminta (lihat chrome.cast.ReceiverAction). Nilai tidak boleh nol.

initialize

statis

inisialisasi(apiConfig, successCallback, errorCallback)

Menginisialisasi API. Perhatikan bahwa suksesCallback dan errorCallback akan dipanggil setelah API menyelesaikan inisialisasi. sessionListener dan penerimaListener dapat dipanggil kapan saja setelahnya, dan mungkin lebih dari sekali.

Jika menggunakan Framework API, gunakan cast.framework.CastContext#setOptions, bukan fungsi ini.

Parameter
apiConfig	chrome.cast.ApiConfig Objek dengan parameter untuk menginisialisasi API. Nilai tidak boleh nol.
successCallback	function()
errorCallback	function(non-null chrome.cast.Error) Error yang mungkin terjadi adalah TIMEOUT, INVALID_PARAMETER, EXTENSION_MISSING.

logMessage

statis

logMessage(message)

Mencatat pesan debug dari aplikasi ke dalam log. Pesan ini mungkin dikirim dalam laporan masukan ke Google jika pengguna secara eksplisit memilih untuk menyertakan log penting.

Parameter
pesan	string Pesan yang akan dicatat.

Tidak digunakan lagi

Tidak didukung dengan Cast SDK berbasis Presentation API.

pra-cache

statis

precache(data)

Kirim permintaan untuk melakukan precache data. Jika sebuah sesi terhubung, permintaan langsung akan dikirimkan, atau permintaan langsung akan dikirimkan ke semua perangkat dalam jaringan.

Parameter
data	string Data yang akan di-precache.

Tidak digunakan lagi

Tidak didukung.

removeReceiverActionListener

statis

removeReceiverActionListener(listener)

Menghapus fungsi pemroses yang sebelumnya ditambahkan dengan addReceiverActionListener.

Parameter
pemroses	chrome.cast.ReceiverActionListener Fungsi pemroses yang akan dihapus. Nilai tidak boleh nol.

requestSession

statis

requestSession(successCallback, errorCallback, sessionRequest)

Meminta pembuatan atau penggabungan sesi aplikasi penerima. Secara default, SessionRequest yang diteruskan ke API pada waktu inisialisasi akan digunakan; hal ini dapat diganti dengan meneruskan permintaan sesi yang berbeda di sessionRequest.

Jika menggunakan Framework API, gunakan cast.framework.CastContext#requestSession, bukan fungsi ini.

Parameter
successCallback	function(non-null chrome.cast.Session)
errorCallback	function(non-null chrome.cast.Error) Error yang mungkin terjadi adalah TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED, CANCEL, CHANNEL_ERROR, SESSION_ERROR, RECEIVER_UNAVAILABLE, dan EXTENSION_EXTENSION. Perhatikan bahwa timer waktu tunggu dimulai setelah pengguna memilih penerima. Memilih penerima memerlukan tindakan pengguna, yang tidak memiliki waktu tunggu. Jika permintaan sesi sedang berlangsung, errorCallback akan dipanggil dengan kode error INVALID_PARAMETER dan deskripsi yang menjelaskan error tersebut.
sessionRequest	Opsional chrome.cast.SessionRequest Nilai tidak boleh nol.

requestSessionById

statis

requestSessionById(sessionId)

Permintaan untuk bergabung ke sesi yang ada dengan ID tertentu. Setelah bergabung, sesi akan diteruskan ke sessionListener yang ditetapkan oleh chrome.cast.initialize.

Jika sesi dengan sessionId yang diberikan sudah diketahui saat fungsi ini dipanggil, sessionListener akan segera dipanggil. Jika tidak, setelah sesi dengan sessionId tertentu ditemukan, sessionListener akan dipanggil.

Parameter
sessionId	string ID sesi untuk bergabung.

setCustomReceivers

statis

setCustomReceivers(receivers, successCallback, errorCallback)

Menetapkan daftar penerima kustom

Parameter
penerima	Array chrome.cast.Receiver non-null Daftar baru. Nilai tidak boleh nol.
successCallback	function()
errorCallback	function(non-null chrome.cast.Error) Error yang mungkin terjadi adalah TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, dan EXTENSION_MISSRING.

Tidak digunakan lagi

Tidak didukung dengan Cast SDK berbasis Presentation API.

setPageContext

statis

setPageContext(win)

Melakukan inisialisasi fungsi Cast untuk halaman yang memuat Cast SDK dalam iframe. Harus dipanggil setelah SDK diinisialisasi.

Parameter
menang	Jendela Objek jendela halaman. Nilai tidak boleh nol.

setReceiverDisplayStatus

statis

setReceiverDisplayStatus(receiver, successCallback, errorCallback)

Menetapkan nama penerima dan status tampilan. Untuk menampilkan penerima sebagai tidak ada aktivitas, setel displayStatus ke null.

Hanya berlaku untuk penerima KUSTOM. DisplayStatus penerima diabaikan jika penerima ini adalah CAST; status penerima transmisi diperbarui oleh aplikasi penerima.

Parameter
penerima	chrome.cast.Receiver Penerima. Nilai tidak boleh nol.
successCallback	function() Callback saat status setelan berhasil.
errorCallback	function(non-null chrome.cast.Error) Error yang mungkin terjadi adalah TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED, dan EXTENSION_MISSING.

Tidak digunakan lagi

Tidak didukung dengan Cast SDK berbasis Presentation API.

unescape

statis

unescape(escaped) menampilkan string

Metode utilitas untuk membatalkan konversi string yang di-escape URI. Misalnya, nama yang cocok untuk penerima akan ditampilkan sebagai string yang di-escape URI. Gunakan metode ini untuk melakukan unescape string tersebut jika diperlukan.

Parameter
di-escape	string String untuk melakukan unescape

Hasil

string String yang tidak di-escape

Jenis abstrak

ReceiverActionListener

statis

ReceiverActionListener()