Intégrer Cast à votre application iOS

Ce guide du développeur explique comment ajouter la compatibilité Google Cast à votre application émettrice iOS à l'aide du SDK émetteur iOS.

L'appareil mobile ou l'ordinateur portable est l'expéditeur qui contrôle la lecture, et l'appareil Google Cast est le récepteur qui affiche le contenu sur le téléviseur.

Le framework de l'expéditeur fait référence au binaire de la bibliothèque de classes Cast et aux ressources associées présentes au moment de l'exécution sur l'expéditeur. L'application émettrice ou l'application Cast désigne une application qui s'exécute également sur l'émetteur. L'application Web Receiver désigne l'application HTML qui s'exécute sur Web Receiver.

Le framework de l'expéditeur utilise une conception de rappel asynchrone pour informer l'application de l'expéditeur des événements et pour passer d'un état à un autre du cycle de vie de l'application Cast.

Déroulement des opérations de l'application

Les étapes suivantes décrivent le flux d'exécution général typique d'une application iOS émettrice :

  • Le framework Cast démarre GCKDiscoveryManager en fonction des propriétés fournies dans GCKCastOptions pour commencer à rechercher des appareils.
  • Lorsque l'utilisateur clique sur le bouton Cast, le framework présente la boîte de dialogue Cast avec la liste des appareils Cast détectés.
  • Lorsque l'utilisateur sélectionne un appareil Cast, le framework tente de lancer l'application Web Receiver sur l'appareil Cast.
  • Le framework appelle des rappels dans l'application émettrice pour confirmer que l'application Web Receiver a été lancée.
  • Le framework crée un canal de communication entre l'application émettrice et les applications Web Receiver.
  • Le framework utilise le canal de communication pour charger et contrôler la lecture multimédia sur le Web Receiver.
  • Le framework synchronise l'état de lecture du contenu multimédia entre l'expéditeur et le Web Receiver : lorsque l'utilisateur effectue des actions dans l'UI de l'expéditeur, le framework transmet ces demandes de contrôle du contenu multimédia au Web Receiver. Lorsque le Web Receiver envoie des mises à jour de l'état du contenu multimédia, le framework met à jour l'état de l'UI de l'expéditeur.
  • Lorsque l'utilisateur clique sur l'icône Cast pour se déconnecter de l'appareil Cast, le framework déconnecte l'application émettrice du Web Receiver.

Pour résoudre les problèmes liés à votre expéditeur, vous devez activer la journalisation.

Pour obtenir la liste complète de toutes les classes, méthodes et événements du framework Google Cast iOS, consultez la documentation de référence de l'API Google Cast iOS. Les sections suivantes décrivent les étapes d'intégration de Cast à votre application iOS.

Appeler des méthodes à partir du thread principal

Initialiser le contexte Cast

Le framework Cast possède un objet singleton global, GCKCastContext, qui coordonne toutes les activités du framework. Cet objet doit être initialisé tôt dans le cycle de vie de l'application, généralement dans la méthode -[application:didFinishLaunchingWithOptions:] du délégué de l'application, afin que la reprise automatique de la session au redémarrage de l'application émettrice puisse se déclencher correctement.

Un objet GCKCastOptions doit être fourni lors de l'initialisation de GCKCastContext. Cette classe contient des options qui affectent le comportement du framework. L'ID d'application Web Receiver est le plus important. Il est utilisé pour filtrer les résultats de la découverte et pour lancer l'application Web Receiver lorsqu'une session Cast est démarrée.

La méthode -[application:didFinishLaunchingWithOptions:] est également un bon endroit pour configurer un délégué de journalisation afin de recevoir les messages de journalisation du framework. Elles peuvent être utiles pour le débogage et le dépannage.

Swift
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate, GCKLoggerDelegate {
  let kReceiverAppID = kGCKDefaultMediaReceiverApplicationID
  let kDebugLoggingEnabled = true

  var window: UIWindow?

  func applicationDidFinishLaunching(_ application: UIApplication) {
    let criteria = GCKDiscoveryCriteria(applicationID: kReceiverAppID)
    let options = GCKCastOptions(discoveryCriteria: criteria)
    GCKCastContext.setSharedInstanceWith(options)

    // Enable logger.
    GCKLogger.sharedInstance().delegate = self

    ...
  }

  // MARK: - GCKLoggerDelegate

  func logMessage(_ message: String,
                  at level: GCKLoggerLevel,
                  fromFunction function: String,
                  location: String) {
    if (kDebugLoggingEnabled) {
      print(function + " - " + message)
    }
  }
}
Objective-C

AppDelegate.h

@interface AppDelegate () <GCKLoggerDelegate>
@end

AppDelegate.m

@implementation AppDelegate

static NSString *const kReceiverAppID = @"AABBCCDD";
static const BOOL kDebugLoggingEnabled = YES;

- (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  GCKDiscoveryCriteria *criteria = [[GCKDiscoveryCriteria alloc]
                                    initWithApplicationID:kReceiverAppID];
  GCKCastOptions *options = [[GCKCastOptions alloc] initWithDiscoveryCriteria:criteria];
  [GCKCastContext setSharedInstanceWithOptions:options];

  // Enable logger.
  [GCKLogger sharedInstance].delegate = self;

  ...

  return YES;
}

...

#pragma mark - GCKLoggerDelegate

- (void)logMessage:(NSString *)message
           atLevel:(GCKLoggerLevel)level
      fromFunction:(NSString *)function
          location:(NSString *)location {
  if (kDebugLoggingEnabled) {
    NSLog(@"%@ - %@, %@", function, message, location);
  }
}

@end

Widgets d'UI Cast

Le SDK Cast pour iOS fournit les widgets suivants, qui sont conformes à la checklist de conception Cast :

  • Calque d'introduction : la classe GCKCastContext dispose d'une méthode, presentCastInstructionsViewControllerOnceWithCastButton, qui peut être utilisée pour mettre en évidence le bouton Cast la première fois qu'un Web Receiver est disponible. L'application de l'expéditeur peut personnaliser le texte, la position du texte du titre et le bouton "Fermer".

  • Icône Cast : À partir du SDK Cast iOS Sender 4.6.0, l'icône Cast est toujours visible lorsque l'appareil émetteur est connecté au Wi-Fi. La première fois que l'utilisateur appuie sur le bouton Cast après avoir lancé l'application, une boîte de dialogue d'autorisation s'affiche pour lui permettre d'accorder à l'application l'accès au réseau local pour les appareils du réseau. Par la suite, lorsque l'utilisateur appuie sur le bouton Cast, une boîte de dialogue Cast s'affiche et liste les appareils détectés. Lorsque l'utilisateur appuie sur le bouton Cast alors que l'appareil est connecté, les métadonnées multimédias actuelles (telles que le titre, le nom du studio d'enregistrement et une image miniature) s'affichent ou l'utilisateur peut se déconnecter de l'appareil Cast. Lorsque l'utilisateur appuie sur l'icône Cast alors qu'aucun appareil n'est disponible, un écran s'affiche pour lui expliquer pourquoi aucun appareil n'a été trouvé et comment résoudre le problème.

  • Mini-contrôleur : lorsque l'utilisateur diffuse du contenu et qu'il a quitté la page de contenu actuelle ou le contrôleur étendu pour accéder à un autre écran de l'application émettrice, le mini-contrôleur s'affiche en bas de l'écran pour permettre à l'utilisateur de voir les métadonnées du contenu multimédia en cours de diffusion et de contrôler la lecture.

  • Contrôleur étendu : lorsque l'utilisateur diffuse du contenu, s'il clique sur la notification multimédia ou sur le mini-contrôleur, le contrôleur étendu se lance. Il affiche les métadonnées du contenu multimédia en cours de lecture et fournit plusieurs boutons pour contrôler la lecture du contenu multimédia.

Ajouter un bouton Cast

Le framework fournit un composant de bouton Cast en tant que sous-classe UIButton. Il peut être ajouté à la barre de titre de l'application en l'encapsulant dans un UIBarButtonItem. Une sous-classe UIViewController type peut installer un bouton Cast comme suit :

Swift
let castButton = GCKUICastButton(frame: CGRect(x: 0, y: 0, width: 24, height: 24))
castButton.tintColor = UIColor.gray
navigationItem.rightBarButtonItem = UIBarButtonItem(customView: castButton)
Objective-C
GCKUICastButton *castButton = [[GCKUICastButton alloc] initWithFrame:CGRectMake(0, 0, 24, 24)];
castButton.tintColor = [UIColor grayColor];
self.navigationItem.rightBarButtonItem = [[UIBarButtonItem alloc] initWithCustomView:castButton];

Par défaut, lorsque l'utilisateur appuie sur le bouton, la boîte de dialogue Cast fournie par le framework s'ouvre.

Les GCKUICastButton peuvent également être ajoutés directement au storyboard.

Configurer la découverte des appareils

Dans le framework, la découverte des appareils s'effectue automatiquement. Il n'est pas nécessaire de démarrer ou d'arrêter explicitement le processus de découverte, sauf si vous implémentez une UI personnalisée.

La découverte dans le framework est gérée par la classe GCKDiscoveryManager, qui est une propriété de GCKCastContext. Le framework fournit un composant de boîte de dialogue Cast par défaut pour la sélection et le contrôle des appareils. La liste des appareils est classée par ordre lexicographique en fonction du nom descriptif de l'appareil.

Fonctionnement de la gestion des sessions

Le SDK Cast introduit le concept de session Cast, dont l'établissement combine les étapes de connexion à un appareil, de lancement (ou d'association) d'une application Web Receiver, de connexion à cette application et d'initialisation d'un canal de contrôle multimédia. Pour en savoir plus sur les sessions Cast et le cycle de vie Web Receiver, consultez le guide sur le cycle de vie des applications Web Receiver.

Les sessions sont gérées par la classe GCKSessionManager, qui est une propriété de GCKCastContext. Les sessions individuelles sont représentées par des sous-classes de la classe GCKSession. Par exemple, GCKCastSession représente les sessions avec des appareils Cast. Vous pouvez accéder à la session Cast active (le cas échéant) en tant que propriété currentCastSession de GCKSessionManager.

L'interface GCKSessionManagerListener permet de surveiller les événements de session, tels que la création, la suspension, la reprise et la fin d'une session. Le framework suspend automatiquement les sessions lorsque l'application émettrice passe en arrière-plan et tente de les reprendre lorsque l'application revient au premier plan (ou est relancée après un arrêt anormal/brutal de l'application alors qu'une session était active).

Si la boîte de dialogue Cast est utilisée, les sessions sont créées et supprimées automatiquement en réponse aux gestes de l'utilisateur. Sinon, l'application peut démarrer et arrêter des sessions de manière explicite via des méthodes sur GCKSessionManager.

Si l'application doit effectuer un traitement spécial en réponse aux événements du cycle de vie de la session, elle peut enregistrer une ou plusieurs instances GCKSessionManagerListener avec GCKSessionManager. GCKSessionManagerListener est un protocole qui définit les rappels pour des événements tels que le début et la fin d'une session, etc.

Transfert de diffusion

La conservation de l'état de la session est à la base du transfert de diffusion, qui permet aux utilisateurs de déplacer des flux audio et vidéo existants d'un appareil à un autre à l'aide de commandes vocales, de l'application Google Home ou d'écrans connectés. Le contenu multimédia cesse d'être lu sur un appareil (la source) et continue sur un autre (la destination). Tout appareil Cast doté du dernier micrologiciel peut servir de source ou de destination lors d'un transfert de diffusion.

Pour obtenir le nouvel appareil de destination lors du transfert de diffusion, utilisez la propriété GCKCastSession#device lors du rappel [sessionManager:didResumeCastSession:].

Pour en savoir plus, consultez Transfert de diffusion sur Web Receiver.

Reconnexion automatique

Le framework Cast ajoute une logique de reconnexion pour gérer automatiquement la reconnexion dans de nombreux cas particuliers subtils, tels que :

  • Récupérer les données en cas de perte temporaire de la connexion Wi-Fi
  • Sortir l'appareil du mode veille
  • Récupérer l'application après l'avoir mise en arrière-plan
  • Récupérer les données en cas de plantage de l'application

Fonctionnement du contrôle multimédia

Si une session Cast est établie avec une application Web Receiver compatible avec l'espace de noms média, une instance de GCKRemoteMediaClient est créée automatiquement par le framework. Elle est accessible en tant que propriété remoteMediaClient de l'instance GCKCastSession.

Toutes les méthodes sur GCKRemoteMediaClient qui émettent des requêtes vers le Web Receiver renvoient un objet GCKRequest qui peut être utilisé pour suivre cette requête. Un GCKRequestDelegate peut être attribué à cet objet pour recevoir des notifications sur le résultat final de l'opération.

Il est prévu que l'instance de GCKRemoteMediaClient puisse être partagée par plusieurs parties de l'application. En effet, certains composants internes du framework, tels que la boîte de dialogue Cast et les commandes multimédias réduites, partagent l'instance. Pour ce faire, GCKRemoteMediaClient permet d'enregistrer plusieurs GCKRemoteMediaClientListener.

Définir les métadonnées du contenu multimédia

La classe GCKMediaMetadata représente les informations sur un élément multimédia que vous souhaitez caster. L'exemple suivant crée une instance GCKMediaMetadata d'un film et définit le titre, le sous-titre, le nom du studio d'enregistrement et deux images.

Swift
let metadata = GCKMediaMetadata()
metadata.setString("Big Buck Bunny (2008)", forKey: kGCKMetadataKeyTitle)
metadata.setString("Big Buck Bunny tells the story of a giant rabbit with a heart bigger than " +
  "himself. When one sunny day three rodents rudely harass him, something " +
  "snaps... and the rabbit ain't no bunny anymore! In the typical cartoon " +
  "tradition he prepares the nasty rodents a comical revenge.",
                   forKey: kGCKMetadataKeySubtitle)
metadata.addImage(GCKImage(url: URL(string: "https://commondatastorage.googleapis.com/gtv-videos-bucket/sample/images/BigBuckBunny.jpg")!,
                           width: 480,
                           height: 360))
Objective-C
GCKMediaMetadata *metadata = [[GCKMediaMetadata alloc]
                                initWithMetadataType:GCKMediaMetadataTypeMovie];
[metadata setString:@"Big Buck Bunny (2008)" forKey:kGCKMetadataKeyTitle];
[metadata setString:@"Big Buck Bunny tells the story of a giant rabbit with a heart bigger than "
 "himself. When one sunny day three rodents rudely harass him, something "
 "snaps... and the rabbit ain't no bunny anymore! In the typical cartoon "
 "tradition he prepares the nasty rodents a comical revenge."
             forKey:kGCKMetadataKeySubtitle];
[metadata addImage:[[GCKImage alloc]
                    initWithURL:[[NSURL alloc] initWithString:@"https://commondatastorage.googleapis.com/"
                                 "gtv-videos-bucket/sample/images/BigBuckBunny.jpg"]
                    width:480
                    height:360]];

Consultez la section Sélection et mise en cache des images sur l'utilisation des images avec les métadonnées multimédias.

Charger des contenus multimédias

Pour charger un élément multimédia, créez une instance GCKMediaInformation à l'aide des métadonnées du contenu multimédia. Obtenez ensuite le GCKCastSession actuel et utilisez son GCKRemoteMediaClient pour charger le contenu multimédia sur l'application réceptrice. Vous pouvez ensuite utiliser GCKRemoteMediaClient pour contrôler une application de lecteur multimédia exécutée sur le récepteur, par exemple pour la lecture, la pause et l'arrêt.

Swift
let url = URL.init(string: "https://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4")
guard let mediaURL = url else {
  print("invalid mediaURL")
  return
}

let mediaInfoBuilder = GCKMediaInformationBuilder.init(contentURL: mediaURL)
mediaInfoBuilder.streamType = GCKMediaStreamType.none;
mediaInfoBuilder.contentType = "video/mp4"
mediaInfoBuilder.metadata = metadata;
mediaInformation = mediaInfoBuilder.build()

guard let mediaInfo = mediaInformation else {
  print("invalid mediaInformation")
  return
}

if let request = sessionManager.currentSession?.remoteMediaClient?.loadMedia(mediaInfo) {
  request.delegate = self
}
Objective-C
GCKMediaInformationBuilder *mediaInfoBuilder =
  [[GCKMediaInformationBuilder alloc] initWithContentURL:
   [NSURL URLWithString:@"https://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4"]];
mediaInfoBuilder.streamType = GCKMediaStreamTypeNone;
mediaInfoBuilder.contentType = @"video/mp4";
mediaInfoBuilder.metadata = metadata;
self.mediaInformation = [mediaInfoBuilder build];

GCKRequest *request = [self.sessionManager.currentSession.remoteMediaClient loadMedia:self.mediaInformation];
if (request != nil) {
  request.delegate = self;
}

Consultez également la section sur l'utilisation des pistes multimédias.

Format vidéo 4K

Pour déterminer le format vidéo de votre contenu multimédia, utilisez la propriété videoInfo de GCKMediaStatus pour obtenir l'instance actuelle de GCKVideoInfo. Cette instance contient le type de format TV HDR, ainsi que la hauteur et la largeur en pixels. Les variantes du format 4K sont indiquées dans la propriété hdrType par les valeurs enum GCKVideoInfoHDRType.

Ajouter des mini-contrôleurs

Selon la Checklist de conception Cast, une application émettrice doit fournir un contrôle persistant appelé mini-contrôleur, qui doit s'afficher lorsque l'utilisateur quitte la page de contenu actuelle. La télécommande miniature permet d'accéder instantanément à la session Cast en cours et de la voir.

Le framework Cast fournit une barre de contrôle, GCKUIMiniMediaControlsViewController, qui peut être ajoutée aux scènes dans lesquelles vous souhaitez afficher le mini-lecteur.

Lorsque votre application émettrice lit une diffusion en direct vidéo ou audio, le SDK affiche automatiquement un bouton de lecture/arrêt à la place du bouton de lecture/pause dans le mini-lecteur.

Consultez Personnaliser l'UI de l'émetteur iOS pour découvrir comment votre application émettrice peut configurer l'apparence des widgets Cast.

Il existe deux façons d'ajouter le mini-contrôleur à une application émettrice :

  • Laissez le framework Cast gérer la mise en page du mini-contrôleur en encapsulant votre contrôleur de vue existant avec son propre contrôleur de vue.
  • Gérez vous-même la mise en page du widget de mini-contrôleur en l'ajoutant à votre contrôleur de vue existant en fournissant une sous-vue dans le storyboard.

Encapsuler à l'aide de GCKUICastContainerViewController

La première consiste à utiliser GCKUICastContainerViewController, qui encapsule un autre contrôleur de vue et ajoute un GCKUIMiniMediaControlsViewController en bas. Cette approche est limitée, car vous ne pouvez pas personnaliser l'animation ni configurer le comportement du contrôleur de vue de conteneur.

Cette première méthode est généralement utilisée dans la méthode -[application:didFinishLaunchingWithOptions:] du délégué d'application :

Swift
func applicationDidFinishLaunching(_ application: UIApplication) {
  ...

  // Wrap main view in the GCKUICastContainerViewController and display the mini controller.
  let appStoryboard = UIStoryboard(name: "Main", bundle: nil)
  let navigationController = appStoryboard.instantiateViewController(withIdentifier: "MainNavigation")
  let castContainerVC =
          GCKCastContext.sharedInstance().createCastContainerController(for: navigationController)
  castContainerVC.miniMediaControlsItemEnabled = true
  window = UIWindow(frame: UIScreen.main.bounds)
  window!.rootViewController = castContainerVC
  window!.makeKeyAndVisible()

  ...
}
Objective-C
- (BOOL)application:(UIApplication *)application
        didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  ...

  // Wrap main view in the GCKUICastContainerViewController and display the mini controller.
  UIStoryboard *appStoryboard = [UIStoryboard storyboardWithName:@"Main" bundle:nil];
  UINavigationController *navigationController =
          [appStoryboard instantiateViewControllerWithIdentifier:@"MainNavigation"];
  GCKUICastContainerViewController *castContainerVC =
          [[GCKCastContext sharedInstance] createCastContainerControllerForViewController:navigationController];
  castContainerVC.miniMediaControlsItemEnabled = YES;
  self.window = [[UIWindow alloc] initWithFrame:UIScreen.mainScreen.bounds];
  self.window.rootViewController = castContainerVC;
  [self.window makeKeyAndVisible];
  ...

}
Swift
var castControlBarsEnabled: Bool {
  set(enabled) {
    if let castContainerVC = self.window?.rootViewController as? GCKUICastContainerViewController {
      castContainerVC.miniMediaControlsItemEnabled = enabled
    } else {
      print("GCKUICastContainerViewController is not correctly configured")
    }
  }
  get {
    if let castContainerVC = self.window?.rootViewController as? GCKUICastContainerViewController {
      return castContainerVC.miniMediaControlsItemEnabled
    } else {
      print("GCKUICastContainerViewController is not correctly configured")
      return false
    }
  }
}
Objective-C

AppDelegate.h

@interface AppDelegate : UIResponder <UIApplicationDelegate>

@property (nonatomic, strong) UIWindow *window;
@property (nonatomic, assign) BOOL castControlBarsEnabled;

@end

AppDelegate.m

@implementation AppDelegate

...

- (void)setCastControlBarsEnabled:(BOOL)notificationsEnabled {
  GCKUICastContainerViewController *castContainerVC;
  castContainerVC =
      (GCKUICastContainerViewController *)self.window.rootViewController;
  castContainerVC.miniMediaControlsItemEnabled = notificationsEnabled;
}

- (BOOL)castControlBarsEnabled {
  GCKUICastContainerViewController *castContainerVC;
  castContainerVC =
      (GCKUICastContainerViewController *)self.window.rootViewController;
  return castContainerVC.miniMediaControlsItemEnabled;
}

...

@end

Intégrer dans un contrôleur de vue existant

La deuxième méthode consiste à ajouter le mini-lecteur directement à votre contrôleur de vue existant en utilisant createMiniMediaControlsViewController pour créer une instance GCKUIMiniMediaControlsViewController, puis en l'ajoutant au contrôleur de vue du conteneur en tant que sous-vue.

Configurez votre contrôleur de vue dans le délégué d'application :

Swift
func application(_ application: UIApplication,
                 didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
  ...

  GCKCastContext.sharedInstance().useDefaultExpandedMediaControls = true
  window?.clipsToBounds = true

  let rootContainerVC = (window?.rootViewController as? RootContainerViewController)
  rootContainerVC?.miniMediaControlsViewEnabled = true

  ...

  return true
}
Objective-C
- (BOOL)application:(UIApplication *)application
    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  ...

  [GCKCastContext sharedInstance].useDefaultExpandedMediaControls = YES;

  self.window.clipsToBounds = YES;

  RootContainerViewController *rootContainerVC;
  rootContainerVC =
      (RootContainerViewController *)self.window.rootViewController;
  rootContainerVC.miniMediaControlsViewEnabled = YES;

  ...

  return YES;
}

Dans votre contrôleur de vue racine, créez une instance GCKUIMiniMediaControlsViewController et ajoutez-la au contrôleur de vue conteneur en tant que sous-vue :

Swift
let kCastControlBarsAnimationDuration: TimeInterval = 0.20

@objc(RootContainerViewController)
class RootContainerViewController: UIViewController, GCKUIMiniMediaControlsViewControllerDelegate {
  @IBOutlet weak private var _miniMediaControlsContainerView: UIView!
  @IBOutlet weak private var _miniMediaControlsHeightConstraint: NSLayoutConstraint!
  private var miniMediaControlsViewController: GCKUIMiniMediaControlsViewController!
  var miniMediaControlsViewEnabled = false {
    didSet {
      if self.isViewLoaded {
        self.updateControlBarsVisibility()
      }
    }
  }

  var overriddenNavigationController: UINavigationController?

  override var navigationController: UINavigationController? {

    get {
      return overriddenNavigationController
    }

    set {
      overriddenNavigationController = newValue
    }
  }
  var miniMediaControlsItemEnabled = false

  override func viewDidLoad() {
    super.viewDidLoad()
    let castContext = GCKCastContext.sharedInstance()
    self.miniMediaControlsViewController = castContext.createMiniMediaControlsViewController()
    self.miniMediaControlsViewController.delegate = self
    self.updateControlBarsVisibility()
    self.installViewController(self.miniMediaControlsViewController,
                               inContainerView: self._miniMediaControlsContainerView)
  }

  func updateControlBarsVisibility() {
    if self.miniMediaControlsViewEnabled && self.miniMediaControlsViewController.active {
      self._miniMediaControlsHeightConstraint.constant = self.miniMediaControlsViewController.minHeight
      self.view.bringSubview(toFront: self._miniMediaControlsContainerView)
    } else {
      self._miniMediaControlsHeightConstraint.constant = 0
    }
    UIView.animate(withDuration: kCastControlBarsAnimationDuration, animations: {() -> Void in
      self.view.layoutIfNeeded()
    })
    self.view.setNeedsLayout()
  }

  func installViewController(_ viewController: UIViewController?, inContainerView containerView: UIView) {
    if let viewController = viewController {
      self.addChildViewController(viewController)
      viewController.view.frame = containerView.bounds
      containerView.addSubview(viewController.view)
      viewController.didMove(toParentViewController: self)
    }
  }

  func uninstallViewController(_ viewController: UIViewController) {
    viewController.willMove(toParentViewController: nil)
    viewController.view.removeFromSuperview()
    viewController.removeFromParentViewController()
  }

  override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
    if segue.identifier == "NavigationVCEmbedSegue" {
      self.navigationController = (segue.destination as? UINavigationController)
    }
  }

...
Objective-C

RootContainerViewController.h

static const NSTimeInterval kCastControlBarsAnimationDuration = 0.20;

@interface RootContainerViewController () <GCKUIMiniMediaControlsViewControllerDelegate> {
  __weak IBOutlet UIView *_miniMediaControlsContainerView;
  __weak IBOutlet NSLayoutConstraint *_miniMediaControlsHeightConstraint;
  GCKUIMiniMediaControlsViewController *_miniMediaControlsViewController;
}

@property(nonatomic, weak, readwrite) UINavigationController *navigationController;

@property(nonatomic, assign, readwrite) BOOL miniMediaControlsViewEnabled;
@property(nonatomic, assign, readwrite) BOOL miniMediaControlsItemEnabled;

@end

RootContainerViewController.m

@implementation RootContainerViewController

- (void)viewDidLoad {
  [super viewDidLoad];
  GCKCastContext *castContext = [GCKCastContext sharedInstance];
  _miniMediaControlsViewController =
      [castContext createMiniMediaControlsViewController];
  _miniMediaControlsViewController.delegate = self;

  [self updateControlBarsVisibility];
  [self installViewController:_miniMediaControlsViewController
              inContainerView:_miniMediaControlsContainerView];
}

- (void)setMiniMediaControlsViewEnabled:(BOOL)miniMediaControlsViewEnabled {
  _miniMediaControlsViewEnabled = miniMediaControlsViewEnabled;
  if (self.isViewLoaded) {
    [self updateControlBarsVisibility];
  }
}

- (void)updateControlBarsVisibility {
  if (self.miniMediaControlsViewEnabled &&
      _miniMediaControlsViewController.active) {
    _miniMediaControlsHeightConstraint.constant =
        _miniMediaControlsViewController.minHeight;
    [self.view bringSubviewToFront:_miniMediaControlsContainerView];
  } else {
    _miniMediaControlsHeightConstraint.constant = 0;
  }
  [UIView animateWithDuration:kCastControlBarsAnimationDuration
                   animations:^{
                     [self.view layoutIfNeeded];
                   }];
  [self.view setNeedsLayout];
}

- (void)installViewController:(UIViewController *)viewController
              inContainerView:(UIView *)containerView {
  if (viewController) {
    [self addChildViewController:viewController];
    viewController.view.frame = containerView.bounds;
    [containerView addSubview:viewController.view];
    [viewController didMoveToParentViewController:self];
  }
}

- (void)uninstallViewController:(UIViewController *)viewController {
  [viewController willMoveToParentViewController:nil];
  [viewController.view removeFromSuperview];
  [viewController removeFromParentViewController];
}

- (void)prepareForSegue:(UIStoryboardSegue *)segue sender:(id)sender {
  if ([segue.identifier isEqualToString:@"NavigationVCEmbedSegue"]) {
    self.navigationController =
        (UINavigationController *)segue.destinationViewController;
  }
}

...

@end

GCKUIMiniMediaControlsViewControllerDelegate indique au contrôleur de vue hôte quand le mini-lecteur doit être visible :

Swift
  func miniMediaControlsViewController(_: GCKUIMiniMediaControlsViewController,
                                       shouldAppear _: Bool) {
    updateControlBarsVisibility()
  }
Objective-C
- (void)miniMediaControlsViewController:
            (GCKUIMiniMediaControlsViewController *)miniMediaControlsViewController
                           shouldAppear:(BOOL)shouldAppear {
  [self updateControlBarsVisibility];
}

Ajouter un contrôleur étendu

La checklist de conception Google Cast exige qu'une application émettrice fournisse un contrôleur étendu pour le contenu multimédia casté. Le lecteur étendu est une version plein écran du lecteur réduit.

Le contrôleur étendu est une vue en plein écran qui offre un contrôle total de la lecture multimédia à distance. Cette vue doit permettre à une application Cast de gérer tous les aspects gérables d'une session Cast, à l'exception du contrôle du volume Web Receiver et du cycle de vie de la session (connexion/arrêt de la diffusion). Il fournit également toutes les informations d'état sur la session multimédia (illustration, titre, sous-titre, etc.).

La fonctionnalité de cette vue est implémentée par la classe GCKUIExpandedMediaControlsViewController.

La première chose à faire est d'activer le contrôleur étendu par défaut dans le contexte Cast. Modifiez le délégué d'application pour activer le contrôleur développé par défaut :

Swift
func applicationDidFinishLaunching(_ application: UIApplication) {
  ..

  GCKCastContext.sharedInstance().useDefaultExpandedMediaControls = true

  ...
}
Objective-C
- (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  ...

  [GCKCastContext sharedInstance].useDefaultExpandedMediaControls = YES;

  ..
}

Ajoutez le code suivant à votre contrôleur de vue pour charger le contrôleur étendu lorsque l'utilisateur commence à caster une vidéo :

Swift
func playSelectedItemRemotely() {
  GCKCastContext.sharedInstance().presentDefaultExpandedMediaControls()

  ...

  // Load your media
  sessionManager.currentSession?.remoteMediaClient?.loadMedia(mediaInformation)
}
Objective-C
- (void)playSelectedItemRemotely {
  [[GCKCastContext sharedInstance] presentDefaultExpandedMediaControls];

  ...

  // Load your media
  [self.sessionManager.currentSession.remoteMediaClient loadMedia:mediaInformation];
}

Le contrôleur étendu se lance également automatiquement lorsque l'utilisateur appuie sur le contrôleur réduit.

Lorsque votre application émettrice lit une diffusion en direct vidéo ou audio, le SDK affiche automatiquement un bouton de lecture/arrêt à la place du bouton de lecture/pause dans le contrôleur étendu.

Consultez Appliquer des styles personnalisés à votre application iOS pour découvrir comment votre application émettrice peut configurer l'apparence des widgets Cast.

Réglage du volume

Le framework Cast gère automatiquement le volume de l'application émettrice. Il se synchronise automatiquement avec le volume du récepteur Web pour les widgets d'UI fournis. Pour synchroniser un curseur fourni par l'application, utilisez GCKUIDeviceVolumeController.

Contrôle du volume avec les boutons physiques

Les boutons physiques de volume sur l'appareil émetteur peuvent être utilisés pour modifier le volume de la session Cast sur le Web Receiver à l'aide du flag physicalVolumeButtonsWillControlDeviceVolume sur GCKCastOptions, qui est défini sur GCKCastContext.

Swift
let criteria = GCKDiscoveryCriteria(applicationID: kReceiverAppID)
let options = GCKCastOptions(discoveryCriteria: criteria)
options.physicalVolumeButtonsWillControlDeviceVolume = true
GCKCastContext.setSharedInstanceWith(options)
Objective-C
GCKDiscoveryCriteria *criteria = [[GCKDiscoveryCriteria alloc]
                                          initWithApplicationID:kReceiverAppID];
GCKCastOptions *options = [[GCKCastOptions alloc]
                                          initWithDiscoveryCriteria :criteria];
options.physicalVolumeButtonsWillControlDeviceVolume = YES;
[GCKCastContext setSharedInstanceWithOptions:options];

Gérer les erreurs

Il est très important que les applications émettrices gèrent tous les rappels d'erreur et décident de la meilleure réponse pour chaque étape du cycle de vie Cast. L'application peut afficher des boîtes de dialogue d'erreur à l'utilisateur ou décider de mettre fin à la session Cast.

Notez que certaines erreurs, y compris l'erreur GCKErrorCode GCKErrorCodeCancelled, sont des comportements prévus.

N'essayez pas de rétablir une connexion qui a échoué avec GCKErrorCodeCancelled. Cela peut entraîner un comportement inattendu.

Journalisation

GCKLogger est un singleton utilisé pour la journalisation par le framework. Utilisez GCKLoggerDelegate pour personnaliser la façon dont vous gérez les messages de journaux.

À l'aide de GCKLogger, le SDK génère des journaux sous forme de messages de débogage, d'erreurs et d'avertissements. Ces messages de journalisation facilitent le débogage et sont utiles pour résoudre les problèmes et les identifier. Par défaut, la sortie du journal est supprimée, mais en attribuant un GCKLoggerDelegate, l'application émettrice peut recevoir ces messages du SDK et les consigner dans la console système.

Swift
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate, GCKLoggerDelegate {
  let kReceiverAppID = kGCKDefaultMediaReceiverApplicationID
  let kDebugLoggingEnabled = true

  var window: UIWindow?

  func applicationDidFinishLaunching(_ application: UIApplication) {
    ...

    // Enable logger.
    GCKLogger.sharedInstance().delegate = self

    ...
  }

  // MARK: - GCKLoggerDelegate

  func logMessage(_ message: String,
                  at level: GCKLoggerLevel,
                  fromFunction function: String,
                  location: String) {
    if (kDebugLoggingEnabled) {
      print(function + " - " + message)
    }
  }
}
Objective-C

AppDelegate.h

@interface AppDelegate () <GCKLoggerDelegate>
@end

AppDelegate.m

@implementation AppDelegate

static NSString *const kReceiverAppID = @"AABBCCDD";
static const BOOL kDebugLoggingEnabled = YES;

- (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  ...

  // Enable logger.
  [GCKLogger sharedInstance].delegate = self;

  ...

  return YES;
}

...

#pragma mark - GCKLoggerDelegate

- (void)logMessage:(NSString *)message
           atLevel:(GCKLoggerLevel)level
      fromFunction:(NSString *)function
          location:(NSString *)location {
  if (kDebugLoggingEnabled) {
    NSLog(@"%@ - %@, %@", function, message, location);
  }
}

@end

Pour activer également les messages de débogage et détaillés, ajoutez cette ligne au code après avoir défini le délégué (comme indiqué précédemment) :

Swift
let filter = GCKLoggerFilter.init()
filter.minimumLevel = GCKLoggerLevel.verbose
GCKLogger.sharedInstance().filter = filter
Objective-C
GCKLoggerFilter *filter = [[GCKLoggerFilter alloc] init];
[filter setMinimumLevel:GCKLoggerLevelVerbose];
[GCKLogger sharedInstance].filter = filter;

Vous pouvez également filtrer les messages de journal générés par GCKLogger. Définissez le niveau de journalisation minimal par classe, par exemple :

Swift
let filter = GCKLoggerFilter.init()
filter.setLoggingLevel(GCKLoggerLevel.verbose, forClasses: ["GCKUICastButton",
                                                            "GCKUIImageCache",
                                                            "NSMutableDictionary"])
GCKLogger.sharedInstance().filter = filter
Objective-C
GCKLoggerFilter *filter = [[GCKLoggerFilter alloc] init];
[filter setLoggingLevel:GCKLoggerLevelVerbose
             forClasses:@[@"GCKUICastButton",
                          @"GCKUIImageCache",
                          @"NSMutableDictionary"
                          ]];
[GCKLogger sharedInstance].filter = filter;

Les noms de classe peuvent être des noms littéraux ou des modèles globaux, par exemple GCKUI\* et GCK\*Session.

Précédent
Autorisations et visibilité sur iOS
Suivant
Personnaliser l'interface utilisateur