Présentation
Une classe qui gère une session Cast avec un appareil récepteur.
Les sessions sont créées et gérées automatiquement par le GCKSessionManager. L'application ne doit pas appeler directement les méthodes de cycle de vie de la session telles que start (GCKSession(Protected)) ou endAndStopCasting: (GCKSession(Protected)).
- Depuis
- 3,0
Hérite de GCKSession.
Résumé des méthodes d'instance | |
(instancetype) | - initWithDevice:sessionID:castOptions: |
initialiseur désigné. Plus... | |
(BOOL) | - addChannel: |
Enregistre un canal avec la session. Plus... | |
(BOOL) | - removeChannel: |
Supprime un canal précédemment enregistré de la session. Plus... | |
(void) | - addDeviceStatusListener: |
Ajoute un GCKCastDeviceStatusListener à la liste des écouteurs de cet objet. Plus... | |
(void) | - removeDeviceStatusListener: |
Supprime un GCKCastDeviceStatusListener de la liste des écouteurs de cet objet. Plus... | |
(GCKRequest *) | - setDeviceVolume:forMultizoneDevice: |
Définit le volume d'un appareil spécifique dans un groupe multizone. Plus... | |
(GCKRequest *) | - setDeviceMuted:forMultizoneDevice: |
Définit l'état du son d'un appareil spécifique dans un groupe multizone. Plus... | |
(GCKRequest *) | - requestMultizoneStatus |
Demander l'état multizone à un groupe multizone Plus... | |
(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 le mode silencieux 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 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 été réactivée. Plus... | |
(void) | - notifyDidSuspendWithReason: |
Appelée par des sous-classes pour avertir 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ée par des sous-classes pour avertir le framework que l'appareil a reçu une mise à jour du volume et de l'état de désactivation du son. Plus... | |
(void) | - notifyDidReceiveDeviceStatus: |
Appelée par des sous-classes pour avertir le framework que l'appareil a reçu un état mis à jour. Plus... | |
Résumé de la propriété | |
GCKActiveInputStatus | activeInputStatus |
État "Entrée active " actuel de l'appareil. Plus... | |
GCKStandbyStatus | standbyStatus |
État de veille actuel de l'appareil. Plus... | |
GCKApplicationMetadata * | applicationMetadata |
Métadonnées de l'application réceptrice en cours d'exécution sur l'appareil récepteur, le cas échéant. Sinon, nil . Plus... | |
GCKDevice * | device |
Appareil auquel cette session est associée. Plus... | |
NSString * | sessionID |
L'ID de session actuel, le cas échéant Plus... | |
GCKConnectionState | connectionState |
État actuel de la connexion de la session. Plus... | |
BOOL | suspended |
Indique si la session est actuellement suspendue. Plus... | |
NSString * | deviceStatusText |
Texte indiquant l'état actuel de l'appareil. Plus... | |
GCKSessionTraits * | traits |
Traits de session. Plus... | |
float | currentDeviceVolume |
Volume actuel de l'appareil, compris dans la plage [0,0, 1,0]. Plus... | |
BOOL | currentDeviceMuted |
État actuel du mode silencieux de l'appareil. Plus... | |
GCKRemoteMediaClient * | remoteMediaClient |
Objet GCKRemoteMediaClient qui peut être utilisé pour contrôler la lecture des contenus multimédias 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 | |
sessionID: | (NSString *__nullable) | sessionID | |
castOptions: | (GCKCastOptions *) | castOptions | |
initialiseur désigné.
Construit une session Cast avec les options Cast spécifiées.
- Parameters
-
device The receiver device. sessionID The session ID, if resuming; otherwise nil
.castOptions The Cast options.
- (BOOL) addChannel: | (GCKCastChannel *) | channel |
Enregistre un canal avec la session.
Si la session est connectée et que l'application réceptrice accepte l'espace de noms du canal, le canal est automatiquement connecté. Si la session n'est pas connectée, le canal reste déconnecté jusqu'au démarrage de la session.
- Parameters
-
channel The channel to register.
- Renvoie
YES
si la chaîne a bien été enregistrée, ouNO
dans le cas contraire.
- (BOOL) removeChannel: | (GCKCastChannel *) | channel |
Supprime un canal précédemment enregistré de la session.
- Parameters
-
channel The channel to unregister.
- Renvoie
YES
si l'enregistrement de la chaîne a abouti,NO
dans le cas contraire.
- (void) addDeviceStatusListener: | (id< GCKCastDeviceStatusListener >) | listener |
Ajoute un GCKCastDeviceStatusListener à la liste des écouteurs de cet objet.
- Parameters
-
listener The listener to add.
- (void) removeDeviceStatusListener: | (id< GCKCastDeviceStatusListener >) | listener |
Supprime un GCKCastDeviceStatusListener de la liste des écouteurs de cet objet.
- Parameters
-
listener The listener to remove.
- (GCKRequest *) setDeviceVolume: | (float) | volume | |
forMultizoneDevice: | (GCKMultizoneDevice *) | device | |
Définit le volume d'un appareil spécifique dans un groupe multizone.
Il s'agit d'une opération asynchrone.
- Parameters
-
volume The new volume, in the range [0.0, 1.0]. device The multizone device.
- Renvoie
- Un objet GCKRequest pour suivre la requête.
- (GCKRequest *) setDeviceMuted: | (BOOL) | muted | |
forMultizoneDevice: | (GCKMultizoneDevice *) | device | |
Définit l'état du son d'un appareil spécifique dans un groupe multizone.
Il s'agit d'une opération asynchrone.
- Parameters
-
muted The new muted state. device The multizone device.
- Renvoie
- Un objet GCKRequest pour suivre la requête.
- (GCKRequest *) requestMultizoneStatus |
Demander l'état multizone à un groupe multizone
Il s'agit d'une opération asynchrone. Lorsque l'état multizone est reçu, la méthode déléguée castSession:didReceiveMultizoneStatus: (GCKCastDeviceStatusListener-p) est envoyée par message.
- Renvoie
- Un objet GCKRequest pour suivre la requête.
- (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
- Un objet GCKRequest pour 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 le mode silencieux 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
- Un objet GCKRequest pour 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 des sous-classes pour avertir 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 des sous-classes pour avertir 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 des sous-classes pour avertir le framework que la session a été réactivée.
Fourni par la catégorie GCKSession(Protected).
- (void) notifyDidSuspendWithReason: | (GCKConnectionSuspendReason) | reason |
Appelée par des 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ée par des 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 des sous-classes pour avertir le framework que l'appareil a reçu une mise à jour du volume et de l'état de désactivation du son.
- 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 des sous-classes pour avertir le framework que l'appareil a reçu un état mis à jour.
- Parameters
-
statusText The new status.
Fourni par la catégorie GCKSession(Protected).
Détails de la propriété
|
readnonatomicassign |
État "Entrée active " actuel de l'appareil.
|
readnonatomicassign |
État de veille actuel de l'appareil.
|
readnonatomiccopy |
Métadonnées de l'application réceptrice en cours d'exécution sur l'appareil récepteur, le cas échéant. Sinon, nil
.
|
readnonatomicstronginherited |
Appareil auquel cette session est associée.
|
readnonatomiccopyinherited |
L'ID de session actuel, le cas échéant
|
readnonatomicassigninherited |
État actuel de la connexion de la session.
|
readnonatomicassigninherited |
Indique si la session est actuellement suspendue.
|
readnonatomiccopyinherited |
Texte indiquant l'état actuel de l'appareil.
|
readnonatomiccopyinherited |
Traits de session.
|
readnonatomicassigninherited |
Volume actuel de l'appareil, compris dans la plage [0,0, 1,0].
|
readnonatomicassigninherited |
État actuel du mode silencieux de l'appareil.
|
readnonatomicstronginherited |
Objet GCKRemoteMediaClient qui peut être utilisé pour contrôler la lecture des contenus multimédias dans cette session.
Il est défini sur 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.
|
readnonatomicstronginherited |
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 contenu multimédia n'est actuellement chargé sur le récepteur.