DCR Podcasts in Digital: Difference between revisions
From Engineering Client Portal
(parms update) |
(podcast list) |
||
Line 5: | Line 5: | ||
This document assumes you have implemented Digital Audio with Live AM/FM stream measurement with a "radio" content type. It outlines the new parameters you will use to implement podcast measurement with the DCR content type. | This document assumes you have implemented Digital Audio with Live AM/FM stream measurement with a "radio" content type. It outlines the new parameters you will use to implement podcast measurement with the DCR content type. | ||
# Send a list of your podcasts or programs to your TAM | #Get a new appid from your TAM for the applications that will offer podcasts | ||
#Send a list of your podcasts or programs to your TAM | |||
#Update the parameters you use to call the SDK play and playheadPosition. Reference the appropriate [[Podcasts|Changes for Podcast Measurement]] below. | #Update the parameters you use to call the SDK play and playheadPosition. Reference the appropriate [[Podcasts|Changes for Podcast Measurement]] below. | ||
#Obtain Nielsen Podcast certification once your changes are complete and tested | #Obtain Nielsen Podcast certification once your changes are complete and tested |
Revision as of 16:06, 13 December 2017
Steps
This document assumes you have implemented Digital Audio with Live AM/FM stream measurement with a "radio" content type. It outlines the new parameters you will use to implement podcast measurement with the DCR content type.
- Get a new appid from your TAM for the applications that will offer podcasts
- Send a list of your podcasts or programs to your TAM
- Update the parameters you use to call the SDK play and playheadPosition. Reference the appropriate Changes for Podcast Measurement below.
- Obtain Nielsen Podcast certification once your changes are complete and tested
- Complete a Production License with your Nielsen Account Representative
Library
Use the same library as Digital Audio, live AM/FM stream measurement.
Changes for Podcast Measurement
Initializing the SDK
Update your appid to the new ID provided by your TAM for podcast measurement. When you initialize the SDK, use 'dcr' in the sfcode instead of 'drm'.
play
Continue to use play to pass the channel descriptor information through the channelName parameter when the user taps the Play button on the player.
loadMetadata
Use loadMetadata to pass information about your podcast to the SDK. The parameters 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’ ("type": "content").
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 Parameters Example
Convert the API calls below to the OS and language requirements for your platform.
Call play with channelName JSON as below.
{
"channelName": "KABC-FM Morning Show"
}
Call loadMetadata with JSON metadata for content as below.
{
"type": "content",
"assetid": "KABC:345-67483",
"program": "KABC MorningShow",
"title": "20171125: HR1",
"length": "3600",
"segB": "KABC-FM", // station call letters and band are optional here
"isfullepisode": "y",
"airdate": "20171125 06:00:00",
"adloadtype": "2",
"pipmode":"false"
}
Call playheadPosition every one second until a pause / stop.
Type | Sample code | Description |
---|---|---|
Start of stream | [nielsenMeter play: channelName]; |
// channelName contains JSON metadata of program 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. |
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 |