GCKSession-Klasse

GCKSession-Klassenreferenz

Überblick

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

Abgeleitete Klassen müssen die Methoden start (GCKSession(Protected)) und endWithAction: (GCKSession(Protected)) implementieren und die entsprechenden Notifier-Methoden (z. B. notifyDidStartWithSessionID: (GCKSession(Protected))) aufrufen, um entsprechende Änderungen im Sitzungsstatus anzuzeigen. Abgeleitete Klassen können auch setDeviceVolume: (GCKSession), setDeviceMuted: (GCKSession) und remoteMediaClient implementieren, wenn das Gerät solche Vorgänge unterstützt.

Eine Sitzung wird mithilfe der Sitzungsmethoden in GCKSessionManager erstellt und gesteuert, die die entsprechende GCKDeviceProvider zum Erstellen der Sitzung verwendet und dann Sitzungsanfragen an dieses GCKSession-Objekt delegiert.

Seit
3,0

Übernimmt NSObject.

Übernommen von GCKCastSession.

Übersicht über Instanzmethoden

(instancetype) - initWithDevice:traits:sessionID:
 Initialisiert ein neues Sitzungsobjekt für das angegebene Gerät mit Standardoptionen. Mehr...
 
(instancetype) - initWithDevice:traits:sessionID:sessionOptions:
 Initialisiert ein neues Sitzungsobjekt für das angegebene Gerät. Mehr...
 
(GCKRequest *) - setDeviceVolume:
 Legt die Lautstärke des Geräts fest. Mehr...
 
(GCKRequest *) - setDeviceMuted:
 Legt die Stummschaltung des Geräts fest. Mehr...
 
(void) - start
 Startet die Sitzung. Mehr...
 
(void) - endWithAction:
 Beendet die Sitzung mit der angegebenen Aktion. Mehr...
 
(void) - notifyDidStartWithSessionID:
 Wird von Unterklassen aufgerufen, um das Framework zu benachrichtigen, dass die Sitzung gestartet wurde. Mehr...
 
(void) - notifyDidFailToStartWithError:
 Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass die Sitzung nicht gestartet wurde. Mehr...
 
(void) - notifyDidEndWithError:willTryToResume:
 Wird von Unterklassen aufgerufen, um das Framework über das Ende der Sitzung zu informieren. Mehr...
 
(void) - notifyDidReceiveDeviceVolume:muted:
 Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass die Gerätelautstärke und der Stummschaltungsstatus vom Gerät aktualisiert wurden. Mehr...
 
(void) - notifyDidReceiveDeviceStatus:
 Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass der aktualisierte Status vom Gerät empfangen wurde. Mehr...
 
(void) - notifyDidSuspendWithReason:
 Eingestellt, nicht verwenden – als No-Op implementiert. Mehr...
 
(void) - notifyDidResume
 Eingestellt, nicht verwenden – als No-Op implementiert. Mehr...
 

Property-Zusammenfassung

GCKDevicedevice
 Das Gerät, mit dem diese Sitzung verknüpft ist. Mehr...
 
NSString * sessionID
 Die aktuelle Sitzungs-ID, falls vorhanden. Mehr...
 
GCKSessionOptions * sessionOptions
 Die Sitzungsoptionen, falls vorhanden. Mehr...
 
GCKConnectionState connectionState
 Der aktuelle Verbindungsstatus der Sitzung. Mehr...
 
BOOL suspended
 Eine Markierung, die angibt, ob die Sitzung derzeit ausgesetzt ist. Mehr...
 
NSString * deviceStatusText
 Text für den aktuellen Gerätestatus Mehr...
 
GCKSessionTraitstraits
 Die Sitzungseigenschaften. Mehr...
 
float currentDeviceVolume
 Die aktuelle Gerätelautstärke im Bereich [0, 0 bis 1, 0]. Mehr...
 
BOOL currentDeviceMuted
 Der aktuelle Stummschaltungsstatus des Geräts. Mehr...
 
GCKRemoteMediaClientremoteMediaClient
 Das GCKRemoteMediaClient-Objekt, mit dem die Medienwiedergabe in dieser Sitzung gesteuert werden kann. Mehr...
 
GCKMediaMetadatamediaMetadata
 Die aktuellen Medienmetadaten, falls vorhanden. Mehr...
 

Methodendetail

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

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

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 

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.
sessionOptionsThe session options, if any; otherwise nil.
Seit
4,0
- (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 GCKErrorCodeSupportedFeature scheitert.

Parameters
volumeThe new volume.
Rückgaben
Ein GCKRequest-Objekt zum Verfolgen der Anfrage.
Seit
3.4. In früheren Framework-Versionen gab diese Methode void zurück.
- (GCKRequest *) setDeviceMuted: (BOOL)  muted

Legt die Stummschaltung des Geräts fest.

Dies ist ein asynchroner Vorgang. Die Standardimplementierung ist ein No-Op, bei dem die Anfrage mit dem Fehler GCKErrorCodeSupportedFeature scheitert.

Parameters
mutedThe new mute state.
Rückgaben
Ein GCKRequest-Objekt zum Verfolgen der Anfrage.
Seit
3.4. In früheren Framework-Versionen gab diese Methode void zurück.
- (void) start

Startet die Sitzung.

Dies ist ein asynchroner Vorgang. Muss von Unterklassen überschrieben werden.

Bereitgestellt von der Kategorie „GCKSession(Protected)“.

- (void) endWithAction: (GCKSessionEndAction action

Beendet die Sitzung mit der angegebenen Aktion.

Dies ist ein asynchroner Vorgang. Muss von Unterklassen überschrieben werden.

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

Bereitgestellt von der Kategorie „GCKSession(Protected)“.

- (void) notifyDidStartWithSessionID: (NSString *)  sessionID

Wird von Unterklassen aufgerufen, um das Framework zu benachrichtigen, dass die Sitzung gestartet wurde.

Parameters
sessionIDThe session's unique ID.

Bereitgestellt von der Kategorie „GCKSession(Protected)“.

- (void) notifyDidFailToStartWithError: (GCKError *)  error

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

Parameters
errorThe error that occurred.

Bereitgestellt von der Kategorie „GCKSession(Protected)“.

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

Wird von Unterklassen aufgerufen, um das Framework über das Ende der Sitzung zu informieren.

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.

Bereitgestellt von der Kategorie „GCKSession(Protected)“.

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

Wird von Unterklassen aufgerufen, um das Framework darüber zu informieren, dass die Gerätelautstärke und der Stummschaltungsstatus vom Gerät aktualisiert wurden.

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

Bereitgestellt von der Kategorie „GCKSession(Protected)“.

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

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

Parameters
statusTextThe new status.

Bereitgestellt von der Kategorie „GCKSession(Protected)“.

- (void) notifyDidSuspendWithReason: (GCKConnectionSuspendReason reason

Veraltet, nicht verwenden – als No-Op implementiert.

Deprecated:
Nicht anrufen.

Bereitgestellt von der Kategorie „GCKSession(Protected)“.

- (void) notifyDidResume

Veraltet, nicht verwenden – als No-Op implementiert.

Deprecated:
Nicht anrufen.

Bereitgestellt von der Kategorie „GCKSession(Protected)“.

Objektdetails

- (GCKDevice*) device
readnonatomicstrong

Das Gerät, mit dem diese Sitzung verknüpft ist.

- (NSString*) sessionID
readnonatomiccopy

Die aktuelle Sitzungs-ID, falls vorhanden.

- (GCKSessionOptions*) sessionOptions
readnonatomicstrong

Die Sitzungsoptionen, falls vorhanden.

Seit
4,0
- (GCKConnectionState) connectionState
readnonatomicassign

Der aktuelle Verbindungsstatus der Sitzung.

- (BOOL) suspended
readnonatomicassign

Eine Markierung, die angibt, ob die Sitzung derzeit ausgesetzt ist.

Deprecated:
GCKSession unterstützt den Status "Gesperrt" nicht mehr. Verschieben Sie diese Funktionalität bei Bedarf in eine Unterklasse.
- (NSString*) deviceStatusText
readnonatomiccopy

Text für den aktuellen Gerätestatus

- (GCKSessionTraits*) traits
readnonatomiccopy

Die Sitzungseigenschaften.

- (float) currentDeviceVolume
readnonatomicassign

Die aktuelle Gerätelautstärke im Bereich [0, 0 bis 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 gestartet wurde oder wenn die Sitzung die GCKRemoteMediaClient API nicht unterstützt. Abgeleitete Klassen, die eine GCKRemoteMediaClient-Schnittstelle bereitstellen, müssen die Getter-Methode überschreiben.

- (GCKMediaMetadata*) mediaMetadata
readnonatomicstrong

Die aktuellen Medienmetadaten, falls vorhanden.

Ist nil, wenn die Sitzung den Medien-Namespace nicht unterstützt oder wenn derzeit keine Medien auf dem Empfänger geladen sind.