Classe GCKDeviceManager

Documentation de référence de la classe GCKDeviceManager

Présentation

Une télécommande pour les appareils Cast.

Cette classe peut envoyer et recevoir des messages, ainsi que lancer et fermer des applications s'exécutant sur un appareil Cast.

L'instance GCKDeviceManager doit rester dans le champ d'application tant qu'une connexion à l'appareil Cast est établie, en cours de création ou en cours de suppression. Il est possible de libérer l'objet avant le démarrage d'une connexion avec connect (GCKDeviceManager), ou après l'appel du rappel de délégué deviceManager:didDisconnectWithError: (GCKDeviceManagerDelegate-p), deviceManager:didSuspendConnectionWithReason: (GCKDeviceManagerDelegate-p) ou deviceManager:didFailToConnectWithError: (GCKDeviceManagerDelegate-p).

Deprecated:
Utilisez GCKSessionManager et GCKCastSession pour interagir avec les récepteurs Cast.

Hérite de NSObject.

Récapitulatif des méthodes d'instance

(instancetype) - initWithDevice:clientPackageName:
 Construit un GCKDeviceManager avec l'appareil donné. Plus
 
(instancetype) - initWithDevice:clientPackageName:ignoreAppStateNotifications:
 Initialiseur désigné. Plus
 
(void) - connect
 Se connecter à l'appareil Plus
 
(void) - disconnect
 Se déconnecte de l'appareil. Plus
 
(void) - disconnectWithLeave:
 Se déconnecte de l'appareil. Plus
 
(BOOL) - addChannel:
 Ajoute un canal qui peut envoyer et recevoir des messages pour cet appareil dans un espace de noms spécifique. Plus
 
(BOOL) - removeChannel:
 Supprime une chaîne précédemment ajoutée. Plus
 
(NSInteger) - launchApplication:
 Lance une application. Plus
 
(NSInteger) - launchApplication:withLaunchOptions:
 Lance une application à l'aide des options de lancement fournies. Plus
 
(NSInteger) - launchApplication:relaunchIfRunning:
 Lance une application, en la relançant éventuellement si elle est déjà en cours d'exécution. Plus
 
(NSInteger) - joinApplication:
 Rejoint une application. Plus
 
(NSInteger) - joinApplication:sessionID:
 Associe une application à un ID de session d'application spécifique. Plus
 
(BOOL) - leaveApplication
 Quitte l'application en cours. Plus
 
(NSInteger) - stopApplication
 Arrête toutes les applications en cours d'exécution. Plus
 
(NSInteger) - stopApplicationWithSessionID:
 Arrête l'application avec l'ID de session d'application donné. Plus
 
(NSInteger) - setVolume:
 Règle le volume du système. Plus
 
(NSInteger) - setMuted:
 Active ou désactive le son. En savoir plus
 
(NSInteger) - requestDeviceStatus
 Demande l'état actuel de l'appareil. Plus
 

Récapitulatif des propriétés

BOOL ignoreAppStateNotifications
 Indique si cet objet écoutera les notifications d'état de l'application. Plus
 
GCKConnectionState connectionState
 État de connexion actuel du gestionnaire d'appareils. Plus
 
GCKConnectionState applicationConnectionState
 État actuel de la connexion de l'application du gestionnaire d'appareils. Plus
 
BOOL isConnected
 La valeur est "true" si le gestionnaire d'appareils a établi une connexion à l'appareil. Plus
 
BOOL isConnectedToApp
 La valeur est "true" si le gestionnaire d'appareils a établi une connexion à une application sur l'appareil. Plus
 
BOOL isReconnecting
 True si le gestionnaire d'appareils est déconnecté en raison d'un événement potentiellement transitoire (par exemple, l'application est en arrière-plan ou une erreur réseau s'est produite et peut être résolue en se reconnectant). Plus
 
NSTimeInterval reconnectTimeout
 Une tentative de reconnexion sera effectuée pendant cette durée si le socket se déconnecte avec une erreur potentiellement temporaire. Plus
 
GCKDevicedevice
 L'appareil contrôlé par ce GCKDeviceManager. Plus
 
id< GCKDeviceManagerDelegatedelegate
 Délégué pour la réception des notifications de GCKDeviceManager. Plus
 
float deviceVolume
 Volume actuel de l'appareil dans la plage [0.0, 1.0], si connu ; sinon, 0. Plus
 
BOOL deviceMuted
 État actuel du son de l'appareil, s'il est connu. Sinon, NO. Plus
 
GCKActiveInputStatus activeInputStatus
 État actuel de l'entrée active de l'appareil. Plus
 
GCKStandbyStatus standbyStatus
 État de veille actuel de l'appareil. Plus
 
NSString * applicationSessionID
 ID de session de l'application réceptrice actuellement connectée, le cas échéant. Sinon, nil. Plus
 
GCKApplicationMetadataapplicationMetadata
 Métadonnées de l'application réceptrice actuellement en cours d'exécution sur le récepteur, le cas échéant. Sinon, nil. Plus
 
NSString * applicationStatusText
 Texte d'état le plus récent de l'application réceptrice en cours d'exécution, le cas échéant. Sinon, nil. Plus
 

Détails sur la méthode

- (instancetype) initWithDevice: (GCKDevice *)  device
clientPackageName: (NSString *)  clientPackageName 

Construit un GCKDeviceManager avec l'appareil donné.

L'objet écoute les notifications d'état de l'application et se déconnecte automatiquement de l'appareil lorsque l'application passe en arrière-plan. Il tente ensuite de se reconnecter à l'appareil lorsque l'application revient au premier plan.

Parameters
deviceThe device to control.
clientPackageNameThe client package name.
- (instancetype) initWithDevice: (GCKDevice *)  device
clientPackageName: (NSString *)  clientPackageName
ignoreAppStateNotifications: (BOOL)  ignoreAppStateNotifications 

Initialiseur désigné.

Construit un nouveau GCKDeviceManager pour contrôler l'appareil donné.

Si ignoreAppStateNotifications est défini sur NO, l'objet écoute les modifications de l'état de l'application et se déconnecte automatiquement de l'appareil lorsque l'application passe en arrière-plan. Il tente ensuite de se reconnecter à l'appareil lorsque l'application revient au premier plan.

Si ignoreAppStateNotifications est défini sur YES, l'objet n'écoutera pas ces notifications et il incombera à l'application de gérer le cycle de vie de la connexion. Notez qu'en général, une application iOS mise en arrière-plan ne peut pas continuer à s'exécuter indéfiniment, et que ses connexions réseau actives seront finalement fermées par le système d'exploitation.

Parameters
deviceThe device to control.
clientPackageNameThe client package name.
ignoreAppStateNotificationsWhether this object will ignore app state notifications.
- (void) connect

Se connecter à l'appareil

- (void) disconnect

Se déconnecte de l'appareil.

Il s'agit d'une déconnexion explicite.

L'une des méthodes de déconnexion doit être appelée à un moment donné après l'appel de connect et avant que cet objet ne soit libéré par son propriétaire.

- (void) disconnectWithLeave: (BOOL)  leaveApplication

Se déconnecte de l'appareil.

L'une des méthodes de déconnexion doit être appelée à un moment donné après l'appel de connect et avant que cet objet ne soit libéré par son propriétaire.

Parameters
leaveApplicationYES if this is an explicit disconnect that should disconnect from ("leave") the receiver application before closing the connection; NO if this is an implicit disconnect that should just close the connection.
- (BOOL) addChannel: (GCKCastChannel *)  channel

Ajoute un canal qui peut envoyer et recevoir des messages pour cet appareil dans un espace de noms spécifique.

Parameters
channelThe channel.
Renvoie
YES si la chaîne a été ajoutée, NO si elle n'a pas été ajoutée, car une chaîne était déjà associée à cet espace de noms.
- (BOOL) removeChannel: (GCKCastChannel *)  channel

Supprime une chaîne précédemment ajoutée.

Parameters
channelThe channel.
Renvoie
YES si la chaîne a été supprimée, NO si elle n'a pas été supprimée, car la chaîne indiquée n'était pas associée auparavant.
- (NSInteger) launchApplication: (NSString *)  applicationID

Lance une application.

Parameters
applicationIDThe application ID.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) launchApplication: (NSString *)  applicationID
withLaunchOptions: (GCKLaunchOptions *__nullable)  launchOptions 

Lance une application à l'aide des options de lancement fournies.

Parameters
applicationIDThe application ID.
launchOptionsThe launch options for this request. If nil, defaults will be used.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) launchApplication: (NSString *)  applicationID
relaunchIfRunning: (BOOL)  relaunchIfRunning 

Lance une application, en la relançant éventuellement si elle est déjà en cours d'exécution.

Deprecated:
Utilisez plutôt launchApplication:withLaunchOptions:.
Parameters
applicationIDThe application ID.
relaunchIfRunningIf YES, relaunches the application if it is already running instead of joining the running application.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) joinApplication: (NSString *__nullable)  applicationID

Rejoint une application.

Parameters
applicationIDThe application ID. If nil, attempts to join whichever application is currently running; otherwise, attempts to join the specified application.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) joinApplication: (NSString *)  applicationID
sessionID: (NSString *)  sessionID 

Associe une application à un ID de session d'application spécifique.

La requête échouera si l'ID de session fourni n'est plus actif sur le récepteur.

Parameters
applicationIDThe application ID.
sessionIDThe application session ID.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (BOOL) leaveApplication

Quitte l'application en cours.

Renvoie
NO si le message n'a pas pu être envoyé.
- (NSInteger) stopApplication

Arrête toutes les applications en cours d'exécution.

Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) stopApplicationWithSessionID: (NSString *__nullable)  sessionID

Arrête l'application avec l'ID de session d'application donné.

La requête échouera si l'ID de session fourni n'est plus actif sur le récepteur.

Parameters
sessionIDThe application session ID, which may not be nil.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) setVolume: (float)  volume

Règle le volume du système.

Parameters
volumeThe new volume, in the range [0.0, 1.0]. Out of range values will be silently clipped.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) setMuted: (BOOL)  muted

Active ou désactive la désactivation du son.

Parameters
mutedWhether audio should be muted or unmuted.
Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.
- (NSInteger) requestDeviceStatus

Demande l'état actuel de l'appareil.

Cela entraînera l'appel de tous les rappels de mise à jour de l'état du délégué une fois les informations d'état mises à jour reçues.

Renvoie
ID de la requête ou kGCKInvalidRequestID si la requête n'a pas pu être envoyée.

Détails de la propriété

- (BOOL) ignoreAppStateNotifications
readnonatomicassign

Indique si cet objet écoutera les notifications d'état de l'application.

Cet indicateur peut être spécifié dans l'initialiseur. La valeur par défaut est NO.

- (GCKConnectionState) connectionState
readnonatomicassign

État de connexion actuel du gestionnaire d'appareils.

- (GCKConnectionState) applicationConnectionState
readnonatomicassign

État actuel de la connexion de l'application du gestionnaire d'appareils.

- (BOOL) isConnected
readnonatomicassign

La valeur est "true" si le gestionnaire d'appareils a établi une connexion à l'appareil.

Deprecated:
 Utilisez connectionState.
- (BOOL) isConnectedToApp
readnonatomicassign

La valeur est "true" si le gestionnaire d'appareils a établi une connexion à une application sur l'appareil.

Deprecated:
 Utilisez applicationConnectionState.
- (BOOL) isReconnecting
readnonatomicassign

True si le gestionnaire d'appareils est déconnecté en raison d'un événement potentiellement transitoire (par exemple, l'application est en arrière-plan ou une erreur réseau s'est produite et peut être résolue en se reconnectant).

Notez que les rappels de déconnexion/connexion ne seront pas appelés pendant que le gestionnaire d'appareils tente de se reconnecter après un événement potentiellement transitoire, mais les propriétés refléteront toujours l'état actuel réel et pourront être observées.

- (NSTimeInterval) reconnectTimeout
readwritenonatomicassign

Une tentative de reconnexion sera effectuée pendant cette durée si le socket se déconnecte avec une erreur potentiellement temporaire.

Le délai avant expiration par défaut est de 15 secondes.

- (GCKDevice*) device
readnonatomicassign

L'appareil contrôlé par ce GCKDeviceManager.

- (id<GCKDeviceManagerDelegate>) delegate
readwritenonatomicweak

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

- (float) deviceVolume
readnonatomicassign

Volume actuel de l'appareil dans la plage [0.0, 1.0], si connu ; sinon, 0.

- (BOOL) deviceMuted
readnonatomicassign

État actuel du son de l'appareil, s'il est connu. Sinon, NO.

- (GCKActiveInputStatus) activeInputStatus
readnonatomicassign

État actuel de l'entrée active de l'appareil.

- (GCKStandbyStatus) standbyStatus
readnonatomicassign

État de veille actuel de l'appareil.

- (NSString*) applicationSessionID
readnonatomiccopy

ID de session de l'application réceptrice actuellement connectée, le cas échéant. Sinon, nil.

Un nouvel ID de session unique est généré chaque fois qu'une application récepteur est lancée (y compris lorsque la même application est relancée) et reste en vigueur tant que l'application récepteur continue de s'exécuter.

- (GCKApplicationMetadata*) applicationMetadata
readnonatomiccopy

Métadonnées de l'application réceptrice actuellement en cours d'exécution sur le récepteur, le cas échéant. Sinon, nil.

- (NSString*) applicationStatusText
readnonatomiccopy

Texte d'état le plus récent de l'application réceptrice en cours d'exécution, le cas échéant. Sinon, nil.