DCR Ireland Video iOS SDK

Engineering Portal / Digital / International DCR / DCR Ireland Video iOS SDK

Overview

The Nielsen SDK is one of the multiple framework SDKs that Nielsen provides to enable measuring linear (live) and on-demand TV viewing using TVs, mobile devices, etc. The App SDK is the framework for mobile application developers to integrate Nielsen Measurement into their media player applications. It supports a variety of Nielsen Measurement Products like Digital Content Ratings (DCR), and Digital Ad Ratings (DAR). Nielsen SDKs are also equipped to measure static content and can track key life cycle events of an application like:

• Application launch events and how long app was running

Special Notes regarding iOS14

Permission to Track

Apple recently released a new policy on consent requirements, that require the user's permission, to track them using their device's advertising identifier (IDFA). To request the user's permission, use the AppTrackingTransparency framework. The ID for Vendors (IDFV), may be used for analytics across apps from the same content provider. The IDFV may not be combined with other data to track a user across apps and websites owned by other companies unless you have been granted permission to track by the user.

For more information, see:

• App Tracking Transparency
• Human Interface Guidelines
• AdSupport Framework

More detailed information on how the Nielsen SDK versions work with the AppTrackingTransparency framework is located on our DCR Video iOS14 Migration page.

App store privacy questionnaire

As of April 22nd, 2021, any app submitted to the app store will need to provide information about your app's privacy practices, including the practices of third-party partners such as Nielsen, through App Store Connect. Nielsen has created a guide which is titled, User Privacy and Data Use to make information about Nielsen’s data collection practices available to clients who use the Nielsen Digital SDK and Nielsen tags. The guide is organized using headings of the App privacy details on the App Store (as of December 7th, 2020) webpage for convenience.

Prerequisites

Before you start the integration, you will need:

Item	Description	Source
App ID (appid)	Unique ID assigned to the player/site and configured by product.	Provided by Nielsen
Nielsen SDK	Includes SDK frameworks and sample implementation; See iOS SDK Release Notes	Download

If need App ID(s) or our SDKs, feel free to reach out to us and we will be happy to help you get started. Refer to Digital Measurement Onboarding guide for information on how to get a Nielsen App SDK and appid.

Implementation

Version 8 of the Nielsen App SDK will come in three versions. One that is enabled to work with the App Tracking Transparency Framework, another version that does not use the Ad Framework, and a version for Kids Apps or where noID is required.

SDK Flavor	Description
iOS Ad Version	* Opt-In and Opt-Out functionality managed by the AppTrackingTransparency framework . (Preferred approach) * The Nielsen SDK will attempt to collect the IDFA (Id for Advertisers) on the device. * For iOS14+, if the value returned is ATTrackingManager.AuthorizationStatus.authorized. * If the device is running iOS12 or iOS13, the Limit Ad Tracking setting is requested.
iOS No Ad Framework	* Without the Ad Framework, the Nielsen SDK cannot read the IDFA, so it will attempt to retrieve the IDFV. * The ID for Vendors (IDFV), may be used for analytics across apps from the same content provider. * The developer is required to present the User Choice Opt Out page which is described in the Privacy Section.
iOS SDK noID	* This version of the Nielsen SDK is perfect for Kid apps, or where no ID is required. * Please review the Opt Out Requirement.

How to obtain the NielsenAppApi.Framework

The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of CocoaPods. We recommend using the CocoaPods-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.

• iOS Package Dependency Guides (CocoaPods, Carthage, Swift Package Manager)
• Select to Download Directly
• Using the XCFramework bundle

Setting up your Development Environment

Prior to SDK Version 6.2.0.0 the IOS framework has been distributed as a static library packaged into framework bundle format. Apple recommends to use dynamic framework, it has some benefits over static libraries like less executable file size of an app, faster startup time and native support in xCode IDE. Nielsen AppSDK has been transformed into dynamic framework in this release (static framework is still available).

If migrating from the static library to this new dynamic framework, once implemented, unless your specific application requires, you can remove the following Frameworks that were once required: [AdSupport, JavascriptCore, SystemConfiguration, Security, AVFoundation, libc++]

The Dynamic framework is created as a fat framework. It means that it contains slices required for devices (armv7, arm64) as well as slices required for simulators (i386, x86_64). Simulator slices are needed to let clients build and debug their app on the simulators, but they should be removed before sending the app to the AppStore. The example of the shell script that should be added as a Run Script phase in the application can be found below.

XCFramework is solution for the problems described above Apple recommends to use XCFrameworks. In XCFramework, we no longer build a single framework with multiple architectures. Instead, we build one small framework for each combination of architecture and target and store it in its own folder. The top-level XCFramework folder have folders like ios-arm64, ios-arm64-simulator, etc. Each of these folders is its own framework, complete with headers, modules, and binary.

Configuring Xcode Development Environment

Starting with SDK version 6.0.0.0, the Nielsen App SDK is compatible with Apple iOS versions 8.0 and above. In addition, when using the dynamic framework, all the required frameworks are linked automatically as the are needed. More details can be found here: https://stackoverflow.com/questions/24902787/dont-we-need-to-link-framework-to-xcode-project-anymore

Note: All communications between the SDK and the Census (Collection Facility) use HTTPS.

Special Note for Static Framework

Starting from 8.2.0.0 release framework is build from the mixed (swift + objc) source code. If static (xc)framework is integrated additional settings should be applied to fix build or runtime issues.

Download Framework

The first step is to download and copy the NielsenAppApi.framework bundle to the app project directory. (Not required if using CocaPods)

Add Framework

In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries. (Not required if using CocaPods)

Add Path

Add path to the NielsenAppApi.framework in the Framework Search Paths build setting. (Not required if using CocaPods)

Import Framework

Add NielsenAppApi.framework module in the source file of your app:

Using Swift

Add the following:

import NielsenAppApi

Using Objective-C

@import NielsenAppApi;

xCode 12 building errors

Developers who uses "fat" framework in their apps started reporting the following error that they get building the app in xCode 12.3+:

Building for iOS Simulator, but the linked and embedded framework 'MyFramework.framework' was built for iOS + iOS Simulator.

The binary framework contains different code for the same architecture in multiple places, and Xcode doesn’t know how to handle it. There is workaround that people recommend to use in such cases:

• https://stackoverflow.com/questions/63267897/building-for-ios-simulator-but-the-linked-framework-framework-was-built
• https://stackoverflow.com/questions/63932158/xcode12-issus-ld-building-for-ios-simulator-but-linking-in-object-file-built

IPA processing failure

Assertion failed: Expected 4 archs in otool output:

The error above is due to the "fat" (simulator+device) framework which will not appear if you have not enabled Bitcode. To build your app with full Bitcode support, it is recommended that you use a XCFramework to avoid the 4 archs in otool output message.

Create SDK Instance

The latest version of the Nielsen App SDK allows instantiating multiple instances of the SDK object when needed, which can then be used simultaneously. For the general use case where only one video is played at the same time in the App, a single instance of SDK object can then be used to play back and measure all watched streams one after another.

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.

Parameter / Argument	Description	Source	Required/Obligatory?	Example
appid	Unique id for the application assigned by Nielsen. It is GUID data type.	Nielsen-specified	Yes	"PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
appname	Name of the application	Client-defined	Yes	"Nielsen Sample App"
appversion	Current version of the app used	Client-defined	Yes	"1.0.2"
sfcode	Nielsen collection facility to which the SDK should connect.	Nielsen-specified	Yes	"ire"
nol_devDebug	Enables Nielsen console logging. Only required for testing	Nielsen-specified	Optional	"DEBUG"

Debug flag for development environment

Player application developers / integrators can use Debug flag to check whether an App SDK API call made is successful. To activate the Debug flag, Pass the argument @"nol_devDebug":@"DEBUG", in the JSON string.

• DEBUG: Debug logs, used by the developers to debug more complex issues.

Once the flag is active, it logs each API call made and the data passed. The log created by this flag is minimal.

Note: DO NOT activate the Debug flag in a production environment.

Sample SDK Initialization Code

Initialize the Nielsen App object within the viewDidLoad view controller delegate method using initWithAppInfo:delegate:

If App SDK is initialized using init or new methods, it will ignore the API calls resulting in no measurement. The SDK will not return any errors.

Using Objective-C

#import "NlsAppApiFactory.h"
#import <NielsenAppApi/NielsenAppApi.h>

@implementation NlsAppApiFactory

+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;
{
    NSDictionary *appInformation = @{
                                     @"appid": "PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                                     @"appversion": "1.0",
                                     @"appname": "app name here",
                                     @"sfcode": "ire",
                                     @"nol_devDebug": @"DEBUG"
                                    };
    return [[NielsenAppApi alloc] initWithAppInfo:appInformation delegate:delegate];
}
@end

The following would be the NlsAppApiFactory.h file:

#import <Foundation/Foundation.h>

@class NielsenAppApi;
@protocol NielsenAppApiDeligate;

@interface NlsAppApiFactory : NSObject

+ (NielsenAppAPI *) createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;

@end

Using Swift

NielsenInit.swift

class NielsenInit: NSObject {
    class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
    let appInformation:[String: String] = [
            "appid": "PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "appversion": "1.0",
            "appname": "app name here",
            "sfcode": "ire",
            "nol_devDebug": "DEBUG"
        ]
        return NielsenAppApi(appInfo:appInformation, delegate:delegate)
    }
}

Sample code using AVPlayer.
ViewController.swift

class ViewController: UIViewController, NielsenAppApiDelegate, AVPictureInPictureControllerDelegate, CLLocationManagerDelegate  {

    let avPlayerViewController = AVPlayerViewController()
    var avPlayer:AVPlayer?
    var nielsenAppApi: NielsenAppApi!

  override func viewDidLoad() {
        super.viewDidLoad()

        self.nielsenAppApi = NielsenInit.createNielsenAppApi(delegate: self)
        NSLog("Nielsen SDK initialized")

            }
  }

APP SDK Error & Event Codes

To view the Error and Event codes for iOS and Android, please review the App SDK Event Code Reference page.

Life cycle of SDK instance

The life cycle of SDK instance includes four general states:

1. Initial state – The SDK is not initialized and hence, not ready to process playing information. Once the SDK is moved out of this state, it needs instantiation of the new SDK instance in order to get the instance in the Initial state.
2. Idle state – The SDK is initialized and is ready to process playing information. Once Initialized, the SDK instance is not processing any data, but is listening for the play event to occur.
3. Processing state – The SDK instance is processing playing information. API calls "play" and "loadMetadata" move the SDK instance into this state. In this state, the SDK instance will be able to process the API calls (see below)
4. Disabled state – The SDK instance is disabled and is not processing playing information. SDK instance moves into this state in one of the following scenarios.
   1. Initialization fails
   2. appDisableApi is called

@property (assign) BOOL appDisableApi;

Create Metadata Objects

The parameters passed must be either a JSON formatted NSString or a NSDictionary object. The JSON passed in the SDK must be well-formed.

• NSDictionary object
  • If an object of unexpected type is passed to the method, the error message will be logged.
  • If string has invalid JSON format, the error message will be logged.
• JSON value must be string value.
  • This includes boolean and numeric values. For example, a value of true should be represented with "true", number value 123 should be "123".
  • All the Variable Names like appid, appname, dataSrc, title, type etc. are case-sensitive. Use the correct variable name as specified in the documentation.
• JSON string can be prepared using either raw NSString or serialized NSDictionary.
  

Create channelName Metadata

channelName should remain constant throughout the completion of an episode or live stream.

Key	Description	Values	Required
channelName	Any string representing the channel/stream	custom	Yes

Create Content Metadata

Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.

Keys	Description	Values	Required
type	type of asset	'content'	Yes
assetid	unique ID assigned to asset (32 Character limit)	custom (no Special Characters)	Yes
program	name of program (100 character limit)	custom	Yes
title	name of episode (100 character limit)	custom	Yes
length	length of content in seconds	Length of content in seconds (86400 seconds for live stream (24/7). For Event-Live streams planned length. For VoD video length)	Yes
airdate	the airdate in the linear TV	YYYYMMDD HH24:MI:SS	Yes
isfullepisode	full episode flag	'y'- full episode, 'n'- non full episode	Yes
adloadtype	type of ad load: '1' Linear – matches TV ad load '2' Dynamic – Dynamic Ad Insertion (DAI)	'2' - DCR measures content with dynamic ads	Yes
segB	custom segment for the clients granular reporting within a brand	Example: ChannelName	Optional
segC	custom segment for the clients granular reporting within a brand	Example: PlayerName	Optional

Create Ad Metadata

The Ad Metadata (if applicable) should be passed for each individual ad.

Keys	Description	Values	Required
type	type of Ad	'preroll', 'midroll', 'postroll'	Yes
assetid	unique ID assigned to Ad	custom (no Special Characters)	Yes

Note: All metadata values should be passed as UTF-8 strings.

URL Character Limit: There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers.

MetaData Example

Using Objective-C

NSDictionary  *channelInfo = @
{
    @"channelName":@"My Channel Name 1",
}


NSDictionary *contentMetadata = @
  {
    @ "type": @ "content",
    @ "assetid": @ "88675545",
    @ "title": @ "Program S3, EP1",
    @ "isfullepisode": @ "y",  
    @ "program": @ "Program Name",
    @ "length": @ "3600",
    @ "airdate": @ "20200321 10:05:00",
    @ "adloadtype": @ "2"
    @ "segB": @ "ChannelName", //optional
    @ "segC": @ "PlayerName" //optional
}

NSDictionary *adMetadata = @
  {
    @"type" : "postroll",
    @"assetid" : "AD-ID123"
}

Using Swift

     let channelInfo = [
        "channelName": "My Channel Name 1",
     ]

     let contentMetadata = [
         "type": "content",
         "assetid": "88675545",
         "title": "Program S3, EP1",
         "isfullepisode":"y",
         "adloadtype":"2",
         "program":"Program Name",
         "length":"3600", 
         "airdate":"20171020 10:05:00"
         "segB": "ChannelName", //optional
         "segC": "PlayerName" //optional
     ]


    let adMetadata = [
        "type": "preroll",
        "assetid" : "ad123"
    ]

Start the Measurement

Overview of SDK API Calls

play

The play method prepares the SDK for reporting once an asset has loaded and playback has begun. Use play to pass the channel descriptor information through channelName parameter when the user taps the Play button on the player. Call play only when initially starting the video.

Using Objective-C

[self.nielsenAppApi play:channelInfo];

Using Swift

self.nielsenAppApi?.play(channelInfo);

loadMetadata

Needs to be called at the beginning of each asset, pass JSON object for relevant content or ad. Make sure to pass as 1st loadMetadata for content at the begining of playlist - see below API call sequence examples.

Using Objective-C

[self.nielsenAppApi loadMetadata:metadataDict];

Using Swift

self.nielsenAppApi?.loadMetadata(metadataDict)

playheadPosition

Pass playhead position every second during playback. for VOD: pass current position in seconds. for Live: current Unix timestamp (seconds since Jan-1-1970 UTC) - if it is possible to seek back in Live content, then pass related Unix time (not current). Pass whole number that increments only by 1 like 1,2,3..

Using Objective-C

[self.nielsenAppApi playheadPosition:pos];

Using Swift

self.nielsenAppApi?.playheadPosition(pos);

stop

Call when

• ads complete playing
• when a user pauses playback
• upon any user interruption scenario - see bellow chapter Interruption scenario

Using Objective-C

[self.nielsenAppApi stop];

Using Swift

self.nielsenAppApi?.stop;

end

Call when the content asset completes playback. Stops measurement progress.

Using Objective-C

[self.nielsenAppApi end];

Using Swift

self.nielsenAppApi?.end

API Call Sequence

Use Case 1: Content has no Ads

Call play() with channelName JSON as below.

{
   "channelName": "ChannelName"
}

Call loadMetadata() with JSON metadata for content as below.

{
  "type": "content",
  "assetid": "vid345-67483",
  "program": "ProgramName",
  "title": "Program S3, EP1",
  "length": "3600",
  ...
}

Call playheadPosition() every one second until a pause. Use the sample API sequence below as a reference to identify the specific events that need to be called during content playback without ads.

Type	Sample code	Description
Start of stream	mAppSdk.play(channelName);	// channelName contains JSON metadata of channel/video name being played
	mAppSdk.loadMetadata(contentMetaDataObject);	// contentMetadataObject contains the JSON metadata for the content being played
Content	mAppSdk.playheadPosition(playheadPosition);	// position is position of the playhead while the content is being played
End of Stream	mAppSdk.end();	// Content playback is completed.

Use Case 2: Content has Ads

Call play() with channelName JSON as below.

{
   "channelName": "ChannelName"
}

Call loadMetadata() with JSON metadata for ad as below.

{
   "type": "preroll",
   "assetid": "ad_123",
   ...
}

Note: In case the individual ad details are not available, send ad pod (presence) details through the loadMetadata and playhead position through playheadPosition.

Call playheadPosition() every one second until a pause / another loadMetadata() is called. Playhead should be passed for the entire duration of ad pod, if the ad pod details are passed as part of loadMetadata().

The sample API sequence can be used as a reference to identify the specific events that need to be called during content and ad playback.

Type	Sample code	Description
Start of stream	mAppSdk.play(channelName);	// channelName contains JSON metadata of channel/video name being played
	mAppSdk.loadMetadata(contentMetaDataObject);	// contentMetadataObject contains the JSON metadata for the content being played
Preroll	mAppSdk.loadMetadata(prerollMetadataObject);	// prerollMetadataObject contains the JSON metadata for the preroll ad
	mAppSdk.playheadPosition(playheadPosition);	// position is position of the playhead while the preroll ad is being played
	mAppSdk.stop();	// Call stop after preroll occurs
Content	mAppSdk.loadMetadata(contentMetaDataObject);	// contentMetadataObject contains the JSON metadata for the content being played
	mAppSdk.setPlayheadPosition(playheadPosition);	// position is position of the playhead while the content is being played
Midroll	mAppSdk.loadMetadata(midrollMetaDataObject);	// midrollMetadataObject contains the JSON metadata for the midroll ad
	mAppSdk.playheadPosition(playheadPosition);	// position is position of the playhead while the midroll ad is being played
	mAppSdk.stop();	// App moves to background(midroll pauses)
	mAppSdk.loadMetadata(midrollMetaDataObject);	// App moves to foreground (midroll resumes)
	mAppSdk.playheadPosition(playheadPosition);	// playheadPosition is position of the playhead while the midroll ad is being played
	mAppSdk.stop();	// Call stop after midroll occurs
Content (End of stream)	mAppSdk.loadMetadata(contentMetaDataObject);	// contentMetadataObject contains the JSON metadata for the content being played
	mAppSdk.playheadPosition(playheadPosition);	// position is position of the playhead while the content is being played
End of Stream	mAppSdk.end();	// Call end() at the end of content
Postroll	mAppSdk.loadMetadata(postrollMetaDataObject);	// postrollMetadataObject contains the JSON metadata for the postroll ad
	mAppSdk.playheadPosition(playheadPosition);	// position is position of the playhead while the postroll ad is being played
	mAppSdk.stop();	// Call stop after postroll occurs

Note: Each Ad playhead should reset or begin from 0 at ad start. When content has resumed following an ad break, playhead position must continue from where previous content segment was left off.

Stop/Resume the Measurement for video Playback Interruptions

As part of integrating Nielsen App SDK with the player application, the Audio / Video app developer needs to handle the following possible interruption scenarios:

• Pause / Play
• Network Loss (Wi-Fi / Airplane / Cellular)
• Call Interrupt (SIM or Third-party Skype / Hangout call)
• Alarm Interrupt
• Content Buffering
• Device Lock / Unlock (Video players only, not for Audio players)
• App going in the Background/Foreground (Video players only, not for Audio players)
• Channel / Station Change Scenario
• Unplugging of headphone

In case of encountering one of the above interruptions, the player application needs to

• Call stop immediately (except when content is buffering) and withhold sending playhead position.
• Once the playback resumes, start sending pings playheadPosition for the new viewing session.

Please see the Digital Measurement FAQ for more details

Review SDK Integration Architecture Diagram

For Content Playback

For Ad Playback

Privacy and Opt-Out

The Irish Market build of the Nielsen SDK automatically Opt's Users out of the collection of any User Identifiable information or any Device Advertising ID.

When building your app:

1. Ensure that you are using the NoID version of the Nielsen SDK Framework.
2. Immediately following the initialization of the Nielsen SDK ensure you call the userOptOut API with Opt out selection:

NielsenAppApi?.userOptOut("nielsenappsdk://1"); // User opt-out

Required Privacy Links

Users must either have access to the "About Nielsen Measurement" page, or have similar text available within the native app. Include "About Nielsen Measurement" and "Your Choices" link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

In addition, the following text must be included in your app store description.

"Please note: This app features Nielsen’s proprietary measurement software which contributes to market research, like Nielsen’s TV Ratings. Please see https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/

Retrieve current Opt-Out preference

Whether the user is opted out via OS-level Opt-out or via User Choice Opt-out, the current Opt-Out status as detected by the SDK is available via the optOutStatus property in the Nielsen SDK API

@property (readonly) BOOL optOutStatus

AirPlay

To implement OTT measurement, report OTT changes to the SDK using public API interface: updateOTT

In order to detect AirPlay and mirroring changes we use AVAudioSessionPortDescription properties that are different on different iOS versions. We found that on iOS versions 8 - 10 AVAudioSessionPortDescription has the following values:
AirPlay: type = AirPlay; name = Apple TV 4K; UID = DC:56:E7:53:72:85-airplay
Mirroring: type = AirPlay; name = Apple TV 4K; UID = DC:56:E7:53:72:85-screen

For iOS 11+ some parameters like name and UID have different values:
AirPlay: type = AirPlay; name = AirPlay; UID = 0eb63aae-5915-45f1-b0f7-0102a0e50d53
Mirroring: type = AirPlay; name = Apple TV 4K; UID = 4335E8A9-1C0A-4251-9000-28CA5FA2F3CF-192731714653291-screen


The following code snipped is suggested for AirPlay / mirroring detection on iOS devices.

Swift

nielsenSdk.updateOTT(currentStatus)

Subscribe to AVAudioSessionRouteChangeNotification

NotificationCenter.default.addObserver(self, selector: #selector(handleRouteChanged(_:)), name: NSNotification.Name.AVAudioSessionRouteChange, object: nil)

Handle AVAudioSessionRouteChangeNotification and prepare OTT dictionary:

func handleRouteChanged(_ notification: Notification) {
var currentStatus: [String: String] = ["ottStatus": "0"]

let session = AVAudioSession.sharedInstance()
let currentRoute = session.currentRoute
for outputPort in currentRoute.outputs {
if outputPort.portType == AVAudioSessionPortAirPlay {
currentStatus["ottStatus"] = "1"
currentStatus["ottDeviceModel"] = outputPort.portName
currentStatus["ottDeviceID"] = outputPort.uid

if outputPort.portName == "AirPlay" {
currentStatus["ottDevice"] = "airplay"
currentStatus["ottType"] = "airplay"
}
else {
if outputPort.portName.contains("Apple TV") {
currentStatus["ottDevice"] = "appleTV"
}
else {
currentStatus["ottDevice"] = "other"
}

if outputPort.uid.hasSuffix("airplay") {
currentStatus["ottType"] = "airplay"
}
else if outputPort.uid.hasSuffix("screen") {
currentStatus["ottType"] = "mirroring"
}
else {
currentStatus["ottType"] = "other"
}
}
}
}

// report OTT status update to Nielsen SDK
self.reportOTTUpdate(currentStatus)
}

Report OTT update to the Nielsen SDK

func reportOTTUpdate(_ ottDict: [String: String]) {
if let nielsenSdk = self.nielsenAppApi {
nielsenSdk.updateOTT(currentStatus)
}
}

Objective C

– (void)updateOTT:(id)ottInfo;

Subscribe to AVAudioSessionRouteChangeNotification

[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(handleRouteChanged:) name:AVAudioSessionRouteChangeNotification object:nil];

Handle AVAudioSessionRouteChangeNotification and prepare OTT dictionary:

- (void)handleRouteChanged:(NSNotification *)notification
{
NSMutableDictionary *ottDict = [NSMutableDictionary dictionaryWithDictionary: @{@"ottStatus": @"0"}];

AVAudioSession *audioSession = [AVAudioSession sharedInstance];
AVAudioSessionRouteDescription *currentRoute = audioSession.currentRoute;
for (AVAudioSessionPortDescription *outputPort in currentRoute.outputs) {
if ([outputPort.portType isEqualToString:AVAudioSessionPortAirPlay]) {
ottDict[@"ottStatus"] = @"1";
ottDict[@"ottDeviceModel"] = outputPort.portName;
ottDict[@"ottDeviceID"] = outputPort.UID;

if ([outputPort.portName isEqualToString:@"AirPlay"]) {
ottDict[@"ottDevice"] = @"airplay";
ottDict[@"ottType"] = @"airplay";
}
else {
if ([outputPort.portName containsString:@"Apple TV"]) {
ottDict[@"ottDevice"] = @"appleTV";
}
else {
ottDict[@"ottDevice"] = @"other";
}

if ([outputPort.UID hasSuffix:@"airplay"]) {
ottDict[@"ottType"] = @"airplay";
}
else if ([outputPort.UID hasSuffix:@"screen"]) {
ottDict[@"ottType"] = @"mirroring";
}
else {
ottDict[@"ottType"] = @"other";
}
}
}
}

// report OTT status update to Nielsen SDK
[self reportOTTWithDict:ottDict];
}

Report OTT update to the Nielsen SDK

- (void)reportOTTWithDict:(NSDictionary *)ottDict
{
[self.nielsenSDK updateOTT:ottDict];
}

Test your player by yourself

Guide

1. Connect your PC and test device (tablet or phone) via same router.
2. PC side: run Proxy sw (like Charles) and get local IP
3. Test device: modify Wifi setting to pass through Proxy IP from step 2.
4. Test device: run your player, launch video
5. PC side: filter traffic by "nmrodam" and confirm presence of SDK pings

Example of SDK ping (https call)

https://secure-ire.nmrodam.com/cgi-bin/gn?prd=dcr&ci=se-910685&ch=se-910685_c01_P&asn=defChnAsset&fp_id=a2nfmy17lyvkhlxqstvmgypqly90m1629966210&fp_cr_tm=1629966210&fp_acc_tm=1629966210&fp_emm_tm=1629966210&ve_id=20A7CFD5-9860-4256-A6CE-45C251F4C243&sessionId=yvx0rtsxydmaxueji8zgfzj0f2f1w1629966209&tl=&prv=1&c6=vc,c01&ca=se-910685_c01_51HERB1501&cg=Play%20%3E%20Webbtv%20%3E%20Nyheter&c13=asid,P3D8D326A-2DBC-486A-8FD8-9AF4452B2A41&c32=segA,NA&c33=segB,NA&c34=segC,NA&c15=apn,Aftonbladet&plugv=&playerv=&sup=1&segment2=&segment1=&forward=0&ad=1&cr=4_00_99_D1_00000&c9=devid,12b9377cbe7e5c94e8a70d9d23929523d14afa954793130f8a3959c7b849aca8&enc=true&c1=nuid,12b9377cbe7e5c94e8a70d9d23929523d14afa954793130f8a3959c7b849aca8&at=timer&rt=video&c16=sdkv,ai.8.1.0&c27=cln,15&crs=&lat=&lon=&c29=plid,16299662096458868&c30=bldv,ai.8.1.0.0_gsxaoni&st=dcr&c7=osgrp,&c8=devgrp,&c10=plt,&c40=adbid,&c14=osver,iOS14.6&c26=dmap,1&dd=&hrd=&wkd=&c35=adrsid,&c36=cref1,&c37=cref2,&c11=agg,1&c12=apv,5.47.83.0.25245&c51=adl,15&c52=noad,1&sd=15&pc=NA&c53=fef,n&c54=oad,&c55=cref3,&c57=adldf,2&ai=51HERB1501&c3=st,a&c64=starttm,1629966240&adid=51HERB1501&c58=isLive,false&c59=sesid,iqal6k21r0de8gm901kif5xznar7q1629966240&c61=createtm,1629966255&c63=pipMode,&ci_userid=&is_auto_play=&pl_title=&is_prem=&is_prog=&ad_origin=&adidx=1%2F1&is_tpad=&ci_passthr=&c62=sendTime,1629966255&c68=bndlid,se.aftonbladet.Aftonbladet&c69=cvw,&nodeTM=&logTM=&c73=phtype,&c74=dvcnm,&c76=adbsnid,&uoo=&c44=progen,&davty=1&si=&c66=mediaurl,&sdd=retry,0~~retryreason,~~devmodel,iPhone9%2C4~~devtypid,iPhone9%2C4~~sysname,iOS~~sysversion,14.6~~manuf,Apple&cat_id=a6f7fb13-8801-484c-9692-6db6dfb470aa&vtoff=0&rnd=1629966255319

Provide your app for certification

Once ready please send your application to Nielsen local staff for certification.

Going Live

Following Nielsen testing, you will need to:

1. Disable Debug Logging: Disable logging by deleting {nol_devDebug: 'DEBUG'} from initialization call.
2. Notify Nielsen: Once you are ready to go live, let us know so we can enable you for reporting. We will not be able to collect or report data prior to receiving notification from you.