Introdução à extensão de IMA do ExoPlayer

O ExoPlayer é um player de mídia para Android. Este guia mostra como usar a extensão do IMA do ExoPlayer. Essa extensão usa o SDK de DAI do IMA para solicitar e reproduzir fluxos de mídia com anúncios e conteúdo.

Confira a seguir os benefícios da extensão:

• Simplifica o código necessário para integrar recursos da IMA.
• Reduz o tempo necessário para atualizar para novas versões do IMA.

A extensão IMA do ExoPlayer é compatível com os protocolos de streaming HLS e DASH. Confira um resumo:

Compatibilidade com streams da extensão ExoPlayer-IMA
	Transmissão ao vivo	Streams de VOD
HLS
DASH

O ExoPlayer-IMA versão 1.1.0 e mais recentes oferecem suporte a transmissões ao vivo DASH.

Este guia usa o guia do ExoPlayer para ajudar você a criar um app completo e integrar a extensão. Para um app de exemplo completo, consulte o ExoPlayerExample no GitHub.

Importante: a extensão do IMA do ExoPlayer exige o ExoPlayer. Se você preferir um player diferente, siga o guia de primeiros passos para integrar o SDK do IMA DAI ao seu app.

Pré-requisitos

• Android Studio
• AndroidX Media3 ExoPlayer versão 1.0.0 ou mais recente para suporte à DAI.

Criar um novo projeto do Android Studio

Para criar seu projeto do Android Studio, siga estas etapas:

1. Inicie o Android Studio.
2. Selecione Start a new Android Studio project.
3. Na página Choose your project, selecione o modelo No Activity.
4. Clique em Próxima.
5. Na página Configurar seu projeto, dê um nome ao projeto e selecione Java como a linguagem. Observação: o SDK do IMA DAI funciona com Kotlin, mas este guia usa exemplos em Java.

• Clique em Concluir.

Adicionar a extensão IMA do ExoPlayer ao projeto

Para adicionar a extensão do ExoPlayer IMA, faça o seguinte:

1. Inclua as seguintes importações na seção dependencies do arquivo build.gradle do app:

   dependencies {
       def media3_version = "1.8.0"
       implementation(platform("org.jetbrains.kotlin:kotlin-bom:1.8.0"))
       implementation 'androidx.appcompat:appcompat:1.7.1'
       implementation "androidx.media3:media3-ui:$media3_version"
       implementation "androidx.media3:media3-exoplayer:$media3_version"
       implementation "androidx.media3:media3-exoplayer-hls:$media3_version"
       implementation "androidx.media3:media3-exoplayer-dash:$media3_version"
   
       // The library adds the IMA ExoPlayer integration for ads.
       implementation "androidx.media3:media3-exoplayer-ima:$media3_version"
   }
   build.gradle
   

2. Adicione as permissões de usuário necessárias para o SDK da DAI do IMA solicitar anúncios:

   <uses-permission android:name="android.permission.INTERNET"/>
   <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
   AndroidManifest.xml
   

Configurar a interface do ExoPlayer

Para configurar a interface do ExoPlayer, faça o seguinte:

1. Crie o objeto PlayerView para o ExoPlayer.

2. Mude a visualização androidx.constraintlayout.widget.ConstraintLayout para uma LinearLayout, conforme recomendado pela extensão IMA do ExoPlayer:

   <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
       xmlns:tools="http://schemas.android.com/tools"
       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:fitsSystemWindows="true"
           android:layout_width="match_parent"
           android:layout_height="wrap_content" />
   
       <!-- UI element for viewing SDK event log -->
       <TextView
           android:id="@+id/logText"
           android:gravity="bottom"
           android:layout_width="match_parent"
           android:layout_height="wrap_content"
           android:maxLines="100"
           android:scrollbars="vertical"
           android:textSize="@dimen/font_size">
       </TextView>
   
   </LinearLayout>
   activity_my.xml
   

Adicionar parâmetros de stream

Consulte a página de amostra de stream da IMA para ver recursos de amostra de stream e testar seu projeto. Para configurar seus próprios fluxos, consulte a seção do Ad Manager sobre DAI.

Esta etapa configura uma transmissão ao vivo. A extensão do ExoPlayer IMA também é compatível com streams de VOD da DAI. Para saber quais mudanças seu app precisa fazer para transmissões de VOD, consulte a etapa para transmissões de vídeo on demand (VOD).

Importar a extensão IMA do ExoPlayer

1. Adicione as seguintes instruções de importação para a extensão do ExoPlayer:

   import static androidx.media3.common.C.CONTENT_TYPE_HLS;
   
   import android.annotation.SuppressLint;
   import android.app.Activity;
   import android.net.Uri;
   import android.os.Bundle;
   import android.text.method.ScrollingMovementMethod;
   import android.util.Log;
   import android.widget.TextView;
   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.ui.PlayerView;
   import com.google.ads.interactivemedia.v3.api.AdEvent;
   import com.google.ads.interactivemedia.v3.api.ImaSdkFactory;
   import com.google.ads.interactivemedia.v3.api.ImaSdkSettings;
   import java.util.HashMap;
   import java.util.Map;
   MyActivity.java
   

2. Em MyActivity.java, adicione estas variáveis particulares:

   • PlayerView
   • ExoPlayer
   • ImaServerSideAdInsertionMediaSource.AdsLoader
   • ImaServerSideAdInsertionMediaSource.AdsLoader.State

   Para testar com a transmissão HLS Big Buck Bunny (ao vivo), adicione a chave de recurso dela. Encontre mais streams para testar na página de stream de amostra da IMA.

3. Crie uma constante KEY_ADS_LOADER_STATE para salvar e recuperar o estado AdsLoader:

   /** Main Activity. */
   @SuppressLint("UnsafeOptInUsageError")
   /* @SuppressLint is needed for new media3 APIs. */
   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 LOG_TAG = "ImaExoPlayerExample";
   
     private PlayerView playerView;
     private TextView logText;
     private ExoPlayer player;
     private ImaServerSideAdInsertionMediaSource.AdsLoader adsLoader;
     private ImaServerSideAdInsertionMediaSource.AdsLoader.State adsLoaderState;
     private ImaSdkSettings imaSdkSettings;
   MyActivity.java
   

Criar uma instância adsLoader

Modifique o método onCreate. Nele, encontre o PlayerView e verifique se há um AdsLoader.State salvo. Você pode usar esse estado ao inicializar o objeto adsLoader.

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

  // Initialize the IMA SDK as early as possible when the app starts. If your app already
  // overrides Application.onCreate(), call this method inside the onCreate() method.
  // https://developer.android.com/topic/performance/vitals/launch-time#app-creation
  ImaSdkFactory.getInstance().initialize(this, getImaSdkSettings());

  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);
    }
  }
}

private ImaSdkSettings getImaSdkSettings() {
  if (imaSdkSettings == null) {
    imaSdkSettings = ImaSdkFactory.getInstance().createImaSdkSettings();
    // Set any IMA SDK settings here.
  }
  return imaSdkSettings;
}
MyActivity.java

Importante:para melhorar os tempos de carregamento da IMA, chame o método ImaSdkFactory.initialize() o mais cedo possível no ciclo de vida do app. Chamar o método cedo maximiza o tempo para a IMA carregar os recursos necessários antes da primeira solicitação de stream. A chamada de método ImaSdkFactory.initialize() aceita uma instância de ImaSdkSettings. Use os mesmos valores de configurações aqui e ao criar uma instância AdsLoader. Este exemplo usa o método auxiliar getImaSdkSettings() para garantir que os valores de configurações sejam os mesmos. Para mais informações, consulte o guia de otimização do tempo de carregamento da IMA>.

Adicionar métodos para inicializar o player

Adicione um método para inicializar o player. Esse método precisa fazer o seguinte:

• Crie uma instância AdsLoader.
• Crie o ExoPlayer.
• Crie um MediaItem usando a chave de recurso da transmissão ao vivo.
• Defina o MediaItem para seu player.

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

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

  return adsLoaderBuilder
      .setAdEventListener(buildAdEventListener())
      .setImaSdkSettings(getImaSdkSettings())
      .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 a SimpleExoPlayer and set it as the player for content and ads.
  player = new ExoPlayer.Builder(this).setMediaSourceFactory(mediaSourceFactory).build();
  playerView.setPlayer(player);
  adsLoader.setPlayer(player);

  // Create the MediaItem to play, specifying the stream URI.
  Uri ssaiUri = buildLiveStreamUri(SAMPLE_ASSET_KEY, CONTENT_TYPE_HLS);
  MediaItem ssaiMediaItem = MediaItem.fromUri(ssaiUri);

  // 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);
}

/**
 * Builds an IMA SSAI live stream URI for the given asset key and format.
 *
 * @param assetKey The asset key of the live stream.
 * @param format The format of the live stream request, either {@code CONTENT_TYPE_HLS} or {@code
 *     CONTENT_TYPE_DASH}.
 * @return The URI of the live stream.
 */
public Uri buildLiveStreamUri(String assetKey, int format) {
  Map<String, String> adTagParams = new HashMap<String, String>();
  // Update the adTagParams map with any parameters.
  // For more information, see https://support.google.com/admanager/answer/7320899

  return new ImaServerSideAdInsertionUriBuilder()
      .setAssetKey(assetKey)
      .setFormat(format)
      .setAdTagParameters(adTagParams)
      .build();
}
MyActivity.java

Observação:esta seção usa métodos com nomes que se referem a conceitos de inserção de anúncios do lado do servidor (SSAI).

• A DAI do Google Ad Manager é um exemplo de SSAI.
• A extensão IMA do ExoPlayer deste guia funciona especificamente com a DAI do Ad Manager. A extensão do ExoPlayer IMA também é compatível com diferentes soluções de SSAI.

Adicionar um método para liberar o player

Adicione um método para liberar o player. Esse método precisa realizar as seguintes ações em sequência:

• Defina as referências do player como nulas e libere os recursos dele.
• Libere o estado adsLoader.

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();
}
MyActivity.java

Processar eventos do player

Para processar eventos do player, crie callbacks para os eventos do ciclo de vida da atividade e gerencie a reprodução de stream.

Para o nível 24 da API Android e versões mais recentes, use os seguintes métodos:

• onStart()
• onStop()

Para níveis de API do Android anteriores a 24, use os seguintes métodos:

• onResume()
• onPause()

Os métodos onStart() e onResume() são mapeados para playerView.onResume(), enquanto onStop() e onPause() são mapeados para playerView.onPause().

Importante: este exemplo é compatível com o SDK do Android versão 24 e anteriores. Use onStart()/onStop() para a versão 24 ou mais recente do SDK do Android e onResume()/onPause() para versões anteriores à 24.

Essa etapa também usa o evento onSaveInstanceState() para salvar o adsLoaderState.

@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());
  }
}
MyActivity.java

Configuração do stream de VOD (opcional)

Se o app precisar reproduzir conteúdo de VOD com anúncios, siga estas etapas:

1. Adicione um CMS ID e um Video ID para um stream de VOD. Para testes, use estes parâmetros de stream:
   • ID do CMS: "2548831"
   • ID do vídeo: "tears-of-steel"

2. Crie um URI de VOD da SSAI usando o método ImaServerSideAdInsertionUriBuilder():

   /**
    * Builds an IMA SSAI VOD stream URI for the given CMS ID, video ID, and format.
    *
    * @param cmsId The CMS ID of the VOD stream.
    * @param videoId The video ID of the VOD stream.
    * @param format The format of the VOD stream request, either {@code CONTENT_TYPE_HLS} or {@code
    *     CONTENT_TYPE_DASH}.
    * @return The URI of the VOD stream.
    */
   public Uri buildVodStreamUri(String cmsId, String videoId, int format) {
     Map<String, String> adTagParams = new HashMap<String, String>();
     // Update the adTagParams map with any parameters.
     // For more information, see https://support.google.com/admanager/answer/7320899
   
     return new ImaServerSideAdInsertionUriBuilder()
         .setContentSourceId(cmsId)
         .setVideoId(videoId)
         .setFormat(format)
         .setAdTagParameters(adTagParams)
         .build();
   }
   MyActivity.java
   

3. Defina o novo URI de stream de VOD como o item de mídia do player usando o método MediaItem.fromUri().

Se for bem-sucedido, você poderá solicitar e reproduzir um fluxo de mídia com a extensão IMA do ExoPlayer. Para conferir o exemplo completo, consulte Exemplos de DAI do Android no GitHub.