Esta página cubre SDK 3.x de JavaScript solo de Analytics. Para la implementación recomendada, consulte Implementar medios de transmisión mediante Edge Network.
ADB.Media
Métodos estáticos
Configura MediaSDK para el seguimiento. Se debe llamar a este método una vez antes de crear instancias de seguimiento en una página.
Sintaxis
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| Nombre de variable | Tipo | Descripción |
mediaConfig |
ADB.MediaConfig |
Configuración de medios válida |
appMeasurement |
objeto | Instancia de AppMeasurement |
Ejemplo
| code language-javascript |
|---|
|
Crea una instancia del contenido para realizar un seguimiento de la sesión de reproducción. Devuelve null si se llama antes de configurar los medios.
Sintaxis
| code language-javascript |
|---|
|
| table 0-row-4 1-row-4 1-align-left 2-align-left 3-align-center 4-align-left 6-align-left 7-align-left 8-align-center 9-align-left | |||
|---|---|---|---|
| Nombre de variable | Tipo | Requerido | Descripción |
trackerConfig |
Configuración del rastreador | No | Objeto de configuración del rastreador. |
Ejemplo
| code language-javascript |
|---|
|
Para anular channel o playerName por instancia de seguimiento, pase los valores de anulación en el objeto de configuración del rastreador.
Ejemplo con la configuración del rastreador
| code language-javascript |
|---|
|
Crea un objeto que contiene información multimedia. Devuelve un objeto vacío si se pasan parámetros no válidos.
Sintaxis
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 1-align-left 2-align-left 3-align-left 5-align-left 6-align-left 7-align-left 9-align-left 10-align-left 11-align-left 13-align-left 14-align-left 15-align-left 17-align-left 18-align-left 19-align-left 21-align-left 22-align-left 23-align-left | ||
|---|---|---|
| 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 |
number | Número positivo que indica la longitud de los medios en segundos. Utilice 0 si se desconoce la longitud. |
streamType |
string | Tipo de emisión o cadena no vacía para indicar el tipo de emisión de contenido. |
mediaType |
Tipo de medio | Tipo de medios (audio o vídeo) |
Ejemplo
| code language-javascript |
|---|
|
Crea un objeto que contiene información de un salto. Devuelve un objeto vacío si se pasan parámetros no válidos.
Sintaxis
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 2-row-3 3-row-3 1-align-left 2-align-left 3-align-left 5-align-left 6-align-left 7-align-left 9-align-left 10-align-left 11-align-left 13-align-left 14-align-left 15-align-left | ||
|---|---|---|
| Nombre de variable | Tipo | Descripción |
name |
string | Cadena no vacía que indica el nombre de un salto de página (anuncio previo a la emisión, anuncio durante la emisión y anuncio posterior a la emisión) |
position |
number | La posición numérica de la pausa publicitaria dentro del contenido, empezando por 1 |
startTime |
number | Valor del cabezal de reproducción al comienzo de la pausa publicitaria. |
Ejemplo
| code language-javascript |
|---|
|
Crea un objeto que contiene información de publicidad. Devuelve un objeto vacío si se pasan parámetros no válidos.
Sintaxis
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 1-align-left 2-align-left 3-align-left 5-align-left 6-align-left 7-align-left 9-align-left 10-align-left 11-align-left 13-align-left 14-align-left 15-align-left 17-align-left 18-align-left 19-align-left | ||
|---|---|---|
| Nombre de variable | Tipo | Descripción |
name |
string | Cadena no vacía que indica el nombre del anuncio |
id |
string | Cadena no vacía que indica un ID de anuncio |
position |
number | La posición numérica del anuncio dentro del salto de página, empezando por 1 |
length |
number | Número positivo que indica la duración del anuncio |
Ejemplo
| code language-javascript |
|---|
|
Crea un objeto que contiene información del capítulo. Devuelve un objeto vacío si se pasan parámetros no válidos.
Sintaxis
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 1-align-left 2-align-left 3-align-left 5-align-left 6-align-left 7-align-left 9-align-left 10-align-left 11-align-left 13-align-left 14-align-left 15-align-left 17-align-left 18-align-left 19-align-left | ||
|---|---|---|
| Nombre de variable | Tipo | Descripción |
name |
string | Cadena no vacía que indica el nombre del capítulo |
position |
number | La posición del capítulo dentro del contenido, empezando por 1 |
length |
number | Número positivo que indica la longitud del capítulo |
startTime |
number | Valor del cabezal de reproducción al principio del capítulo |
Ejemplo
| code language-javascript |
|---|
|
Crea un objeto que contiene información de estado. Devuelve un objeto vacío si se pasan parámetros no válidos.
Sintaxis
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 1-align-left 2-align-left 3-align-left 5-align-left 6-align-left 7-align-left | ||
|---|---|---|
| Nombre de variable | Tipo | Descripción |
name |
string | Estado del reproductor o cadena no vacía que indica el nombre del estado |
Ejemplo
| code language-javascript |
|---|
|
Crea un objeto que contiene información de QoE. Devuelve un objeto vacío si se pasan parámetros no válidos.
Sintaxis
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 1-align-left 2-align-left 3-align-left 5-align-left 6-align-left 7-align-left 9-align-left 10-align-left 11-align-left 13-align-left 14-align-left 15-align-left 17-align-left 18-align-left 19-align-left | ||
|---|---|---|
| Nombre de variable | Tipo | Descripción |
bitrate |
número | Número positivo que indica la velocidad de bits actual (0 si se desconoce) |
startupTime |
number | Número positivo que indica la hora de inicio (0 si se desconoce) |
fps |
number | Número positivo que indica el fps actual (0 si se desconoce) |
droppedFrames |
number | Número positivo que indica el número de fotogramas perdidos (0 si se desconoce) |
Ejemplo
| code language-javascript |
|---|
|
Devuelve la versión de MediaSDK.
Sintaxis
| code language-javascript |
|---|
|
Ejemplo
| code language-javascript |
|---|
|
Métodos de instancia
Realice un seguimiento de la intención de iniciar la reproducción. Esto inicia una sesión de seguimiento en la instancia de seguimiento de medios. Consulte también Reanudación de contenido.
Sintaxis
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 2-row-3 1-align-left 2-align-left 3-align-center 5-align-left 6-align-left 7-align-center 9-align-left 10-align-left 11-align-center | ||
|---|---|---|
| Nombre de variable | Descripción | Requerido |
mediaObject |
Información multimedia creada con el método createMediaObject. |
Sí |
contextData |
Datos de contexto de medios opcionales. Para las claves de metadatos estándar, utilice constantes de vídeo estándar o constantes de audio estándar. | No |
Ejemplo
| code language-javascript |
|---|
|
Rastrear la reproducción o reanudación de contenido después de una pausa previa.
Sintaxis
| code language-javascript |
|---|
|
Ejemplo
| code language-javascript |
|---|
|
Rastrear pausa de medios.
Sintaxis
| code language-javascript |
|---|
|
Ejemplo
| code language-javascript |
|---|
|
Seguimiento de contenido completado. Llame a este método solo cuando el medio se haya visto por completo.
Sintaxis
| code language-javascript |
|---|
|
Ejemplo
| code language-javascript |
|---|
|
Rastrear el final de una sesión de visualización. Llame a este método aunque el usuario no vea el contenido completo.
Sintaxis
| code language-javascript |
|---|
|
Ejemplo
| code language-javascript |
|---|
|
Realizar un seguimiento de un error en la reproducción de contenido.
Sintaxis
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 1-align-left 2-align-left 3-align-center 5-align-left 6-align-left 7-align-center | ||
|---|---|---|
| Nombre de variable | Descripción | Requerido |
errorId |
Cadena no vacía que contiene información de error | Sí |
Ejemplo
| code language-javascript |
|---|
|
Método para realizar un seguimiento de eventos de contenidos.
| table 0-row-2 1-row-2 2-row-2 3-row-2 1-align-left 2-align-left 4-align-left 5-align-left 7-align-left 8-align-left 10-align-left 11-align-left | |
|---|---|
| Nombre de variable | Descripción |
event |
Evento de medios |
info |
Para el evento AdBreakStart, la información de adbreak se crea mediante el método createAdBreakObject. Para el evento AdStart, la información de la publicidad se crea mediante el método createAdObject. Para el evento ChapterStart, la información del capítulo se crea mediante el método createChapterObject. Para los eventos StateStart y StateEnd, la información de estado se crea mediante el método createStateObject. Esto no es necesario para otros eventos. |
contextData |
Se pueden proporcionar datos de contexto opcionales para los eventos AdStart y ChapterStart. Esto no es necesario para otros eventos. |
Sintaxis
| code language-javascript |
|---|
|
Ejemplos
Rastrear AdBreaks
| code language-javascript |
|---|
|
Anuncios de seguimiento
| code language-javascript |
|---|
|
Seguimiento de capítulos
| code language-javascript |
|---|
|
Estados de seguimiento
| code language-javascript |
|---|
|
Seguimiento de eventos de reproducción
| code language-javascript |
|---|
|
Cambios de velocidad de bits de seguimiento
| code language-javascript |
|---|
|
Proporcione el cabezal de reproducción de medios actual al rastreador de medios. Para obtener un seguimiento preciso, invoque este método siempre que el cabezal de reproducción cambie durante la reproducción.
Sintaxis
| code language-javascript |
|---|
|
| table 0-row-2 1-row-2 1-align-left 2-align-left 4-align-left 5-align-left | |
|---|---|
| Nombre de variable | Descripción |
time |
Cabezal de reproducción actual en segundos. Para vídeo bajo demanda (VOD), el valor se especifica segundos después del comienzo del elemento de medios. Para el streaming en directo, si el reproductor no proporciona información acerca de la duración del contenido, el valor se puede especificar como el número de segundos desde la medianoche (UTC) de ese día. Nota: Cuando se utilizan marcadores de progreso, la duración del contenido es obligatoria y el cabezal de reproducción debe actualizarse como número de segundos desde el principio del elemento de medios, empezando por 0. |
Ejemplo
| code language-javascript |
|---|
|
Proporciona información actual de QoE al rastreador de medios. Para obtener un seguimiento preciso, llame a este método varias veces cuando el reproductor de contenido proporcione la información de QoE actualizada.
Sintaxis
| code language-javascript |
|---|
|
| table 0-row-2 1-row-2 1-align-left 2-align-left 4-align-left 5-align-left | |
|---|---|
| Nombre de variable | Descripción |
qoeObject |
Información actual de QoE creada con el método createQoEObject. |
Ejemplo
| code language-javascript |
|---|
|
Destruye la instancia de seguimiento.
Sintaxis
| code language-javascript |
|---|
|
Ejemplo
| code language-javascript |
|---|
|
Constantes
Define las claves de configuración que se pueden establecer por cada instancia de seguimiento.
| code language-javascript |
|---|
|
Define el tipo de medio que se está rastreando actualmente.
| code language-javascript |
|---|
|
Define el tipo de flujo del contenido que se rastrea actualmente.
| code language-javascript |
|---|
|
ADB.Media.VideoMetadataKeys, ADB.Media.AudioMetadataKeys y ADB.Media.AdMetadataKeys proporcionan las cadenas de clave de datos de contexto para los metadatos estándar. Para obtener la lista completa de claves y sus variables de informes correspondientes, consulte Referencia de variable de metadatos estándar.Define el tipo de un evento de seguimiento.
| code language-javascript |
|---|
|
Define valores estándar para rastrear el estado del reproductor.
| code language-javascript |
|---|
|
Constante para indicar que la sesión de seguimiento actual está reanudando una sesión previamente cerrada. Esta información debe proporcionarse al iniciar una sesión de seguimiento.
Sintaxis
| code language-javascript |
|---|
|
Ejemplo
| code language-javascript |
|---|
|
ADB.MediaConfig
trackingServerchannelplayerNameappVersiondebugLoggingfalse)ssltrue)