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 méthodes d'alerte 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 de telles opérations.
Une session est créée et contrôlée à l'aide des méthodes de session de 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 du NSObject.
Héritée par GCKCastSession.
Résumé des méthodes d'instance | |
(instancetype) | - initWithDevice:traits:sessionID: |
Initialise un nouvel objet de session pour l'appareil donné, avec des options par défaut. Plus... | |
(instancetype) | - initWithDevice:traits:sessionID:sessionOptions: |
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) | - endWithAction: |
Met fin à la session avec l'action spécifiée. 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) | - notifyDidEndWithError:willTryToResume: |
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... | |
(void) | - notifyDidSuspendWithReason: |
Obsolète, ne pas utiliser. Implémenté en tant que no-op. Plus... | |
(void) | - notifyDidResume |
Obsolète, ne pas utiliser. Implémenté en tant que no-op. Plus... | |
Résumé de la propriété | |
GCKDevice * | device |
Appareil auquel cette session est associée. Plus... | |
NSString * | sessionID |
L'ID de session actuel, le cas échéant Plus... | |
GCKSessionOptions * | sessionOptions |
Options de session, 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 | |
traits: | (nullable GCKSessionTraits *) | traits | |
sessionID: | (nullable NSString *) | sessionID | |
Initialise un nouvel objet de session pour l'appareil donné, avec des options par défaut.
- 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.
- (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
-
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.sessionOptions The session options, if any; otherwise nil
.
- Depuis
- 4,0
- (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) endWithAction: | (GCKSessionEndAction) | action |
Met fin à la session avec l'action spécifiée.
Il s'agit d'une opération asynchrone. Doit être remplacé par les sous-classes.
- Parameters
-
action The action to take when ending the session; see GCKSessionEndAction for more details.
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: | (GCKError *) | 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) notifyDidEndWithError: | (nullable NSError *) | error | |
willTryToResume: | (BOOL) | willTryToResume | |
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.willTryToResume Whether the session will try to resume itself automatically.
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: | (nullable NSString *) | 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).
- (void) notifyDidSuspendWithReason: | (GCKConnectionSuspendReason) | reason |
Obsolète, ne pas utiliser : implémenté 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é en tant que no-op.
- Deprecated:
- Ne pas appeler.
Fourni par la catégorie GCKSession(Protected).
Détails de la propriété
|
readnonatomicstrong |
Appareil auquel cette session est associée.
|
readnonatomiccopy |
L'ID de session actuel, le cas échéant
|
readnonatomicstrong |
Options de session, le cas échéant.
- Depuis
- 4,0
|
readnonatomicassign |
État actuel de la connexion de la session.
|
readnonatomicassign |
Indique si la session est actuellement suspendue.
- Deprecated:
- GCKSession ne peut plus être suspendu. Si nécessaire, déplacez cette fonctionnalité vers une sous-classe.
|
readnonatomiccopy |
Texte indiquant l'état actuel de l'appareil.
|
readnonatomiccopy |
Traits de session.
|
readnonatomicassign |
Volume actuel de l'appareil, compris dans la plage [0,0, 1,0].
|
readnonatomicassign |
État actuel du mode silencieux de l'appareil.
|
readnonatomicstrong |
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.
|
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 contenu multimédia n'est actuellement chargé sur le récepteur.