Adverts Context
The business logic for managing and displaying adverts is abstracted into it's own context and provider.
Properties
Property | Type | Details |
|---|---|---|
| adEngines | AdEngine [] | An array of Ad Engines, either prop via config or returned from MAPI, contains the list of Advert Engines for the given radioplayer id |
| adswizzProvider | AdProvider | The provider for Adswizz adverts |
| vastProvider | AdProvider | The provider for VAST adverts |
| tritonProvider | AdProvider | The provider for Triton adverts |
| adswizzEngine | AdsWizzEngine | The engine used to configure Adswizz ads |
| tritonEngine | TritonEngine | The engine used to configure Triton ads |
| vastEngine | VastEngine | The engine used to configure Vast ads |
| gptTag | GoogleAdProvider | Google Publish Tags adverts provider |
| videoAdHolderRef | PropRef-HTMLDivElement | The ref of the div container the advert element is rendered within - Used to get dimensions of advert |
| videoRef | PropRef-HTMLVideoElement | The ref of the video element the advert is rendered in - Used to control playback of advert |
| requestStreamPlay | Function | Makes a request to the audio engine that the audio stream continues playback after an Ad |
| requestStreamPlay | Function | Makes a request to the audio engine that the audio stream pauses playback to play an Ad |
| providerNames | string | The names of the advert providers - used by the cookie banner |
| videoAdPlaying | boolean | If a video advert is currently playing |
| companionAd | string | Data for a non-Google provided advert |