Ce guide du développeur explique comment rendre votre application émettrice Android compatible avec Google Cast à l'aide du SDK Android Sender.
L'appareil mobile ou l'ordinateur portable sont 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'émetteur. L'application émettrice ou l'application Cast fait référence à une application exécutée également sur l'émetteur. L'application Web Receiver fait référence à l'application HTML exécutée sur l'appareil compatible Cast.
Le framework de l'émetteur utilise une conception de rappel asynchrone pour informer l'application émettrice des événements et passer d'un état à l'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 de haut niveau typique pour une application Android émettrice:
- Le framework Cast lance automatiquement la détection de l'appareil
MediaRouteren fonction du cycle de vieActivity. - Lorsque l'utilisateur clique sur l'icône Cast, le framework affiche 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 vérifier que l'application Web Receiver a été lancée.
- Le framework crée un canal de communication entre l'application émettrice et l'application Web Receiver.
- Le framework utilise le canal de communication pour charger et contrôler la lecture de contenus multimédias sur le récepteur Web.
- Le framework synchronise l'état de la lecture des contenus multimédias entre l'émetteur et le récepteur Web: lorsque l'utilisateur effectue des actions dans l'UI de l'émetteur, le framework transmet ces requêtes de contrôle multimédia au récepteur Web, et lorsque celui-ci envoie des mises à jour de l'état des contenus multimédias, le framework met à jour l'état de l'UI de l'émetteur.
- 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 récepteur Web.
Pour obtenir la liste complète des classes, des méthodes et des événements du SDK Android Google Cast, consultez la documentation de référence de l'API Google Cast Sender pour Android. Les sections suivantes décrivent la procédure à suivre pour ajouter Cast à votre application Android.
Configurer le fichier manifeste Android
Le fichier AndroidManifest.xml de votre application nécessite que vous configuriez les éléments suivants pour le SDK Cast:
uses-sdk
Définissez les niveaux d'API Android minimaux et cibles compatibles avec le SDK Cast. Actuellement, la valeur minimale est le niveau d'API 21 et la cible est le niveau d'API 28.
<uses-sdk
android:minSdkVersion="21"
android:targetSdkVersion="28" />
android:theme
Définissez le thème de votre application en fonction de la version minimale du SDK Android. Par exemple, si vous n'implémentez pas votre propre thème, vous devez utiliser une variante de Theme.AppCompat lorsque vous ciblez une version minimale du SDK Android antérieure à Lollipop.
<application
android:icon="@drawable/ic_launcher"
android:label="@string/app_name"
android:theme="@style/Theme.AppCompat" >
...
</application>
Initialiser le contexte Cast
Le framework dispose d'un objet singleton global, CastContext, qui coordonne toutes ses interactions.
Votre application doit implémenter l'interface OptionsProvider pour fournir les options nécessaires à l'initialisation du Singleton CastContext. OptionsProvider fournit une instance de CastOptions qui contient des options affectant le comportement du framework. Le plus important d'entre eux est l'ID d'application Web Receiver, qui permet de filtrer les résultats de détection et de lancer l'application Web Receiver lorsqu'une session Cast est lancée.
class CastOptionsProvider : OptionsProvider {
override fun getCastOptions(context: Context): CastOptions {
return Builder()
.setReceiverApplicationId(context.getString(R.string.app_id))
.build()
}
override fun getAdditionalSessionProviders(context: Context): List<SessionProvider>? {
return null
}
}
public class CastOptionsProvider implements OptionsProvider {
@Override
public CastOptions getCastOptions(Context context) {
CastOptions castOptions = new CastOptions.Builder()
.setReceiverApplicationId(context.getString(R.string.app_id))
.build();
return castOptions;
}
@Override
public List<SessionProvider> getAdditionalSessionProviders(Context context) {
return null;
}
}
Vous devez déclarer le nom complet du OptionsProvider implémenté en tant que champ de métadonnées dans le fichier AndroidManifest.xml de l'application émettrice:
<application>
...
<meta-data
android:name=
"com.google.android.gms.cast.framework.OPTIONS_PROVIDER_CLASS_NAME"
android:value="com.foo.CastOptionsProvider" />
</application>
CastContext est initialisé en différé lors de l'appel de CastContext.getSharedInstance().
class MyActivity : FragmentActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
val castContext = CastContext.getSharedInstance(this)
}
}
public class MyActivity extends FragmentActivity {
@Override
public void onCreate(Bundle savedInstanceState) {
CastContext castContext = CastContext.getSharedInstance(this);
}
}
Widgets de l'expérience utilisateur Cast
Le framework Cast fournit les widgets conformes à la checklist de conception Cast:
Superposition d'introduction : le framework fournit une vue personnalisée,
IntroductoryOverlay, qui est présentée à l'utilisateur pour attirer l'attention sur l'icône Cast la première fois qu'un récepteur est disponible. L'application Sender peut personnaliser le texte et la position du texte du titre.Bouton Cast : l'icône Cast est visible lorsqu'un récepteur compatible avec votre application est détecté. Lorsque l'utilisateur clique pour la première fois sur l'icône Cast, une boîte de dialogue Cast s'affiche et répertorie les appareils détectés. Lorsque l'utilisateur clique sur l'icône 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 vignette) s'affichent ou permettent à l'utilisateur de se déconnecter de l'appareil Cast.
Mini-télécommande : lorsque l'utilisateur caste du contenu et qu'il a quitté la page de contenu actuelle ou la télécommande agrandie pour passer à un autre écran de l'application émettrice, la mini-télécommande s'affiche en bas de l'écran pour permettre à l'utilisateur de voir les métadonnées multimédias en cours de diffusion et de contrôler la lecture.
Manette agrandie : lorsque l'utilisateur caste du contenu et clique sur la notification multimédia ou la mini-télécommande, celle-ci se lance. Elle affiche les métadonnées multimédias en cours de lecture et fournit plusieurs boutons pour contrôler la lecture.
Notification : Android uniquement. Lorsque l'utilisateur caste du contenu et quitte l'application émettrice, une notification multimédia s'affiche. Elle indique les métadonnées et les commandes de lecture en cours de diffusion.
Écran de verrouillage : Android uniquement. Lorsque l'utilisateur caste du contenu et accède à l'écran de verrouillage (ou que l'appareil expire), une commande d'écran de verrouillage multimédia s'affiche. Elle indique les métadonnées multimédias et les commandes de lecture en cours de diffusion.
Le guide suivant explique comment ajouter ces widgets à votre application.
Ajouter une icône Cast
Les API MediaRouter Android sont conçues pour permettre l'affichage et la lecture de contenus multimédias sur des appareils secondaires.
Les applications Android qui utilisent l'API MediaRouter doivent inclure une icône Cast dans leur interface utilisateur afin de permettre aux utilisateurs de sélectionner une route multimédia pour lire des contenus multimédias sur un appareil secondaire, tel qu'un appareil Cast.
Le framework facilite l'ajout d'un MediaRouteButton en tant que Cast button. Vous devez d'abord ajouter un élément de menu ou un élément MediaRouteButton dans le fichier XML qui définit votre menu, puis utiliser CastButtonFactory pour le connecter au framework.
// To add a Cast button, add the following snippet.
// menu.xml
<item
android:id="@+id/media_route_menu_item"
android:title="@string/media_route_menu_title"
app:actionProviderClass="androidx.mediarouter.app.MediaRouteActionProvider"
app:showAsAction="always" />
// Then override the onCreateOptionMenu() for each of your activities.
// MyActivity.kt
override fun onCreateOptionsMenu(menu: Menu): Boolean {
super.onCreateOptionsMenu(menu)
menuInflater.inflate(R.menu.main, menu)
CastButtonFactory.setUpMediaRouteButton(
applicationContext,
menu,
R.id.media_route_menu_item
)
return true
}
// Then override the onCreateOptionMenu() for each of your activities.
// MyActivity.java
@Override public boolean onCreateOptionsMenu(Menu menu) {
super.onCreateOptionsMenu(menu);
getMenuInflater().inflate(R.menu.main, menu);
CastButtonFactory.setUpMediaRouteButton(getApplicationContext(),
menu,
R.id.media_route_menu_item);
return true;
}
Ensuite, si votre Activity hérite de FragmentActivity, vous pouvez ajouter un MediaRouteButton à votre mise en page.
// activity_layout.xml
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:gravity="center_vertical"
android:orientation="horizontal" >
<androidx.mediarouter.app.MediaRouteButton
android:id="@+id/media_route_button"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_weight="1"
android:mediaRouteTypes="user"
android:visibility="gone" />
</LinearLayout>
// MyActivity.kt
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_layout)
mMediaRouteButton = findViewById<View>(R.id.media_route_button) as MediaRouteButton
CastButtonFactory.setUpMediaRouteButton(applicationContext, mMediaRouteButton)
mCastContext = CastContext.getSharedInstance(this)
}
// MyActivity.java
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_layout);
mMediaRouteButton = (MediaRouteButton) findViewById(R.id.media_route_button);
CastButtonFactory.setUpMediaRouteButton(getApplicationContext(), mMediaRouteButton);
mCastContext = CastContext.getSharedInstance(this);
}
Pour définir l'apparence de l'icône Cast à l'aide d'un thème, consultez la section Personnaliser l'icône Cast.
Configurer la détection d'appareils
La détection d'appareils est entièrement gérée par CastContext.
Lors de l'initialisation de CastContext, l'application émettrice spécifie l'ID d'application Web Receiver et peut éventuellement demander un filtrage des espaces de noms en définissant supportedNamespaces dans CastOptions.
CastContext contient une référence à MediaRouter en interne et lance le processus de découverte lorsque l'application émettrice passe au premier plan et s'arrête lorsque l'application émettrice passe en arrière-plan.
class CastOptionsProvider : OptionsProvider {
companion object {
const val CUSTOM_NAMESPACE = "urn:x-cast:custom_namespace"
}
override fun getCastOptions(appContext: Context): CastOptions {
val supportedNamespaces: MutableList<String> = ArrayList()
supportedNamespaces.add(CUSTOM_NAMESPACE)
return CastOptions.Builder()
.setReceiverApplicationId(context.getString(R.string.app_id))
.setSupportedNamespaces(supportedNamespaces)
.build()
}
override fun getAdditionalSessionProviders(context: Context): List<SessionProvider>? {
return null
}
}
class CastOptionsProvider implements OptionsProvider {
public static final String CUSTOM_NAMESPACE = "urn:x-cast:custom_namespace";
@Override
public CastOptions getCastOptions(Context appContext) {
List<String> supportedNamespaces = new ArrayList<>();
supportedNamespaces.add(CUSTOM_NAMESPACE);
CastOptions castOptions = new CastOptions.Builder()
.setReceiverApplicationId(context.getString(R.string.app_id))
.setSupportedNamespaces(supportedNamespaces)
.build();
return castOptions;
}
@Override
public List<SessionProvider> getAdditionalSessionProviders(Context context) {
return null;
}
}
Fonctionnement de la gestion des sessions
Le SDK Cast introduit le concept d'une session Cast, qui consiste à se connecter à un appareil, à lancer (ou à rejoindre) une application de récepteur Web, à se connecter à cette application et à initialiser un canal de commande multimédia. Pour en savoir plus sur les sessions Cast et le cycle de vie de Web Receiver, consultez le guide du cycle de vie des applications de Web Receiver.
Les sessions sont gérées par la classe SessionManager à laquelle votre application peut accéder via CastContext.getSessionManager().
Les sessions individuelles sont représentées par des sous-classes de la classe Session.
Par exemple, CastSession représente les sessions avec des appareils Cast. Votre application peut accéder à la session Cast actuellement active via SessionManager.getCurrentCastSession().
Votre application peut utiliser la classe SessionManagerListener pour surveiller les événements de session, tels que la création, la suspension, la reprise et l'arrêt. Le framework tente automatiquement de reprendre après un arrêt anormal/brusque alors qu'une session était active.
Les sessions sont créées et détruites automatiquement en réponse aux gestes de l'utilisateur à partir des boîtes de dialogue MediaRouter.
Pour mieux comprendre les erreurs de démarrage de Cast, les applications peuvent utiliser CastContext#getCastReasonCodeForCastStatusCode(int) afin de convertir l'erreur de démarrage de session en CastReasonCodes.
Veuillez noter que certaines erreurs de démarrage de session (telles que CastReasonCodes#CAST_CANCELLED) sont intentionnelles et ne doivent pas être consignées en tant qu'erreur.
Si vous devez être informé des changements d'état de la session, vous pouvez implémenter un SessionManagerListener. Cet exemple écoute la disponibilité d'un élément CastSession dans un élément Activity.
class MyActivity : Activity() {
private var mCastSession: CastSession? = null
private lateinit var mCastContext: CastContext
private lateinit var mSessionManager: SessionManager
private val mSessionManagerListener: SessionManagerListener<CastSession> =
SessionManagerListenerImpl()
private inner class SessionManagerListenerImpl : SessionManagerListener<CastSession?> {
override fun onSessionStarting(session: CastSession?) {}
override fun onSessionStarted(session: CastSession?, sessionId: String) {
invalidateOptionsMenu()
}
override fun onSessionStartFailed(session: CastSession?, error: Int) {
val castReasonCode = mCastContext.getCastReasonCodeForCastStatusCode(error)
// Handle error
}
override fun onSessionSuspended(session: CastSession?, reason Int) {}
override fun onSessionResuming(session: CastSession?, sessionId: String) {}
override fun onSessionResumed(session: CastSession?, wasSuspended: Boolean) {
invalidateOptionsMenu()
}
override fun onSessionResumeFailed(session: CastSession?, error: Int) {}
override fun onSessionEnding(session: CastSession?) {}
override fun onSessionEnded(session: CastSession?, error: Int) {
finish()
}
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
mCastContext = CastContext.getSharedInstance(this)
mSessionManager = mCastContext.sessionManager
}
override fun onResume() {
super.onResume()
mCastSession = mSessionManager.currentCastSession
mSessionManager.addSessionManagerListener(mSessionManagerListener, CastSession::class.java)
}
override fun onPause() {
super.onPause()
mSessionManager.removeSessionManagerListener(mSessionManagerListener, CastSession::class.java)
mCastSession = null
}
}
public class MyActivity extends Activity {
private CastContext mCastContext;
private CastSession mCastSession;
private SessionManager mSessionManager;
private SessionManagerListener<CastSession> mSessionManagerListener =
new SessionManagerListenerImpl();
private class SessionManagerListenerImpl implements SessionManagerListener<CastSession> {
@Override
public void onSessionStarting(CastSession session) {}
@Override
public void onSessionStarted(CastSession session, String sessionId) {
invalidateOptionsMenu();
}
@Override
public void onSessionStartFailed(CastSession session, int error) {
int castReasonCode = mCastContext.getCastReasonCodeForCastStatusCode(error);
// Handle error
}
@Override
public void onSessionSuspended(CastSession session, int reason) {}
@Override
public void onSessionResuming(CastSession session, String sessionId) {}
@Override
public void onSessionResumed(CastSession session, boolean wasSuspended) {
invalidateOptionsMenu();
}
@Override
public void onSessionResumeFailed(CastSession session, int error) {}
@Override
public void onSessionEnding(CastSession session) {}
@Override
public void onSessionEnded(CastSession session, int error) {
finish();
}
}
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
mCastContext = CastContext.getSharedInstance(this);
mSessionManager = mCastContext.getSessionManager();
}
@Override
protected void onResume() {
super.onResume();
mCastSession = mSessionManager.getCurrentCastSession();
mSessionManager.addSessionManagerListener(mSessionManagerListener, CastSession.class);
}
@Override
protected void onPause() {
super.onPause();
mSessionManager.removeSessionManagerListener(mSessionManagerListener, CastSession.class);
mCastSession = null;
}
}
Transfert de diffusion
La conservation de l'état de la session est la base du transfert de flux, qui permet aux utilisateurs de transférer des flux audio et vidéo existants d'un appareil à l'autre à l'aide de commandes vocales, de l'application Google Home ou d'écrans connectés. La lecture du contenu multimédia s'arrête sur un appareil (la source) et se poursuit sur un autre (la destination). Tout appareil Cast équipé du dernier micrologiciel peut servir de sources ou de destinations lors d'un transfert de flux.
Pour obtenir le nouvel appareil de destination lors d'un transfert ou d'une extension de flux, enregistrez un Cast.Listener à l'aide de CastSession#addCastListener.
Appelez ensuite CastSession#getCastDevice() lors du rappel onDeviceNameChanged.
Pour en savoir plus, consultez la section Transfert de flux sur Web Receiver.
Reconnexion automatique
Le framework fournit un ReconnectionService que l'application émettrice peut activer pour gérer la reconnexion dans de nombreux cas subtils, tels que:
- Se remettre d'une perte temporaire de connexion Wi-Fi
- Se remettre du mode veille de l'appareil
- Récupérer l'application après l'avoir mise en arrière-plan
- Récupérer si l'application a planté
Ce service est activé par défaut et peut être désactivé dans CastOptions.Builder.
Ce service peut être fusionné automatiquement avec le fichier manifeste de votre application si la fusion automatique est activée dans votre fichier Gradle.
Le framework démarre le service lorsqu'il existe une session multimédia et l'arrête à la fin de celle-ci.
Fonctionnement des commandes multimédias
Le framework Cast abandonne la classe RemoteMediaPlayer de Cast 2.x au profit d'une nouvelle classe RemoteMediaClient, qui fournit la même fonctionnalité dans un ensemble d'API plus pratiques et évite de devoir transmettre un GoogleApiClient.
Lorsque votre application établit un CastSession avec une application de récepteur Web compatible avec l'espace de noms multimédia, le framework crée automatiquement une instance de RemoteMediaClient. Votre application peut y accéder en appelant la méthode getRemoteMediaClient() sur l'instance CastSession.
Toutes les méthodes de RemoteMediaClient qui envoient des requêtes au récepteur Web renvoient un objet PendingResult permettant de suivre cette requête.
Il est normal que l'instance de RemoteMediaClient soit partagée par plusieurs parties de votre application, ainsi que par certains composants internes du framework, tels que les mini-contrôleurs persistants et le service de notification.
À cette fin, cette instance accepte l'enregistrement de plusieurs instances de RemoteMediaClient.Listener.
Définir les métadonnées multimédias
La classe MediaMetadata représente les informations sur un élément multimédia que vous souhaitez caster. L'exemple suivant crée une instance MediaMetadata d'un film et définit le titre, le sous-titre et deux images.
val movieMetadata = MediaMetadata(MediaMetadata.MEDIA_TYPE_MOVIE) movieMetadata.putString(MediaMetadata.KEY_TITLE, mSelectedMedia.getTitle()) movieMetadata.putString(MediaMetadata.KEY_SUBTITLE, mSelectedMedia.getStudio()) movieMetadata.addImage(WebImage(Uri.parse(mSelectedMedia.getImage(0)))) movieMetadata.addImage(WebImage(Uri.parse(mSelectedMedia.getImage(1))))
MediaMetadata movieMetadata = new MediaMetadata(MediaMetadata.MEDIA_TYPE_MOVIE); movieMetadata.putString(MediaMetadata.KEY_TITLE, mSelectedMedia.getTitle()); movieMetadata.putString(MediaMetadata.KEY_SUBTITLE, mSelectedMedia.getStudio()); movieMetadata.addImage(new WebImage(Uri.parse(mSelectedMedia.getImage(0)))); movieMetadata.addImage(new WebImage(Uri.parse(mSelectedMedia.getImage(1))));
Consultez la section Sélection d'images pour découvrir comment utiliser des images avec des métadonnées multimédias.
Charger du contenu multimédia
Votre application peut charger un élément multimédia, comme indiqué dans le code suivant. Utilisez d'abord MediaInfo.Builder avec les métadonnées du contenu multimédia pour créer une instance MediaInfo. Récupérez le RemoteMediaClient à partir du CastSession actuel, puis chargez le MediaInfo dans cet RemoteMediaClient. Utilisez RemoteMediaClient pour lire, mettre en pause et contrôler une application de lecteur multimédia exécutée sur le récepteur Web.
val mediaInfo = MediaInfo.Builder(mSelectedMedia.getUrl())
.setStreamType(MediaInfo.STREAM_TYPE_BUFFERED)
.setContentType("videos/mp4")
.setMetadata(movieMetadata)
.setStreamDuration(mSelectedMedia.getDuration() * 1000)
.build()
val remoteMediaClient = mCastSession.getRemoteMediaClient()
remoteMediaClient.load(MediaLoadRequestData.Builder().setMediaInfo(mediaInfo).build())
MediaInfo mediaInfo = new MediaInfo.Builder(mSelectedMedia.getUrl())
.setStreamType(MediaInfo.STREAM_TYPE_BUFFERED)
.setContentType("videos/mp4")
.setMetadata(movieMetadata)
.setStreamDuration(mSelectedMedia.getDuration() * 1000)
.build();
RemoteMediaClient remoteMediaClient = mCastSession.getRemoteMediaClient();
remoteMediaClient.load(new MediaLoadRequestData.Builder().setMediaInfo(mediaInfo).build());
Consultez également la section sur l'utilisation des pistes multimédias.
Format vidéo 4K
Pour vérifier le format vidéo de votre contenu multimédia, utilisez getVideoInfo() dans MediaStatus pour obtenir l'instance actuelle de VideoInfo.
Cette instance contient le type de format de téléviseur HDR, ainsi que la hauteur et la largeur d'affichage en pixels. Les variantes du format 4K sont indiquées par les constantes HDR_TYPE_*.
Contrôlez les notifications à distance sur plusieurs appareils
Lorsqu'un utilisateur caste un contenu, les autres appareils Android du même réseau reçoivent une notification les invitant à contrôler la lecture. Toute personne dont l'appareil reçoit ces notifications peut les désactiver pour cet appareil dans l'application Paramètres sous Google > Google Cast > Afficher les notifications de la télécommande. Les notifications incluent un raccourci vers l'application Paramètres. Pour en savoir plus, consultez la section Notifications de la télécommande Cast.
Ajouter une mini-télécommande
Conformément à la checklist de conception de Google Cast, une application émettrice doit fournir une commande persistante appelée mini-contrôleur, qui doit s'afficher lorsque l'utilisateur quitte la page de contenu actuelle et accède à une autre partie de l'application émettrice. La mini-télécommande envoie un rappel visible à l'utilisateur de la session Cast actuelle. En appuyant sur la mini-télécommande, l'utilisateur peut revenir à la vue agrandie de la manette de diffusion en plein écran.
Le framework fournit une vue personnalisée, MiniControllerFragment, que vous pouvez ajouter en bas du fichier de mise en page de chaque activité dans laquelle vous souhaitez afficher la mini-télécommande.
<fragment
android:id="@+id/castMiniController"
android:layout_width="fill_parent"
android:layout_height="wrap_content"
android:layout_alignParentBottom="true"
android:visibility="gone"
class="com.google.android.gms.cast.framework.media.widget.MiniControllerFragment" />
Lorsque l'application émettrice lit un flux vidéo ou audio en direct, le SDK affiche automatiquement un bouton de lecture/arrêt à la place de celui-ci dans la mini-télécommande.
Pour définir l'apparence du texte du titre et du sous-titre de cette vue personnalisée et choisir les boutons, consultez Personnaliser la mini-télécommande.
Ajouter une manette agrandie
La checklist de conception de Google Cast exige que l'application émettrice soit dotée d'une télécommande agrandie pour le contenu multimédia en cours de diffusion. La manette agrandie est une version plein écran de la mini-télécommande.
Le SDK Cast fournit un widget pour la télécommande agrandie, appelé ExpandedControllerActivity.
Il s'agit d'une classe abstraite que vous devez sous-classer pour ajouter une icône Cast.
Commencez par créer un fichier de ressources de menu pour la manette développée afin de fournir l'icône Cast:
<menu xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto">
<item
android:id="@+id/media_route_menu_item"
android:title="@string/media_route_menu_title"
app:actionProviderClass="androidx.mediarouter.app.MediaRouteActionProvider"
app:showAsAction="always"/>
</menu>
Créez une classe qui étend ExpandedControllerActivity.
class ExpandedControlsActivity : ExpandedControllerActivity() {
override fun onCreateOptionsMenu(menu: Menu): Boolean {
super.onCreateOptionsMenu(menu)
menuInflater.inflate(R.menu.expanded_controller, menu)
CastButtonFactory.setUpMediaRouteButton(this, menu, R.id.media_route_menu_item)
return true
}
}
public class ExpandedControlsActivity extends ExpandedControllerActivity {
@Override
public boolean onCreateOptionsMenu(Menu menu) {
super.onCreateOptionsMenu(menu);
getMenuInflater().inflate(R.menu.expanded_controller, menu);
CastButtonFactory.setUpMediaRouteButton(this, menu, R.id.media_route_menu_item);
return true;
}
}
Déclarez maintenant votre nouvelle activité dans le fichier manifeste de l'application au sein de la balise application:
<application>
...
<activity
android:name=".expandedcontrols.ExpandedControlsActivity"
android:label="@string/app_name"
android:launchMode="singleTask"
android:theme="@style/Theme.CastVideosDark"
android:screenOrientation="portrait"
android:parentActivityName="com.google.sample.cast.refplayer.VideoBrowserActivity">
<intent-filter>
<action android:name="android.intent.action.MAIN"/>
</intent-filter>
</activity>
...
</application>
Modifiez CastOptionsProvider, puis NotificationOptions et CastMediaOptions pour définir l'activité cible sur votre nouvelle activité:
override fun getCastOptions(context: Context): CastOptions? {
val notificationOptions = NotificationOptions.Builder()
.setTargetActivityClassName(ExpandedControlsActivity::class.java.name)
.build()
val mediaOptions = CastMediaOptions.Builder()
.setNotificationOptions(notificationOptions)
.setExpandedControllerActivityClassName(ExpandedControlsActivity::class.java.name)
.build()
return CastOptions.Builder()
.setReceiverApplicationId(context.getString(R.string.app_id))
.setCastMediaOptions(mediaOptions)
.build()
}
public CastOptions getCastOptions(Context context) {
NotificationOptions notificationOptions = new NotificationOptions.Builder()
.setTargetActivityClassName(ExpandedControlsActivity.class.getName())
.build();
CastMediaOptions mediaOptions = new CastMediaOptions.Builder()
.setNotificationOptions(notificationOptions)
.setExpandedControllerActivityClassName(ExpandedControlsActivity.class.getName())
.build();
return new CastOptions.Builder()
.setReceiverApplicationId(context.getString(R.string.app_id))
.setCastMediaOptions(mediaOptions)
.build();
}
Mettez à jour la méthode loadRemoteMedia de LocalPlayerActivity pour afficher votre nouvelle activité lorsque le contenu multimédia à distance est chargé:
private fun loadRemoteMedia(position: Int, autoPlay: Boolean) {
val remoteMediaClient = mCastSession?.remoteMediaClient ?: return
remoteMediaClient.registerCallback(object : RemoteMediaClient.Callback() {
override fun onStatusUpdated() {
val intent = Intent(this@LocalPlayerActivity, ExpandedControlsActivity::class.java)
startActivity(intent)
remoteMediaClient.unregisterCallback(this)
}
})
remoteMediaClient.load(
MediaLoadRequestData.Builder()
.setMediaInfo(mSelectedMedia)
.setAutoplay(autoPlay)
.setCurrentTime(position.toLong()).build()
)
}
private void loadRemoteMedia(int position, boolean autoPlay) {
if (mCastSession == null) {
return;
}
final RemoteMediaClient remoteMediaClient = mCastSession.getRemoteMediaClient();
if (remoteMediaClient == null) {
return;
}
remoteMediaClient.registerCallback(new RemoteMediaClient.Callback() {
@Override
public void onStatusUpdated() {
Intent intent = new Intent(LocalPlayerActivity.this, ExpandedControlsActivity.class);
startActivity(intent);
remoteMediaClient.unregisterCallback(this);
}
});
remoteMediaClient.load(new MediaLoadRequestData.Builder()
.setMediaInfo(mSelectedMedia)
.setAutoplay(autoPlay)
.setCurrentTime(position).build());
}
Lorsque l'application émettrice lit un flux vidéo ou audio en direct, le SDK affiche automatiquement un bouton de lecture/arrêt à la place de celui-ci dans la manette agrandie.
Pour définir l'apparence à l'aide de thèmes, choisissez les boutons à afficher et ajoutez des boutons personnalisés. Consultez Personnaliser le contrôleur développé.
Contrôle du volume
Le framework gère automatiquement le volume pour l'application émettrice. Il synchronise automatiquement les applications de l'émetteur et du récepteur Web afin que l'UI de l'émetteur signale toujours le volume spécifié par le récepteur Web.
Contrôle du volume du bouton physique
Sur Android, les boutons physiques de l'appareil émetteur peuvent être utilisés pour modifier par défaut le volume de la session Cast sur le récepteur Web sur tous les appareils utilisant Jelly Bean ou version ultérieure.
Contrôle du volume du bouton physique avant Jelly Bean
Pour contrôler le volume du récepteur Web sur les appareils Android antérieurs à Jelly Bean à l'aide des boutons de volume physiques, l'application émettrice doit ignorer dispatchKeyEvent dans ses activités et appeler CastContext.onDispatchVolumeKeyEventBeforeJellyBean():
class MyActivity : FragmentActivity() {
override fun dispatchKeyEvent(event: KeyEvent): Boolean {
return (CastContext.getSharedInstance(this)
.onDispatchVolumeKeyEventBeforeJellyBean(event)
|| super.dispatchKeyEvent(event))
}
}
class MyActivity extends FragmentActivity {
@Override
public boolean dispatchKeyEvent(KeyEvent event) {
return CastContext.getSharedInstance(this)
.onDispatchVolumeKeyEventBeforeJellyBean(event)
|| super.dispatchKeyEvent(event);
}
}
Ajouter des commandes multimédias aux notifications et à l'écran de verrouillage
Sur Android uniquement, la checklist de conception de Google Cast exige qu'une application émettrice implémente des commandes multimédias dans une notification et sur l'écran de verrouillage, lorsque l'expéditeur diffuse du contenu, mais n'est pas sélectionné par l'application émettrice. Le framework fournit MediaNotificationService et MediaIntentReceiver pour aider l'application émettrice à créer des commandes multimédias dans une notification et sur l'écran de verrouillage.
MediaNotificationService s'exécute lorsque l'émetteur diffuse du contenu et affiche une notification contenant une vignette de l'image et des informations sur l'élément en cours de diffusion, un bouton de lecture/pause et un bouton d'arrêt.
MediaIntentReceiver est un BroadcastReceiver qui gère les actions de l'utilisateur à partir de la notification.
Votre application peut configurer les notifications et le contrôle des contenus multimédias depuis l'écran de verrouillage via NotificationOptions.
Votre application peut configurer les boutons de commande à afficher dans la notification et le Activity à ouvrir lorsque l'utilisateur appuie sur la notification. Si les actions ne sont pas explicitement fournies, les valeurs par défaut (MediaIntentReceiver.ACTION_TOGGLE_PLAYBACK et MediaIntentReceiver.ACTION_STOP_CASTING) sont utilisées.
// Example showing 4 buttons: "rewind", "play/pause", "forward" and "stop casting".
val buttonActions: MutableList<String> = ArrayList()
buttonActions.add(MediaIntentReceiver.ACTION_REWIND)
buttonActions.add(MediaIntentReceiver.ACTION_TOGGLE_PLAYBACK)
buttonActions.add(MediaIntentReceiver.ACTION_FORWARD)
buttonActions.add(MediaIntentReceiver.ACTION_STOP_CASTING)
// Showing "play/pause" and "stop casting" in the compat view of the notification.
val compatButtonActionsIndices = intArrayOf(1, 3)
// Builds a notification with the above actions. Each tap on the "rewind" and "forward" buttons skips 30 seconds.
// Tapping on the notification opens an Activity with class VideoBrowserActivity.
val notificationOptions = NotificationOptions.Builder()
.setActions(buttonActions, compatButtonActionsIndices)
.setSkipStepMs(30 * DateUtils.SECOND_IN_MILLIS)
.setTargetActivityClassName(VideoBrowserActivity::class.java.name)
.build()
// Example showing 4 buttons: "rewind", "play/pause", "forward" and "stop casting".
List<String> buttonActions = new ArrayList<>();
buttonActions.add(MediaIntentReceiver.ACTION_REWIND);
buttonActions.add(MediaIntentReceiver.ACTION_TOGGLE_PLAYBACK);
buttonActions.add(MediaIntentReceiver.ACTION_FORWARD);
buttonActions.add(MediaIntentReceiver.ACTION_STOP_CASTING);
// Showing "play/pause" and "stop casting" in the compat view of the notification.
int[] compatButtonActionsIndices = new int[]{1, 3};
// Builds a notification with the above actions. Each tap on the "rewind" and "forward" buttons skips 30 seconds.
// Tapping on the notification opens an Activity with class VideoBrowserActivity.
NotificationOptions notificationOptions = new NotificationOptions.Builder()
.setActions(buttonActions, compatButtonActionsIndices)
.setSkipStepMs(30 * DateUtils.SECOND_IN_MILLIS)
.setTargetActivityClassName(VideoBrowserActivity.class.getName())
.build();
L'affichage des commandes multimédias à partir des notifications et de l'écran de verrouillage est activé par défaut. Vous pouvez le désactiver en appelant setNotificationOptions avec une valeur nulle dans CastMediaOptions.Builder.
Actuellement, la fonctionnalité d'écran de verrouillage est activée tant que les notifications sont activées.
// ... continue with the NotificationOptions built above
val mediaOptions = CastMediaOptions.Builder()
.setNotificationOptions(notificationOptions)
.build()
val castOptions: CastOptions = Builder()
.setReceiverApplicationId(context.getString(R.string.app_id))
.setCastMediaOptions(mediaOptions)
.build()
// ... continue with the NotificationOptions built above
CastMediaOptions mediaOptions = new CastMediaOptions.Builder()
.setNotificationOptions(notificationOptions)
.build();
CastOptions castOptions = new CastOptions.Builder()
.setReceiverApplicationId(context.getString(R.string.app_id))
.setCastMediaOptions(mediaOptions)
.build();
Lorsque l'application émettrice lit un flux vidéo ou audio en direct, le SDK affiche automatiquement un bouton de lecture/d'arrêt à la place de celui-ci sur la commande de notification, mais pas sur la commande de l'écran de verrouillage.
Remarque: Pour afficher les commandes de l'écran de verrouillage sur les appareils antérieurs à Lollipop, RemoteMediaClient demande automatiquement la sélection audio à votre place.
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 ou décider d'interrompre la connexion au récepteur Web.