Questa pagina è stata tradotta dall'API Cloud Translation.

SDK IMA DAI per Roku

Classe ima

Metodi

disableLogging, getStreamManager, initSdk, requestStream

Funzioni globali che controllano l'SDK IMA.

`disableLogging()`

Disattiva il logging dell'SDK. Il logging è attivo per impostazione predefinita.

`getStreamManager()`

Restituisce un gestore dello stream, se disponibile. Se la gestione stream non è ancora disponibile, viene restituito Non valido. Se si è verificato un errore durante la creazione di Gestore flussi, viene restituito un oggetto di errore.

Restituisci object: il gestore dello stream o l'oggetto di errore.

`initSdk(settings)`

Inizializza l'SDK.

Parametro	Tipo	Descrizione
`settings`	`object`	Oggetto impostazioni IMA facoltativo.

`requestStream(streamRequest)`

Avvia una richiesta di flusso asincrona Il controllo torna immediatamente al player dopo aver chiamato questo metodo.

Restituisci object: un errore o non è valido se non sono presenti errori

Parametro	Tipo	Descrizione
`streamRequest`	`object`

Nome	Tipo	Descrizione
`adPosition`		L'indice dell'annuncio nell'interruzione pubblicitaria. Sarà 1 per gli annunci autonomi.
`duration`		La durata massima dell'interruzione in secondi o -1 se sconosciuta.
`podIndex`		Per i live streaming, restituisce sempre -1. Per i video on demand (VOD), restituisce l'indice del pod di annunci. Per un pod pre-roll, restituisce 0. Per gli annunci mid-roll, restituisce 1, 2, ..., n. Per un pod post-roll, restituisce n+1...n+x. Il valore predefinito è 0 se l'annuncio non fa parte di un pod o se questo pod non fa parte di una playlist.
`timeOffset`		La posizione del pod nei contenuti in secondi. Il pre-roll restituisce 0, i resi post-roll -1 e i mid-roll restituiscono il tempo pianificato del pod.
`totalAds`		Il numero totale di annunci contenuti in questa interruzione pubblicitaria. Sarà 1 per gli annunci autonomi.

Nome	Tipo	Descrizione
`AD_PERIOD_ENDED`		Attivato ogni volta che lo stream passa dalla pubblicità o dallo slate ai contenuti. Questo verrà attivato anche quando l'annuncio viene riprodotto una seconda volta o quando ne cerchi uno.
`AD_PERIOD_STARTED`		Attivato ogni volta che lo stream passa dai contenuti alla pubblicità o allo slate. Questo verrà attivato anche quando l'annuncio viene riprodotto una seconda volta o quando ne cerchi uno.
`COMPLETE`		Attivato quando termina la riproduzione dell'annuncio.
`ERROR`		Attivato quando si verifica un errore.
`FIRST_QUARTILE`		Attivato quando la testina di riproduzione dell'annuncio supera il primo quartile.
`ICON_FALLBACK_IMAGE_CLOSED`		Attivato quando l'utente chiude la finestra di dialogo dell'immagine di riserva dell'icona.
`ICON_FALLBACK_IMAGE_SHOWN`		Attivato quando viene visualizzata l'immagine di riserva dell'icona.
`MIDPOINT`		Attivato quando la testina di riproduzione dell'annuncio supera il punto centrale.
`PROGRESS`		Attivato quando è presente un aggiornamento dell'avanzamento di un annuncio.
`SKIPPABLE_STATE_CHANGED`		Attivato quando cambia lo stato di un annuncio ignorabile.
`SKIPPED`		Attivato quando un annuncio viene ignorato.
`START`		Attivato quando inizia la riproduzione di un annuncio.
`THIRD_QUARTILE`		Attivato quando la testina di riproduzione dell'annuncio supera il terzo quartile.

Nome	Tipo	Descrizione
`adBreakInfo`		Informazioni relative all'intera interruzione in cui si trova questo annuncio.
`adDescription`		La descrizione dell'annuncio.
`adId`		L'ID dell'annuncio o una stringa vuota se sconosciuto.
`adSystem`		Il sistema di annunci che fornisce la creatività.
`adTitle`		Il titolo dell'annuncio.
`advertiserName`		Il nome dell'inserzionista come definito dalla parte pubblicata.
`companions`		Gli annunci companion specificati nella risposta VAST.
`currentTime`		L'ora corrente all'interno di un annuncio in secondi o -1 se sconosciuta.
`duration`		La durata di questo singolo annuncio in secondi o -1 se sconosciuta.
`skipOffset`		Il tempo necessario affinché l'annuncio diventi ignorabile o -1 se sconosciuto.
`universalAdIDRegistry`		Stringa utilizzata per identificare l'URL del sito web del registry in cui è catalogato l'ID annuncio universale della creatività selezionata.
`universalAdIDValue`		L'ID annuncio universale della creatività selezionata per l'annuncio.
`wrappers`		Un array di ima.WrapperInfo con informazioni wrapper per l'annuncio. dall'involucro esterno a quello interno.

Nome	Tipo	Descrizione
`apiFramework`		API necessaria per pubblicare l'annuncio oppure non valida se non disponibile.
`creativeType`		Rappresenta il tipo di creatività; generalmente un tipo MIME.
`height`		L'altezza dell'annuncio companion in pixel. 0 se non disponibile.
`trackingEvents`		Una mappa degli eventi di monitoraggio in cui la chiave è l'evento e il valore è un elenco di URL a cui inviare il ping per tale evento.
`url`		L'URL della risorsa statica di questo companion.
`width`		La larghezza della creatività companion in pixel. 0 se non disponibile.

Nome	Tipo	Descrizione
`end`		L'ora di fine di un cue point in secondi. Corrisponde a un'interruzione pubblicitaria.
`hasPlayed`		Un valore booleano che indica che il cue point è già stato riprodotto.
`start`		L'ora di inizio di un cue point in secondi. Corrisponde a un'interruzione pubblicitaria.

Nome	Tipo	Descrizione
`id`		L'ID dell'errore. Consulta la costante ErrorEvent per un elenco dei codici di errore.
`info`		Informazioni aggiuntive sull'errore.
`type`		Imposta sempre su errore per indicare il tipo di questo oggetto.

Nome	Tipo	Descrizione
`BAD_STREAM_REQUEST`		La richiesta di stream non è stata compilata correttamente.
`COULD_NOT_LOAD_STREAM`		Impossibile caricare lo stream.
`ERROR`		Errore sconosciuto.
`INVALID_RESPONSE`		La risposta del server non è valida.
`STREAM_API_KEY_NOT_VALID`		La chiave API fornita non è stata accettata dal server.

Nome	Tipo	Descrizione
`format`		Il formato del video: hls o trattino. Definito in ima.StreamFormat.
`manifest`		URL dello stream.
`streamId`		Un ID univoco per lo stream.
`streamType`		Il tipo di video: dal vivo oppure on demand. Definito in ima.StreamType.
`subtitles`		Sottotitoli, se disponibili. In caso contrario non valido.

Parametro	Tipo	Descrizione
`streamRequest`	`ima.StreamRequest`
`streamInitResponse`	`ima.StreamInitResponse`

Parametro	Tipo	Descrizione
`streamManifest`	`string`	L'URL del manifest dello stream con gli annunci uniti.
`streamSubtitle`	`ifArray>\|Invalid`	I sottotitoli associati allo stream o `Invalid`, in caso contrario.

Nome	Tipo	Descrizione
`adTagParameters`		Campo facoltativo. Puoi sostituire un insieme limitato di parametri di tag annuncio nella richiesta di streaming. Fornisci parametri di targeting al tuo stream fornisce maggiori informazioni. Puoi anche utilizzare i parametri dai-ot e dai-ov per la preferenza della variante streaming. Per ulteriori informazioni, consulta Sostituire i parametri delle varianti per la riproduzione in streaming.
`adUiNode`		Nodo del grafico di una scena in cui viene visualizzata l'UI dell'annuncio. L'IMA inserisce elementi come i pulsanti Perché questo annuncio e Salta su questo elemento durante gli annunci. L'elemento deve sovrapporsi all'intero elemento video.
`apiKey`		Campo facoltativo. Queste chiavi possono essere utilizzate per autenticare le richieste di flusso. Le chiavi di autenticazione DAI devono essere impostate nell'interfaccia utente di DFP.
`assetKey`		Obbligatorio per i live streaming. Viene usato per stabilire quale streaming deve essere riprodotto. La chiave asset della richiesta di live streaming è un identificatore che puoi trovare nell'interfaccia utente di DFP.
`authToken`		Il token di autorizzazione per la richiesta di flusso. Utilizzata al posto della chiave API per un'autorizzazione dei contenuti più rigorosa. L'editore può controllare le autorizzazioni per gli stream di contenuti individuali in base a questo token.
`contentSourceId`		Obbligatorio per gli stream on demand. cmsid proviene dall'origine di contenuto video di DFP nell'interfaccia utente di DFP.
`customAssetKey`		La chiave asset personalizzata viene utilizzata per stabilire quale stream riprodurre. Per le richieste di flusso di pubblicazione dei pod, sono necessarie chiavi asset personalizzate.
`format`		Il formato del flusso. Il valore predefinito è `ima.StreamFormat.HLS`.
`networkCode`		Il codice di rete del publisher che effettua la richiesta di streaming. I codici di rete sono necessari per le richieste di flusso di gestione dei pod.
`player`		Un'implementazione dell'interfaccia del player.
`ppid`		Deprecato. Utilizzare adTagParameters. Campo facoltativo. Un identificatore fornito dal publisher di DFP Audience.
`streamActivityMonitorId`		L'ID da utilizzare per eseguire il debug dello stream con il Monitoraggio attività di streaming. Viene utilizzato per fornire un modo conveniente per consentire agli editori di trovare un log dello stream nello strumento Monitoraggio attività di streaming.
`videoId`		Obbligatorio per gli stream on demand. Identificatore della fonte di contenuto video.
`videoObject`		L'oggetto video (ad esempio Video roSGNode) responsabile della riproduzione del video nell'app client. Questo oggetto eseguirà il polling di vari dati da utilizzare per sincronizzare correttamente gli eventi ID3 HLS dal vivo.
`videoStitcherSessionOptions`		Le opzioni della sessione vengono utilizzate per impostare parametri specifici dello strumento video per le richieste stream di VideoStitcher.

Parametro	Tipo	Descrizione
`adTagUrl`	`string`
`networkCode`	`string`
`contentSourceUrl`	`string`
`region`	`string`
`projectNumber`	`string`
`oAuthToken`	`string`

Parametro	Tipo	Descrizione
`vodConfigId`	`string`
`networkCode`	`string`
`region`	`string`
`projectNumber`	`string`
`oAuthToken`	`string`

SDK IMA DAI per Roku

Classe ima

disableLogging()

getStreamManager()

initSdk(settings)

requestStream(streamRequest)

Classe ima.AdBreakInfo

Proprietà

createAdBreakInfo()

Classe ima.AdEvent

Proprietà

Classe ima.AdInfo

Proprietà

createAdInfo()

Classe ima.Companion

Proprietà

createCompanion()

Classe ima.CuePoint

Proprietà

createCuePoint()

Classe ima.Error

Proprietà

createError()

Classe ima.ErrorEvent

Proprietà

Classe ima.Player

adBreakEnded(adBreakInfo)

adBreakStarted(adBreakInfo)

allVideoComplete()

createPlayer()

loadUrl(streamInfo)

Classe ima.StreamFormat

Proprietà

Classe ima.StreamInfo

Proprietà

createStreamInfo()

Classe ima.StreamManager

addEventListener(event, callback)

createStreamManager(streamRequest, streamInitResponse)

enableInteractiveAds()

getContentTime(streamTime)

getCuePoints()

getPreviousCuePoint(time)

getStreamTime(contentTime)

loadThirdPartyStream(streamManifest, streamSubtitle)

onMessage(msg)

replaceAdTagParameters(adTagParameters)

start()

Classe ima.StreamRequest

Proprietà

createLiveStreamRequest(assetKey, apiKey)

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

createPodVodStreamRequest(networkCode)

createStreamRequest()

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

CreateVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

createVodStreamRequest(contentSourceId, videoId, apiKey)

Classe ima.StreamType

Proprietà

Classe ima.WrapperInfo

Proprietà

createWrapperInfo()

`disableLogging()`

`getStreamManager()`

`initSdk(settings)`

`requestStream(streamRequest)`

`createAdBreakInfo()`

`createAdInfo()`

`createCompanion()`

`createCuePoint()`

`createError()`

`adBreakEnded(adBreakInfo)`

`adBreakStarted(adBreakInfo)`

`allVideoComplete()`

`createPlayer()`

`loadUrl(streamInfo)`

`createStreamInfo()`

`addEventListener(event, callback)`

`createStreamManager(streamRequest, streamInitResponse)`

`enableInteractiveAds()`

`getContentTime(streamTime)`

`getCuePoints()`

`getPreviousCuePoint(time)`

`getStreamTime(contentTime)`

`loadThirdPartyStream(streamManifest, streamSubtitle)`

`onMessage(msg)`

`replaceAdTagParameters(adTagParameters)`

`start()`

`createLiveStreamRequest(assetKey, apiKey)`

`createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)`

`createPodVodStreamRequest(networkCode)`

`createStreamRequest()`

`createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)`

`createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)`

`CreateVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)`

`createVodStreamRequest(contentSourceId, videoId, apiKey)`

`createWrapperInfo()`