Kelas: Sesi

Konstruktor

Sesi

new Session(sessionId, appId, displayName, appImages, penerima)

Parameter

sessionId

string

ID sesi.

appId

string

ID aplikasi penerima.

displayName

string

Nama tampilan aplikasi.

appImages

Array chrome.cast.Image non-null

Gambar yang terkait dengan aplikasi.

Nilai tidak boleh nol.

penerima

chrome.cast.Receiver

Penerima yang menjalankan aplikasi.

Nilai tidak boleh nol.

Properti

appId

string

ID aplikasi Cast. Bukan untuk ditampilkan.

appImages

Array non-null dari chrome.cast.Image non-null

Array gambar yang tersedia mendeskripsikan aplikasi.

displayName

string

Nama aplikasi Cast yang dapat dibaca manusia, misalnya, "YouTube".

media

Array non-null dari chrome.cast.media.Media non-null

Media milik sesi Transmisi ini, termasuk yang dimuat oleh pengirim lain.

namespace

Array non-null dari {name: string}

Daftar namespace yang didukung oleh aplikasi penerima.

penerima

chrome.cast.Receiver bukan null

Penerima yang menjalankan aplikasi.

senderApps

Array non-null dari chrome.cast.SenderApplication non-null

Aplikasi pengirim yang didukung oleh aplikasi penerima. Atribut ini dapat digunakan untuk meminta pengguna menginstal atau mengunjungi aplikasi pengirim.

sessionId

string

Secara unik mengidentifikasi instance aplikasi penerima ini.

status

chrome.cast.SessionStatus non-null

Status sesi Transmisi ini ke aplikasi penerima.

statusText

string nullable

Teks deskriptif untuk konten aplikasi saat ini, misalnya “Slideshow Pernikahan Saya”.

transportId

string

ID yang secara unik mendeskripsikan sesi ini untuk tujuan transpor. Ini bersifat internal untuk saluran komunikasi.

Metode

addMediaListener

addMediaListener(listener)

Menambahkan pemroses yang dipanggil saat sesi media dibuat oleh pengirim lain.

Parameter

pemroses

function(non-null chrome.cast.media.Media)

Pemroses yang akan ditambahkan.

addMessageListener

addMessageListener(namespace, listener)

Menambahkan pemroses yang dipanggil saat pesan diterima dari aplikasi penerima. Pemroses dipanggil dengan namespace sebagai argumen pertama dan pesan sebagai argumen kedua.

Parameter

namespace

string

Namespace yang akan diproses, misalnya 'urn:x-cast:com.example.namespace'.

pemroses

fungsi(string, string)

Pemroses yang akan ditambahkan.

addUpdateListener

addUpdateListener(listener)

Menambahkan pemroses yang dipanggil saat Sesi telah berubah. Perubahan pada properti berikut akan memicu pemroses: statusText, namespace, status, dan volume penerima.

Pemroses harus memeriksa properti status dari Sesi untuk menentukan status koneksinya. Parameter boolean isAlive tidak digunakan lagi dan digantikan dengan properti Sesi status. Parameter isAlive tetap diteruskan untuk kompatibilitas mundur, dan bernilai benar kecuali jika status = chrome.cast.SessionStatus.STOPPED.

Parameter

pemroses

function(boolean)

Pemroses yang akan ditambahkan.

getDialAppInfo

getDialAppInfo(successCallback, errorCallback)

Mendapatkan info aplikasi DIAL.

Parameter

successCallback

function(non-null chrome.cast.DialLaunchData)

errorCallback

function(non-null chrome.cast.Error)

berangkat

left(successCallback, errorCallback)

Keluar (terputus) dari aplikasi penerima yang sedang berjalan yang terkait dengan sesi tersebut.

Klien yang ada dalam cakupan yang ditetapkan oleh AutoJoinPolicy klien ini akan terputus. Klien mendatang tidak akan otomatis bergabung ke sesi yang ditinggalkan.

Semua klien yang terputus akan memanggil pemroses pembaruan sesinya dengan isAlive = true. Pemroses harus memeriksa properti status Sesi untuk menentukan status koneksinya karena isAlive tidak digunakan lagi. Dalam hal ini, status = chrome.cast.SessionStatus.DISCONNECTED.

Parameter

successCallback

function()

errorCallback

function(non-null chrome.cast.Error)

Error yang mungkin terjadi adalah TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR, dan EXTENSION_MISSING.

loadMedia

loadMedia(loadRequest, successCallback, errorCallback)

Memuat media ke aplikasi penerima yang sedang berjalan.

Parameter

loadRequest

chrome.cast.media.LoadRequest

Permintaan untuk memuat media.

Nilai tidak boleh nol.

successCallback

function(non-null chrome.cast.media.Media)

Dipanggil dengan Media yang dimuat saat berhasil.

errorCallback

function(non-null chrome.cast.Error)

Dipanggil saat terjadi error. Error yang mungkin terjadi adalah TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR, dan EXTENSION_MISSING.

queueLoad

queueLoad(queueLoadRequest, successCallback, errorCallback)

Memuat dan secara opsional memulai pemutaran antrean baru item media ke aplikasi penerima yang sedang berjalan.

Parameter

queueLoadRequest

chrome.cast.media.QueueLoadRequest

Permintaan untuk memuat antrean baru item media.

Nilai tidak boleh nol.

successCallback

function(non-null chrome.cast.media.Media)

Dipanggil dengan Media yang dimuat saat berhasil.

errorCallback

function(non-null chrome.cast.Error)

Dipanggil saat terjadi error. Error yang mungkin terjadi adalah TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR, dan EXTENSION_MISSING.

Tidak digunakan lagi
Gunakan cast.framework.CastSession#loadMedia dan berikan chrome.cast.media.LoadRequest#queueData yang relevan.

removeMediaListener

removeMediaListener(listener)

Menghapus pemroses yang sebelumnya ditambahkan dengan addMediaListener.

Parameter

pemroses

function(non-null chrome.cast.media.Media)

Pemroses yang akan dihapus.

removeMessageListener

removeMessageListener(namespace, listener)

Menghapus pemroses yang sebelumnya ditambahkan untuk pesan.

Parameter

namespace

string

Namespace yang diproses, misalnya 'urn:x-cast:com.example.namespace'.

pemroses

fungsi(string, string)

Pemroses yang akan dihapus.

removeUpdateListener

removeUpdateListener(listener)

Menghapus pemroses yang sebelumnya ditambahkan untuk Sesi ini.

Parameter

pemroses

function(boolean)

Pemroses yang akan dihapus.

sendMessage

sendMessage(namespace, message, successCallback, errorCallback)

Mengirim pesan ke aplikasi penerima di namespace yang ditentukan. SuccessCallback dipanggil saat pesan telah dikirim ke saluran pesan. Pengiriman ke aplikasi penerima adalah upaya terbaik dan tidak dijamin.

Parameter

namespace

string

Namespace tempat pesan dikirim, misalnya, 'urn:x-cast:com.example.namespace'.

pesan

(non-null Object or string)

successCallback

function()

Dipanggil saat pesan telah dikirim.

errorCallback

function(non-null chrome.cast.Error)

Dipanggil saat terjadi error. Error yang mungkin terjadi adalah TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR, dan EXTENSION_MISSING.

setReceiverMuted

setReceiverMuted(muted, successCallback, errorCallback)

Menyetel volume penerima.

Parameter

dibisukan

boolean

Status suara baru yang dibisukan.

successCallback

function()

errorCallback

function(non-null chrome.cast.Error)

Error yang mungkin terjadi adalah TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR, dan EXTENSION_MISSING.

setReceiverVolumeLevel

setReceiverVolumeLevel(newLevel, successCallback, errorCallback)

Menyetel volume penerima.

Parameter

newLevel

angka

Level volume baru antara 0,0 dan 1,0.

successCallback

function()

errorCallback

function(non-null chrome.cast.Error)

Error yang mungkin terjadi adalah TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR, dan EXTENSION_MISSING.

perhentian

stop(successCallback, errorCallback)

Menghentikan aplikasi penerima yang sedang berjalan dan terkait dengan sesi tersebut.

Parameter

successCallback

function()

errorCallback

function(non-null chrome.cast.Error)

Error yang mungkin terjadi adalah TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR, dan EXTENSION_MISSING.