Legendas ocultas

Esta página aborda a coleta de dados para o estado de player Legendas ocultas. Consulte Fluxos afetados pelas legendas ocultas, Contagens de legendas ocultas e Duração total das legendas ocultas para as métricas de relatório correspondentes.

O estado das legendas ocultas do player é rastreado quando o visualizador ativa e desativa as legendas. Acione um evento de início de estado quando as legendas estiverem ativadas e um evento de fim de estado quando as legendas estiverem desativadas. O back-end calcula três métricas desses eventos: fluxos afetados, contagem de entradas de estado e tempo total no estado.

SDK da web

Use sendEvent para enviar um evento media.statesUpdate com o estado adicionado a statesStart:

alloy("sendEvent", {
  xdm: {
    eventType: "media.statesUpdate",
    mediaCollection: {
      statesStart: [{ name: "closedCaptioning" }],
      sessionID: "{sid}",
      playhead: 60
    }
  }
});

Quando o visualizador desabilitar legendas, enviar outro evento com o estado em statesEnd:

alloy("sendEvent", {
  xdm: {
    eventType: "media.statesUpdate",
    mediaCollection: {
      statesEnd: [{ name: "closedCaptioning" }],
      sessionID: "{sid}",
      playhead: 90
    }
  }
});

SDK móvel

Use tracker.trackPlayerStateStart() e tracker.trackPlayerStateEnd() com a constante MediaConstants.PlayerState.CLOSED_CAPTION.

iOS (Swift)

let stateObject = Media.createStateObjectWith(stateName: MediaConstants.PlayerState.CLOSED_CAPTION)

tracker.trackPlayerStateStart(info: stateObject)
tracker.trackPlayerStateEnd(info: stateObject)

Android (Kotlin)

val stateObject = Media.createStateObject(MediaConstants.PlayerState.CLOSED_CAPTION)

tracker.trackPlayerStateStart(stateObject)
tracker.trackPlayerStateEnd(stateObject)

Roku (BrightScript)

Use sendMediaEvent para enviar um evento media.statesUpdate com o estado adicionado a statesStart:

m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.statesUpdate",
        "mediaCollection": {
            "statesStart": [{ "name": "closedCaptioning" }],
            "playhead": 60
        }
    }
})

Quando o visualizador desabilitar legendas, enviar outro evento com o estado em statesEnd:

m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.statesUpdate",
        "mediaCollection": {
            "statesEnd": [{ "name": "closedCaptioning" }],
            "playhead": 90
        }
    }
})

API de borda de mídia

Chame o ponto de extremidade statesUpdate com closedCaptioning em statesStart (ou statesEnd quando o visualizador desabilitar legendas):

{
  "events": [{
    "xdm": {
      "eventType": "media.statesUpdate",
      "mediaCollection": {
        "statesStart": [{ "name": "closedCaptioning" }],
        "sessionID": "{sid}",
        "playhead": 60
      }
    }
  }]
}

SDK de mídia

Use ADB.Media.createStateObject e a constante ADB.Media.PlayerState.ClosedCaptioning:

var stateObject = ADB.Media.createStateObject(ADB.Media.PlayerState.ClosedCaptioning);

tracker.trackPlayerStateStart(stateObject);
tracker.trackPlayerStateEnd(stateObject);

API da coleção de mídia

Enviar uma solicitação POST stateStart quando as legendas estiverem habilitadas, e uma POST stateEnd quando estiverem desabilitadas:

{
  "playerTime": { "playhead": 60, "ts": 1699523820000 },
  "eventType": "stateStart",
  "params": {
    "media.state.name": "closedCaptioning"
  }
}

Consulte a Referência de eventos da API Media Collection para obter a estrutura de solicitação completa.