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 doivent appeler les méthodes de notification appropriées (par exemple, notifyDidStartWithSessionID: (GCKSession(Protected))) pour indiquer les modifications correspondantes de l'état de la session. Les sous-classes peuvent également implémenter setDeviceVolume: (GCKSession), setDeviceMuted: (GCKSession) et remoteMediaClient si l'appareil est compatible avec 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.
- Depuis
- 3.0
Hérite de NSObject.
Hérité par GCKCastSession.
Récapitulatif des méthodes d'instance | |
(instancetype) | - initWithDevice:traits:sessionID: |
Initialise un nouvel objet de session pour l'appareil donné. Plus | |
(GCKRequest *) | - setDeviceVolume: |
Règle le volume de l'appareil. Plus | |
(GCKRequest *) | - setDeviceMuted: |
Définit l'état de mise en sourdine de l'appareil. Plus | |
(void) | - start |
Démarre la session. Plus | |
(void) | - endAndStopCasting: |
Met fin à la session. Plus | |
(void) | - suspendWithReason: |
Suspend la session pour le motif indiqué. Plus | |
(void) | - resume |
Reprend la session. Plus | |
(void) | - notifyDidStartWithSessionID: |
Appelée par les sous-classes pour informer le framework que la session a démarré. Plus | |
(void) | - notifyDidFailToStartWithError: |
Appelée par les sous-classes pour informer le framework que la session n'a pas pu démarrer. Plus | |
(void) | - notifyDidResume |
Appelée par les sous-classes pour informer le framework que la session a été reprise. Plus | |
(void) | - notifyDidSuspendWithReason: |
Appelée par les sous-classes pour avertir le framework que la session a été suspendue. Plus | |
(void) | - notifyDidEndWithError: |
Appelé par les sous-classes pour avertir le framework que la session est terminée. Plus | |
(void) | - notifyDidReceiveDeviceVolume:muted: |
Appelée par les sous-classes pour informer le framework que le volume et l'état de la mise en sourdine de l'appareil ont été reçus. Plus | |
(void) | - notifyDidReceiveDeviceStatus: |
Appelée par les sous-classes pour informer le framework qu'un état mis à jour a été reçu de l'appareil. Plus | |
Récapitulatif des propriétés | |
GCKDevice * | device |
Appareil auquel cette session est associée. Plus | |
NSString * | sessionID |
ID de la session en cours, le cas échéant. Plus | |
GCKConnectionState | connectionState |
État de la connexion de la session en cours. Plus | |
BOOL | suspended |
Indicateur indiquant si la session est actuellement suspendue. Plus | |
NSString * | deviceStatusText |
Texte de l'état actuel de l'appareil. Plus | |
GCKSessionTraits * | traits |
Caractéristiques de la session. Plus | |
float | currentDeviceVolume |
Volume actuel de l'appareil, compris entre 0,0 et 1,0. Plus | |
BOOL | currentDeviceMuted |
État actuel de la désactivation du son de l'appareil. Plus | |
GCKRemoteMediaClient * | remoteMediaClient |
Objet GCKRemoteMediaClient pouvant être utilisé pour contrôler la lecture du contenu multimédia dans cette session. Plus | |
GCKMediaMetadata * | mediaMetadata |
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
-
device The device. traits The session traits. sessionID The 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 |
Règle 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
-
volume The new volume.
- Renvoie
- Objet GCKRequest permettant de suivre la requête.
- Depuis
- 3.4 ; dans les versions précédentes du framework, cette méthode renvoyait
void
.
- (GCKRequest *) setDeviceMuted: | (BOOL) | muted |
Définit l'état de mise en sourdine 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
-
muted The new mute state.
- Renvoie
- Objet GCKRequest permettant de suivre la requête.
- Depuis
- 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. Doit être remplacé par les sous-classes.
Fourni par la catégorie GCKSession(Protected).
- (void) endAndStopCasting: | (BOOL) | stopCasting |
Met fin à la session.
Il s'agit d'une opération asynchrone. Doit être remplacé par les sous-classes.
- Parameters
-
stopCasting Whether to stop casting content to the receiver.
Fourni par la catégorie GCKSession(Protected).
- (void) suspendWithReason: | (GCKConnectionSuspendReason) | reason |
Suspend la session pour le motif indiqué.
Il s'agit d'une opération asynchrone. Doit être remplacé par les sous-classes.
Fourni par la catégorie GCKSession(Protected).
- (void) resume |
Reprend la session.
Il s'agit d'une opération asynchrone. Doit être remplacé par les sous-classes.
Fourni par la catégorie GCKSession(Protected).
- (void) notifyDidStartWithSessionID: | (NSString *) | sessionID |
Appelée par les sous-classes pour informer le framework que la session a démarré.
- Parameters
-
sessionID The session's unique ID.
Fourni par la catégorie GCKSession(Protected).
- (void) notifyDidFailToStartWithError: | (NSError *) | error |
Appelée par les sous-classes pour informer le framework que la session n'a pas pu démarrer.
- Parameters
-
error The error that occurred.
Fourni par la catégorie GCKSession(Protected).
- (void) notifyDidResume |
Appelée par les sous-classes pour informer le framework que la session a été reprise.
Fourni par la catégorie GCKSession(Protected).
- (void) notifyDidSuspendWithReason: | (GCKConnectionSuspendReason) | reason |
Appelée par les sous-classes pour avertir le framework que la session a été suspendue.
- Parameters
-
reason The reason for the suspension.
Fourni par la catégorie GCKSession(Protected).
- (void) notifyDidEndWithError: | (NSError *__nullable) | error |
Appelé par les sous-classes pour avertir le framework que la session est terminée.
- Parameters
-
error The 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ée par les sous-classes pour informer le framework que le volume et l'état de la mise en sourdine de l'appareil ont été reçus.
- Parameters
-
volume The device's current volume. Must be in the range [0, 1.0]; muted The device's current mute state.
Fourni par la catégorie GCKSession(Protected).
- (void) notifyDidReceiveDeviceStatus: | (NSString *__nullable) | statusText |
Appelée par les sous-classes pour informer le framework qu'un état mis à jour a été reçu de l'appareil.
- Parameters
-
statusText The new status.
Fourni par la catégorie GCKSession(Protected).
Détails de la propriété
|
readnonatomicstrong |
Appareil auquel cette session est associée.
|
readnonatomiccopy |
ID de la session en cours, le cas échéant.
|
readnonatomicassign |
État de la connexion de la session en cours.
|
readnonatomicassign |
Indicateur indiquant si la session est actuellement suspendue.
|
readnonatomiccopy |
Texte de l'état actuel de l'appareil.
|
readnonatomiccopy |
Caractéristiques de la session.
|
readnonatomicassign |
Volume actuel de l'appareil, compris entre 0,0 et 1,0.
|
readnonatomicassign |
État actuel de la désactivation du son de l'appareil.
|
readnonatomicstrong |
Objet GCKRemoteMediaClient pouvant être utilisé pour contrôler la lecture du contenu multimédia dans cette session.
La valeur 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.
|
readnonatomicstrong |
Métadonnées multimédias actuelles, le cas échéant.
La valeur sera nil
si la session ne prend pas en charge l'espace de noms multimédia ou si aucun contenu multimédia n'est actuellement chargé sur le récepteur.