Premiers pas avec l'extension IMA d'ExoPlayer

ExoPlayer est un lecteur multimédia au niveau de l'application pour Android. Ce guide explique comment utiliser l'extension IMA d'ExoPlayer, qui encapsule le SDK DAI IMA, pour demander et lire un flux multimédia contenant à la fois des annonces et du contenu.

Voici quelques-uns des avantages de cette extension:

  • Simplifie le code nécessaire pour intégrer IMA aux fonctionnalités.
  • Réduit le temps de développement nécessaire pour passer aux nouvelles versions d'IMA.

L'extension IMA d'ExoPlayer est compatible avec les protocoles de streaming HLS et DASH. Voici un récapitulatif:

Prise en charge du streaming de l'extension ExoPlayer-IMA
Diffusion en direct Flux VOD
HLS Coche Coche
DASH Coche Coche

Les diffusions en direct DASH sont compatibles avec ExoPlayer-IMA version 1.1.0 ou ultérieure.

Ce guide est basé sur le guide ExoPlayer et explique comment créer une application complète et intégrer l'extension. Consultez ExoPlayerExample sur GitHub pour voir un exemple d'application complète.

Prérequis

Créer un projet Android Studio

Pour créer votre projet Android Studio, procédez comme suit:

  • Lancez Android Studio.
  • Sélectionnez Start a new Android Studio project (Démarrer un nouveau projet Android Studio).
  • Sur la page Choose your project (Choisir votre projet), sélectionnez le modèle No Activity (Aucune activité).
  • Cliquez sur Suivant.
  • Sur la page Configurer votre projet, nommez votre projet et sélectionnez Java comme langage.

  • Cliquez sur Terminer.

Ajouter l'extension IMA d'ExoPlayer à votre projet

Ajoutez des importations pour l'extension au fichier build.gradle au niveau de l'application dans la section dependencies.

Configurez votre application et activez le multidex. Cela est nécessaire en raison de la taille de l'extension et est obligatoire pour les applications dont minSdkVersion est défini sur Android 4.4W (niveau d'API 20) ou version antérieure.

Exemple :

app/build.gradle

android {

  ...

  defaultConfig {
      applicationId "com.google.ads.interactivemedia.v3.samples.videoplayerapp"
      minSdkVersion 21
      targetSdkVersion 34
      multiDexEnabled true
      versionCode 1
      versionName "1.0"
  }

    ...
}
dependencies {
    implementation 'androidx.multidex:multidex:2.0.1'
    implementation 'androidx.media3:media3-ui:1.1.1'
    implementation 'androidx.media3:media3-exoplayer:1.1.1'
    implementation 'androidx.media3:media3-exoplayer-hls:1.1.1'
    implementation 'androidx.media3:media3-exoplayer-dash:1.1.1'

    // Adding the ExoPlayer IMA extension for ads will also include the IMA
    // SDK as a dependency.
    implementation 'androidx.media3:media3-exoplayer-ima:1.1.1'
}

Ajoutez les autorisations utilisateur requises par le SDK DAI IMA pour demander des annonces:

app/src/main/AndroidManifest.xml

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.project name">

    <!-- Required permissions for the IMA DAI SDK -->
    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

    ...

</manifest>

Ajouter des déclarations d'intent

Si votre application cible Android 11 (niveau d'API 30) ou une version ultérieure, les versions actuelles et récentes du SDK IMA DAI nécessitent une déclaration explicite d'intention d'ouvrir des liens Web. Ajoutez l'extrait de code suivant au fichier manifeste de votre application pour activer les clics sur les annonces (les utilisateurs cliquent sur le bouton En savoir plus).

  <?xml version="1.0" encoding="utf-8"?>
  <manifest xmlns:android="http://schemas.android.com/apk/res/android"
      package="com.example.project name">

      ...

    </application>

    <queries>
      <intent>
          <action android:name="android.intent.action.VIEW" />
          <data android:scheme="https" />
      </intent>
      <intent>
          <action android:name="android.intent.action.VIEW" />
          <data android:scheme="http" />
      </intent>
    </queries>
  </manifest>

Configurer l'UI d'ExoPlayer

Créez l'objet PlayerView à utiliser par ExoPlayer.

Remplacez androidx.constraintlayout.widget.ConstraintLayout par LinearLayout, ce qui est recommandé pour l'extension IMA d'ExoPlayer.

Exemple :

app/src/main/res/layout/activity_my.xml

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:background="@android:color/black"
    android:id="@+id/container"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    tools:context=".MyActivity"
    tools:ignore="MergeRootFrame">

    <androidx.media3.ui.PlayerView
        android:id="@+id/player_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />

</LinearLayout>

Ajouter vos paramètres de flux

Consultez la page d'exemples de flux IMA pour obtenir des exemples d'assets de flux à utiliser pour tester votre projet. Consultez également la section Ad Manager sur la publicité dynamique pour savoir comment configurer vos propres flux.

Cette étape montre comment configurer un flux en direct, mais l'extension IMA d'ExoPlayer est également compatible avec les flux VOD DAI. Consultez l'étape pour les flux vidéo à la demande (VOD) pour connaître les modifications que votre application doit apporter pour gérer les flux VOD.

Importer l'extension IMA d'ExoPlayer

Ajoutez les instructions d'importation pour l'extension ExoPlayer.

Ajoutez les variables privées suivantes à MyActivity.java:

Ajoutez la clé d'élément du flux HLS Big Buck Bunny (Live) pour tester ce flux. D'autres flux sont disponibles à des fins de test sur la page d'exemples de flux de l'IMA.

Créez une constante KEY_ADS_LOADER_STATE pour enregistrer et récupérer l'état AdsLoader.

Exemple :

app/src/main/java/com/example/project name/MyActivity.java


import static androidx.media3.common.C.CONTENT_TYPE_HLS;

import android.app.Activity;
import android.net.Uri;
import android.os.Bundle;
import androidx.annotation.Nullable;
import androidx.annotation.OptIn;
import androidx.media3.common.MediaItem;
import androidx.media3.common.util.Util;
import androidx.media3.datasource.DataSource;
import androidx.media3.datasource.DefaultDataSource;
import androidx.media3.exoplayer.ExoPlayer;
import androidx.media3.exoplayer.ima.ImaServerSideAdInsertionMediaSource;
import androidx.media3.exoplayer.ima.ImaServerSideAdInsertionUriBuilder;
import androidx.media3.exoplayer.source.DefaultMediaSourceFactory;
import androidx.media3.exoplayer.util.EventLogger;
import androidx.media3.ui.PlayerView;
import androidx.multidex.MultiDex;

...

public class MyActivity extends Activity {

  private static final String KEY_ADS_LOADER_STATE = "ads_loader_state";
  private static final String SAMPLE_ASSET_KEY = "c-rArva4ShKVIAkNfy6HUQ";

  private PlayerView playerView;
  private ExoPlayer player;
  private ImaServerSideAdInsertionMediaSource.AdsLoader adsLoader;
  private ImaServerSideAdInsertionMediaSource.AdsLoader.State adsLoaderState;

}

Créer une instance adsLoader

Remplacez la méthode onCreate pour rechercher PlayerView et rechercher un AdsLoader.State enregistré, qui peut être utilisé lors de l'initialisation de l'objet adsLoader.

Activez également Multidex si le nombre de méthodes et minSdkVersion de votre application l'exige (comme expliqué à l'étape 2).

Exemple :

app/src/main/java/com/example/project name/MyActivity.java

...

public class MyActivity extends Activity {

  private static final String KEY_ADS_LOADER_STATE = "ads_loader_state";
  private static final String SAMPLE_ASSET_KEY = "c-rArva4ShKVIAkNfy6HUQ";

  private PlayerView playerView;
  private ExoPlayer player;
  private ImaServerSideAdInsertionMediaSource.AdsLoader adsLoader;
  private ImaServerSideAdInsertionMediaSource.AdsLoader.State adsLoaderState;

  @Override
  protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_my);
    MultiDex.install(this);

    playerView = findViewById(R.id.player_view);

    // Checks if there is a saved AdsLoader state to be used later when
    // initiating the AdsLoader.
    if (savedInstanceState != null) {
      Bundle adsLoaderStateBundle = savedInstanceState.getBundle(KEY_ADS_LOADER_STATE);
      if (adsLoaderStateBundle != null) {
        adsLoaderState =
            ImaServerSideAdInsertionMediaSource.AdsLoader.State.fromBundle(
                adsLoaderStateBundle);
      }
    }
  }

}

Ajouter des méthodes pour initialiser le lecteur

Ajoutez une méthode pour initialiser le lecteur et procédez comme suit:

  • Créez une instance AdsLoader.
  • Créez le sous-réseau ExoPlayer.
  • Créez un MediaItem avec la clé d'élément de la diffusion en direct.
  • Définissez MediaItem sur votre lecteur.

Exemple :

app/src/main/java/com/example/project name/MyActivity.java

public class MyActivity extends Activity {

  ...

  
  // Create a server side ad insertion (SSAI) AdsLoader.
  private ImaServerSideAdInsertionMediaSource.AdsLoader createAdsLoader() {
    ImaServerSideAdInsertionMediaSource.AdsLoader.Builder adsLoaderBuilder =
        new ImaServerSideAdInsertionMediaSource.AdsLoader.Builder(this, playerView);

    // Attempt to set the AdsLoader state if available from a previous session.
    if (adsLoaderState != null) {
      adsLoaderBuilder.setAdsLoaderState(adsLoaderState);
    }

    return adsLoaderBuilder.build();
  }

  private void initializePlayer() {
    adsLoader = createAdsLoader();

    // Set up the factory for media sources, passing the ads loader.
    DataSource.Factory dataSourceFactory = new DefaultDataSource.Factory(this);
    DefaultMediaSourceFactory mediaSourceFactory = new DefaultMediaSourceFactory(dataSourceFactory);

    // MediaSource.Factory to create the ad sources for the current player.
    ImaServerSideAdInsertionMediaSource.Factory adsMediaSourceFactory =
        new ImaServerSideAdInsertionMediaSource.Factory(adsLoader, mediaSourceFactory);

    // 'mediaSourceFactory' is an ExoPlayer component for the DefaultMediaSourceFactory.
    // 'adsMediaSourceFactory' is an ExoPlayer component for a MediaSource factory for IMA server
    // side inserted ad streams.
    mediaSourceFactory.setServerSideAdInsertionMediaSourceFactory(adsMediaSourceFactory);

    // Create an ExoPlayer and set it as the player for content and ads.
    player = new ExoPlayer.Builder(this).setMediaSourceFactory(mediaSourceFactory).build();
    playerView.setPlayer(player);
    adsLoader.setPlayer(player);

    // Build an IMA SSAI media item to prepare the player with.
    Uri ssaiLiveUri =
        new ImaServerSideAdInsertionUriBuilder()
            .setAssetKey(SAMPLE_ASSET_KEY)
            .setFormat(CONTENT_TYPE_HLS) // Use CONTENT_TYPE_DASH for dash streams.
            .build();

    // Create the MediaItem to play, specifying the stream URI.
    MediaItem ssaiMediaItem = MediaItem.fromUri(ssaiLiveUri);

    // Prepare the content and ad to be played with the ExoPlayer.
    player.setMediaItem(ssaiMediaItem);
    player.prepare();

    // Set PlayWhenReady. If true, content and ads will autoplay.
    player.setPlayWhenReady(false);
  }
}

Ajouter une méthode pour libérer le lecteur

Ajoutez une méthode pour libérer le joueur dans cette séquence:

  • Définissez les références du lecteur sur "null" et libérez ses ressources.
  • Libérez l'état du adsLoader.

app/src/main/java/com/example/project name/MyActivity.java

public class MyActivity extends Activity {

  ...

  private void releasePlayer() {
    // Set the player references to null and release the player's resources.
    playerView.setPlayer(null);
    player.release();
    player = null;

    // Release the adsLoader state so that it can be initiated again.
    adsLoaderState = adsLoader.release();
  }

Gérer les événements du lecteur

Enfin, créez des rappels pour les événements de cycle de vie de l'activité afin de gérer la lecture du flux.

Pour prendre en charge la version 24 ou ultérieure du SDK Android:

Pour prendre en charge les versions du SDK Android inférieures à la version 24 : - onResume() - onPause()

onStart() et onResume() correspondent à playerView.onResume(), et onStop() et onPause() correspondent à playerView.onPause().

Cette étape utilise également l'événement onSaveInstanceState() pour tenter d'enregistrer le adsLoaderState.

app/src/main/java/com/example/project name/MyActivity.java

public class MyActivity extends Activity {

  ...

  @Override
  public void onStart() {
    super.onStart();
    if (Util.SDK_INT > 23) {
      initializePlayer();
      if (playerView != null) {
        playerView.onResume();
      }
    }
  }

  @Override
  public void onResume() {
    super.onResume();
    if (Util.SDK_INT <= 23 || player == null) {
      initializePlayer();
      if (playerView != null) {
        playerView.onResume();
      }
    }
  }

  @Override
  public void onPause() {
    super.onPause();
    if (Util.SDK_INT <= 23) {
      if (playerView != null) {
        playerView.onPause();
      }
      releasePlayer();
    }
  }

  @Override
  public void onStop() {
    super.onStop();
    if (Util.SDK_INT > 23) {
      if (playerView != null) {
        playerView.onPause();
      }
      releasePlayer();
    }
  }

  @Override
  public void onSaveInstanceState(Bundle outState) {
    // Attempts to save the AdsLoader state to handle app backgrounding.
    if (adsLoaderState != null) {
      outState.putBundle(KEY_ADS_LOADER_STATE, adsLoaderState.toBundle());
    }
  }

  ...

}

Configuration du flux VOD (facultatif)

Si votre application doit diffuser du contenu VOD avec des annonces, procédez comme suit:

  1. Ajoutez un CMS ID et un Video ID pour un flux de test de VOD.
  2. Créez un URI VOD SSAI à l'aide de ImaServerSideAdInsertionUriBuilder().
  3. Utilisez ce nouvel URI comme élément multimédia de votre lecteur.

app/src/main/java/com/example/project name/MyActivity.java

public class MyActivity extends Activity {

  private static final String KEY_ADS_LOADER_STATE = "ads_loader_state";
  private static final String SAMPLE_ASSET_KEY = "c-rArva4ShKVIAkNfy6HUQ";
  private static final String SAMPLE_CMS_ID = "2548831";
  private static final String SAMPLE_VIDEO_ID = "tears-of-steel";

  ...

  private void initializePlayer() {

     ...

    Uri ssaiVodUri =
        new ImaServerSideAdInsertionUriBuilder()
            .setContentSourceId(SAMPLE_CMS_ID)
            .setVideoId(SAMPLE_VIDEO_ID)
            .setFormat(CONTENT_TYPE_HLS)
            .build();

    // Create the MediaItem to play, specifying the stream URI.
    MediaItem ssaiMediaItem = MediaItem.fromUri(ssaiVodUri);

    // Prepare the content and ad to be played with the ExoPlayer.
    player.setMediaItem(ssaiMediaItem);
    player.prepare();

    // Set PlayWhenReady. If true, content and ads will autoplay.
    player.setPlayWhenReady(false);
  }

Et voilà ! Vous demandez et lisez maintenant un flux multimédia avec l'extension IMA d'ExoPlayer. Pour obtenir le code complet, consultez les exemples Android DAI sur GitHub.