OOPulse Class Reference

Inherits from NSObject
Declared in OOPulse.h

Overview

The Ooyala Pulse SDK.

This class is used to request ad sessions from Ooyala Pulse. An ad session contains all the ads that will be played along with a specific piece of content.

When your application has content which it wants to display alongside advertisements, it requests a new ad session using this class. (See OOPulseSession.)

Methods

+ setPulseHost:deviceContainer:persistentId:

Initialize the Pulse SDK.

+ (void)setPulseHost:(NSString *)host deviceContainer:(NSString *)deviceContainer persistentId:(NSString *)persistentId

Parameters

host

The Ooyala Pulse hostname for the client account being used.

deviceContainer

The Ooyala Pulse device container, if any; can be nil.

persistentId

The Ooyala Pulse persistent user id, if any; can be nil.

Discussion

This method must be called before requesting any ad sessions.

Declared In

OOPulse.h

+ setLogListener:

Set a listener to receive low-level log messages about errors, warnings and the like, which may be dispatched during ad or tracking requests.

+ (void)setLogListener:(OOLogListenerBlock)listener

Parameters

listener

A OOLogListenerBlock which is called with the log messages.

Declared In

OOPulse.h

+ sessionWithContentMetadata:requestSettings:

Create a new Pulse ad session with the passed metadata and request settings.

+ (id<OOPulseSession>)sessionWithContentMetadata:(OOContentMetadata *)contentMetadata requestSettings:(OORequestSettings *)requestSettings

Parameters

contentMetadata

Information about the content along with which the requested ads are to be displayed.

requestSettings

Information about the environment in which the ad will play.

Return Value

An object conforming to the OOPulseSession protocol.

Declared In

OOPulse.h

+ logDebugMessages:

Set whether or not debug information from the SDK should be logged to the console.

+ (void)logDebugMessages:(BOOL)value

Parameters

value

YES if debug messages should be logged; NO otherwise.

Declared In

OOPulse.h

+ isDebugLoggingEnabled

Method that requests the status of the debug messages logging inside the Pulse framework.

+ (BOOL)isDebugLoggingEnabled

Return Value

YES if debug messages are enabled; NO otherwise.

Declared In

OOPulse.h