Klasa GCKSession

Dokumentacja klasy GCKSession

Przegląd

Abstrakcyjna klasa bazowa reprezentująca sesję z urządzeniem odbierającym.

Podklasy muszą implementować metody start (GCKSession(Protected)), endAndStopCasting: (GCKSession(Protected)), suspendWithReason: (GCKSession(Protected))resume (GCKSession(Protected)) oraz wywoływać odpowiednie metody powiadamiania (np. notifyDidStartWithSessionID: (GCKSession(Protected))), aby wskazywać odpowiednie zmiany stanu sesji. Podklasy mogą też implementować metody setDeviceVolume: (GCKSession), setDeviceMuted: (GCKSession)remoteMediaClient, jeśli urządzenie obsługuje takie operacje.

Sesja jest tworzona i kontrolowana za pomocą metod sesji w GCKSessionManager, która używa odpowiedniego GCKDeviceProvider do utworzenia sesji, a następnie przekazuje żądania sesji do obiektu GCKSession.

Od
3,0

Dziedziczy z klasy NSObject.

Odziedziczone przez: GCKCastSession.

Podsumowanie metod 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 urządzenia. Więcej…
 
(void) - start
 Rozpoczyna sesję. Więcej…
 
(void) - endAndStopCasting:
 Kończy sesję. Więcej…
 
(void) - suspendWithReason:
 Zawiesza sesję z podanego powodu. Więcej…
 
(void) - resume
 Wznawia sesję. Więcej…
 
(void) - notifyDidStartWithSessionID:
 Wywoływana przez podklasy w celu powiadomienia platformy, że sesja została rozpoczęta. Więcej…
 
(void) - notifyDidFailToStartWithError:
 Wywoływana przez podklasy w celu powiadomienia platformy, że nie udało się rozpocząć sesji. Więcej…
 
(void) - notifyDidResume
 Wywoływana przez podklasy w celu powiadomienia platformy, że sesja została wznowiona. Więcej…
 
(void) - notifyDidSuspendWithReason:
 Wywoływana przez podklasy w celu powiadomienia platformy, że sesja została zawieszona. Więcej…
 
(void) - notifyDidEndWithError:
 Wywoływana przez podklasy w celu powiadomienia platformy o zakończeniu sesji. Więcej…
 
(void) - notifyDidReceiveDeviceVolume:muted:
 Wywoływana przez podklasy w celu powiadomienia platformy o otrzymaniu z urządzenia zaktualizowanego poziomu głośności i stanu wyciszenia. Więcej…
 
(void) - notifyDidReceiveDeviceStatus:
 Wywoływana 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 występuje). Więcej…
 
GCKConnectionState connectionState
 Bieżący stan połączenia sesji. Więcej…
 
BOOL suspended
 Flaga wskazująca, czy sesja jest obecnie zawieszona. Więcej…
 
NSString * deviceStatusText
 Tekst bieżącego 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
 Bieżący stan wyciszenia urządzenia. Więcej…
 
GCKRemoteMediaClientremoteMediaClient
 Obiekt GCKRemoteMediaClient, za pomocą którego można sterować odtwarzaniem multimediów w tej sesji. Więcej…
 
GCKMediaMetadatamediaMetadata
 bieżące metadane multimediów (jeśli są dostępne); 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 pusta, która powoduje niepowodzenie żądania z błędem GCKErrorCodeUnsupportedFeature.

Parameters
volumeThe new volume.
Zwroty
Obiekt GCKRequest do śledzenia żądania.
Od
3.4; w poprzednich wersjach platformy ta metoda zwracała wartość void.
- (GCKRequest *) setDeviceMuted: (BOOL)  muted

Ustawia stan wyciszenia urządzenia.

Jest to operacja asynchroniczna. Domyślna implementacja to operacja pusta, która powoduje niepowodzenie żądania z błędem GCKErrorCodeUnsupportedFeature.

Parameters
mutedThe new mute state.
Zwroty
Obiekt GCKRequest do śledzenia żądania.
Od
3.4; w poprzednich wersjach platformy ta metoda zwracała wartość void.
- (void) start

Rozpoczyna sesję.

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

Dostarczane przez kategorię GCKSession(Protected).

- (void) endAndStopCasting: (BOOL)  stopCasting

Kończy sesję.

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

Parameters
stopCastingWhether to stop casting content to the receiver.

Dostarczane przez kategorię GCKSession(Protected).

- (void) suspendWithReason: (GCKConnectionSuspendReason reason

Zawiesza sesję z podanego powodu.

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

Dostarczane przez kategorię GCKSession(Protected).

- (void) resume

Wznawia sesję.

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

Dostarczane przez kategorię GCKSession(Protected).

- (void) notifyDidStartWithSessionID: (NSString *)  sessionID

Wywoływana przez podklasy w celu powiadomienia platformy, że sesja została rozpoczęta.

Parameters
sessionIDThe session's unique ID.

Dostarczane przez kategorię GCKSession(Protected).

- (void) notifyDidFailToStartWithError: (NSError *)  error

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

Parameters
errorThe error that occurred.

Dostarczane przez kategorię GCKSession(Protected).

- (void) notifyDidResume

Wywoływana przez podklasy w celu powiadomienia platformy, że sesja została wznowiona.

Dostarczane przez kategorię GCKSession(Protected).

- (void) notifyDidSuspendWithReason: (GCKConnectionSuspendReason reason

Wywoływana przez podklasy w celu powiadomienia platformy, że sesja została zawieszona.

Parameters
reasonThe reason for the suspension.

Dostarczane przez kategorię GCKSession(Protected).

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

Wywoływana 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.

Dostarczane przez kategorię GCKSession(Protected).

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

Wywoływana przez podklasy w celu powiadomienia platformy o otrzymaniu z urządzenia zaktualizowanego poziomu głośności i stanu wyciszenia.

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

Dostarczane przez kategorię GCKSession(Protected).

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

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

Parameters
statusTextThe new status.

Dostarczane 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 występuje).

- (GCKConnectionState) connectionState
readnonatomicassign

Bieżący stan połączenia sesji.

- (BOOL) suspended
readnonatomicassign

Flaga wskazująca, czy sesja jest obecnie zawieszona.

- (NSString*) deviceStatusText
readnonatomiccopy

Tekst bieżącego 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

Bieżący stan wyciszenia urządzenia.

- (GCKRemoteMediaClient*) remoteMediaClient
readnonatomicstrong

Obiekt GCKRemoteMediaClient, za pomocą którego można sterować odtwarzaniem multimediów w tej sesji.

Jest to nil przed rozpoczęciem sesji lub jeśli sesja nie obsługuje interfejsu GCKRemoteMediaClient API. Podklasy, które udostępniają interfejs GCKRemoteMediaClient, muszą zastąpić metodę pobierającą.

- (GCKMediaMetadata*) mediaMetadata
readnonatomicstrong

bieżące metadane multimediów (jeśli są dostępne);

Wartość nil, jeśli sesja nie obsługuje przestrzeni nazw multimediów lub jeśli na odbiorniku nie są obecnie załadowane żadne multimedia.