Esta documentación abarca el seguimiento en la versión 3.x del SDK. Si va implementar cualquier versión anterior del SDK, puede descargar las guías del desarrollador aquí: Descargar SDK
Configuración de seguimiento inicial
Identifique el momento en que el usuario desencadena la intención de reproducir (cuando hace clic en reproducir o la reproducción automática está activada) y cree una instancia de MediaObject
.
Nombre de variable | Tipo | Descripción |
---|---|---|
name |
string | Cadena no vacía que indica el nombre de los medios. |
id |
string | Cadena no vacía que indica un identificador de medios único. |
length |
entero | Número positivo que indica la longitud de los medios en segundos. Utilice 0 si se desconoce la longitud. |
streamType |
string | |
mediaType |
Tipo de medios (audio o vídeo). |
StreamType
Constantes de:
Nombre de la constante | Descripción |
---|---|
VOD |
Tipo de emisión de vídeo bajo demanda. |
AOD |
Tipo de emisión de audio a la carta. |
MediaType
Constantes de:
Nombre de la constante | Descripción |
---|---|
Audio |
Tipo de contenido para emisiones de audio. |
Video |
Tipo de contenido para emisiones de vídeo. |
var mediaObject = ADB.Media.createMediaObject(<MEDIA_NAME>,
<MEDIA_ID,
<MEDIA_LENGTH>,
<STREAM_TYPE>,
<MEDIA_TYPE>);
Adjuntar metadatos
Opcionalmente, se pueden adjuntar metadatos estándar o personalizados a la sesión de seguimiento mediante el uso de variables de datos de contexto.
Metadatos estándar
La adición de metadatos estándar es opcional.
Referencia de API de claves de metadatos de contenidos: Claves de metadatos estándar de JavaScript
Consulte el conjunto completo de metadatos disponibles aquí: Parámetros de audio y vídeo.
Metadatos personalizados
Cree un objeto de variable para las variables personalizadas y rellénelo con los datos de estos contenidos. Por ejemplo:
/* Set context data */
var contextData = {};
//Standard metadata
contextData[ADB.Media.VideoMetadataKeys] = "Sample Episode";
contextData[ADB.Media.VideoMetadataKeys] = "Sample Show";
//Custom metadata
contextData["isUserLoggedIn"] = "false";
contextData["tvStation"] = "Sample TV Station";
Realice un seguimiento de la intención de iniciar la reproducción
Para empezar a realizar el seguimiento de una sesión multimedia, invoque a trackSessionStart
en la instancia de Media Heartbeat:
var mediaObject = ADB.Media.createMediaObject("video-name",
"video-id",
60.0,
ADB.Media.StreamType.VOD,
ADB.Media.MediaType.Video);
var contextData = {};
//Standard metadata
contextData[ADB.Media.VideoMetadataKeys] = "Sample Episode";
contextData[ADB.Media.VideoMetadataKeys] = "Sample Show";
//Custom metadata
contextData["isUserLoggedIn"] = "false";
contextData["tvStation"] = "Sample TV Station";
tracker.trackSessionStart(mediaObject, contextData);
trackSessionStart
rastrea la intención de reproducción, no el comienzo de la reproducción. Esta API se utiliza para cargar los datos y los metadatos, y para calcular la métrica de QoS (tiempo entre trackSessionStart
y trackPlay
).
Si no utiliza datos de contexto, envíe un objeto vacío para el argumento data
en trackSessionStart
.
Realizar un seguimiento del inicio real de la reproducción
Identifique el evento del reproductor de contenido para el principio de la reproducción, cuando se renderice el primer fotograma del contenido en la pantalla, e invoque trackPlay
:
tracker.trackPlay();
Realizar un seguimiento de la finalización de la reproducción
Identifique el evento del reproductor de contenido para la finalización de la reproducción cuando el usuario ha visto el contenido hasta el final e invoque trackComplete
:
tracker.trackComplete();
Realizar un seguimiento del final de la sesión
Identifique el evento del reproductor de contenido para la carga o el cierre de la reproducción, cuando el usuario cierra o se completa la descarga, e invoque trackSessionEnd
:
tracker.trackSessionEnd();
trackSessionEnd
marca el final de una sesión de seguimiento. Si la sesión se ha visto por completo correctamente, es decir, el usuario ha visto el contenido hasta el final, asegúrese de invocar trackComplete
antes que trackSessionEnd
. Las demás llamadas de la API track*
se pasan por alto después de trackSessionEnd
(salvo trackSessionStart
en una nueva sesión de seguimiento).
Rastrear todos los escenarios de pausa posibles
Identifique el evento desde el reproductor de contenidos para pausar e invocar trackPause
:
tracker.trackPause();
Pausar escenarios
Identifique cualquier situación en la que se pausará el reproductor de contenido y compruebe que se ha invocado trackPause
correctamente. Las siguientes situaciones requieren que la aplicación invoque trackPause()
:
Identifique el evento del reproductor para la reproducción o reanudación después de la pausa e invoque trackPlay
:
tracker.trackPlay();
Puede ser el mismo origen de evento empleado en el paso 4. Asegúrese de que cada llamada de API trackPause()
esté emparejada con una llamada posterior a la API trackPlay()
cuando se reanude la reproducción.