Pulse SDK API Documentation
This SDK allows you to integrate ad serving from your Pulse account into your native Android/Android TV application.
Note: Open Measurement functionality and viewability tracking is currently not supported on Android TV.
Please see the changelog to see what is new and changed for this version.
Getting Started
During the startup of the video player application, you initialise the Pulse SDK and set up the connection to your Pulse account using the Pulse.setPulseHost method.
VOD Scenario: After initialization, use Pulse.createSession to create a PulseSession. The PulseSession is assigned a PulseSessionListener implementation which handles all the communication between the video player and the PulseSession.
When it is time to play a video ad, your PulseSessionListener will be sent a PulseVideoAd through the PulseSessionListener.startAdPlayback method.
LIVE scenario: After initialization, use Pulse.createLiveSession to create a PulseLiveSession. The PulseLiveSession is assigned a PulseLiveSessionListener implementation which handles all the communication between the video player and the PulseLiveSession.
The integration code is responsible for triggering ad breaks. When calling createLiveSession the SDK will do an ad request, but then it's up to the integration to call PulseLiveSession.getAdBreak(com.ooyala.pulse.RequestSettings.AdBreakType)
to access the desired ad break and display the ads returned from PulseLiveAdBreak.getAllLinearAds(com.ooyala.pulse.PulseLiveAdBreak.AdListReadyCallback)
Integration sample:
Android Integration Sample on GitHub| Package | Description |
|---|---|
| com.ooyala.pulse |
Classes related to the Ooyala Pulse SDK.
|