OONielsenPlugin Class Reference

Ooyala Nielson analytics plugin implementation. More...

#import "OONielsenPlugin.h"

Inheritance diagram for OONielsenPlugin:

Instance Methods
(instancetype)	- initWithPlayer:appId:appVersion:appName:sfcode:parameters:
	Initializes the ID3Meter metering framework. More...
(NielsenAppApi *)	- getNielsenAppApi
	Get the underlying nielsen app api. More...
(void)	- addObservers: [implementation]
(void)	- dealloc [implementation]
(void)	- nielsenAppApi:eventOccurred: [implementation]
(void)	- nielsenAppApi:errorOccurred: [implementation]
(void)	- onJson: [implementation]
(void)	- onStateChanged: [implementation]
(void)	- onPlayhead: [implementation]
(void)	- onCurrentItemChanged: [implementation]
(void)	- onAdEvent: [implementation]
(void)	- onApplicationWillResignActive: [implementation]
(void)	- configureMetadata [implementation]
(BOOL)	- isCMS [implementation]
(void)	- sendPlay [implementation]
	Send start playing a content. More...
(void)	- insertMetaDataFromDictionary: [implementation]
(void)	- sendStop [implementation]
	Send stop or pause playing a content. More...
(void)	- playheadPosition: [implementation]
	Current playhead position. More...
(void)	- sendID3: [implementation]
	Send Nielsen ID3 tag data. More...

Class Methods
(NSString *)	+ dictToJson: [implementation]
(NSString *)	+ removeNielsenInvalidCharacters: [implementation]
(NSString *)	+ stringForAdType: [implementation]

Protected Attributes
long long	_lastPlayhead
BOOL	_isPlaying

Properties
NSDictionary *	customMetadata
	cutomer metadata that overrides server values More...
NielsenAppApi *	nielsenApi [implementation]
NSString *	channelName [implementation]
NSMutableDictionary *	metaData [implementation]
OOOoyalaPlayer *	player [implementation]

Detailed Description

Ooyala Nielson analytics plugin implementation.

OONielsenPlugin.

OONielsenPlugin.h in OoyalaNielsenSDK

Method Documentation

- (void) addObservers: (OOOoyalaPlayer *)  player

implementation

- (void) configureMetadata

implementation

- (void) dealloc

implementation

+ (NSString *) dictToJson: (NSDictionary *)  dict

implementation

- (NielsenAppApi *) getNielsenAppApi

Get the underlying nielsen app api.

Returns

the nielsenAppApi instance

- (instancetype) initWithPlayer:		(OOOoyalaPlayer *)	player
appId:		(NSString *)	appId
appVersion:		(NSString *)	appVersion
appName:		(NSString *)	appName
sfcode:		(NSString *)	sfcode
parameters:		(NSDictionary *)	otherParameters

Initializes the ID3Meter metering framework.

Parameters

[in]	player	the ooyala player the plugin associate with
[in]	appId	appId provided by Nielsen
[in]	appVersion	the app version
[in]	appName	the app name
[in]	sfcode	the sfcode
[in]	otherParameters	such as longitude, latitude, dma or cccode

Returns

the initialized nielsen plugin object

Parameters

[in]	appId	appId provided by Nielsen
[in]	appVersion	the app version
[in]	appName	the app name
[in]	sfcode	the sfcode
[in]	otherParameters	such as longitude, latitude, dma or cccode

Returns

returns (id) pointer to object of a Meter object; nil if error occurred.

- (void) insertMetaDataFromDictionary: (NSDictionary *)  dict

implementation

- (BOOL) isCMS

implementation

- (void) nielsenAppApi: (NielsenAppApi *)  appApi errorOccurred: (NSDictionary *)  error

implementation

- (void) nielsenAppApi: (NielsenAppApi *)  appApi eventOccurred: (NSDictionary *)  event

implementation

- (void) onAdEvent: (NSNotification *)  notifcation

implementation

- (void) onApplicationWillResignActive: (NSNotification *)  notification

implementation

- (void) onCurrentItemChanged: (NSNotification *)  notification

implementation

- (void) onJson: (NSNotification *)  notification

implementation

- (void) onPlayhead: (NSNotification *)  notification

implementation

- (void) onStateChanged: (NSNotification *)  notification

implementation

- (void) playheadPosition: (long long)  playheadPos

implementation

Current playhead position.

Parameters

playheadPos

A long integer value represents offset in second from the beginning of the content

+ (NSString *) removeNielsenInvalidCharacters: (NSString *)  json

implementation

- (void) sendID3: (NSString *)  data

implementation

Send Nielsen ID3 tag data.

Parameters

data	A string captured from ID3 PRIV info field

- (void) sendPlay

implementation

Send start playing a content.

- (void) sendStop

implementation

Send stop or pause playing a content.

+ (NSString *) stringForAdType: (OOAdType)  type

implementation

Member Data Documentation

- (BOOL) _isPlaying

protected

- (long long) _lastPlayhead

protected

Property Documentation

- (NSString*) channelName

readwritenonatomicassignimplementation

- (NSDictionary*) customMetadata

readwritenonatomicretain

cutomer metadata that overrides server values

- (NSMutableDictionary*) metaData

readwritenonatomicassignimplementation

- (NielsenAppApi*) nielsenApi

readwritenonatomicassignimplementation

- (OOOoyalaPlayer*) player

readwritenonatomicweakimplementation

---

The documentation for this class was generated from the following files:

• OONielsenPlugin.h
• OONielsenPlugin.m