Ooyala Player v4 Pulse Integration for iOS Documentation

The Ooyala Pulse Integration framework for iOS allows you to display ads served from Ooyala Pulse along with your video content in the Ooyala Player for iOS.

The OOPulseManager class provides the support for displaying Ooyala Pulse ads to your OOOoyalaPlayer.

Prerequisites

• The Ooyala Player framework for iOS (aka the Ooyala Mobile SDK for iOS)
• The Ooyala Pulse framework for iOS

Getting Started

1. Import the Ooyala Pulse Integration framework:

   @import <OoyalaPulseIntegration/OoyalaPulseIntegration.h>

2. Create an OOPulseManager object and associate it with your OOOoyalaPlayer:

   self.manager = [[OOPulseManager alloc] initWithPlayer:self.player];
   self.manager.delegate = self;

3. Optionally, set any ad player options through the OOPulsePlayerOptions object on the OOPulseManager. Possible options are:

   • displayingAdTitle: Boolean indicating whether to show the ad title during the ad playback or not. Default value is false, and indicates to not show the ad title.

     ``` OOPulsePlayerOptions * pulsePlayerOptions = [[OOPulsePlayerOptions alloc] init]; self.manager.pulsePlayerOptions.displayingAdTitle = true; ```

4. Implement the OOPulseManagerDelegate method pulseManager:createSessionForVideo:withPulseHost:contentMetadata:requestSettings: in your delegate. Initial values for all parameters in this method are automatically taken from settings in your Backlot account, but if needed, you may modify the host location of your Ooyala Pulse account, persistent ID, content metadata, request settings and so on, before creating the session. For more information about these parameters, refer to Ooyala Video Advertising SDK Parameter Reference.

- (id<OOPulseSession>)pulseManager:(OOPulseManager *)manager
             createSessionForVideo:(OOVideo *)video
                     withPulseHost:(NSString *)pulseHost
                   contentMetadata:(VPContentMetadata *)contentMetadata
                   requestSettings:(VPRequestSettings *)requestSettings
{
  // Set the correct pulse host and options
  [OOPulse setPulseHost:pulsehost
        deviceContainer:nil
           persistentId:nil];

  // Here we assume a landscape orientation for video playback
  requestSettings.width = (NSInteger)MAX(self.view.frame.size.width, self.view.frame.size.height);
  requestSettings.height = (NSInteger)MIN(self.view.frame.size.width, self.view.frame.size.height);

  // Implement a way of determining the max
  // bitrate of ads to request.
  requestSettings.maxBitRate = [BandwidthChecker maxBitRate];

  return [OOPulse sessionWithContentMetadata:contentMetadata
                             requestSettings:requestSettings];
}

Sample Application

The sample integration is coded in OBJ-C and is found here