Classe GCKSession

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
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)) et endWithAction: (GCKSession(Protected)), et appeler les systèmes de notification appropriés (par exemple, notifyDidStartWithSessionID: (GCKSession(Protected))) pour indiquer les modifications correspondantes 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 "session" pour l'appareil donné, avec les options par défaut. Plus...
 
(instancetype) - initWithDevice:traits:sessionID:sessionOptions:
 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) - endWithAction:
 Met fin à la session avec l'action spécifiée. 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) - notifyDidEndWithError:willTryToResume:
 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...
 
(void) - notifyDidSuspendWithReason:
 Obsolète. Ne pas utiliser. Implémentée comme no-op. Plus...
 
(void) - notifyDidResume
 Obsolète. Ne pas utiliser. Implémentée comme no-op. 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...
 
GCKSessionOptions * sessionOptions
 Options de la session, 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: (nullable GCKSessionTraits *)  traits
sessionID: (nullable NSString *)  sessionID 

Initialise un nouvel objet "session" pour l'appareil donné, avec les options par défaut.

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 

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.
sessionOptionsThe session options, if any; otherwise nil.
Sincé
4,0
- (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) endWithAction: (GCKSessionEndAction action

Met fin à la session avec l'action spécifiée.

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

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

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) notifyDidEndWithError: (nullable NSError *)  error
willTryToResume: (BOOL)  willTryToResume 

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.
willTryToResumeWhether the session will try to resume itself automatically.

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: (nullable NSString *)  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)

- (void) notifyDidSuspendWithReason: (GCKConnectionSuspendReason reason

Obsolète. Ne pas utiliser. Implémentée en tant que no-op.

Deprecated:
Ne pas appeler.

Fourni par la catégorie GCKSession(Protected)

- (void) notifyDidResume

Obsolète. Ne pas utiliser. Implémentée en tant que no-op.

Deprecated:
Ne pas appeler.

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.

- (GCKSessionOptions*) sessionOptions
readnonatomicstrong

Options de la session, le cas échéant.

Sincé
4,0
- (GCKConnectionState) connectionState
readnonatomicassign

État actuel de la connexion à la session.

- (BOOL) suspended
readnonatomicassign

Indicateur indiquant si la session est actuellement suspendue.

Deprecated:
GCKSession ne permet plus d'être suspendu. Si nécessaire, déplacez cette fonctionnalité vers une sous-classe.
- (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.