Class GCKCastSession

Referensi Class GCKCastSession

Ringkasan

Class yang mengelola sesi Cast dengan perangkat penerima.

Sesi dibuat dan dikelola secara otomatis oleh GCKSessionManager. Aplikasi tidak boleh secara langsung memanggil metode siklus proses sesi seperti start (GCKSession(Protected)) atau endAndStopCasting: (GCKSession(Protected)).

Sejak
3,0

Mewarisi GCKSession.

Ringkasan Metode Instance

(instancetype) - initWithDevice:sessionID:castOptions:
 Penginisialisasi yang ditetapkan. Lainnya...
 
(BOOL) - addChannel:
 Mendaftarkan channel ke sesi. Lainnya...
 
(BOOL) - removeChannel:
 Menghapus saluran yang sebelumnya terdaftar dari sesi. Lainnya...
 
(void) - addDeviceStatusListener:
 Menambahkan GCKCastDeviceStatusListener ke daftar pemroses objek ini. Lainnya...
 
(void) - removeDeviceStatusListener:
 Menghapus GCKCastDeviceStatusListener dari daftar pemroses objek ini. Lainnya...
 
(GCKRequest *) - setDeviceVolume:forMultizoneDevice:
 Menyetel volume setiap perangkat dalam grup multizona. Lainnya...
 
(GCKRequest *) - setDeviceMuted:forMultizoneDevice:
 Menyetel status dibisukan setiap perangkat di grup multizona. Lainnya...
 
(GCKRequest *) - requestMultizoneStatus
 Meminta status multizona dari grup multizona. Lainnya...
 
(instancetype) - initWithDevice:traits:sessionID:
 Menginisialisasi objek sesi baru untuk perangkat tertentu. Lainnya...
 
(GCKRequest *) - setDeviceVolume:
 Menyetel volume perangkat. Lainnya...
 
(GCKRequest *) - setDeviceMuted:
 Mengatur status bisukan perangkat. Lainnya...
 
(void) - start
 Memulai sesi. Lainnya...
 
(void) - endAndStopCasting:
 Mengakhiri sesi. Lainnya...
 
(void) - suspendWithReason:
 Menangguhkan sesi karena alasan yang ditentukan. Lainnya...
 
(void) - resume
 Melanjutkan sesi. Lainnya...
 
(void) - notifyDidStartWithSessionID:
 Dipanggil oleh subclass untuk memberi tahu framework bahwa sesi telah dimulai. Lainnya...
 
(void) - notifyDidFailToStartWithError:
 Dipanggil oleh subclass untuk memberi tahu framework bahwa sesi gagal dimulai. Lainnya...
 
(void) - notifyDidResume
 Dipanggil oleh subclass untuk memberi tahu framework bahwa sesi telah dilanjutkan. Lainnya...
 
(void) - notifyDidSuspendWithReason:
 Dipanggil oleh subclass untuk memberi tahu framework bahwa sesi telah ditangguhkan. Lainnya...
 
(void) - notifyDidEndWithError:
 Dipanggil oleh subclass untuk memberi tahu framework bahwa sesi telah berakhir. Lainnya...
 
(void) - notifyDidReceiveDeviceVolume:muted:
 Dipanggil oleh subclass untuk memberi tahu framework bahwa volume perangkat dan status bisu yang diperbarui telah diterima dari perangkat. Lainnya...
 
(void) - notifyDidReceiveDeviceStatus:
 Dipanggil oleh subclass untuk memberi tahu framework bahwa status yang diperbarui telah diterima dari perangkat. Lainnya...
 

Ringkasan Properti

GCKActiveInputStatus activeInputStatus
 Status "input aktif" perangkat saat ini. Lainnya...
 
GCKStandbyStatus standbyStatus
 Status "standby" perangkat saat ini. Lainnya...
 
GCKApplicationMetadataapplicationMetadata
 Metadata untuk aplikasi penerima yang sedang berjalan di perangkat penerima, jika ada; jika tidak, nil. Lainnya...
 
GCKDevicedevice
 Perangkat yang dikaitkan dengan sesi ini. Lainnya...
 
NSString * sessionID
 ID sesi saat ini, jika ada. Lainnya...
 
GCKConnectionState connectionState
 Status koneksi sesi saat ini. Lainnya...
 
BOOL suspended
 Tanda yang menunjukkan apakah sesi saat ini ditangguhkan. Lainnya...
 
NSString * deviceStatusText
 Teks status perangkat saat ini. Lainnya...
 
GCKSessionTraitstraits
 Ciri sesi. Lainnya...
 
float currentDeviceVolume
 Volume perangkat saat ini, dalam rentang [0,0, 1,0]. Lainnya...
 
BOOL currentDeviceMuted
 Status bisukan perangkat saat ini. Lainnya...
 
GCKRemoteMediaClientremoteMediaClient
 Objek GCKRemoteMediaClient yang dapat digunakan untuk mengontrol pemutaran media di sesi ini. Lainnya...
 
GCKMediaMetadatamediaMetadata
 Metadata media saat ini, jika ada. Lainnya...
 

Detail Metode

- (instancetype) initWithDevice: (GCKDevice *)  device
sessionID: (NSString *__nullable)  sessionID
castOptions: (GCKCastOptions *)  castOptions 

Penginisialisasi yang ditetapkan.

Membuat sesi Transmisi baru dengan opsi Transmisi yang ditentukan.

Parameters
deviceThe receiver device.
sessionIDThe session ID, if resuming; otherwise nil.
castOptionsThe Cast options.
- (BOOL) addChannel: (GCKCastChannel *)  channel

Mendaftarkan channel ke sesi.

Jika sesi terhubung dan aplikasi penerima mendukung namespace saluran, saluran akan terhubung secara otomatis. Jika sesi tidak terhubung, saluran akan tetap dalam status terputus hingga sesi dimulai.

Parameters
channelThe channel to register.
Hasil
YES jika channel berhasil didaftarkan, NO jika tidak.
- (BOOL) removeChannel: (GCKCastChannel *)  channel

Menghapus saluran yang sebelumnya terdaftar dari sesi.

Parameters
channelThe channel to unregister.
Hasil
YES jika channel berhasil dibatalkan pendaftarannya, NO jika sebaliknya.
- (void) addDeviceStatusListener: (id< GCKCastDeviceStatusListener >)  listener

Menambahkan GCKCastDeviceStatusListener ke daftar pemroses objek ini.

Parameters
listenerThe listener to add.
- (void) removeDeviceStatusListener: (id< GCKCastDeviceStatusListener >)  listener

Menghapus GCKCastDeviceStatusListener dari daftar pemroses objek ini.

Parameters
listenerThe listener to remove.
- (GCKRequest *) setDeviceVolume: (float)  volume
forMultizoneDevice: (GCKMultizoneDevice *)  device 

Menyetel volume setiap perangkat dalam grup multizona.

Ini adalah operasi asinkron.

Parameters
volumeThe new volume, in the range [0.0, 1.0].
deviceThe multizone device.
Hasil
Objek GCKRequest untuk melacak permintaan.
- (GCKRequest *) setDeviceMuted: (BOOL)  muted
forMultizoneDevice: (GCKMultizoneDevice *)  device 

Menyetel status dibisukan setiap perangkat di grup multizona.

Ini adalah operasi asinkron.

Parameters
mutedThe new muted state.
deviceThe multizone device.
Hasil
Objek GCKRequest untuk melacak permintaan.
- (GCKRequest *) requestMultizoneStatus

Meminta status multizona dari grup multizona.

Ini adalah operasi asinkron. Saat status multizona diterima, metode delegasi castSession:didReceiveMultizoneStatus: (GCKCastDeviceStatusListener-p) akan menerima pesan.

Hasil
Objek GCKRequest untuk melacak permintaan.
- (instancetype) initWithDevice: (GCKDevice *)  device
traits: (GCKSessionTraits *)  traits
sessionID: (NSString *__nullable)  sessionID 

Menginisialisasi objek sesi baru untuk perangkat tertentu.

Parameters
deviceThe device.
traitsThe session traits.
sessionIDThe session ID of an existing session, if this object will be used to resume a session; otherwise nil if it will be used to start a new session.
- (GCKRequest *) setDeviceVolume: (float)  volume

Menyetel volume perangkat.

Ini adalah operasi asinkron. Implementasi default-nya adalah tanpa pengoperasian yang menggagalkan permintaan dengan error GCKErrorCodeSupportedFeature.

Parameters
volumeThe new volume.
Hasil
Objek GCKRequest untuk melacak permintaan.
Sejak
3.4; dalam versi framework sebelumnya, metode ini menampilkan void.
- (GCKRequest *) setDeviceMuted: (BOOL)  muted

Mengatur status bisukan perangkat.

Ini adalah operasi asinkron. Implementasi default-nya adalah tanpa pengoperasian yang menggagalkan permintaan dengan error GCKErrorCodeSupportedFeature.

Parameters
mutedThe new mute state.
Hasil
Objek GCKRequest untuk melacak permintaan.
Sejak
3.4; dalam versi framework sebelumnya, metode ini menampilkan void.
- (void) start

Memulai sesi.

Ini adalah operasi asinkron. Harus diganti oleh subclass.

Disediakan menurut kategori GCKSession(Protected).

- (void) endAndStopCasting: (BOOL)  stopCasting

Mengakhiri sesi.

Ini adalah operasi asinkron. Harus diganti oleh subclass.

Parameters
stopCastingWhether to stop casting content to the receiver.

Disediakan menurut kategori GCKSession(Protected).

- (void) suspendWithReason: (GCKConnectionSuspendReason reason

Menangguhkan sesi karena alasan yang ditentukan.

Ini adalah operasi asinkron. Harus diganti oleh subclass.

Disediakan menurut kategori GCKSession(Protected).

- (void) resume

Melanjutkan sesi.

Ini adalah operasi asinkron. Harus diganti oleh subclass.

Disediakan menurut kategori GCKSession(Protected).

- (void) notifyDidStartWithSessionID: (NSString *)  sessionID

Dipanggil oleh subclass untuk memberi tahu framework bahwa sesi telah dimulai.

Parameters
sessionIDThe session's unique ID.

Disediakan menurut kategori GCKSession(Protected).

- (void) notifyDidFailToStartWithError: (NSError *)  error

Dipanggil oleh subclass untuk memberi tahu framework bahwa sesi gagal dimulai.

Parameters
errorThe error that occurred.

Disediakan menurut kategori GCKSession(Protected).

- (void) notifyDidResume

Dipanggil oleh subclass untuk memberi tahu framework bahwa sesi telah dilanjutkan.

Disediakan menurut kategori GCKSession(Protected).

- (void) notifyDidSuspendWithReason: (GCKConnectionSuspendReason reason

Dipanggil oleh subclass untuk memberi tahu framework bahwa sesi telah ditangguhkan.

Parameters
reasonThe reason for the suspension.

Disediakan menurut kategori GCKSession(Protected).

- (void) notifyDidEndWithError: (NSError *__nullable)  error

Dipanggil oleh subclass untuk memberi tahu framework bahwa sesi telah berakhir.

Parameters
errorThe error that caused the session to end, if any. Should be nil if the session was ended intentionally.

Disediakan menurut kategori GCKSession(Protected).

- (void) notifyDidReceiveDeviceVolume: (float)  volume
muted: (BOOL)  muted 

Dipanggil oleh subclass untuk memberi tahu framework bahwa volume perangkat dan status bisu yang diperbarui telah diterima dari perangkat.

Parameters
volumeThe device's current volume. Must be in the range [0, 1.0];
mutedThe device's current mute state.

Disediakan menurut kategori GCKSession(Protected).

- (void) notifyDidReceiveDeviceStatus: (NSString *__nullable)  statusText

Dipanggil oleh subclass untuk memberi tahu framework bahwa status yang diperbarui telah diterima dari perangkat.

Parameters
statusTextThe new status.

Disediakan menurut kategori GCKSession(Protected).

Detail Properti

- (GCKActiveInputStatus) activeInputStatus
readnonatomicassign

Status "input aktif" perangkat saat ini.

- (GCKStandbyStatus) standbyStatus
readnonatomicassign

Status "standby" perangkat saat ini.

- (GCKApplicationMetadata*) applicationMetadata
readnonatomiccopy

Metadata untuk aplikasi penerima yang sedang berjalan di perangkat penerima, jika ada; jika tidak, nil.

- (GCKDevice*) device
readnonatomicstronginherited

Perangkat yang dikaitkan dengan sesi ini.

- (NSString*) sessionID
readnonatomiccopyinherited

ID sesi saat ini, jika ada.

- (GCKConnectionState) connectionState
readnonatomicassigninherited

Status koneksi sesi saat ini.

- (BOOL) suspended
readnonatomicassigninherited

Tanda yang menunjukkan apakah sesi saat ini ditangguhkan.

- (NSString*) deviceStatusText
readnonatomiccopyinherited

Teks status perangkat saat ini.

- (GCKSessionTraits*) traits
readnonatomiccopyinherited

Ciri sesi.

- (float) currentDeviceVolume
readnonatomicassigninherited

Volume perangkat saat ini, dalam rentang [0,0, 1,0].

- (BOOL) currentDeviceMuted
readnonatomicassigninherited

Status bisukan perangkat saat ini.

- (GCKRemoteMediaClient*) remoteMediaClient
readnonatomicstronginherited

Objek GCKRemoteMediaClient yang dapat digunakan untuk mengontrol pemutaran media di sesi ini.

nil sebelum sesi dimulai, atau jika sesi tidak mendukung GCKRemoteMediaClient API. Subclass yang menyediakan antarmuka GCKRemoteMediaClient harus mengganti metode pengambil.

- (GCKMediaMetadata*) mediaMetadata
readnonatomicstronginherited

Metadata media saat ini, jika ada.

Akan menjadi nil jika sesi tidak mendukung namespace media atau jika tidak ada media yang dimuat di penerima.