Visão geral da configuração do SDK de mídia de streaming 2.x herdado setup-overview

As instruções desta seção se aplicam aos SDKs de mídia 2.x herdados.

  • Para mais informações sobre a implementação de uma versão 1.x do SDK de mídia, consulte a Documentação do SDK de mídia 1.x.

  • Para os integradores do Primetime, consulte a Documentação do SDK de mídia do Primetime.

IMPORTANT
Com o fim do suporte para SDKs móveis da versão 4 em 31 de agosto de 2021, a Adobe também encerrará o suporte para o SDKs do Media Analytics para iOS e Android. Para obter mais informações, consulte Perguntas frequentes sobre o fim do suporte do SDK do Media Analytics.

Suporte mínimo para versão da plataforma minimum-platform-version

A tabela a seguir descreve as versões mínimas da plataforma compatíveis com cada SDK, a partir de 19 de fevereiro de 2019.

OS/Navegador
Versão mín. necessária
iOS
iOS 6+
Android
Android 5.0+ - Lollipop
Chrome
v22+
Mozilla
v27+
Safari
v7+
IE
v11+

Diretrizes gerais de implementação general-implementation-guidelines

Há três componentes principais do SDK envolvidos no rastreamento de mídia:

  • Config Media Heartbeat - A configuração contém as configurações básicas do relatórios.
  • Delegar Media Heartbeat - O delegado controla o tempo de reprodução e o objeto QoS.
  • Media Heartbeat - A biblioteca principal que contém membros e métodos.

Complete as etapas de implementação a seguir:

  1. Crie uma instância MediaHeartbeatConfig e defina os valores do parâmetro de configuração.

    table 0-row-4 1-row-4 2-row-4 3-row-4 4-row-4 5-row-4 6-row-4 7-row-4 3-align-center 8-align-center 13-align-center 18-align-center 23-align-center 28-align-center 33-align-center 38-align-center
    Nome da variável Descrição Obrigatório Valor padrão
    trackingServer Servidor de rastreamento para análise de mídia. Isso é diferente do servidor de rastreamento de análise. Sim String vazia
    channel Nome do canal Não String vazia
    ovp Nome da plataforma de mídia online pela qual o conteúdo é distribuído. Não String vazia
    appVersion Versão do aplicativo do reprodutor de vídeo/SDK Não String vazia
    playerName Nome do media player em uso, ou seja, "AVPlayer", "HTML5 Player", "My Custom Player" Não String vazia
    ssl Indica se as chamadas devem ser feitas em HTTPS Não false
    debugLogging Indica se o registro de depuração está ativado Não false
  2. Implementar o MediaHeartbeatDelegate.

    table 0-row-3 1-row-3 2-row-3 3-align-center 7-align-center 11-align-center
    Nome do método Descrição Obrigatório
    getQoSObject() Retorna a instância MediaObject que contém as informações de QoS atuais. Esse método será chamado várias vezes durante uma sessão de reprodução. A implementação do player sempre deve retornar os dados de QoS mais recentes. Sim
    getCurrentPlaybackTime() Retorna a posição atual do indicador de reprodução.
    Para rastreamento de VOD, o valor é especificado em segundos a partir do início do item de mídia.
    Para transmissões ao vivo, se o player não fornecer informações sobre a duração do conteúdo, o valor pode ser especificado como o número de segundos desde a meia-noite UTC daquele dia.
    Observação: ao usar marcadores de progresso, a duração do conteúdo é necessária e o indicador de reprodução precisa ser atualizado para o número de segundos desde o início do item de mídia, começando com 0.
    Sim
    note tip
    TIP
    O objeto de Qualidade do serviço (QoS) é opcional. Se os dados de QoS estiverem disponíveis para o player e você desejar rastrear esses dados, as seguintes variáveis serão necessárias:
    table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 3-align-center 7-align-center 11-align-center 15-align-center 19-align-center
    Nome da variável Descrição Obrigatório
    bitrate A taxa de bits da mídia em bits por segundo. Sim
    startupTime A hora de início da mídia em milissegundos. Sim
    fps Os quadros exibidos por segundo. Sim
    droppedFrames O número de quadros soltos até agora. Sim
  3. Crie a instância MediaHeartbeat.

    Use MediaHertbeatConfig e MediaHertbeatDelegate para criar a instância MediaHeartbeat.

    note important
    IMPORTANT
    Certifique-se de que a instância MediaHeartbeat possa ser acessada e não seja desalocada até o final da sessão. Essa instância será usada para todos os eventos de rastreamento de mídia a seguir.
    note tip
    TIP
    MediaHeartbeat exige uma instância do AppMeasurement para enviar chamadas para o Adobe Analytics.
  4. Combine todas as partes.

    O código de exemplo a seguir usa o SDK 2.x do JavaScript para um player de vídeo HTML5:

    code language-javascript
    // Create local references to the heartbeat classes
    var MediaHeartbeat = ADB.va.MediaHeartbeat;
    var MediaHeartbeatConfig = ADB.va.MediaHeartbeatConfig;
    var MediaHeartbeatDelegate = ADB.va.MediaHeartbeatDelegate;
    
    //Media Heartbeat Config
    var mediaConfig = new MediaHeartbeatConfig();
    mediaConfig.trackingServer = "[your_namespace].hb.omtrdc.net";
    mediaConfig.playerName = "HTML5 Basic";
    mediaConfig.channel = "Video Channel";
    mediaConfig.debugLogging = true;
    mediaConfig.appVersion = "2.0";
    mediaConfig.ssl = false;
    mediaConfig.ovp = "";
    
    // Media Heartbeat Delegate
    var mediaDelegate = new MediaHeartbeatDelegate();
    
    // Set mediaDelegate CurrentPlaybackTime
    mediaDelegate.getCurrentPlaybackTime = function() {
        return video.currentTime;
    };
    
    // Set mediaDelegate QoSObject - OPTIONAL
    mediaDelegate.getQoSObject = function() {
        return MediaHeartbeat.createQoSObject(video.bitrate,
                                              video.startuptime,
                                              video.fps,
                                              video.droppedframes);
    }
    // Create mediaHeartbeat instance
    this.mediaHeartbeat =
      new MediaHeartbeat(mediaDelegate, mediaConfig, appMeasurementInstance);
    

Validar validate

As implementações de rastreamento do Media Analytics geram dois tipos de chamadas de rastreamento:

  • Chamadas de início de mídia e anúncio são enviadas diretamente para o servidor do Adobe Analytics (AppMeasurement).

  • As chamadas de heartbeat são enviadas para o servidor de rastreamento do Media Analytics (heartbeats), processadas e repassadas para o servidor do Adobe Analytics.

  • Servidor do Adobe Analytics (AppMeasurement) Para obter mais informações sobre as opções do servidor de rastreamento, consulte Preencher corretamente as variáveis trackingServer e trackingServerSecure.

    note important
    IMPORTANT
    Um servidor de rastreamento RDC, ou CNAME que é resolvido para um servidor RDC, é necessário para o serviço de ID do visitante da Experience Cloud.

    O servidor de rastreamento do Analytics deve terminar com “.sc.omtrdc.net” ou ser um CNAME.

  • ** Servidor do Media Analytics (Heartbeats)**
    Este sempre tem o formato "[your_namespace].hb.omtrdc.net". O valor "[your_namespace]" especifica sua empresa e é fornecido pela Adobe.

O rastreamento de mídia funciona da mesma forma em todas as plataformas, desktops e dispositivos móveis. O rastreamento de áudio funciona atualmente em plataformas móveis. Para todas as chamadas de rastreamento, há algumas variáveis universais principais que precisam ser validadas:

Documentação do SDK 1.x sdk-1x-documentation

SDKs do Video Analytics 1.x
Guias do desenvolvedor (somente PDFs)
Android
Configurar para Android
Apple TV
Configurar para a Apple TV
Chromecast
Configurar para Chromecast
iOS
Configurar para iOS
JavaScript
Configurar para JavaScript
Primetime
TVML
Configurar para TVML

Documentação do SDK de mídia do Primetime primetime-docs

recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb