View source for DCR Podcasts in Digital

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== 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. 

#Send a list of your podcasts or programs to your TAM to register them for reporting 
#Get new appids from your TAM for the applications that will offer podcasts
#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 
#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. 

===play Example ===
<syntaxhighlight lang="json">{
   "channelName": "KABC-FM Morning Show"
}</syntaxhighlight>

=== loadMetadata ===
Use [[loadMetadata]] to pass information about your podcast to the SDK. The parameters must be passed as a JSON object.
<syntaxhighlight lang="objective-c">    – (void) loadMetadata :(id)metadata;</syntaxhighlight>
Refer to [[loadMetadata]] for the list of parameters to be passed in the JSON object.
<blockquote>'''Note:''' The [[loadMetadata]] call after the first [[play]] call '''must have ‘content’ ("type": "content").''' </blockquote>

=== loadMetadata Example ===
<syntaxhighlight lang="json">{
  "type": "content",
  "assetid": "KABC:345-67483",
  "program": "KABC Morning Show",
  "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" 
}</syntaxhighlight>

=== 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.
<syntaxhighlight lang="objective-c">    – (void) playheadPosition: (long long) playheadPos</syntaxhighlight>
{| class="wikitable"
|-
! 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'''
<syntaxhighlight lang="objective-c">    CMTime curTime=[player currentTime];
    long pos=CMTimeGetSeconds(curTime);
    [nAppApiObject playheadPosition:pos];</syntaxhighlight>

{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play: channelName];</code> || // channelName contains JSON metadata of program being played
|-
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>[nielsenMeter playheadPosition: position];</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>[nielsenMeter end];</code> || // 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.
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play: channelName];</code> || // channelName contains JSON metadata of channel/video name being played
|-
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| rowspan="3" | Preroll || <code>[nielsenMeter loadMetadata: prerollMetadataObject];</code> || // prerollMetadataObject contains the JSON metadata for the preroll ad
|-
| <code>[nielsenMeter playheadPosition: position];</code> || // position is position of the playhead while the preroll ad is being played
|-
| <code>[nielsenMeter stop];</code> || // Call stop after preroll occurs
|-
| rowspan="3" | Content || <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>[nielsenMeter playheadPosition: position];</code> || // position is position of the playhead while the content is being played
|-
| <code>[nielsenMeter stop];</code> || // Call stop after the content is paused (ad starts)
|-
| rowspan="3" | Midroll || <code>[nielsenMeter loadMetadata: midrollMetadataObject];</code> || // midrollMetadataObject contains the JSON metadata for the midroll ad
|-
| <code>[nielsenMeter playheadPosition: position];</code> || // position is position of the playhead while the midroll ad is being played
|-
| <code>[nielsenMeter stop];</code> || // Call stop after midroll occurs
|-
| rowspan="3" | Content (End of stream) || <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>[nielsenMeter playheadPosition: position];</code> || // position is position of the playhead while the content is being played
|-
| <code>[nielsenMeter end];</code> || // Called at the end of content
|-
| rowspan="3" | Postroll || <code>[nielsenMeter loadMetadata: postrollMetadataObject];</code> || // postrollMetadataObject contains the JSON metadata for the postroll ad
|-
| <code>[nielsenMeter playheadPosition: position];</code> || // position is position of the playhead while the postroll ad is being played
|-
| <code>[nielsenMeter stop];</code> || // Call stop after postroll occurs
|}

<blockquote>'''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.</blockquote>

== Nielsen Measurement Opt-Out Implementation ==
Opt-out implementation for podcasts is the same as live AM/FM stream measurement. 

== Technical Guides ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 50%;" | DCR Implementation Guide
!| SDK Documentation
|-
| rowspan="7" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Video iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Video Android SDK]]'''
| [[Android SDK API Reference]]
|}

{| class="wikitable"
|-
! style="width: 90px;" |
! style="width: 42%;" | Technical Guides
!
|-
| rowspan="7" | {{SmallIcon|DigitalIcon.png}}
| '''[[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]]'''
|}