chrome. yayınlayın
Bu, chrome.cast ad alanıdır.
Sınıflar
ApiYapılandırması
İlk başlatıldığında API'nin yapılandırmasını muhafaza eder.
Kimlik Bilgisi Verileri
Gönderenin kimlik bilgilerini tanımlamak için kullanılan kimlik bilgisi verileri.
Arama İsteği
DIAL uygulamasını başlatma isteği.
Hata
API tarafından döndürülen bir hatayı açıklar. Normalde bu nesneler istemci tarafından oluşturulmamalıdır.
Resim
Alıcı uygulamayı veya medya öğesini açıklayan resim. Bu, uygulama simgesi, kapak resmi veya küçük resim olabilir.
Alıcı
Bir uygulamanın çalıştırıldığı alıcıyı tanımlar. Normalde bu nesneler istemci tarafından oluşturulmamalıdır.
AlıcıGörüntülü Reklam Durumu
Alıcı kullanıcı arayüzünde uzantı kullanıcı arayüzünde gösterilir. Yalnızca ÖZEL alıcılar için geçerlidir.
GönderenUygulama
Gönderen uygulamayı açıklar. Normalde bu nesneler istemci tarafından oluşturulmamalıdır.
Oturum
Şu anda çalışan bir Yayın uygulamasının durumunu açıklar. Normalde bu nesneler istemci tarafından oluşturulmamalıdır.
Oturum İsteği
Oturum başlatma veya oturuma bağlanma isteği.
Zaman aşımı
API yöntemleri için varsayılan zaman aşımı değerlerini milisaniye cinsinden tanımlar.
Hacim
Cihazın veya medya akışının ses seviyesi.
Ad alanı
medya
Numaralandırmalar
Otomatik Birleştirme Politikası
string
Otomatik katılma politikası, SDK'nın bir API'yi başlattıktan sonra mevcut bir oturuma otomatik olarak ne zaman bağlayacağını belirler.
Değer |
|
---|---|
TAB_AND_ORIGIN_SCOPED |
string Oturum, aynı appId ile aynı sekmede ve sayfa kaynağında başlatıldığında otomatik olarak bağlanır. |
ORIGIN_Kapsamı |
string Oturum başlatıldığında aynı appId ve aynı sayfa kaynağıyla (sekmede bağımsız olarak) otomatik olarak bağlanır. |
SAYFA_KAPATILDI |
string Otomatik bağlantı yok. |
Kapasite
string
Alıcı cihazın desteklediği özellikler.
Değer |
|
---|---|
VİDEO_OUT |
string Alıcı, video çıkışını destekler. |
SES |
string Alıcı, ses çıkışını destekler. |
VIDEO_IN |
string Alıcı, video girişini (kamera) destekler. |
SES |
string Alıcı, ses girişini (mikrofon) destekler. |
ÇOKTAN_Grup |
string Alıcı, çok bölgeli bir grubu temsil ediyor. |
Varsayılan İşlem Politikası
string
Varsayılan işlem politikası, SDK'nın API başlatıldıktan sonra otomatik olarak oturum oluşturacağı zamanı belirler. Bu işlem, uzantı pop-up'ındaki sekme için varsayılan işlemi de denetler.
Değer |
|
---|---|
OLUŞTURUN_SESSION |
string API başlatıldığında uygulamayı içeren sekme yayınlanıyorsa SDK, sekme yayınlamayı durdurur ve uygulamayı otomatik olarak başlatır. Uzantı pop-up'ı, kullanıcıdan uygulamayı yayınlamasını ister. |
CAST_THIS_TAB |
string Sekme başlatılırken bile, API başlatıldıktan sonra otomatik olarak başlatma yapılmaz. Uzantı pop-up'ında kullanıcıdan sekmeyi yayınlaması istenir. |
Numara Çevirici
string
DIAL uygulamasının olası durumları.
Değer |
|
---|---|
ÇALIŞIYOR |
string |
DURDURULDU |
string |
HATA |
string Teknik özelliğin bir parçası değil. Hataları belirtmek için kullanılır. |
ErrorCode
string
SDK tarafından döndürülen hatalar.
Değer |
|
---|---|
İPTAL |
string İşlem kullanıcı tarafından iptal edildi. |
Zaman Aşımı |
string İşlem zaman aşımına uğradı. |
API_NOT_INITIALIZED |
string API başlatılmadı. |
GEÇERSİZ_PARAMETRE |
string İşlemin parametreleri geçerli değildi. |
UZANTI_OLMAYAN |
string API komut dosyası, yüklü Cast uzantısıyla uyumlu değil. |
UZANTI_MIMI |
string Cast uzantısı kullanılamıyor. |
RECEIVER_UNAVAILABLE |
string Hiçbir alıcı oturum isteğiyle uyumlu değildi. |
OTURUM_HATASI |
string Bir oturum oluşturulamadı veya oturum geçersizdi. |
KANAL_HATASI |
string Alıcı için kanal kullanılamıyor. |
YÜKSELİŞ_MEDYASI |
string Medya yüklenemedi. |
Alıcıİşlemi
string
Kullanıcının uzantıdaki bir alıcı üzerinde gerçekleştirebileceği işlemler. Bunlar, yayınlama işlemi tamamen tamamlanmadan (veya başarısız olmadan) önce gönderen uygulamanın kullanıcı arayüzünde bir geçiş göstermek için kullanılabilir.
Değer |
|
---|---|
YAYINLA |
string Kullanıcı, gönderen uygulamasıyla yayını gerçekleştirmek amacıyla bir alıcı seçti. Alıcının tam kimliği bilinmeyebilir. |
DURDUR |
string Kullanıcı, alıcı üzerinde oturumun durdurulmasını istedi. |
Alıcının Kullanılabilirliği
string
Yayın alıcısının kullanılabilirliğini açıklar.
Değer |
|
---|---|
KULLANILABİLİR |
string Oturum isteğiyle uyumlu olan en az bir alıcı mevcut. |
KULLANILAMIYOR |
string Kullanılabilir alıcı yok. |
Alıcı Türü
string
Değer |
|
---|---|
YAYINLA |
string Yayın alıcı, ör. Chromecast |
ÇEKİCİ |
string DIDI cihazı, ör. akıllı TV |
HANGOUT |
string Sosyal |
ÖZEL |
string İstemci tarafından sağlanan özel alıcı |
GönderenPlatformu
string
Gönderen uygulama platformunu açıklar.
Değer |
|
---|---|
CHROME |
string |
iOS |
string |
ANDROID |
string |
Oturum Durumu
string
Alıcı uygulamasına gönderilen Yayın oturumunun durumunu açıklar.
Değer |
|
---|---|
BAĞLI |
string Oturum, alıcı uygulamaya bağlı. |
BAĞLANTI KESİLDİ |
string Oturumun alıcı uygulamayla bağlantısı kesildi. Alıcı uygulaması çalışıyor olabilir veya olmayabilir. |
DURDURULDU |
string Alıcı uygulaması durduruldu. |
Ses Düzeyi Kontrol Türü
string
Ses denetimi türlerini açıklar.
Değer |
|
---|---|
ETKİLEŞİM |
string Yayın cihazının ses seviyesi değiştirilebilir. |
DÜZELTİLMİŞ |
string Yayın cihazının ses düzeyi sabittir ve değiştirilemez. |
ÖNEMLİ |
string Ana sistem ses seviyesi kontrolü, ör. TV veya Ses cihazı ses seviyesi değiştirilir. |
Özellikler
Otomatik Birleştirme Politikası
string
Otomatik katılma politikası, SDK'nın bir API'yi başlattıktan sonra mevcut bir oturuma otomatik olarak ne zaman bağlayacağını belirler.
Değer |
|
---|---|
TAB_AND_ORIGIN_SCOPED |
string Oturum, aynı appId ile aynı sekmede ve sayfa kaynağında başlatıldığında otomatik olarak bağlanır. |
ORIGIN_Kapsamı |
string Oturum başlatıldığında aynı appId ve aynı sayfa kaynağıyla (sekmede bağımsız olarak) otomatik olarak bağlanır. |
SAYFA_KAPATILDI |
string Otomatik bağlantı yok. |
Kapasite
string
Alıcı cihazın desteklediği özellikler.
Değer |
|
---|---|
VİDEO_OUT |
string Alıcı, video çıkışını destekler. |
SES |
string Alıcı, ses çıkışını destekler. |
VIDEO_IN |
string Alıcı, video girişini (kamera) destekler. |
SES |
string Alıcı, ses girişini (mikrofon) destekler. |
ÇOKTAN_Grup |
string Alıcı, çok bölgeli bir grubu temsil ediyor. |
Varsayılan İşlem Politikası
string
Varsayılan işlem politikası, SDK'nın API başlatıldıktan sonra otomatik olarak oturum oluşturacağı zamanı belirler. Bu işlem, uzantı pop-up'ındaki sekme için varsayılan işlemi de denetler.
Değer |
|
---|---|
OLUŞTURUN_SESSION |
string API başlatıldığında uygulamayı içeren sekme yayınlanıyorsa SDK, sekme yayınlamayı durdurur ve uygulamayı otomatik olarak başlatır. Uzantı pop-up'ı, kullanıcıdan uygulamayı yayınlamasını ister. |
CAST_THIS_TAB |
string Sekme başlatılırken bile, API başlatıldıktan sonra otomatik olarak başlatma yapılmaz. Uzantı pop-up'ında kullanıcıdan sekmeyi yayınlaması istenir. |
Numara Çevirici
string
DIAL uygulamasının olası durumları.
Değer |
|
---|---|
ÇALIŞIYOR |
string |
DURDURULDU |
string |
HATA |
string Teknik özelliğin bir parçası değil. Hataları belirtmek için kullanılır. |
ErrorCode
string
SDK tarafından döndürülen hatalar.
Değer |
|
---|---|
İPTAL |
string İşlem kullanıcı tarafından iptal edildi. |
Zaman Aşımı |
string İşlem zaman aşımına uğradı. |
API_NOT_INITIALIZED |
string API başlatılmadı. |
GEÇERSİZ_PARAMETRE |
string İşlemin parametreleri geçerli değildi. |
UZANTI_OLMAYAN |
string API komut dosyası, yüklü Cast uzantısıyla uyumlu değil. |
UZANTI_MIMI |
string Cast uzantısı kullanılamıyor. |
RECEIVER_UNAVAILABLE |
string Hiçbir alıcı oturum isteğiyle uyumlu değildi. |
OTURUM_HATASI |
string Bir oturum oluşturulamadı veya oturum geçersizdi. |
KANAL_HATASI |
string Alıcı için kanal kullanılamıyor. |
YÜKSELİŞ_MEDYASI |
string Medya yüklenemedi. |
Kullanılabilir
boolean
API'nin yüklenip yüklenmediğini kontrol etmek için müşterileri işaretleme.
Alıcıİşlemi
string
Kullanıcının uzantıdaki bir alıcı üzerinde gerçekleştirebileceği işlemler. Bunlar, yayınlama işlemi tamamen tamamlanmadan (veya başarısız olmadan) önce gönderen uygulamanın kullanıcı arayüzünde bir geçiş göstermek için kullanılabilir.
Değer |
|
---|---|
YAYINLA |
string Kullanıcı, gönderen uygulamasıyla yayını gerçekleştirmek amacıyla bir alıcı seçti. Alıcının tam kimliği bilinmeyebilir. |
DURDUR |
string Kullanıcı, alıcı üzerinde oturumun durdurulmasını istedi. |
Alıcının Kullanılabilirliği
string
Yayın alıcısının kullanılabilirliğini açıklar.
Değer |
|
---|---|
KULLANILABİLİR |
string Oturum isteğiyle uyumlu olan en az bir alıcı mevcut. |
KULLANILAMIYOR |
string Kullanılabilir alıcı yok. |
Alıcı Türü
string
Değer |
|
---|---|
YAYINLA |
string Yayın alıcı, ör. Chromecast |
ÇEKİCİ |
string DIDI cihazı, ör. akıllı TV |
HANGOUT |
string Sosyal |
ÖZEL |
string İstemci tarafından sağlanan özel alıcı |
GönderenPlatformu
string
Gönderen uygulama platformunu açıklar.
Değer |
|
---|---|
CHROME |
string |
iOS |
string |
ANDROID |
string |
Oturum Durumu
string
Alıcı uygulamasına gönderilen Yayın oturumunun durumunu açıklar.
Değer |
|
---|---|
BAĞLI |
string Oturum, alıcı uygulamaya bağlı. |
BAĞLANTI KESİLDİ |
string Oturumun alıcı uygulamayla bağlantısı kesildi. Alıcı uygulaması çalışıyor olabilir veya olmayabilir. |
DURDURULDU |
string Alıcı uygulaması durduruldu. |
zaman aşımı
boş olmayan chrome.cast.Timeout
API yöntemleri için milisaniye cinsinden varsayılan zaman aşımı değerleri.
1
null olmayan sayı dizisi
API sürümü. Bunların ilki ana sürüm, ikincisi alt sürümdür.
Ses Düzeyi Kontrol Türü
string
Ses denetimi türlerini açıklar.
Değer |
|
---|---|
ETKİLEŞİM |
string Yayın cihazının ses seviyesi değiştirilebilir. |
DÜZELTİLMİŞ |
string Yayın cihazının ses düzeyi sabittir ve değiştirilemez. |
ÖNEMLİ |
string Ana sistem ses seviyesi kontrolü, ör. TV veya Ses cihazı ses seviyesi değiştirilir. |
Yöntemler
eklemeAlıcıİşlemiDinleyici
addGetrActionHearer(dinleyici)
Kullanıcı, yayını başlatmak veya durdurmak için kullanıcı arayüzü üzerinden hareket ettiğinde çağrılacak bir dinleyici işlevi ekler. Gönderen uygulama, yayınlama işlemi tamamlanmadan veya başarısız olmadan önce kullanıcı arayüzünde bir geçiş (ör. yerel olarak oynatılan medyayı duraklatmak) göstermek için bunu kullanabilir.
- İşleyicinin çağrılacağı garanti edilmez ve uygulamaların düzgün çalışması için bu işleyiciye güvenmemesi gerekir.
- Dinleyici, varsa işlem yapılan alıcıya iletir. Ancak alıcı bilinmeyebilir ve bunun yerine null değeri döndürülür.
- Kullanıcı işlem yaptıktan sonra dinleyici en kısa sürede aranır. Bu durum, API aracılığıyla gerçekleşen durum değişikliğiyle ilgili olarak bildirim yapılmadan önce çağrılmalıdır.
Framework API'yi kullanıyorsanız bunun yerine cast.framework.CastContext#addEventHearer kullanın ve cast.framework.CastContextEventType#CAST_STATE_CHANGED etkinliği dinleyin.
Parametre |
|
---|---|
işleyici |
Eklenecek dinleyici işlevi. Dinleyicinin ilk bağımsız değişkeni, üzerinde işlem yapılan alıcıdır. Dinleyicinin ikinci bağımsız değişkeni, istenen işlemdir (chrome.cast.GetrAction bölümüne bakın). Değer boş olmamalıdır. |
ilk kullanıma hazırlamak
initialize(apiConfig, successCallback, errorCallback)
API'yi başlatır. API'nin başlatması tamamlandığında başarılı Callback ve errorCallback'in çağrılacağını unutmayın. Oturum İşleyici ve alıcı Dinleyici daha sonra herhangi bir zamanda ve muhtemelen birden fazla kez çağrılabilir.
Framework API'yi kullanıyorsanız bu işlev yerine cast.framework.CastContext#setOptions kullanın.
Parametre |
|
---|---|
apiConfig |
API'yi başlatmak için parametreleri olan nesne. Değer boş olmamalıdır. |
başarılı geri çağırma |
fonksiyon() |
hata geri çağırma |
İşlev(null olmayan chrome.cast.Error) Olası hatalar: TIMEOUT, INVALID_PARAMETER, Extension_MISSING. |
günlükMesajı
logMessage(mesaj)
Uygulamadan bir hata ayıklama mesajı kaydeder. Kullanıcılar açık bir şekilde ayrıntılı günlükleri eklemeyi tercih ederse bu mesaj Google'a bir geri bildirim raporunda gönderilebilir.
Parametre |
|
---|---|
mesaj |
string Günlüğe kaydedilecek mesaj. |
- Kullanımdan kaldırıldı
- Sunu API'si tabanlı Cast SDK'sı ile desteklenmez.
ön önbellek
precache(veriler)
Verileri önbelleğe almak için istek gönderme. Bağlı olan bir oturum, doğrudan istek gönderir. Aksi takdirde ağdaki tüm cihazlara gönderilir.
Parametre |
|
---|---|
veri |
string Önbelleğe alınacak veriler. |
Alıcı Alma İşlemini Dinleyici
removeGetrActionHearer(dinleyici)
Daha önce addGetrActionHearer ile eklenmiş bir işleyici işlevini kaldırır.
Parametre |
|
---|---|
işleyici |
Kaldırılacak dinleyici işlevi. Değer boş olmamalıdır. |
Oturum
requestSession(successCallback, errorCallback, oturumİstek)
Alıcı başvuru oturumu oluşturma veya katılma istekleri. Varsayılan olarak, başlatma sırasında API'ye aktarılan Oturum İsteği kullanılır; oturum İsteği'nde farklı bir oturum isteği iletilerek bu değer geçersiz kılınabilir.
Framework API'yi kullanıyorsanız bu işlev yerine cast.framework.CastContext#requestSession öğesini kullanın.
Parametre |
|
---|---|
başarılı geri çağırma |
İşlev(null olmayan chrome.cast.Session) |
hata geri çağırma |
İşlev(null olmayan chrome.cast.Error) Olası hatalar şunlardır: TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED, CANCEL, CHANNEL_ERROR, SESSION_ERROR, RECEIVER_UNAVAILABLE ve Extension_MISSING. Zaman aşımı zamanlayıcısının kullanıcılar bir alıcı seçtikten sonra başladığını unutmayın. Alıcı seçmek için kullanıcının zaman aşımına uğramadan işlem yapması gerekir. Zaten bir oturum isteği devam ediyorsa errorCallback, INVALID_PARAMETER hata kodu ve hatayı açıklayan bir açıklamayla çağrılır. |
Oturum İsteği |
İsteğe bağlı Değer boş olmamalıdır. |
OturumOturum Kimliği
requestSessionById(sessionId)
Belirtilen kimliğe sahip mevcut bir oturuma katılma istekleri. Katıldıktan sonra oturum chrome.cast.initialize tarafından ayarlanan sessionHearer oturumuna geçirilir.
Belirtilen oturumun olduğu oturum, bu işlev çağrıldığında zaten biliniyorsa oturum dinleyici hemen çağrılır. Aksi takdirde, belirli sessionId ile bir oturum keşfedildiğinde sessionHearer çağrılır.
Parametre |
|
---|---|
oturum kimliği |
string Katılmak istediğiniz oturumun kimliği. |
özel-Alıcılar
setCustomGetrs(alıcılar, successCallback, errorCallback)
Özel alıcı listesini ayarlar
Parametre |
|
---|---|
alıcılar |
Boş olmayan chrome.cast.Getr dizisi Yeni liste. Değer boş olmamalıdır. |
başarılı geri çağırma |
fonksiyon() |
hata geri çağırma |
İşlev(null olmayan chrome.cast.Error) Olası hatalar TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR ve Extension_MISSRING. |
- Kullanımdan kaldırıldı
- Sunu API'si tabanlı Cast SDK'sı ile desteklenmez.
setPageContext
setPageContext(kazan)
Bir iframe içinde Cast SDK'sını yükleyen bir sayfa için yayınlama işlevini başlatır. SDK başlatıldıktan sonra çağrılmalıdır.
Parametre |
|
---|---|
galibiyet |
Window Sayfa penceresi nesnesi. Değer boş olmamalıdır. |
setGetrDisplayDurumu
setGetrDisplayStatus(alıcı, başarılı arama, hata geri çağırma)
Alıcı adını ve görüntü durumunu ayarlar. Alıcıyı boşta olarak göstermek için displayStatus değerini boş olarak ayarlayın.
Yalnızca ÖZEL alıcılar için geçerlidir. Bu alıcı CAST ise alıcının displayStatus yoksayılır; Yayın alıcı durumu alıcı uygulama tarafından güncellenir.
Parametre |
|
---|---|
alıcı |
Alıcı. Değer boş olmamalıdır. |
başarılı geri çağırma |
fonksiyon() Durum ayarlama başarılı olduğunda geri çağırma. |
hata geri çağırma |
İşlev(null olmayan chrome.cast.Error) Olası hatalar: TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED ve Extension_MISSING. |
- Kullanımdan kaldırıldı
- Sunu API'si tabanlı Cast SDK'sı ile desteklenmez.
kod dışına almak
unescape(escape) dizesi dizesi
URI aracılığıyla çıkış yapılan dizelerin kod dışına alınması için yardımcı program yöntemi. Örneğin, alıcı dostu ad, URI çıkışlı bir dize olarak döndürülür. Gerekirse bu dizenin çıkışını kaldırmak için bu yöntemi kullanın.
Parametre |
|
---|---|
kaçtı |
string Çıkış karakterli bir dize |
- İadeler
-
string
Çıkış karaktersiz dize
Soyut türü
Alıcı İşlem İşleyici
Alıcı İşlemcisi()