Klasa GCKSession

Odniesienie do klasy GCKSession

Opis

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

W klasach podrzędnych muszą implementować metody start (GCKSession(Protected)) i endWithAction: (GCKSession(Protected)) oraz wywoływać odpowiednie metody powiadomień (na przykład notifyDidStartWithSessionID: (GCKSession(Protected))), aby wskazać odpowiednie zmiany stanu sesji. W podklasach mogą być też implementowane setDeviceVolume: (GCKSession), setDeviceMuted: (GCKSession) i remoteMediaClient, jeśli urządzenie obsługuje takie operacje.

Sesja jest tworzona i kontrolowana przy użyciu metod sesji w GCKSessionManager, które korzystają z odpowiedniego klucza GCKDeviceProvider do utworzenia sesji, a potem deleguje żądania sesji do tego obiektu GCKSession.

Od
3,0

Dziedziczy NSObject.

Odziedziczone przez: GCKCastSession.

Podsumowanie metody instancji

(instancetype) - initWithDevice:traits:sessionID:
 Inicjuje dla danego urządzenia nowy obiekt sesji z opcjami domyślnymi. Więcej...
 
(instancetype) - initWithDevice:traits:sessionID:sessionOptions:
 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) - endWithAction:
 Kończy sesję określonym działaniem. Więcej...
 
(void) - notifyDidStartWithSessionID:
 Wywoływane przez podklasy w celu powiadomienia platformy o rozpoczęciu sesji. Więcej...
 
(void) - notifyDidFailToStartWithError:
 Wywołane przez klasy podrzędne w celu powiadomienia platformy o niepowodzeniu rozpoczęcia sesji. Więcej...
 
(void) - notifyDidEndWithError:willTryToResume:
 Wywoływane przez klasy podrzędne w celu powiadomienia platformy o zakończeniu sesji. Więcej...
 
(void) - notifyDidReceiveDeviceVolume:muted:
 Wywołane przez podklasy w celu powiadomienia platformy o odebraniu z urządzenia zaktualizowanej głośności i stanu wyciszenia. Więcej...
 
(void) - notifyDidReceiveDeviceStatus:
 Wywołane przez podklasy w celu powiadomienia platformy o otrzymaniu zaktualizowanego stanu z urządzenia. Więcej...
 
(void) - notifyDidSuspendWithReason:
 Wycofano, nie używać – zaimplementowano jako bezobsługowe. Więcej...
 
(void) - notifyDidResume
 Wycofano, nie używać – zaimplementowano jako bezobsługowe. 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...
 
GCKSessionOptions * sessionOptions
 Opcje sesji (jeśli są dostępne). Więcej...
 
GCKConnectionState connectionState
 Bieżący stan połączenia w 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
 Bieżąca 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, którego można używać do sterowania odtwarzaniem multimediów w tej sesji. Więcej...
 
GCKMediaMetadatamediaMetadata
 Bieżące metadane multimediów (jeśli istnieją). Więcej...
 

Szczegóły metody

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

Inicjuje dla danego urządzenia nowy obiekt sesji z opcjami domyślnymi.

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.
- (instancetype) initWithDevice: (GCKDevice *)  device
traits: (nullable GCKSessionTraits *)  traits
sessionID: (nullable NSString *)  sessionID
sessionOptions: (nullable GCKSessionOptions *)  sessionOptions 

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.
sessionOptionsThe session options, if any; otherwise nil.
Od
4,0
- (GCKRequest *) setDeviceVolume: (float)  volume

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

Jest to operacja asynchroniczna. Implementacja domyślna to typ typu Noop, który odrzuca żądanie i zwraca błąd GCKErrorCodeSupportedFeature.

Parameters
volumeThe new volume.
Akcje powrotne
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. Implementacja domyślna to typ typu Noop, który odrzuca żądanie i zwraca błąd GCKErrorCodeSupportedFeature.

Parameters
mutedThe new mute state.
Akcje powrotne
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ąpione przez podklasy.

Udostępnione na podstawie kategorii GCKSession(Protected).

- (void) endWithAction: (GCKSessionEndAction action

Kończy sesję określonym działaniem.

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

Parameters
actionThe action to take when ending the session; see GCKSessionEndAction for more details.

Udostępnione na podstawie kategorii GCKSession(Protected).

- (void) notifyDidStartWithSessionID: (NSString *)  sessionID

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

Parameters
sessionIDThe session's unique ID.

Udostępnione na podstawie kategorii GCKSession(Protected).

- (void) notifyDidFailToStartWithError: (GCKError *)  error

Wywołane przez klasy podrzędne w celu powiadomienia platformy o niepowodzeniu rozpoczęcia sesji.

Parameters
errorThe error that occurred.

Udostępnione na podstawie kategorii GCKSession(Protected).

- (void) notifyDidEndWithError: (nullable NSError *)  error
willTryToResume: (BOOL)  willTryToResume 

Wywoływane przez klasy podrzędne 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.
willTryToResumeWhether the session will try to resume itself automatically.

Udostępnione na podstawie kategorii GCKSession(Protected).

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

Wywołane przez podklasy w celu powiadomienia platformy o odebraniu z urządzenia zaktualizowanej 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.

Udostępnione na podstawie kategorii GCKSession(Protected).

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

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

Parameters
statusTextThe new status.

Udostępnione na podstawie kategorii GCKSession(Protected).

- (void) notifyDidSuspendWithReason: (GCKConnectionSuspendReason reason

Wycofano, nie używać – zaimplementowano jako brak obsługi.

Deprecated:
Nie dzwoń.

Udostępnione na podstawie kategorii GCKSession(Protected).

- (void) notifyDidResume

Wycofano, nie używać – zaimplementowano jako brak obsługi.

Deprecated:
Nie dzwoń.

Udostępnione na podstawie kategorii GCKSession(Protected).

Szczegóły nieruchomości

- (GCKDevice*) device
readnonatomicstrong

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

- (NSString*) sessionID
readnonatomiccopy

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

- (GCKSessionOptions*) sessionOptions
readnonatomicstrong

Opcje sesji (jeśli są dostępne).

Od
4,0
- (GCKConnectionState) connectionState
readnonatomicassign

Bieżący stan połączenia w sesji.

- (BOOL) suspended
readnonatomicassign

Flaga wskazująca, czy sesja jest obecnie zawieszona.

Deprecated:
GCKSession nie może już być zawieszony. W razie potrzeby przenieś tę funkcję do podklasy.
- (NSString*) deviceStatusText
readnonatomiccopy

Tekst bieżącego stanu urządzenia.

- (GCKSessionTraits*) traits
readnonatomiccopy

Cechy sesji.

- (float) currentDeviceVolume
readnonatomicassign

Bieżąca 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, którego można używać do sterowania odtwarzaniem multimediów w tej sesji.

Jest nil przed rozpoczęciem sesji lub jeśli sesja nie obsługuje GCKRemoteMediaClient API. Podklasy udostępniające interfejs GCKRemoteMediaClient muszą zastąpić metodę getter.

- (GCKMediaMetadata*) mediaMetadata
readnonatomicstrong

Bieżące metadane multimediów (jeśli istnieją).

Jeśli sesja nie obsługuje przestrzeni nazw multimediów lub jeśli do odbiornika nie są obecnie załadowane żadne multimedia, stosowana jest wartość nil.