GCKSession-Klasse

GCKSession-Klassenreferenz

Übersicht

Eine abstrakte Basisklasse, die eine Sitzung mit einem Empfängergerät darstellt.

Unterklassen müssen die Methoden start (GCKSession(Protected)), endAndStopCasting: (GCKSession(Protected)), suspendWithReason: (GCKSession(Protected)) und resume (GCKSession(Protected)) implementieren und die entsprechenden Benachrichtigungsmethoden (z. B. notifyDidStartWithSessionID: (GCKSession(Protected))) aufrufen, um entsprechende Änderungen am Sitzungsstatus anzugeben. Unterklassen können auch setDeviceVolume: (GCKSession), setDeviceMuted: (GCKSession) und remoteMediaClient implementieren, wenn das Gerät solche Vorgänge unterstützt.

Eine Sitzung wird mit den Sitzungsmethoden in GCKSessionManager erstellt und gesteuert. Dazu wird das entsprechende GCKDeviceProvider verwendet, um die Sitzung zu erstellen, und dann werden Sitzungsanfragen an dieses GCKSession-Objekt weitergeleitet.

Seit
3.0

Erbt von NSObject.

Von GCKCastSession übernommen.

Zusammenfassung der Instanzmethoden

(instancetype) - initWithDevice:traits:sessionID:
 Initialisiert ein neues Sitzungsobjekt für das angegebene Gerät. Weitere Informationen
 
(GCKRequest *) - setDeviceVolume:
 Legt die Lautstärke des Geräts fest. Weitere Informationen
 
(GCKRequest *) - setDeviceMuted:
 Legt den Stummschaltungsstatus des Geräts fest. Weitere Informationen
 
(void) - start
 Startet die Sitzung. Weitere Informationen
 
(void) - endAndStopCasting:
 Beendet die Sitzung. Weitere Informationen
 
(void) - suspendWithReason:
 Die Sitzung wird aus dem angegebenen Grund unterbrochen. Weitere Informationen
 
(void) - resume
 Setzt die Sitzung fort. Weitere Informationen
 
(void) - notifyDidStartWithSessionID:
 Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass die Sitzung gestartet wurde. Weitere Informationen
 
(void) - notifyDidFailToStartWithError:
 Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass die Sitzung nicht gestartet werden konnte. Weitere Informationen
 
(void) - notifyDidResume
 Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass die Sitzung fortgesetzt wurde. Weitere Informationen
 
(void) - notifyDidSuspendWithReason:
 Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass die Sitzung unterbrochen wurde. Weitere Informationen
 
(void) - notifyDidEndWithError:
 Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass die Sitzung beendet wurde. Weitere Informationen
 
(void) - notifyDidReceiveDeviceVolume:muted:
 Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass aktualisierte Lautstärke- und Stummschaltungsstatus vom Gerät empfangen wurden. Weitere Informationen
 
(void) - notifyDidReceiveDeviceStatus:
 Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass vom Gerät ein aktualisierter Status empfangen wurde. Weitere Informationen
 

Zusammenfassung der Property

GCKDevicedevice
 Das Gerät, dem diese Sitzung zugeordnet ist. Weitere Informationen
 
NSString * sessionID
 Die aktuelle Sitzungs-ID, falls vorhanden. Weitere Informationen
 
GCKConnectionState connectionState
 Der aktuelle Verbindungsstatus der Sitzung. Weitere Informationen
 
BOOL suspended
 Ein Flag, das angibt, ob die Sitzung derzeit unterbrochen ist. Weitere Informationen
 
NSString * deviceStatusText
 Der aktuelle Gerätestatustext. Weitere Informationen
 
GCKSessionTraitstraits
 Die Sitzungsmerkmale. Weitere Informationen
 
float currentDeviceVolume
 Die aktuelle Lautstärke des Geräts im Bereich [0,0, 1,0]. Weitere Informationen
 
BOOL currentDeviceMuted
 Der aktuelle Stummschaltungsstatus des Geräts. Weitere Informationen
 
GCKRemoteMediaClientremoteMediaClient
 Das GCKRemoteMediaClient-Objekt, mit dem die Medienwiedergabe in dieser Sitzung gesteuert werden kann. Weitere Informationen
 
GCKMediaMetadatamediaMetadata
 Die aktuellen Medienmetadaten, falls vorhanden. Weitere Informationen
 

Methodendetail

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

Initialisiert ein neues Sitzungsobjekt für das angegebene Gerät.

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

Legt die Lautstärke des Geräts fest.

Dies ist ein asynchroner Vorgang. Die Standardimplementierung ist ein No-Op, bei dem die Anfrage mit dem Fehler GCKErrorCodeUnsupportedFeature fehlschlägt.

Parameters
volumeThe new volume.
Ausgabe
Ein GCKRequest-Objekt zum Nachverfolgen der Anfrage.
Seit
3.4; in früheren Framework-Versionen wurde von dieser Methode void zurückgegeben.
- (GCKRequest *) setDeviceMuted: (BOOL)  muted

Legt den Stummschaltungsstatus des Geräts fest.

Dies ist ein asynchroner Vorgang. Die Standardimplementierung ist ein No-Op, bei dem die Anfrage mit dem Fehler GCKErrorCodeUnsupportedFeature fehlschlägt.

Parameters
mutedThe new mute state.
Ausgabe
Ein GCKRequest-Objekt zum Nachverfolgen der Anfrage.
Seit
3.4; in früheren Framework-Versionen wurde von dieser Methode void zurückgegeben.
- (void) start

Startet die Sitzung.

Dies ist ein asynchroner Vorgang. Muss von abgeleiteten Klassen überschrieben werden.

Bereitgestellt von Kategorie GCKSession(Protected).

- (void) endAndStopCasting: (BOOL)  stopCasting

Beendet die Sitzung.

Dies ist ein asynchroner Vorgang. Muss von abgeleiteten Klassen überschrieben werden.

Parameters
stopCastingWhether to stop casting content to the receiver.

Bereitgestellt von Kategorie GCKSession(Protected).

- (void) suspendWithReason: (GCKConnectionSuspendReason reason

Die Sitzung wird aus dem angegebenen Grund unterbrochen.

Dies ist ein asynchroner Vorgang. Muss von abgeleiteten Klassen überschrieben werden.

Bereitgestellt von Kategorie GCKSession(Protected).

- (void) resume

Setzt die Sitzung fort.

Dies ist ein asynchroner Vorgang. Muss von abgeleiteten Klassen überschrieben werden.

Bereitgestellt von Kategorie GCKSession(Protected).

- (void) notifyDidStartWithSessionID: (NSString *)  sessionID

Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass die Sitzung gestartet wurde.

Parameters
sessionIDThe session's unique ID.

Bereitgestellt von Kategorie GCKSession(Protected).

- (void) notifyDidFailToStartWithError: (NSError *)  error

Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass die Sitzung nicht gestartet werden konnte.

Parameters
errorThe error that occurred.

Bereitgestellt von Kategorie GCKSession(Protected).

- (void) notifyDidResume

Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass die Sitzung fortgesetzt wurde.

Bereitgestellt von Kategorie GCKSession(Protected).

- (void) notifyDidSuspendWithReason: (GCKConnectionSuspendReason reason

Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass die Sitzung unterbrochen wurde.

Parameters
reasonThe reason for the suspension.

Bereitgestellt von Kategorie GCKSession(Protected).

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

Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass die Sitzung beendet wurde.

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

Bereitgestellt von Kategorie GCKSession(Protected).

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

Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass aktualisierte Lautstärke- und Stummschaltungsstatus vom Gerät empfangen wurden.

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

Bereitgestellt von Kategorie GCKSession(Protected).

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

Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass vom Gerät ein aktualisierter Status empfangen wurde.

Parameters
statusTextThe new status.

Bereitgestellt von Kategorie GCKSession(Protected).

Property-Details

- (GCKDevice*) device
readnonatomicstrong

Das Gerät, dem diese Sitzung zugeordnet ist.

- (NSString*) sessionID
readnonatomiccopy

Die aktuelle Sitzungs-ID, falls vorhanden.

- (GCKConnectionState) connectionState
readnonatomicassign

Der aktuelle Verbindungsstatus der Sitzung.

- (BOOL) suspended
readnonatomicassign

Ein Flag, das angibt, ob die Sitzung derzeit unterbrochen ist.

- (NSString*) deviceStatusText
readnonatomiccopy

Der aktuelle Gerätestatustext.

- (GCKSessionTraits*) traits
readnonatomiccopy

Die Sitzungsmerkmale.

- (float) currentDeviceVolume
readnonatomicassign

Die aktuelle Lautstärke des Geräts im Bereich [0,0, 1,0].

- (BOOL) currentDeviceMuted
readnonatomicassign

Der aktuelle Stummschaltungsstatus des Geräts.

- (GCKRemoteMediaClient*) remoteMediaClient
readnonatomicstrong

Das GCKRemoteMediaClient-Objekt, mit dem die Medienwiedergabe in dieser Sitzung gesteuert werden kann.

Es ist nil, bevor die Sitzung begonnen hat oder wenn die Sitzung die GCKRemoteMediaClient API nicht unterstützt. Unterklassen, die eine GCKRemoteMediaClient-Schnittstelle bereitstellen, müssen die Getter-Methode überschreiben.

- (GCKMediaMetadata*) mediaMetadata
readnonatomicstrong

Die aktuellen Medienmetadaten, falls vorhanden.

Ist nil, wenn der Media-Namespace von der Sitzung nicht unterstützt wird oder wenn derzeit keine Medien auf dem Receiver geladen sind.