DCR Podcasts in Digital

Engineering Portal / Digital / DCR Podcasts in Digital

Prerequisites

This document assumes you have implemented Digital Audio with Live AM/FM stream measurement. It outlines the new parameters you will use to implement podcast measurement with the DCR content type.

Library

Use the same library as Digital Audio, live AM/FM stream measurement.

Changes for Podcast Measurement

play

Continue to use play to pass the channel descriptor information through channelName parameter when the user taps the Play button on the player.

loadMetadata

Use loadMetadata to pass 'content' and 'ad' Digital Measurement Metadata. The CMS data must be passed as a JSON object.

    – (void) loadMetadata :(id)metadata;

Refer to loadMetadata for the list of parameters to be passed in the JSON object.

Note: The loadMetadata call after the first play call must have ‘content’ details ("type": "content"). This call should occur before any preroll ad starts playing.

playheadPosition for "content"

You will continue to use playheadPosition to pass the position of the playhead while the content is being played; however, you will pass the relative position from the beginning of the file.

    – (void) playheadPosition: (long long) playheadPos

Key	Description	Values	Required? (Y/N)	Example
On-Demand Audio	Position taken from beginning of the content in seconds.	Client-defined	Yes	Current player position from beginning of the content.

playheadPosition Syntax Example for iOS

    CMTime curTime=[player currentTime];
    long pos=CMTimeGetSeconds(curTime);
    [nAppApiObject playheadPosition:pos];

API Call sequence

Use Case 1: Content has no Advertisements

Use the sample API sequence below as a reference to identify the specific events that need to be called during content playback without ads.

Call play with channelName JSON as below.

{
   "channelName": "TheMovieTitle"
}

Call loadMetadata with JSON metadata for content as below.

{
  "type": "content",
  "assetid": "vid345-67483",
  "program": "ProgramName",
  "title": "Program S3, EP1",
  "length": "3600",
  "segB": "CustomSegmentValueB",
  "segC": "CustomSegmentValueC",
  "crossId1": "Reference11",
  "crossId2": "Reference22",
  "isfullepisode": "y",
  "airdate": "20161013 20:00:00",
  "adloadtype": "2",
  "progen":"GV"
}

Call playheadPosition every one second until a pause / stop.

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

Use Case 2: Content has Advertisements

Call play with channelName JSON as below.

{
   "channelName": "TheMovieTitle"
}

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 two seconds until a pause / stop / 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	[nielsenMeter play: channelName];	// channelName contains JSON metadata of channel/video name being played
	[nielsenMeter loadMetadata: contentMetadataObject];	// contentMetadataObject contains the JSON metadata for the content being played
Preroll	[nielsenMeter loadMetadata: prerollMetadataObject];	// prerollMetadataObject contains the JSON metadata for the preroll ad
	[nielsenMeter playheadPosition: position];	// position is position of the playhead while the preroll ad is being played
	[nielsenMeter stop];	// Call stop after preroll occurs
Content	[nielsenMeter loadMetadata: contentMetadataObject];	// contentMetadataObject contains the JSON metadata for the content being played
	[nielsenMeter playheadPosition: position];	// position is position of the playhead while the content is being played
	[nielsenMeter stop];	// Call stop after the content is paused (ad starts)
Midroll	[nielsenMeter loadMetadata: midrollMetadataObject];	// midrollMetadataObject contains the JSON metadata for the midroll ad
	[nielsenMeter playheadPosition: position];	// position is position of the playhead while the midroll ad is being played
	[nielsenMeter stop];	// Call stop after midroll occurs
Content (End of stream)	[nielsenMeter loadMetadata: contentMetadataObject];	// contentMetadataObject contains the JSON metadata for the content being played
	[nielsenMeter playheadPosition: position];	// position is position of the playhead while the content is being played
	[nielsenMeter end];	// Called at the end of content
Postroll	[nielsenMeter loadMetadata: postrollMetadataObject];	// postrollMetadataObject contains the JSON metadata for the postroll ad
	[nielsenMeter playheadPosition: position];	// position is position of the playhead while the postroll ad is being played
	[nielsenMeter 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.

Nielsen Measurement Opt-Out Implementation

Opt-out implementation for podcasts is the same as live AM/FM stream measurement.

Technical Guides

Type		OS	DCR Implementation Guide	SDK Documentation
			DCR Video iOS SDK	iOS SDK API Reference
			DCR Video Android SDK	Android SDK API Reference

	Technical Guides
	Digital Measurement Onboarding	Digital Measurement Metadata
	Digital Measurement Testing	Digital Measurement Interruption Scenarios
	Digital Measurement FAQ
	Digital Pre-Certification Checklist App SDK	Digital Pre-Certification Checklist Browser SDK