Personalização

A interface Player é o núcleo da biblioteca ExoPlayer. Um Player expõe a funcionalidade tradicional de alto nível do media player, como a capacidade de armazenar em buffer, reproduzir, pausar e procurar mídia. A implementação padrão ExoPlayer foi projetada para fazer poucas suposições sobre (e, portanto, impor poucas restrições a) o tipo de mídia que está sendo reproduzida, como e onde ela é armazenada e como ela é renderizada. Em vez de implementar o carregamento e a renderização de mídia diretamente, as implementações de ExoPlayer delegam esse trabalho a componentes injetados quando um player é criado ou quando novas fontes de mídia são transmitidas a ele. Os componentes comuns a todas as implementações de ExoPlayer são:

  • Instâncias de MediaSource que definem a mídia a ser reproduzida, carregam a mídia e de onde a mídia carregada pode ser lida. Uma instância de MediaSource é criada de um MediaItem por um MediaSource.Factory dentro do player. Eles também podem ser transmitidos diretamente para o player usando a API de playlist baseada na fonte de mídia.
  • Uma instância de MediaSource.Factory que converte um MediaItem em um MediaSource. O MediaSource.Factory é injetado quando o player é criado.
  • instâncias Renderer que renderizam componentes individuais da mídia. Eles são injetados quando o player é criado.
  • Um TrackSelector que seleciona faixas fornecidas pelo MediaSource para serem usadas por cada Renderer disponível. Um TrackSelector é injetado quando o player é criado.
  • Um LoadControl que controla quando o MediaSource armazena mais mídia em buffer e quanto da mídia é armazenada em buffer. Um LoadControl é injetado quando o player é criado.
  • Um LivePlaybackSpeedControl que controla a velocidade de reprodução durante as transmissões ao vivo para permitir que o player fique próximo de um deslocamento ao vivo configurado. Um LivePlaybackSpeedControl é injetado quando o player é criado.

O conceito de injetar componentes que implementam partes da funcionalidade do player está presente em toda a biblioteca. As implementações padrão de alguns componentes delegam o trabalho a outros componentes injetados. Isso permite que muitos subcomponentes sejam substituídos individualmente por implementações configuradas de maneira personalizada.

Personalização do player

Confira abaixo alguns exemplos comuns de personalização do player com injeção de componentes.

Como configurar a pilha de rede

Temos uma página sobre como personalizar a pilha de rede usada pelo ExoPlayer.

Armazenamento em cache de dados carregados da rede

Consulte os guias sobre armazenamento em cache temporário em tempo real e como fazer o download de mídia.

Personalizar interações do servidor

Alguns apps podem querer interceptar solicitações e respostas HTTP. Talvez você queira injetar cabeçalhos de solicitação personalizados, ler os cabeçalhos de resposta do servidor, modificar os URIs das solicitações etc. Por exemplo, o app pode se autenticar injetando um token como um cabeçalho ao solicitar os segmentos de mídia.

O exemplo abaixo demonstra como implementar esses comportamentos injetando um DataSource.Factory personalizado no DefaultMediaSourceFactory:

Kotlin

val dataSourceFactory =
  DataSource.Factory {
    val dataSource = httpDataSourceFactory.createDataSource()
    // Set a custom authentication request header.
    dataSource.setRequestProperty("Header", "Value")
    dataSource
  }
val player =
  ExoPlayer.Builder(context)
    .setMediaSourceFactory(
      DefaultMediaSourceFactory(context).setDataSourceFactory(dataSourceFactory)
    )
    .build()

Java

DataSource.Factory dataSourceFactory =
    () -> {
      HttpDataSource dataSource = httpDataSourceFactory.createDataSource();
      // Set a custom authentication request header.
      dataSource.setRequestProperty("Header", "Value");
      return dataSource;
    };

ExoPlayer player =
    new ExoPlayer.Builder(context)
        .setMediaSourceFactory(
            new DefaultMediaSourceFactory(context).setDataSourceFactory(dataSourceFactory))
        .build();

No snippet de código acima, o HttpDataSource injetado inclui o cabeçalho "Header: Value" em cada solicitação HTTP. Esse comportamento foi corrigido para cada interação com uma origem HTTP.

Para uma abordagem mais granular, injete o comportamento just-in-time usando um ResolvingDataSource. O snippet de código abaixo mostra como injetar cabeçalhos de solicitação antes de interagir com uma origem HTTP:

Kotlin

val dataSourceFactory: DataSource.Factory =
  ResolvingDataSource.Factory(httpDataSourceFactory) { dataSpec: DataSpec ->
    // Provide just-in-time request headers.
    dataSpec.withRequestHeaders(getCustomHeaders(dataSpec.uri))
  }

Java

    DataSource.Factory dataSourceFactory =
        new ResolvingDataSource.Factory(
            httpDataSourceFactory,
            // Provide just-in-time request headers.
            dataSpec -> dataSpec.withRequestHeaders(getCustomHeaders(dataSpec.uri)));

Também é possível usar um ResolvingDataSource para realizar modificações pontuais do URI, conforme mostrado no snippet abaixo:

Kotlin

val dataSourceFactory: DataSource.Factory =
  ResolvingDataSource.Factory(httpDataSourceFactory) { dataSpec: DataSpec ->
    // Provide just-in-time URI resolution logic.
    dataSpec.withUri(resolveUri(dataSpec.uri))
  }

Java

DataSource.Factory dataSourceFactory =
    new ResolvingDataSource.Factory(
        httpDataSourceFactory,
        // Provide just-in-time URI resolution logic.
        dataSpec -> dataSpec.withUri(resolveUri(dataSpec.uri)));

Personalizar o tratamento de erros

A implementação de um LoadErrorHandlingPolicy personalizado permite que os apps personalizem a maneira como o ExoPlayer reage a erros de carregamento. Por exemplo, um app pode falhar rapidamente em vez de tentar várias vezes ou personalizar a lógica de espera que controla o tempo de espera entre cada tentativa. O snippet a seguir mostra como implementar a lógica de desistência personalizada:

Kotlin

val loadErrorHandlingPolicy: LoadErrorHandlingPolicy =
  object : DefaultLoadErrorHandlingPolicy() {
    override fun getRetryDelayMsFor(loadErrorInfo: LoadErrorInfo): Long {
      // Implement custom back-off logic here.
      return 0
    }
  }
val player =
  ExoPlayer.Builder(context)
    .setMediaSourceFactory(
      DefaultMediaSourceFactory(context).setLoadErrorHandlingPolicy(loadErrorHandlingPolicy)
    )
    .build()

Java

LoadErrorHandlingPolicy loadErrorHandlingPolicy =
    new DefaultLoadErrorHandlingPolicy() {
      @Override
      public long getRetryDelayMsFor(LoadErrorInfo loadErrorInfo) {
        // Implement custom back-off logic here.
        return 0;
      }
    };

ExoPlayer player =
    new ExoPlayer.Builder(context)
        .setMediaSourceFactory(
            new DefaultMediaSourceFactory(context)
                .setLoadErrorHandlingPolicy(loadErrorHandlingPolicy))
        .build();

O argumento LoadErrorInfo contém mais informações sobre a carga com falha para personalizar a lógica com base no tipo de erro ou na solicitação com falha.

Personalizar sinalizações do extrator

As flags do extrator podem ser usadas para personalizar como formatos individuais são extraídos de mídias progressivas. Elas podem ser definidas no DefaultExtractorsFactory fornecido ao DefaultMediaSourceFactory. O exemplo a seguir transmite uma flag que ativa a busca baseada em índice para streams de MP3.

Kotlin

val extractorsFactory =
  DefaultExtractorsFactory().setMp3ExtractorFlags(Mp3Extractor.FLAG_ENABLE_INDEX_SEEKING)
val player =
  ExoPlayer.Builder(context)
    .setMediaSourceFactory(DefaultMediaSourceFactory(context, extractorsFactory))
    .build()

Java

DefaultExtractorsFactory extractorsFactory =
    new DefaultExtractorsFactory().setMp3ExtractorFlags(Mp3Extractor.FLAG_ENABLE_INDEX_SEEKING);

ExoPlayer player =
    new ExoPlayer.Builder(context)
        .setMediaSourceFactory(new DefaultMediaSourceFactory(context, extractorsFactory))
        .build();

Como ativar a busca de taxa de bits constante

Para streams MP3, ADTS e AMR, é possível ativar a busca aproximada usando uma suposição de taxa de bits constante com flags FLAG_ENABLE_CONSTANT_BITRATE_SEEKING. Essas flags podem ser definidas para extratores individuais usando os métodos DefaultExtractorsFactory.setXyzExtractorFlags individuais, conforme descrito acima. Para ativar a busca de taxa de bits constante para todos os extratores compatíveis, use DefaultExtractorsFactory.setConstantBitrateSeekingEnabled.

Kotlin

val extractorsFactory = DefaultExtractorsFactory().setConstantBitrateSeekingEnabled(true)

Java

DefaultExtractorsFactory extractorsFactory =
    new DefaultExtractorsFactory().setConstantBitrateSeekingEnabled(true);

O ExtractorsFactory pode ser injetado por DefaultMediaSourceFactory, conforme descrito para personalizar as flags do extrator acima.

Como ativar o enfileiramento de buffer assíncrono

A fila de buffer assíncrona é uma melhoria no pipeline de renderização do ExoPlayer, que opera instâncias MediaCodec no modo assíncrono e usa outras linhas de execução para programar a decodificação e a renderização de dados. Ativar essa opção pode reduzir a queda de frames e o underrun de áudio.

A fila de buffer assíncrona é ativada por padrão em dispositivos com o Android 12 (nível 31 da API) e versões mais recentes, e pode ser ativada manualmente a partir do Android 6.0 (nível 23 da API). Ative o recurso em dispositivos específicos em que você observa frames perdidos ou áudio com underruns, principalmente ao reproduzir conteúdo protegido por DRM ou com alta taxa de frames.

No caso mais simples, é necessário injetar uma DefaultRenderersFactory no player da seguinte maneira:

Kotlin

val renderersFactory = 
  DefaultRenderersFactory(context).forceEnableMediaCodecAsynchronousQueueing()
val exoPlayer = ExoPlayer.Builder(context, renderersFactory).build()

Java

DefaultRenderersFactory renderersFactory =
    new DefaultRenderersFactory(context).forceEnableMediaCodecAsynchronousQueueing();
ExoPlayer exoPlayer = new ExoPlayer.Builder(context, renderersFactory).build();

Se você estiver instanciando renderizadores diretamente, transmita um AsynchronousMediaCodecAdapter.Factory para os construtores MediaCodecVideoRenderer e MediaCodecAudioRenderer.

Como personalizar operações com ForwardingSimpleBasePlayer

É possível personalizar parte do comportamento de uma instância Player envolvendo-a em uma subclasse de ForwardingSimpleBasePlayer. Essa classe permite interceptar operações específicas, em vez de ter que implementar diretamente os métodos Player. Isso garante um comportamento consistente, por exemplo, de play(), pause() e setPlayWhenReady(boolean). Ele também garante que todas as mudanças de estado sejam corretamente propagadas para instâncias Player.Listener registradas. Para a maioria dos casos de uso de personalização, o ForwardingSimpleBasePlayer deve ser preferido ao ForwardingPlayer, que tem mais chances de apresentar erros, devido a essas garantias de consistência.

Por exemplo, para adicionar uma lógica personalizada quando a reprodução for iniciada ou interrompida:

Kotlin

class PlayerWithCustomPlay(player: Player) : ForwardingSimpleBasePlayer(player) {
  override fun handleSetPlayWhenReady(playWhenReady: Boolean): ListenableFuture<*> {
    // Add custom logic
    return super.handleSetPlayWhenReady(playWhenReady)
  }
}

Java

class PlayerWithCustomPlay extends ForwardingSimpleBasePlayer {

  public PlayerWithCustomPlay(Player player) {
    super(player);
  }

  @Override
  protected ListenableFuture<?> handleSetPlayWhenReady(boolean playWhenReady) {
    // Add custom logic
    return super.handleSetPlayWhenReady(playWhenReady);
  }
}

Ou para proibir o comando SEEK_TO_NEXT (e garantir que Player.seekToNext seja inativo):

Kotlin

class PlayerWithoutSeekToNext(player: Player) : ForwardingSimpleBasePlayer(player) {
  override fun getState(): State {
    val state = super.getState()
    return state
      .buildUpon()
      .setAvailableCommands(
        state.availableCommands.buildUpon().remove(COMMAND_SEEK_TO_NEXT).build()
      )
      .build()
  }

  // We don't need to override handleSeek, because it is guaranteed not to be called for
  // COMMAND_SEEK_TO_NEXT since we've marked that command unavailable.
}

Java

class PlayerWithoutSeekToNext extends ForwardingSimpleBasePlayer {

  public PlayerWithoutSeekToNext(Player player) {
    super(player);
  }

  @Override
  protected State getState() {
    State state = super.getState();
    return state
        .buildUpon()
        .setAvailableCommands(
            state.availableCommands.buildUpon().remove(COMMAND_SEEK_TO_NEXT).build())
        .build();
  }

  // We don't need to override handleSeek, because it is guaranteed not to be called for
  // COMMAND_SEEK_TO_NEXT since we've marked that command unavailable.
}

Personalização do MediaSource

Os exemplos acima injetam componentes personalizados para uso durante a reprodução de todos os objetos MediaItem transmitidos ao player. Quando a personalização precisa ser precisa, também é possível injetar componentes personalizados em instâncias MediaSource individuais, que podem ser transmitidas diretamente ao player. O exemplo abaixo mostra como personalizar um ProgressiveMediaSource para usar um DataSource.Factory, ExtractorsFactory e LoadErrorHandlingPolicy personalizados:

Kotlin

val mediaSource =
  ProgressiveMediaSource.Factory(customDataSourceFactory, customExtractorsFactory)
    .setLoadErrorHandlingPolicy(customLoadErrorHandlingPolicy)
    .createMediaSource(MediaItem.fromUri(streamUri))

Java

ProgressiveMediaSource mediaSource =
    new ProgressiveMediaSource.Factory(customDataSourceFactory, customExtractorsFactory)
        .setLoadErrorHandlingPolicy(customLoadErrorHandlingPolicy)
        .createMediaSource(MediaItem.fromUri(streamUri));

Como criar componentes personalizados

A biblioteca fornece implementações padrão dos componentes listados na parte de cima desta página para casos de uso comuns. Um ExoPlayer pode usar esses componentes, mas também pode ser criado para usar implementações personalizadas, se comportamentos não padrão forem necessários. Alguns casos de uso para implementações personalizadas são:

  • Renderer: é possível implementar um Renderer personalizado para processar um tipo de mídia que não tem suporte nas implementações padrão fornecidas pela biblioteca.
  • TrackSelector: a implementação de um TrackSelector personalizado permite que o desenvolvedor do app mude a forma como as faixas expostas por um MediaSource são selecionadas para consumo por cada um dos Renderers disponíveis.
  • LoadControl: a implementação de um LoadControl personalizado permite que o desenvolvedor do app mude a política de bufferização do player.
  • Extractor: se você precisar oferecer suporte a um formato de contêiner que não tem suporte no momento na biblioteca, implemente uma classe Extractor personalizada.
  • MediaSource: a implementação de uma classe MediaSource personalizada pode ser adequada se você quiser receber amostras de mídia para alimentar os renderizadores de forma personalizada ou implementar o comportamento de composição MediaSource personalizado.
  • MediaSource.Factory: a implementação de um MediaSource.Factory personalizado permite que um aplicativo personalize a maneira como um MediaSource é criado a partir de um MediaItem.
  • DataSource: o pacote upstream do ExoPlayer já contém várias implementações de DataSource para diferentes casos de uso. Talvez você queira implementar sua própria classe DataSource para carregar dados de outra maneira, como em um protocolo personalizado, usando uma pilha HTTP personalizada ou em um cache persistente personalizado.

Ao criar componentes personalizados, recomendamos o seguinte:

  • Se um componente personalizado precisar informar eventos de volta ao app, recomendamos que você faça isso usando o mesmo modelo dos componentes do ExoPlayer, por exemplo, usando classes EventDispatcher ou transmitindo um Handler com um listener para o construtor do componente.
  • Recomendamos que os componentes personalizados usem o mesmo modelo dos componentes existentes do ExoPlayer para permitir a reconfiguração pelo app durante a reprodução. Para fazer isso, os componentes personalizados precisam implementar PlayerMessage.Target e receber mudanças de configuração no método handleMessage. O código do aplicativo precisa transmitir as mudanças de configuração chamando o método createMessage do ExoPlayer, configurando a mensagem e enviando-a ao componente usando PlayerMessage.send. O envio de mensagens para serem entregues na linha de execução garante que elas sejam executadas em ordem com qualquer outra operação realizada no player.