Le istruzioni seguenti forniscono indicazioni per l’implementazione negli SDK 2.x.
Se stai implementando una versione 1.x di SDK, puoi scaricare le guide per sviluppatori 1.x qui: Scarica SDK
Configurazione del tracciamento iniziale
Identifica quando l’utente attiva l’intenzione di riproduzione (l’utente fa clic su play e/o l’esecuzione automatica è attiva) e crea un’istanza MediaObject
.
Nome variabile | Descrizione | Obbligatorio |
---|---|---|
name |
Nome file multimediale | Sì |
mediaid |
Identificatore univoco del file multimediale | Sì |
length |
Lunghezza del file multimediale | Sì |
streamType |
Tipo di flusso (vedi Costanti StreamType sotto) | Sì |
mediaType |
Tipo di file multimediale (vedi Costanti MediaType sotto) | Sì |
Costanti StreamType
:
Nome costante | Descrizione |
---|---|
VOD |
Tipo di flusso per Video on Demand. |
LIVE |
Tipo di flusso per il contenuto LIVE. |
LINEAR |
Tipo di flusso per contenuti LINEAR. |
AOD |
Tipo di flusso per audio on-demand. |
AUDIOBOOK |
Tipo di flusso per audiolibro. |
PODCAST |
Tipo di flusso per podcast. |
Costanti MediaType
:
Nome costante | Descrizione |
---|---|
Audio |
Tipo di file multimediale per flussi Audio. |
Video |
Tipo di file multimediale per i flussi Video. |
var mediaObject =
MediaHeartbeat.createMediaObject(<MEDIA_NAME>,
<MEDIA_ID,
<MEDIA_LENGTH>,
MediaHeartbeat.StreamType.VOD,
<MEDIA_TYPE>);
Allega metadati
Facoltativamente, allega oggetti metadati standard e/o personalizzati alla sessione di tracciamento tramite variabili di dati di contesto.
Metadati standard
Implementazione dei metadati standard in JavaScript
Il collegamento dell’oggetto metadati standard all’oggetto multimediale è facoltativo.
Riferimento API per le chiavi di metadati multimediali: Chiavi di metadati standard - JavaScript
Consulta il set completo dei metadati disponibili qui: Parametri audio e video
Metadati personalizzati
Crea un oggetto variabile per le variabili personalizzate e compila i dati per questo elemento multimediale. Ad esempio:
/* Set custom context data */
var customVideoMetadata = {
isUserLoggedIn: "false",
tvStation: "Sample TV station",
programmer: "Sample programmer"
};
Tracciare l’intenzione di inizio riproduzione
Per iniziare a tracciare una sessione multimediale, effettua una chiamata trackSessionStart
sull’istanza Media Heartbeat:
mediaHeartbeat.trackSessionStart(mediaObject, customVideoMetadata);
Il secondo valore è il nome dell’oggetto metadati multimediali personalizzati creato al passaggio 2.
trackSessionStart
tiene traccia delle intenzioni di riproduzione dell’utente, non dell’inizio della riproduzione. Questa API viene utilizzata per caricare dati/metadati e per stimare la metrica QoS relativa al tempo di avvio (durata tra trackSessionStart
e trackPlay
).
Se non utilizzi metadati personalizzati, invia semplicemente un oggetto vuoto per l’argomento data
in trackSessionStart
, come mostrato nella riga esterna di commento nell’esempio di iOS precedente.
Tracciare l’inizio effettivo della riproduzione
Identifica l’evento dal lettore multimediale per l’inizio della riproduzione, dove viene eseguito il rendering del primo fotogramma del file multimediale sullo schermo ed effettua una chiamata trackPlay
.
mediaHeartbeat.trackPlay();
Tracciare il completamento della riproduzione
Identifica l’evento dal lettore multimediale per il completamento della riproduzione in cui l’utente ha guardato il contenuto fino alla fine ed effettua una chiamata trackComplete
.
mediaHeartbeat.trackComplete();
Tracciare la fine della sessione
Identifica l’evento dal lettore multimediale per lo scaricamento/la chiusura della riproduzione in cui l’utente chiude l’elemento multimediale e/o l’elemento multimediale viene completato e scaricato ed effettua una chiamata trackSessionEnd
.
mediaHeartbeat.trackSessionEnd();
trackSessionEnd
indica la fine di una sessione di tracciamento. Se la sessione è stata guardata correttamente fino al completamento, dove l’utente ha guardato il contenuto fino alla fine, assicurati che trackComplete
venga chiamato prima di trackSessionEnd
. Dopo trackSessionEnd
, qualsiasi chiamata API track*
viene ignorata, tranne la chiamata trackSessionStart
per una nuova sessione di tracciamento video.
Tracciare tutti gli scenari di pausa possibili
Identifica l’evento dal lettore multimediale per la pausa ed effettua una chiamata trackPause
.
mediaHeartbeat.trackPause();
Scenari di pausa
Identifica uno scenario in cui il lettore multimediale si interrompe e verifica che trackPause
sia chiamato correttamente. I seguenti scenari richiedono tutti una chiamata trackPause()
dall’app:
Identifica l’evento dal lettore per la riproduzione e/o la ripresa dalla pausa ed effettua una chiamata trackPlay
:
mediaHeartbeat.trackPlay();
Potrebbe trattarsi della stessa origine evento utilizzata nel passaggio 4. Quando la riproduzione riprende, assicurati che ogni chiamata API trackPause()
sia associata alla seguente chiamata API trackPlay()
.