Ooyala Pulse iOS & tvOS Framework 2.x Reference

This SDK allows you to integrate ad serving from your Ooyala Pulse account into your native iOS video player application.

Please see the changelog to see what is new and changed for this version.

Integrating the Pulse SDK into your project

After downloading the frameworks, you need to add them to the Embedded Binaries of your project. This is required because the Pulse iOS/tvOS framework is now a dynamic library.

To generate a build for the App Store, on the Build Phases of your target you should add a new Run Script Phase and add this line inside it:

bash "${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/Pulse.framework/strip-frameworks.sh"

This script removes the simulator frameworks from the binary before archiving to comply with the Appleā€™s App Store policy of attaching dynamic libraries.

(if you’re building for the Apple TV, replace Pulse.framework with Pulse_tvOS.framework)

Getting Started

During the startup of the video player application, you initialise the Pulse SDK and set up the connection to your Ooyala Pulse account using the setPulseHost method from OOPulse. After initialization, use OOPulse to create an OOPulseSession. The OOPulseSession has an OOPulseSessionDelegate which handles all the communication between the video player and the OOPulseSession.

When it is time to play a video ad, your OOPulseSessionDelegate will be sent an OOPulseVideoAd through the startAdPlaybackWithAd method.

Integration sample: OBJ-C

Low Level or Core SDK - DEPRECATED

The Core SDK is deprecated from version 2.4.17.14.0 and will be removed completely in version 2.5.17.20.0, to be released on October 3rd, 2017. This means that:

  • All new integrations on iOS need to use the iOS Pulse SDK.
  • Integrations using the latest iOS Core SDK are still supported for critical bug fixes until April 2018.
  • If new features are needed in your existing integration, then you must transform the integration to use the iOS Pulse SDK.

As a result of deprecating the Core SDK, changes were made to the Pulse SDK. All classes and constants where the name started with “VP” have been renamed to start with “OO” in the Pulse SDK. For example, VPRequestSettings is now called OORequestSettings. When you upgrade the SDK in your Pulse SDK integration, you must replace the class and constant names according to this new naming convention.

To move away from the Core SDK and start using the Pulse SDK instead, use the following tutorial.

Deprecated Classes, Protocols and Constants