Premiers pas

Pour les cas d'utilisation simples, la prise en main de ExoPlayer consiste à implémenter les étapes suivantes:

  1. Ajoutez ExoPlayer en tant que dépendance à votre projet.
  2. Créez une instance ExoPlayer.
  3. Associez le lecteur à une vue (pour la sortie vidéo et l'entrée utilisateur).
  4. Préparez le joueur avec un MediaItem pour jouer.
  5. Relâchez le lecteur lorsque vous avez terminé.

Ces étapes sont décrites plus en détail ci-dessous. Pour obtenir un exemple complet, consultez PlayerActivity dans l'application de démonstration principale.

Ajouter ExoPlayer comme dépendance

Ajouter des modules ExoPlayer

Le moyen le plus simple de commencer à utiliser AndroidX Media3 consiste à ajouter des dépendances Gradle aux bibliothèques dont vous avez besoin dans le fichier build.gradle de votre module d'application.

Par exemple, pour dépendre d'ExoPlayer avec la prise en charge de la lecture DASH et des composants d'UI, vous pouvez ajouter des dépendances sur les modules comme suit:

Kotlin

implementation("androidx.media3:media3-exoplayer:1.4.1")
implementation("androidx.media3:media3-exoplayer-dash:1.4.1")
implementation("androidx.media3:media3-ui:1.4.1")

Groovy

implementation "androidx.media3:media3-exoplayer:1.4.1"
implementation "androidx.media3:media3-exoplayer-dash:1.4.1"
implementation "androidx.media3:media3-ui:1.4.1"

où la version 1.4.1 est votre version préférée (la dernière version est disponible dans les notes de version). Tous les modules doivent être de la même version.

AndroidX Media3 dispose de modules de bibliothèque qui dépendent de bibliothèques externes pour fournir des fonctionnalités supplémentaires. Certains sont disponibles dans le dépôt Maven, tandis que d'autres doivent être compilés manuellement. Pour en savoir plus, consultez le répertoire des bibliothèques et les fichiers README individuels.

Pour en savoir plus sur les modules de bibliothèque disponibles, consultez la page Google Maven AndroidX Media.

Activer la prise en charge de Java 8

Si ce n'est pas déjà fait, vous devez activer la compatibilité avec Java 8 dans tous les fichiers build.gradle qui dépendent d'ExoPlayer en ajoutant les éléments suivants à la section android:

compileOptions {
  targetCompatibility JavaVersion.VERSION_1_8
}

Activer multidex

Si votre minSdkVersion Gradle est inférieure ou égale à 20, vous devez activer multidex pour éviter les erreurs de compilation.

Créer le lecteur

Vous pouvez créer une instance ExoPlayer à l'aide de ExoPlayer.Builder, qui propose une gamme d'options de personnalisation. Le code suivant est l'exemple le plus simple de création d'une instance.

Kotlin

val player = ExoPlayer.Builder(context).build()

Java

ExoPlayer player = new ExoPlayer.Builder(context).build();

Remarque concernant les threads

Les instances ExoPlayer doivent être accessibles à partir d'un seul thread d'application. Dans la grande majorité des cas, il doit s'agir du thread principal de l'application. L'utilisation du thread principal de l'application est obligatoire lorsque vous utilisez les composants d'interface utilisateur d'ExoPlayer ou l'extension IMA.

Le thread sur lequel une instance ExoPlayer doit être accessible peut être spécifié explicitement en transmettant un Looper lors de la création du lecteur. Si aucun Looper n'est spécifié, le Looper du thread sur lequel le lecteur est créé est utilisé. Si ce thread ne comporte pas de Looper, le Looper du thread principal de l'application est utilisé. Dans tous les cas, le Looper du thread à partir duquel le lecteur doit être accessible peut être interrogé à l'aide de Player.getApplicationLooper.

Pour en savoir plus sur le modèle de threads d'ExoPlayer, consultez la section "Modèle de threads" de la documentation Javadoc d'ExoPlayer.

Associer le lecteur à une vue

La bibliothèque ExoPlayer fournit une gamme de composants d'interface utilisateur prédéfinis pour la lecture multimédia. Il s'agit de PlayerView, qui encapsule un PlayerControlView, un SubtitleView et un Surface sur lesquels la vidéo est affichée. Un PlayerView peut être inclus dans le fichier XML de mise en page de votre application. Par exemple, pour lier le lecteur à la vue:

Kotlin

// Bind the player to the view.
playerView.player = player

Java

// Bind the player to the view.
playerView.setPlayer(player);

Vous pouvez également utiliser PlayerControlView en tant que composant autonome, ce qui est utile pour les cas d'utilisation audio uniquement.

L'utilisation des composants d'UI prédéfinis d'ExoPlayer est facultative. Pour les applications vidéo qui implémentent leur propre interface utilisateur, les SurfaceView, TextureView, SurfaceHolder ou Surface cibles peuvent être définis respectivement à l'aide des méthodes setVideoSurfaceView, setVideoTextureView, setVideoSurfaceHolder et setVideoSurface d'ExoPlayer. La méthode addTextOutput d'ExoPlayer peut être utilisée pour recevoir les sous-titres à afficher pendant la lecture.

Remplir la playlist et préparer le lecteur

Dans ExoPlayer, chaque élément multimédia est représenté par un MediaItem. Pour lire un contenu multimédia, vous devez créer un élément MediaItem correspondant, l'ajouter au lecteur, le préparer et appeler play pour lancer la lecture:

Kotlin

// Build the media item.
val mediaItem = MediaItem.fromUri(videoUri)
// Set the media item to be played.
player.setMediaItem(mediaItem)
// Prepare the player.
player.prepare()
// Start the playback.
player.play()

Java

// Build the media item.
MediaItem mediaItem = MediaItem.fromUri(videoUri);
// Set the media item to be played.
player.setMediaItem(mediaItem);
// Prepare the player.
player.prepare();
// Start the playback.
player.play();

ExoPlayer est directement compatible avec les playlists. Il est donc possible de préparer le lecteur avec plusieurs éléments multimédias à lire l'un après l'autre:

Kotlin

// Build the media items.
val firstItem = MediaItem.fromUri(firstVideoUri)
val secondItem = MediaItem.fromUri(secondVideoUri)
// Add the media items to be played.
player.addMediaItem(firstItem)
player.addMediaItem(secondItem)
// Prepare the player.
player.prepare()
// Start the playback.
player.play()

Java

// Build the media items.
MediaItem firstItem = MediaItem.fromUri(firstVideoUri);
MediaItem secondItem = MediaItem.fromUri(secondVideoUri);
// Add the media items to be played.
player.addMediaItem(firstItem);
player.addMediaItem(secondItem);
// Prepare the player.
player.prepare();
// Start the playback.
player.play();

La playlist peut être mise à jour pendant la lecture sans avoir à préparer à nouveau le lecteur. Pour en savoir plus sur le remplissage et la manipulation de la playlist, consultez la page Playlists. Pour en savoir plus sur les différentes options disponibles lors de la création d'éléments multimédias, comme le découpage et l'ajout de fichiers de sous-titres, consultez la page Éléments multimédias.

Contrôler le lecteur

Une fois le lecteur préparé, la lecture peut être contrôlée en appelant des méthodes sur le lecteur. Voici quelques-unes des méthodes les plus couramment utilisées:

  • play et pause permettent de lancer et de mettre en pause la lecture.
  • seekTo permet de rechercher dans le contenu multimédia.
  • hasPrevious, hasNext, previous et next permettent de parcourir la playlist.
  • setRepeatMode contrôle si les contenus multimédias sont en boucle et comment.
  • setShuffleModeEnabled contrôle le mélange des titres de la playlist.
  • setPlaybackParameters ajuste la vitesse de lecture et le ton audio.

Si le lecteur est associé à un PlayerView ou à un PlayerControlView, l'interaction de l'utilisateur avec ces composants entraîne l'appel des méthodes correspondantes sur le lecteur.

Libérer le lecteur

Il est important de libérer le lecteur lorsqu'il n'est plus nécessaire, afin de libérer des ressources limitées telles que les décodeurs vidéo pour les utiliser par d'autres applications. Pour ce faire, appelez ExoPlayer.release.