La procédure suivante vous permet de convertir votre application émettrice Android de la version 2 du SDK Cast en expéditeur CAF, qui est basé sur le Singleton CastContext.
Le SDK Cast CAF Sender utilise CastContext pour gérer le client GoogleAPIClient en votre nom. CastContext gère les cycles de vie, les erreurs et les rappels à votre place, ce qui simplifie considérablement le développement d'une application Cast.
Introduction
- L'expéditeur CAF est toujours distribué avec les services Google Play à l'aide d'Android SDK Manager
- De nouveaux packages ont été ajoutés pour assurer la conformité avec la checklist de conception Google Cast (
com.google.android.gms.cast.framework.*). - CAF Sender fournit des widgets conformes aux exigences de l'expérience utilisateur Cast. La version 2 ne fournissait aucun composant d'interface utilisateur et vous obligeait à implémenter ces widgets.
- L'utilisation de GoogleApiClient n'est plus nécessaire pour utiliser l'API Cast.
- Le sous-titrage dans CAF Sender est semblable à celui de la version 2.
Dépendances
Les versions 2 et CAF dépendent des mêmes dépendances entre les bibliothèques Support et les services Google Play (9.2.0 ou version ultérieure), comme décrit dans le Guide des fonctionnalités de la bibliothèque Support.
La version minimale du SDK Android compatible avec CAF est la version 9 (Gingerbread).
Initialisation
Dans CAF, une étape d'initialisation explicite est requise pour le framework Cast. Cela implique d'initialiser le singleton CastContext à l'aide d'un OptionsProvider approprié pour spécifier l'ID application du récepteur Web et toute autre option globale.
public class CastOptionsProvider implements OptionsProvider {
@Override
public CastOptions getCastOptions(Context context) {
return new CastOptions.Builder()
.setReceiverApplicationId(context.getString(R.string.app_id))
.build();
}
@Override
public List<SessionProvider> getAdditionalSessionProviders(Context context) {
return null;
}
}
Déclarez OptionsProvider dans le tag "application" du fichier AndroidManifest.xml de l'application:
<application>
...
<meta-data
android:name=
"com.google.android.gms.cast.framework.OPTIONS_PROVIDER_CLASS_NAME"
android:value="com.google.sample.cast.refplayer.CastOptionsProvider" />
</application>
Initialisez de manière différée CastContext dans la méthode onCreate de chaque activité:
private CastContext mCastContext;
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.video_browser);
setupActionBar();
mCastContext = CastContext.getSharedInstance(this);
}
Ces étapes n'étaient pas nécessaires dans la version 2.
Détection d'appareils
Dans CAF, le processus de découverte est lancé et arrêté automatiquement par le framework lorsque l'application passe au premier plan et passe en arrière-plan, respectivement. MediaRouteSelector et MediaRouter.Callback ne doivent pas être utilisés.
Icône Cast et boîte de dialogue "Caster"
Comme dans la version 2, ces composants sont fournis par la bibliothèque Support MediaRouter.
L'icône Cast est toujours implémentée par l'MediaRouteButton et peut être ajoutée à votre activité (à l'aide d'un ActionBar ou d'un Toolbar), en tant qu'élément de menu dans votre menu.
<item
android:id="@+id/media_route_menu_item"
android:title="@string/media_route_menu_title"
app:actionProviderClass="android.support.v7.app.MediaRouteActionProvider"
app:showAsAction="always"/>
Remplacez la méthode onCreateOptionMenu() de chaque activité en utilisant CastButtonFactory pour connecter MediaRouteButton au framework Cast:
private MenuItem mediaRouteMenuItem;
public boolean onCreateOptionsMenu(Menu menu) {
super.onCreateOptionsMenu(menu);
getMenuInflater().inflate(R.menu.browse, menu);
mediaRouteMenuItem =
CastButtonFactory.setUpMediaRouteButton(getApplicationContext(),
menu,
R.id.media_route_menu_item);
return true;
}
Lorsque quelqu'un appuie sur le bouton, la boîte de dialogue "Caster" s'affiche automatiquement.
Contrôle des appareils
Dans CAF, le contrôle des appareils est en grande partie géré par le framework. L'application émettrice n'a pas besoin de gérer (et ne doit pas essayer de gérer) la connexion à l'appareil ni le lancement de l'application Web Receiver à l'aide de GoogleApiClient. L'interaction entre l'expéditeur et le récepteur Web est désormais représentée sous la forme d'une "session". La classe SessionManager gère le cycle de vie de la session, et démarre et arrête automatiquement les sessions en réponse aux gestes de l'utilisateur: une session démarre lorsque l'utilisateur sélectionne un appareil Cast dans la boîte de dialogue Cast et s'arrête lorsqu'il appuie sur le bouton "Arrêter la diffusion" dans la boîte de dialogue ou lorsque l'application émettrice s'arrête. L'application émettrice peut être informée des événements de cycle de vie d'une session en enregistrant un SessionManagerListener avec SessionManager. Les rappels SessionManagerListener définissent des méthodes de rappel pour tous les événements de cycle de vie de la session.
La classe CastSession représente une session avec un appareil Cast. La classe comporte des méthodes permettant de contrôler le volume de l'appareil et l'état de désactivation du son, ce qui était auparavant effectué dans la version 2 à l'aide de méthodes sur Cast.CastApi.
Dans la version 2, les rappels Cast.Listener fournissaient des notifications concernant les changements d'état de l'appareil, y compris le volume, l'état de désactivation du son, l'état de veille, etc.
Dans CAF, les notifications de changement d'état du volume ou du son sont toujours envoyées via des méthodes de rappel dans Cast.Listener. Ces écouteurs sont enregistrés avec CastSession.
Toutes les notifications d'état d'appareil restantes sont envoyées via des rappels CastStateListener. Ces écouteurs sont enregistrés avec CastSession. Veillez à toujours annuler l'enregistrement des écouteurs lorsque les fragments, les activités ou les applications associés passent en arrière-plan.
Logique de reconnexion
Comme dans la version 2, CAF tente de rétablir les connexions réseau qui sont perdues en raison d'une perte temporaire du signal Wi-Fi ou d'autres erreurs réseau. Cette opération s'effectue désormais au niveau de la session. Une session peut passer à l'état "suspendue" lorsque la connexion est perdue, puis revenir à l'état "connecté" lorsque la connectivité est restaurée. Dans le cadre de ce processus, le framework se charge de se reconnecter à l'application Web Receiver et à reconnecter toutes les chaînes Cast.
En outre, CAF ajoute également la reprise de session automatique, qui est activée par défaut (et peut être désactivée via CastOptions).
Si l'application émettrice est envoyée en arrière-plan ou est arrêtée (par balayage ou en raison d'un plantage) pendant qu'une session Cast est en cours, le framework tente de la reprendre lorsque l'application émettrice revient au premier plan ou est redémarrée. Cette opération est gérée automatiquement par SessionManager, qui émet les rappels appropriés sur toutes les instances SessionManagerListener enregistrées.
Enregistrement d'un critère personnalisé
Dans la version 2, les critères personnalisés (implémentés à l'aide de Cast.MessageReceivedCallback) sont enregistrés avec Cast.CastApi. Dans CAF, les critères personnalisés sont enregistrés avec l'instance CastSession. L'enregistrement peut être effectué à l'aide de la méthode de rappel SessionManagerListener.onSessionStarted. Pour les applications multimédias, il n'est plus nécessaire d'enregistrer explicitement le canal de commande multimédia via Cast.CastApi.setMessageReceivedCallbacks. Consultez la section suivante pour en savoir plus.
Commande multimédia
La classe v2 RemoteMediaPlayer est obsolète et ne doit pas être utilisée. Dans CAF, elle est remplacée par la nouvelle classe RemoteMediaClient, qui fournit des fonctionnalités équivalentes dans une API plus pratique. Il n'est pas nécessaire d'initialiser ni d'enregistrer explicitement cet objet. Le framework instancie automatiquement l'objet et enregistre le canal multimédia sous-jacent au début de la session si l'application Web Receiver est connectée à l'espace de noms multimédia.
RemoteMediaClient est accessible en tant que méthode getRemoteMediaClient de l'objet CastSession.
Dans la version 2, toutes les requêtes média émises sur RemoteMediaPlayer renvoyaient un RemoteMediaPlayer.MediaChannelResult via un rappel PendingResult.
Dans CAF, toutes les requêtes média émises sur RemoteMediaClient renvoient un RemoteMediaClient.MediaChannelResult via un rappel PendingResult qui peut être utilisé pour suivre la progression et le résultat final de la requête.
Dans la version 2, RemoteMediaPlayer envoie des notifications concernant les modifications de l'état du lecteur multimédia sur Web Receiver via RemoteMediaPlayer.OnStatusUpdatedListener.
Dans CAF, RemoteMediaClient fournit des rappels équivalents via son interface RemoteMediaClient.Listener. N'importe quel nombre d'écouteurs peut être enregistré auprès de RemoteMediaClient, ce qui permet à plusieurs composants expéditeurs de partager l'instance unique de RemoteMediaClient associée à la session.
Dans la version 2, l'application émettrice devait assurer la synchronisation de l'interface utilisateur avec l'état du lecteur multimédia sur Web Receiver.
Dans CAF, la classe UIMediaController assume l'essentiel de cette responsabilité.
Message d'annonce en superposition
La version 2 ne fournit pas d'interface utilisateur en superposition d'introduction.
CAF fournit une vue personnalisée IntroductoryOverlay pour mettre en surbrillance l'icône Cast lorsqu'elle s'affiche pour la première fois auprès des utilisateurs.
Mini-télécommande
Dans la version 2, vous devez implémenter une mini-télécommande à partir de zéro dans l'application émettrice.
Dans CAF, le SDK fournit une vue personnalisée, MiniControllerFragment, que vous pouvez ajouter au fichier de mise en page de l'application des activités dans lesquelles vous souhaitez afficher la mini-télécommande.
Notifications et écran de verrouillage
Dans la version 2, les contrôleurs de notification et de verrouillage de l'écran ne sont pas fournis par le SDK. Pour ce SDK, vous devez intégrer ces fonctionnalités dans votre application émettrice à l'aide des API du framework Android.
Dans CAF, le SDK fournit un NotificationsOptions.Builder pour vous aider à créer des commandes multimédias pour les notifications et l'écran de verrouillage dans l'application émettrice. Les commandes de notification et d'écran de verrouillage peuvent être activées avec CastOptions lors de l'initialisation de CastContext.
public CastOptions getCastOptions(Context context) {
NotificationOptions notificationOptions = new NotificationOptions.Builder()
.setTargetActivityClassName(VideoBrowserActivity.class.getName())
.build();
CastMediaOptions mediaOptions = new CastMediaOptions.Builder()
.setNotificationOptions(notificationOptions)
.build();
return new CastOptions.Builder()
.setReceiverApplicationId(context.getString(R.string.app_id))
.setCastMediaOptions(mediaOptions)
.build();
}
Télécommande agrandie
Dans la version 2, vous devez implémenter un contrôleur étendu à partir de zéro dans l'application émettrice.
CAF fournit une classe d'assistance UIMediaController qui vous permet de créer facilement votre propre manette agrandie.
CAF ajoute un widget de contrôleur étendu prédéfini ExpandedControllerActivity que vous pouvez simplement ajouter à votre application. Vous n'avez plus besoin d'implémenter un contrôleur étendu personnalisé à l'aide de UIMediaController.
Priorité audio
Dans la version 2, vous devez utiliser MediaSessionCompat pour gérer la priorité audio.
Dans CAF, la priorité audio est gérée automatiquement.
Consignation des données de débogage
Il n'existe aucune option de journalisation dans CAF.
Exemples d'applications
Nous proposons des tutoriels d'atelier de programmation et des exemples d'applications qui utilisent CAF.