Classe GCKSession

Documentation de référence sur la classe GCKSession

Présentation

Classe de base abstraite représentant une session avec un appareil récepteur.

Les sous-classes doivent implémenter les méthodes start (GCKSession(Protected)), endAndStopCasting: (GCKSession(Protected)), suspendWithReason: (GCKSession(Protected)) et resume (GCKSession(Protected)), et appeler les méthodes de notification appropriées (par exemple, notifyDidStartWithSessionID: (GCKSession(Protected))) pour indiquer les changements correspondants dans l'état de la session. Les sous-classes peuvent également implémenter setDeviceVolume: (GCKSession), setDeviceMuted: (GCKSession) et remoteMediaClient si l'appareil accepte ces opérations.

Une session est créée et contrôlée à l'aide des méthodes de session dans GCKSessionManager, qui utilise le GCKDeviceProvider approprié pour créer la session, puis délègue les requêtes de session à cet objet GCKSession.

Sincé
3,0

Hérite de NSObject.

Hérité par GCKCastSession.

Résumé de la méthode d'instance

(instancetype) - initWithDevice:traits:sessionID:
 Initialise un nouvel objet de session pour l'appareil donné. Plus...
 
(GCKRequest *) - setDeviceVolume:
 Permet de régler le volume de l'appareil. Plus...
 
(GCKRequest *) - setDeviceMuted:
 Définit le micro de l'appareil. Plus...
 
(void) - start
 Démarre la session. Plus...
 
(void) - endAndStopCasting:
 Ferme la session. Plus...
 
(void) - suspendWithReason:
 Suspend la session pour la raison donnée. Plus...
 
(void) - resume
 Reprend la session. Plus...
 
(void) - notifyDidStartWithSessionID:
 Appelé par des sous-classes pour avertir le framework que la session a démarré. Plus...
 
(void) - notifyDidFailToStartWithError:
 Appelée par des sous-classes pour avertir le framework que la session n'a pas pu démarrer. Plus...
 
(void) - notifyDidResume
 Appelée par des sous-classes pour avertir le framework que la session a repris. Plus...
 
(void) - notifyDidSuspendWithReason:
 Appelée par des sous-classes pour informer le framework que la session a été suspendue. Plus...
 
(void) - notifyDidEndWithError:
 Appelée par des sous-classes pour avertir le framework que la session est terminée. Plus...
 
(void) - notifyDidReceiveDeviceVolume:muted:
 Appelé par des sous-classes pour informer le framework que le volume de l'appareil mis à jour et l'état de désactivation du son ont été reçus par l'appareil. Plus...
 
(void) - notifyDidReceiveDeviceStatus:
 Appelée par des sous-classes pour informer le framework que l'appareil a reçu un état mis à jour. Plus...
 

Récapitulatif de la propriété

GCKDevicedevice
 Appareil auquel cette session est associée. Plus...
 
NSString * sessionID
 ID de la session actuelle, le cas échéant. Plus...
 
GCKConnectionState connectionState
 État actuel de la connexion à la session. Plus...
 
BOOL suspended
 Indicateur indiquant si la session est actuellement suspendue. Plus...
 
NSString * deviceStatusText
 Texte de l'état actuel de l'appareil. Plus...
 
GCKSessionTraitstraits
 Les caractéristiques de la session. Plus...
 
float currentDeviceVolume
 Volume actuel de l'appareil, compris entre 0 et 1. Plus...
 
BOOL currentDeviceMuted
 État actuel du son de l'appareil. Plus...
 
GCKRemoteMediaClientremoteMediaClient
 Objet GCKRemoteMediaClient permettant de contrôler la lecture des contenus multimédias dans cette session. Plus...
 
GCKMediaMetadatamediaMetadata
 Métadonnées multimédias actuelles, le cas échéant. Plus...
 

Détails sur la méthode

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

Initialise un nouvel objet de session pour l'appareil donné.

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

Permet de régler le volume de l'appareil.

Il s'agit d'une opération asynchrone. L'implémentation par défaut est une opération no-op qui fait échouer la requête avec une erreur GCKErrorCodeUnsupportedFeature.

Parameters
volumeThe new volume.
Retours
Objet GCKRequest permettant de suivre la requête.
Sincé
3.4. Dans les versions précédentes du framework, cette méthode renvoyait void.
- (GCKRequest *) setDeviceMuted: (BOOL)  muted

Définit le micro de l'appareil.

Il s'agit d'une opération asynchrone. L'implémentation par défaut est une opération no-op qui fait échouer la requête avec une erreur GCKErrorCodeUnsupportedFeature.

Parameters
mutedThe new mute state.
Retours
Objet GCKRequest permettant de suivre la requête.
Sincé
3.4. Dans les versions précédentes du framework, cette méthode renvoyait void.
- (void) start

Démarre la session.

Il s'agit d'une opération asynchrone. Elle doit être remplacée par les sous-classes.

Fourni par la catégorie GCKSession(Protected)

- (void) endAndStopCasting: (BOOL)  stopCasting

Ferme la session.

Il s'agit d'une opération asynchrone. Elle doit être remplacée par les sous-classes.

Parameters
stopCastingWhether to stop casting content to the receiver.

Fourni par la catégorie GCKSession(Protected)

- (void) suspendWithReason: (GCKConnectionSuspendReason reason

Suspend la session pour la raison donnée.

Il s'agit d'une opération asynchrone. Elle doit être remplacée par les sous-classes.

Fourni par la catégorie GCKSession(Protected)

- (void) resume

Reprend la session.

Il s'agit d'une opération asynchrone. Elle doit être remplacée par les sous-classes.

Fourni par la catégorie GCKSession(Protected)

- (void) notifyDidStartWithSessionID: (NSString *)  sessionID

Appelé par des sous-classes pour avertir le framework que la session a démarré.

Parameters
sessionIDThe session's unique ID.

Fourni par la catégorie GCKSession(Protected)

- (void) notifyDidFailToStartWithError: (NSError *)  error

Appelée par des sous-classes pour avertir le framework que la session n'a pas pu démarrer.

Parameters
errorThe error that occurred.

Fourni par la catégorie GCKSession(Protected)

- (void) notifyDidResume

Appelée par des sous-classes pour avertir le framework que la session a repris.

Fourni par la catégorie GCKSession(Protected)

- (void) notifyDidSuspendWithReason: (GCKConnectionSuspendReason reason

Appelée par des sous-classes pour informer le framework que la session a été suspendue.

Parameters
reasonThe reason for the suspension.

Fourni par la catégorie GCKSession(Protected)

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

Appelée par des sous-classes pour avertir le framework que la session est terminée.

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

Fourni par la catégorie GCKSession(Protected)

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

Appelé par des sous-classes pour informer le framework que le volume de l'appareil mis à jour et l'état de désactivation du son ont été reçus par l'appareil.

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

Fourni par la catégorie GCKSession(Protected)

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

Appelée par des sous-classes pour informer le framework que l'appareil a reçu un état mis à jour.

Parameters
statusTextThe new status.

Fourni par la catégorie GCKSession(Protected)

Détails de la propriété

- (GCKDevice*) device
readnonatomicstrong

Appareil auquel cette session est associée.

- (NSString*) sessionID
readnonatomiccopy

ID de la session actuelle, le cas échéant.

- (GCKConnectionState) connectionState
readnonatomicassign

État actuel de la connexion à la session.

- (BOOL) suspended
readnonatomicassign

Indicateur indiquant si la session est actuellement suspendue.

- (NSString*) deviceStatusText
readnonatomiccopy

Texte de l'état actuel de l'appareil.

- (GCKSessionTraits*) traits
readnonatomiccopy

Les caractéristiques de la session.

- (float) currentDeviceVolume
readnonatomicassign

Volume actuel de l'appareil, compris entre 0 et 1.

- (BOOL) currentDeviceMuted
readnonatomicassign

État actuel du son de l'appareil.

- (GCKRemoteMediaClient*) remoteMediaClient
readnonatomicstrong

Objet GCKRemoteMediaClient permettant de contrôler la lecture des contenus multimédias dans cette session.

Il est nil avant le début de la session ou si la session n'est pas compatible avec l'API GCKRemoteMediaClient. Les sous-classes qui fournissent une interface GCKRemoteMediaClient doivent remplacer la méthode getter.

- (GCKMediaMetadata*) mediaMetadata
readnonatomicstrong

Métadonnées multimédias actuelles, le cas échéant.

La valeur est nil si la session n'est pas compatible avec l'espace de noms multimédia ou si aucun média n'est actuellement chargé sur le récepteur.