Classe GCKGameManagerChannel

Documentation de référence de la classe GCKGameManagerChannel

Présentation

Sous-classe GCKCastChannel pour les opérations de contrôle du jeu.

Consultez GCKGameManagerChannelDelegate pour le protocole de délégué.

Deprecated:
L'API Game Manager n'est plus prise en charge et sera supprimée dans une prochaine version.

Hérite de GCKCastChannel.

Récapitulatif des méthodes d'instance

(instancetype) - initWithSessionID:
 Initialiseur désigné. Plus
 
(instancetype) - init
 L'initialiseur par défaut n'est pas disponible. Plus
 
(NSInteger) - sendPlayerAvailableRequest:
 Envoie une requête au récepteur pour que le lecteur utilisé en dernier sur cet expéditeur passe à l'état GCKPlayerStateAvailable. Plus
 
(NSInteger) - sendPlayerAvailableRequest:playerID:
 Envoie une requête au récepteur pour mettre le lecteur à l'état GCKPlayerStateAvailable. Plus
 
(NSInteger) - sendPlayerReadyRequest:
 Envoie une requête au récepteur pour que le lecteur utilisé en dernier sur cet expéditeur passe à l'état GCKPlayerStateReady. Plus
 
(NSInteger) - sendPlayerReadyRequest:playerID:
 Envoie une requête au récepteur pour mettre le lecteur à l'état GCKPlayerStateReady. Plus
 
(NSInteger) - sendPlayerPlayingRequest:
 Envoie une requête au récepteur pour que le lecteur utilisé en dernier sur cet expéditeur passe à l'état GCKPlayerStatePlaying. Plus
 
(NSInteger) - sendPlayerPlayingRequest:playerID:
 Envoie une requête au récepteur pour mettre le lecteur à l'état GCKPlayerStatePlaying. Plus
 
(NSInteger) - sendPlayerIdleRequest:
 Envoie une requête au récepteur pour que le lecteur utilisé en dernier sur cet expéditeur passe à l'état GCKPlayerStateIdle. Plus
 
(NSInteger) - sendPlayerIdleRequest:playerID:
 Envoie une requête au récepteur pour mettre le lecteur à l'état GCKPlayerStateIdle. Plus
 
(NSInteger) - sendPlayerQuitRequest:
 Envoie une requête au récepteur pour que le lecteur utilisé en dernier sur cet expéditeur passe à l'état GCKPlayerStateQuit. Plus
 
(NSInteger) - sendPlayerQuitRequest:playerID:
 Envoie une requête au récepteur pour mettre le lecteur à l'état GCKPlayerStateQuit. Plus
 
(NSInteger) - sendGameRequest:
 Envoie un message spécifique au jeu au destinataire. Plus
 
(NSInteger) - sendGameRequest:playerID:
 Envoie un message spécifique au jeu au destinataire. Plus
 
(void) - sendGameMessage:
 Envoie un message spécifique au jeu au destinataire. Plus
 
(void) - sendGameMessage:playerID:
 Envoie un message spécifique au jeu au destinataire. Plus
 
(instancetype) - initWithNamespace:
 Initialiseur désigné. Plus
 
(void) - didReceiveTextMessage:
 Appelée lorsqu'un message texte a été reçu sur ce canal. Plus
 
(BOOL) - sendTextMessage:
 Envoie un message sur ce canal. Plus
 
(BOOL) - sendTextMessage:error:
 Envoie un message sur ce canal. Plus
 
(NSInteger) - generateRequestID
 Génère un ID de requête pour un nouveau message. Plus
 
(NSNumber *__nullable) - generateRequestNumber
 Méthode pratique qui encapsule le résultat de generateRequestID dans un NSNumber. Plus
 
(void) - didConnect
 Appelé lorsque ce canal a été connecté, ce qui indique que des messages peuvent désormais être échangés avec l'appareil Cast sur ce canal. Plus
 
(void) - didDisconnect
 Appelé lorsque ce canal a été déconnecté, ce qui indique que les messages ne peuvent plus être échangés avec l'appareil Cast sur ce canal. Plus
 

Récapitulatif des propriétés

id< GCKGameManagerChannelDelegatedelegate
 Délégué pour la réception des notifications de GCKGameManagerChannel. Plus
 
GCKGameManagerStatecurrentState
 État actuel du gestionnaire de jeu. Plus
 
NSString * lastUsedPlayerID
 ID du dernier lecteur contrôlable utilisé lors de cette session. Plus
 
BOOL isInitialConnectionEstablished
 Indique si cette chaîne est associée au gestionnaire de jeux du récepteur et si nous sommes prêts à interagir avec elle. Plus
 
NSString * protocolNamespace
 Espace de noms du canal. Plus
 
BOOL isConnected
 Indicateur indiquant si cette chaîne est actuellement associée. Plus
 
GCKDeviceManagerdeviceManager
 Gestionnaire d'appareils auprès duquel cette chaîne est enregistrée, le cas échéant. Plus
 

Détails sur la méthode

- (instancetype) initWithSessionID: (NSString *)  castSessionID

Initialiseur désigné.

Se connecte automatiquement au Gestionnaire de jeux du récepteur.

Parameters
castSessionIDThe Session ID corresponding to the currently connected Game Manager.
- (instancetype) init

L'initialiseur par défaut n'est pas disponible.

Implémente GCKCastChannel.

- (NSInteger) sendPlayerAvailableRequest: (id __nullable)  extraData

Envoie une requête au récepteur pour que le lecteur utilisé en dernier sur cet expéditeur passe à l'état GCKPlayerStateAvailable.

Si la transition n'est pas valide pour ce lecteur, une erreur est déclenchée dans GCKGameManagerChannelDelegate. S'il n'y a pas de lecteur utilisé en dernier, un nouveau lecteur sera enregistré et son ID de lecteur sera défini comme ID de lecteur utilisé en dernier lorsque le récepteur répondra à cette requête. Cette méthode ne doit être appelée qu'après l'envoi du message de rappel du délégué gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p). Envoie des messages au rappel de délégué gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) si GCKGameManagerChannel n'est pas encore connecté au gestionnaire de jeux du destinataire.

Voir aussi
lastUsedPlayerID
Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) sendPlayerAvailableRequest: (id __nullable)  extraData
playerID: (NSString *)  playerID 

Envoie une requête au récepteur pour mettre le lecteur à l'état GCKPlayerStateAvailable.

Si la transition n'est pas valide pour ce lecteur, une erreur est déclenchée dans GCKGameManagerChannelDelegate. Si l'ID de joueur est nil, un nouveau joueur sera enregistré et son ID de joueur sera défini comme le dernier ID de joueur utilisé lorsque le récepteur répondra à cette demande. Cette méthode ne doit être appelée qu'après l'envoi du message de rappel du délégué gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p). Envoie des messages au rappel de délégué gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) si GCKGameManagerChannel n'est pas encore connecté au gestionnaire de jeux du destinataire.

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerIDThe player ID of the player whose state is to be changed.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) sendPlayerReadyRequest: (id __nullable)  extraData

Envoie une requête au récepteur pour que le lecteur utilisé en dernier sur cet expéditeur passe à l'état GCKPlayerStateReady.

Si la transition n'est pas valide pour ce lecteur ou s'il n'y a pas d'ID de lecteur utilisé en dernier, une erreur sera déclenchée dans GCKGameManagerChannelDelegate. Cette méthode ne doit être appelée qu'après l'envoi du message de rappel du délégué gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p). Envoie des messages au rappel de délégué gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) si GCKGameManagerChannel n'est pas encore connecté au gestionnaire de jeux du destinataire.

Voir aussi
lastUsedPlayerID
Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) sendPlayerReadyRequest: (id __nullable)  extraData
playerID: (NSString *)  playerID 

Envoie une requête au récepteur pour mettre le lecteur à l'état GCKPlayerStateReady.

Si la transition n'est pas valide pour ce lecteur ou s'il n'y a pas d'ID de lecteur utilisé en dernier, une erreur sera déclenchée dans GCKGameManagerChannelDelegate. Cette méthode ne doit être appelée qu'après l'envoi du message de rappel du délégué gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p). Envoie des messages au rappel de délégué gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) si GCKGameManagerChannel n'est pas encore connecté au gestionnaire de jeux du destinataire.

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerIDThe player ID of the player to change the state.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) sendPlayerPlayingRequest: (id __nullable)  extraData

Envoie une requête au récepteur pour que le lecteur utilisé en dernier sur cet expéditeur passe à l'état GCKPlayerStatePlaying.

Si la transition n'est pas valide pour ce lecteur ou s'il n'y a pas d'ID de lecteur utilisé en dernier, une erreur sera déclenchée dans GCKGameManagerChannelDelegate. Cette méthode ne doit être appelée qu'après l'envoi du message de rappel du délégué gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p). Envoie des messages au rappel de délégué gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) si GCKGameManagerChannel n'est pas encore connecté au gestionnaire de jeux du destinataire.

Voir aussi
lastUsedPlayerID
Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) sendPlayerPlayingRequest: (id __nullable)  extraData
playerID: (NSString *)  playerID 

Envoie une requête au récepteur pour mettre le lecteur à l'état GCKPlayerStatePlaying.

Si la transition n'est pas valide pour ce lecteur ou s'il n'y a pas d'ID de lecteur utilisé en dernier, une erreur sera déclenchée dans GCKGameManagerChannelDelegate. Cette méthode ne doit être appelée qu'après l'envoi du message de rappel du délégué gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p). Envoie des messages au rappel de délégué gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) si GCKGameManagerChannel n'est pas encore connecté au gestionnaire de jeux du destinataire.

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerIDThe player ID of the player to change the state.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) sendPlayerIdleRequest: (id __nullable)  extraData

Envoie une requête au récepteur pour que le lecteur utilisé en dernier sur cet expéditeur passe à l'état GCKPlayerStateIdle.

Si la transition n'est pas valide pour ce lecteur ou s'il n'y a pas d'ID de lecteur utilisé en dernier, une erreur sera déclenchée dans GCKGameManagerChannelDelegate. Cette méthode ne doit être appelée qu'après l'envoi du rappel de délégation gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p). Envoie des messages au rappel de délégué GCKGameManagerChannel::gameManagerChannel:requestDidFailWithID:error: si GCKGameManagerChannel n'est pas encore connecté au gestionnaire de jeu du récepteur.

Voir aussi
lastUsedPlayerID
Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) sendPlayerIdleRequest: (id __nullable)  extraData
playerID: (NSString *)  playerID 

Envoie une requête au récepteur pour mettre le lecteur à l'état GCKPlayerStateIdle.

Si la transition n'est pas valide pour ce lecteur ou s'il n'y a pas d'ID de lecteur utilisé en dernier, une erreur sera déclenchée dans GCKGameManagerChannelDelegate. Cette méthode ne doit être appelée qu'après l'envoi du message de rappel du délégué gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p). Envoie des messages au rappel de délégué gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) si GCKGameManagerChannel n'est pas encore connecté au gestionnaire de jeux du destinataire.

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerIDThe player ID of the player to change the state.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) sendPlayerQuitRequest: (id __nullable)  extraData

Envoie une requête au récepteur pour que le lecteur utilisé en dernier sur cet expéditeur passe à l'état GCKPlayerStateQuit.

Si la transition n'est pas valide pour ce lecteur ou s'il n'y a pas d'ID de lecteur utilisé en dernier, une erreur sera déclenchée dans GCKGameManagerChannelDelegate. Cette méthode ne doit être appelée qu'après l'envoi du message de rappel du délégué gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p). Envoie des messages au rappel de délégué gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) si GCKGameManagerChannel n'est pas encore connecté au gestionnaire de jeux du destinataire.

Voir aussi
lastUsedPlayerID
Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) sendPlayerQuitRequest: (id __nullable)  extraData
playerID: (NSString *)  playerID 

Envoie une requête au récepteur pour mettre le lecteur à l'état GCKPlayerStateQuit.

Si la transition n'est pas valide pour ce lecteur ou s'il n'y a pas d'ID de lecteur utilisé en dernier, une erreur sera déclenchée dans GCKGameManagerChannelDelegate. Cette méthode ne doit être appelée qu'après l'envoi du message de rappel du délégué gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p). Envoie un message au rappel de délégué gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) si GCKGameManagerChannel n'est pas encore connecté au Game Manager du récepteur.

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerIDThe player ID of the player to change the state.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) sendGameRequest: (id __nullable)  extraData

Envoie un message spécifique au jeu au destinataire.

Le contenu des messages dépend entièrement de l'application. Le message proviendra de lastUsedPlayerID. Le destinataire renverra une réponse à cet expéditeur via le GCKGameManagerChannelDelegate. Cette méthode ne doit être appelée qu'après l'envoi du message de rappel du délégué gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p). Envoie des messages au rappel de délégué gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) si GCKGameManagerChannel n'est pas encore connecté au GameManager du récepteur.

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) sendGameRequest: (id __nullable)  extraData
playerID: (NSString *)  playerID 

Envoie un message spécifique au jeu au destinataire.

Le contenu des messages dépend entièrement de l'application. Le message proviendra de playerID. Si playerID est défini sur nil, lastUsedPlayerID sera utilisé. Le destinataire renverra une réponse à cet expéditeur via le GCKGameManagerChannelDelegate. Cette méthode ne doit être appelée qu'après l'envoi du message de rappel du délégué gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p). Envoie des messages au rappel de délégué gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) si GCKGameManagerChannel n'est pas encore connecté au gestionnaire de jeux du destinataire.

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerIDThe id of the controllable player sending this message.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (void) sendGameMessage: (id __nullable)  extraData

Envoie un message spécifique au jeu au destinataire.

Le contenu des messages dépend entièrement de l'application. Le message proviendra de lastUsedPlayerID. Il s'agit d'une méthode "fire-and-forget" (envoyer et oublier) qui ne garantit pas que le message a été envoyé et que le destinataire n'enverra pas de réponse à l'expéditeur. Cette méthode ne doit être appelée qu'après l'envoi du message de rappel du délégué gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p). Envoie des messages au rappel de délégué gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) si GCKGameManagerChannel n'est pas encore connecté au gestionnaire de jeux du destinataire.

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- (void) sendGameMessage: (id __nullable)  extraData
playerID: (NSString *)  playerID 

Envoie un message spécifique au jeu au destinataire.

Le contenu des messages dépend entièrement de l'application. Le message proviendra de l'ID du joueur local spécifié. Il s'agit d'une méthode "fire and forget" (envoyer et oublier) qui ne garantit pas l'envoi du message. Le destinataire n'enverra pas de réponse à l'expéditeur. Cette méthode ne doit être appelée qu'après l'envoi du message de rappel du délégué gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p). Envoie des messages au rappel de délégué gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) si GCKGameManagerChannel n'est pas encore connecté au gestionnaire de jeux du destinataire.

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerIDThe ID of the controllable player sending this message.
- (instancetype) initWithNamespace: (NSString *)  protocolNamespace

Initialiseur désigné.

Construit un nouveau GCKCastChannel avec l'espace de noms donné.

Parameters
protocolNamespaceThe namespace.

Implémenté dans GCKGenericChannel.

- (void) didReceiveTextMessage: (NSString *)  message

Appelée lorsqu'un message texte a été reçu sur ce canal.

L'implémentation par défaut est no-op.

Parameters
messageThe message.
- (BOOL) sendTextMessage: (NSString *)  message

Envoie un message sur ce canal.

Parameters
messageThe message.
Renvoie
YES en cas de succès ou NO si le message n'a pas pu être envoyé (parce que le canal n'est pas connecté ou parce que la mémoire tampon d'envoi est trop pleine pour le moment).
Deprecated:
Utilisez sendTextMessage:error:, qui fournit des informations détaillées sur les erreurs.
- (BOOL) sendTextMessage: (NSString *)  message
error: (GCKError *__nullable *__nullable)  error 

Envoie un message sur ce canal.

Parameters
messageThe message.
errorA pointer at which to store the error result. May be nil.
Renvoie
YES en cas de réussite ou NO si le message n'a pas pu être envoyé.
- (NSInteger) generateRequestID

Génère un ID de requête pour un nouveau message.

Renvoie
ID généré ou kGCKInvalidRequestID si la chaîne n'est pas connectée actuellement.
- (NSNumber * __nullable) generateRequestNumber

Méthode pratique qui encapsule le résultat de generateRequestID dans un NSNumber.

Renvoie
ID généré ou nil si la chaîne n'est pas connectée actuellement.
- (void) didConnect

Appelé lorsque ce canal a été connecté, ce qui indique que des messages peuvent désormais être échangés avec l'appareil Cast sur ce canal.

L'implémentation par défaut est no-op.

- (void) didDisconnect

Appelé lorsque ce canal a été déconnecté, ce qui indique que les messages ne peuvent plus être échangés avec l'appareil Cast sur ce canal.

L'implémentation par défaut est no-op.

Détails de la propriété

- (id<GCKGameManagerChannelDelegate>) delegate
readwritenonatomicweak

Délégué pour la réception des notifications de GCKGameManagerChannel.

- (GCKGameManagerState*) currentState
readnonatomicstrong

État actuel du gestionnaire de jeu.

- (NSString*) lastUsedPlayerID
readnonatomiccopy

ID du dernier lecteur contrôlable utilisé lors de cette session.

Il peut s'agir de nil si aucun lecteur contrôlable n'est configuré avec le récepteur.

Voir aussi
- sendPlayerAvailableRequest:
- (BOOL) isInitialConnectionEstablished
readnonatomicassign

Indique si cette chaîne est associée au gestionnaire de jeux du récepteur et si nous sommes prêts à interagir avec elle.

Cette méthode renvoie NO à partir du point de création de ce canal.

Renvoie
YES si ce canal est connecté au gestionnaire de jeux du récepteur et prêt à interagir ; NO sinon.
- (NSString*) protocolNamespace
readnonatomiccopyinherited

Espace de noms du canal.

- (BOOL) isConnected
readnonatomicassigninherited

Indicateur indiquant si cette chaîne est actuellement associée.

- (GCKDeviceManager*) deviceManager
readnonatomicweakinherited

Gestionnaire d'appareils auprès duquel cette chaîne est enregistrée, le cas échéant.

Deprecated:
Si cette chaîne n'a pas été enregistrée avec la classe GCKDeviceManager obsolète, la valeur sera nil.