Klasa GCKSession

Dokumentacja klasy GCKSession

Omówienie

Abstrakcyjna klasa podstawowa reprezentująca sesję z odbiornikiem.

Podklasy muszą zaimplementować metody start (GCKSession(Protected)), endAndStopCasting: (GCKSession(Protected)), suspendWithReason: (GCKSession(Protected)) i resume (GCKSession(Protected)) oraz wywołać odpowiednie metody powiadomień (np. notifyDidStartWithSessionID: (GCKSession(Protected))), aby wskazać odpowiednie zmiany w stanie sesji. Podklasy mogą też implementować klasy setDeviceVolume: (GCKSession), setDeviceMuted: (GCKSession) i remoteMediaClient, jeśli urządzenie obsługuje takie operacje.

Sesja jest tworzona i kontrolowana przy użyciu metod GCKSessionManager w sesji, w których użyto sesji GCKDeviceProvider, aby utworzyć sesję, a następnie przekazuje żądanie do tego obiektu GCKSession.

Sincé
3,0

Dziedziczy NSObject.

Odziedziczone przez grupę GCKCastSession.

Podsumowanie metody instancji

(instancetype) - initWithDevice:traits:sessionID:
 Inicjuje nowy obiekt sesji dla danego urządzenia. Więcej...
 
(GCKRequest *) - setDeviceVolume:
 Ustawia głośność urządzenia. Więcej...
 
(GCKRequest *) - setDeviceMuted:
 Ustawia stan wyciszenia na urządzeniu. Więcej...
 
(void) - start
 Rozpoczyna sesję. Więcej...
 
(void) - endAndStopCasting:
 Kończy sesję. Więcej...
 
(void) - suspendWithReason:
 Zawieszenie sesji z określonego powodu. Więcej...
 
(void) - resume
 Wznawia sesję. Więcej...
 
(void) - notifyDidStartWithSessionID:
 Wywoływane przez podklasy w celu powiadomienia platformy o rozpoczęciu sesji. Więcej...
 
(void) - notifyDidFailToStartWithError:
 Wywoływane przez podklasy w celu powiadomienia platformy, że nie udało się rozpocząć sesji. Więcej...
 
(void) - notifyDidResume
 Wywoływane przez podklasy w celu powiadomienia platformy o wznowieniu sesji. Więcej...
 
(void) - notifyDidSuspendWithReason:
 Wywoływane przez podklasy w celu powiadomienia platformy o zawieszeniu sesji. Więcej...
 
(void) - notifyDidEndWithError:
 Wywoływane przez podklasy w celu powiadomienia platformy o zakończeniu sesji. Więcej...
 
(void) - notifyDidReceiveDeviceVolume:muted:
 Wywoływane przez podklasy w celu powiadomienia platformy o otrzymaniu zaktualizowanej głośności i stanu wyciszenia urządzenia. Więcej...
 
(void) - notifyDidReceiveDeviceStatus:
 Wywoływane przez podklasy w celu powiadomienia platformy o otrzymaniu zaktualizowanego stanu z urządzenia. Więcej...
 

Podsumowanie usługi

GCKDevicedevice
 Urządzenie, z którym jest powiązana ta sesja. Więcej...
 
NSString * sessionID
 Identyfikator bieżącej sesji (jeśli istnieje). Więcej...
 
GCKConnectionState connectionState
 Obecny stan połączenia sesji. Więcej...
 
BOOL suspended
 Flaga wskazująca, czy sesja jest obecnie zawieszona. Więcej...
 
NSString * deviceStatusText
 Bieżący tekst stanu urządzenia. Więcej...
 
GCKSessionTraitstraits
 Cechy sesji. Więcej...
 
float currentDeviceVolume
 Obecna głośność urządzenia w zakresie [0,0, 1,0]. Więcej...
 
BOOL currentDeviceMuted
 Obecny stan wyciszenia urządzenia. Więcej...
 
GCKRemoteMediaClientremoteMediaClient
 Obiekt GCKRemoteMediaClient, którego można używać do sterowania odtwarzaniem multimediów w tej sesji. Więcej...
 
GCKMediaMetadatamediaMetadata
 Bieżące metadane multimediów. Więcej...
 

Szczegóły metody

- (instancetype) initWithDevice: (GCKDevice *)  device
traits: (GCKSessionTraits *)  traits
sessionID: (NSString *__nullable)  sessionID 

Inicjuje nowy obiekt sesji dla danego urządzenia.

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

Ustawia głośność urządzenia.

Jest to operacja asynchroniczna. Domyślna implementacja to operacja, która nie kończy żądania i zawiera błąd GCKErrorCodeNieobsługiwane.

Parameters
volumeThe new volume.
Zwraca
Obiekt GCKRequest służący do śledzenia żądania.
Sincé
3.4; w poprzednich wersjach platformy ta metoda zwracała void.
- (GCKRequest *) setDeviceMuted: (BOOL)  muted

Ustawia stan wyciszenia na urządzeniu.

Jest to operacja asynchroniczna. Domyślna implementacja to operacja, która nie kończy żądania i zawiera błąd GCKErrorCodeNieobsługiwane.

Parameters
mutedThe new mute state.
Zwraca
Obiekt GCKRequest służący do śledzenia żądania.
Sincé
3.4; w poprzednich wersjach platformy ta metoda zwracała void.
- (void) start

Rozpoczyna sesję.

Jest to operacja asynchroniczna. Musi być zastąpiona przez podklasy.

Dostarczona przez kategorię GCKSession(Protected).

- (void) endAndStopCasting: (BOOL)  stopCasting

Kończy sesję.

Jest to operacja asynchroniczna. Musi być zastąpiona przez podklasy.

Parameters
stopCastingWhether to stop casting content to the receiver.

Dostarczona przez kategorię GCKSession(Protected).

- (void) suspendWithReason: (GCKConnectionSuspendReason reason

Zawieszenie sesji z określonego powodu.

Jest to operacja asynchroniczna. Musi być zastąpiona przez podklasy.

Dostarczona przez kategorię GCKSession(Protected).

- (void) resume

Wznawia sesję.

Jest to operacja asynchroniczna. Musi być zastąpiona przez podklasy.

Dostarczona przez kategorię GCKSession(Protected).

- (void) notifyDidStartWithSessionID: (NSString *)  sessionID

Wywoływane przez podklasy w celu powiadomienia platformy o rozpoczęciu sesji.

Parameters
sessionIDThe session's unique ID.

Dostarczona przez kategorię GCKSession(Protected).

- (void) notifyDidFailToStartWithError: (NSError *)  error

Wywoływane przez podklasy w celu powiadomienia platformy, że nie udało się rozpocząć sesji.

Parameters
errorThe error that occurred.

Dostarczona przez kategorię GCKSession(Protected).

- (void) notifyDidResume

Wywoływane przez podklasy w celu powiadomienia platformy o wznowieniu sesji.

Dostarczona przez kategorię GCKSession(Protected).

- (void) notifyDidSuspendWithReason: (GCKConnectionSuspendReason reason

Wywoływane przez podklasy w celu powiadomienia platformy o zawieszeniu sesji.

Parameters
reasonThe reason for the suspension.

Dostarczona przez kategorię GCKSession(Protected).

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

Wywoływane przez podklasy w celu powiadomienia platformy o zakończeniu sesji.

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

Dostarczona przez kategorię GCKSession(Protected).

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

Wywoływane przez podklasy w celu powiadomienia platformy o otrzymaniu zaktualizowanej głośności i stanu wyciszenia urządzenia.

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

Dostarczona przez kategorię GCKSession(Protected).

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

Wywoływane przez podklasy w celu powiadomienia platformy o otrzymaniu zaktualizowanego stanu z urządzenia.

Parameters
statusTextThe new status.

Dostarczona przez kategorię GCKSession(Protected).

Szczegóły usługi

- (GCKDevice*) device
readnonatomicstrong

Urządzenie, z którym jest powiązana ta sesja.

- (NSString*) sessionID
readnonatomiccopy

Identyfikator bieżącej sesji (jeśli istnieje).

- (GCKConnectionState) connectionState
readnonatomicassign

Obecny stan połączenia sesji.

- (BOOL) suspended
readnonatomicassign

Flaga wskazująca, czy sesja jest obecnie zawieszona.

- (NSString*) deviceStatusText
readnonatomiccopy

Bieżący tekst stanu urządzenia.

- (GCKSessionTraits*) traits
readnonatomiccopy

Cechy sesji.

- (float) currentDeviceVolume
readnonatomicassign

Obecna głośność urządzenia w zakresie [0,0, 1,0].

- (BOOL) currentDeviceMuted
readnonatomicassign

Obecny stan wyciszenia urządzenia.

- (GCKRemoteMediaClient*) remoteMediaClient
readnonatomicstrong

Obiekt GCKRemoteMediaClient, którego można używać do sterowania odtwarzaniem multimediów w tej sesji.

Jest nil, zanim sesja się rozpoczęła, lub jeśli sesja nie obsługuje interfejsu GCKRemoteMediaClient API. Podklasy, które udostępniają interfejs GCKRemoteMediaClient, muszą zastępować metodę getter.

- (GCKMediaMetadata*) mediaMetadata
readnonatomicstrong

Bieżące metadane multimediów.

Wartość będzie wynosić nil, jeśli sesja nie obsługuje przestrzeni nazw multimediów lub jeśli żaden nośnik nie jest obecnie wczytywany na odbiorniku.