Engineering Client Portal - User contributions [en]

DCR Podcasts in Digital

2018-01-29T21:53:17Z

KimBritt: new loadmetadata

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Podcasts]]
{{CategoryIcon|DA.png|Podcasts}}
 
__TOC__

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

#Contact your Nielsen Account Representative to discuss the way you would like your podcasts reported (Classified)
#Your TAM will provide new appIds 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|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 SDK 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 ===
Call [[play]] when the user taps the '''Play''' button to start the content.. The channelName parameter is not required.

'''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. '''This is different than live stream measurement, which uses the live UTC time.'''

{| 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>

'''Usage Sequence and API'''
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"
|-
! Action !! 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
|-
| Listening || <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.
|}

- Continue to call [[playheadPosition]] every two seconds until the user pauses, stops, or loses audio.

- Call a new ''loadMetadata'' when the user selects a different program.

'''With Preroll, Midroll, Postroll Ads'''
'''Please note:''' The below examples include ad pod information. These ads are not ads served as part of the originator's programming (studio-recorded ads). These ads are hosted independently from the podcast content file.

When applicable, Playhead should be passed for the entire duration of ad pod, if the ad pod details are passed as part of [[loadMetadata]].

{| class="wikitable"
|-
! Action !! 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" | Listening || <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 ==
No changes are necessary because 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]]'''
|}

DCR Podcasts in Digital

2018-01-29T21:22:12Z

KimBritt: bold audio

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Podcasts]]
{{CategoryIcon|DA.png|Podcasts}}
 
__TOC__

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

#Contact your Nielsen Account Representative to discuss the way you would like your podcasts reported (Classified)
#Your TAM will provide new appIds 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|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 SDK 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 ===
Call [[play]] when the user taps the '''Play''' button to start the content.. The channelName parameter is not required.

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

{| 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>

'''Usage Sequence and API'''
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"
|-
! Action !! 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
|-
| Listening || <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.
|}

Continue to call [[playheadPosition]] every two seconds until a pause / stop / another ''loadMetadata'' is called when the user selects a different program.

'''With Preroll, Midroll, Postroll Ads'''
'''Please note:''' The below examples include ad pod information. These ads are not ads served as part of the originator's programming (studio-recorded ads). These ads are hosted independently from the podcast content file.

When applicable, Playhead should be passed for the entire duration of ad pod, if the ad pod details are passed as part of [[loadMetadata]].

{| class="wikitable"
|-
! Action !! 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" | Listening || <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 ==
No changes are necessary because 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]]'''
|}

iOS SDK Release Notes

2018-01-18T20:08:09Z

KimBritt: title

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

== Release 6.0.0.2 (1-18-2018) ==
=== DCR and DTVR Products Only ===
*'''Vizu Library Changes:''' AppSDK requires a code change to fix a critical bug pertaining to Viewability as requested by Vizu(VI) library team. AppSDK will subscribe to VI JS event VIExternalDataReady, which will ensure VI library is ready to provide the time series data.
*'''Static Ping Upload Failure:''' Issue occurs during 2 SDK instances. If instance 1 is destroyed and the second instance is still active, broadcast notification is sent to cancel all the pending requests and the session object is destroyed for both. Fix applied to isolate this notification for the destroyed instance only so it will not impact the other instance.
*'''SegA/B/C Fix:''' If empty values are provided for segA, segB, segC in the loadmetadata call, then SDK will use the default values from the config.
*'''DTVR Fix:''' Issue was introduced in v6.0.0.1 where tsv value was getting reset to default after pause. Issue occurred after pause when "stop", "play" and "loadMetadata" methods are called and the tsv flag gets reset to the default value 99 until another tsv request is fired.

== Release 6.0.0.1 (12-14-2017) ==
=== All Products ===
The below updates apply to all products. They do not require code changes. Please check your product's implementation guide for detailed instructions on how to implement best measurement of your product.

*'''Appname Removal:''' Client will no longer need to pass Appname as part of SDK initialization because SDK will be retrieving the name from the application Info.plist file for iOS. Even if client continues to pass the Appname, SDK will ignore it.
*'''Default Privacy Url:''' Return default US privacy url instead of “nil” or blank string for userOptOutURLString.
*'''Event Data Reporting:''' Sending event data in milliseconds compared to seconds for more granular reporting.
*'''Minor Playhead Error:''' SDK will no longer send view ping if the first playhead position is 0 and if the playhead position is not incrementing. SDK will check if the playhead position will increment from 0 and then only send the view ping.
*'''Session Id Change:''' Updated the Session id format to align the AppSDK with the DAR/Browser SDK logic which generates 39 chars sessionid/uaid.

=== DCR and DTVR ===
Affected content types are DCR and DTVR.

*'''Viewability:''' Viewability is as an online tracking mechanism introduced in Nielsen SDK for representing the visibility of a video in the player along a playback that are actually viewed by the customers.
*'''Simplified SDK API:''' This will allow clients to have a simple interface to pass metadata to the sdk and reduce the number of api calls. This feature will currently be available for AppSDK only. New API (trackEvent) is introduced to simplify SDK integration for clients. New API will be implemented as a wrapper for the existing SDK API. Clients will be able to use either new or old SDK API.
*'''Bug Fix For DTVR:''' Fix for DTVR short ping having at parameter as “timer” instead of “sfview” during channel change scenario. iOS fix for 1 trans ping per ID3 tag.
*'''Stop Event Requirement Change:''' ST event will be reported at the end of the content, on End API call regardless of playhead position and channel change.

== Release 5.1.1.29 ==
*Genre parameter will be a part of DCR pings and the value will be reflected as part of c44 parameter.
*Merged adModel and adLoadType flags
*Fix for stop event data carried to next session’s duration ping

== Release 5.1.1.25 ==
*Enhanced support for Digital Audio
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.23 ==
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.19 ==
*Fix for muting background music apps

== Release 5.1.1.18 ==
*Minor bug fixes and performance improvement

== Release 5.1.1.17 ==
*Added “seconds” place to the launch ping
*Ability to opt-out using “Limit Ad Tracking” feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the ‘Limit Ad Tracking’ flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.9 ==
*Fixed Linker error duplicate symbols for Reachability notification in iOS.

== Release 5.1.1.7 ==
*Support for iOS 10
*Usage of stop API call is made optional when switching between content or advertising occurs.
*General bug fix and performance improvements

== Release 5.1.1.5 ==
*Sending event level (button press data) data to census collections.
*Support for Pause timeout (from 30 minutes to 5 minutes)
*Changes in OTT when switching from mobile to Chromecast
*Self-error Reporting for iOS SDK
*General bug fix and performance improvements

== Release 5.1.0.5 ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Changes to use of stop API
*Support for OTT measurement
*Support for Pause timeout
*Offline viewing
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature
*Introduced new API updateOTT to report current OTT status.

== Release 4.0.0.8 ==
*Support for Nielsen DCR product (Digital Content Ratings)
**All the products should be migrated to the latest SDK.
**This SDK distribution does not have a native library component or shared object.
*Support for Nielsen App static measurement
*Support for Ad measurement
*Removal of Native C++ code
*Removed singleton restriction
*Support for iOS 9 and iOS 9 PIP mode
*General bug fix and performance improvements

iOS SDK Release Notes

2018-01-18T17:56:14Z

KimBritt: moved session id change up to All

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

== Release 6.0.0.1 (12-14-2017) ==
=== All Products ===
The below updates apply to all products. They do not require code changes. Please check your product's implementation guide for detailed instructions on how to implement best measurement of your product.

*'''Appname Removal:''' Client will no longer need to pass Appname as part of SDK initialization because SDK will be retrieving the name from the application Info.plist file for iOS. Even if client continues to pass the Appname, SDK will ignore it.
*'''Default Privacy Url:''' Return default US privacy url instead of “nil” or blank string for userOptOutURLString.
*'''Event Data Reporting:''' Sending event data in milliseconds compared to seconds for more granular reporting.
*'''Minor Playhead Error:''' SDK will no longer send view ping if the first playhead position is 0 and if the playhead position is not incrementing. SDK will check if the playhead position will increment from 0 and then only send the view ping.
*'''Session Id Change:''' Updated the Session id format to align the AppSDK with the DAR/Browser SDK logic which generates 39 chars sessionid/uaid.

=== DCR and DTVR ===
Affected content types are DCR and DTVR.

*'''Viewability:''' Viewability is as an online tracking mechanism introduced in Nielsen SDK for representing the visibility of a video in the player along a playback that are actually viewed by the customers.
*'''Simplified SDK API:''' This will allow clients to have a simple interface to pass metadata to the sdk and reduce the number of api calls. This feature will currently be available for AppSDK only. New API (trackEvent) is introduced to simplify SDK integration for clients. New API will be implemented as a wrapper for the existing SDK API. Clients will be able to use either new or old SDK API.
*'''Bug Fix For DTVR:''' Fix for DTVR short ping having at parameter as “timer” instead of “sfview” during channel change scenario. iOS fix for 1 trans ping per ID3 tag.
*'''Stop Event Requirement Change:''' ST event will be reported at the end of the content, on End API call regardless of playhead position and channel change.

== Release 5.1.1.29 ==
*Genre parameter will be a part of DCR pings and the value will be reflected as part of c44 parameter.
*Merged adModel and adLoadType flags
*Fix for stop event data carried to next session’s duration ping

== Release 5.1.1.25 ==
*Enhanced support for Digital Audio
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.23 ==
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.19 ==
*Fix for muting background music apps

== Release 5.1.1.18 ==
*Minor bug fixes and performance improvement

== Release 5.1.1.17 ==
*Added “seconds” place to the launch ping
*Ability to opt-out using “Limit Ad Tracking” feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the ‘Limit Ad Tracking’ flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.9 ==
*Fixed Linker error duplicate symbols for Reachability notification in iOS.

== Release 5.1.1.7 ==
*Support for iOS 10
*Usage of stop API call is made optional when switching between content or advertising occurs.
*General bug fix and performance improvements

== Release 5.1.1.5 ==
*Sending event level (button press data) data to census collections.
*Support for Pause timeout (from 30 minutes to 5 minutes)
*Changes in OTT when switching from mobile to Chromecast
*Self-error Reporting for iOS SDK
*General bug fix and performance improvements

== Release 5.1.0.5 ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Changes to use of stop API
*Support for OTT measurement
*Support for Pause timeout
*Offline viewing
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature
*Introduced new API updateOTT to report current OTT status.

== Release 4.0.0.8 ==
*Support for Nielsen DCR product (Digital Content Ratings)
**All the products should be migrated to the latest SDK.
**This SDK distribution does not have a native library component or shared object.
*Support for Nielsen App static measurement
*Support for Ad measurement
*Removal of Native C++ code
*Removed singleton restriction
*Support for iOS 9 and iOS 9 PIP mode
*General bug fix and performance improvements

iOS SDK Release Notes

2018-01-18T17:55:21Z

KimBritt: title 2

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

== Release 6.0.0.1 (12-14-2017) ==
=== All Products ===
The below updates apply to all products. They do not require code changes. Please check your product's implementation guide for detailed instructions on how to implement best measurement of your product.
*'''Appname Removal:''' Client will no longer need to pass Appname as part of SDK initialization because SDK will be retrieving the name from the application Info.plist file for iOS. Even if client continues to pass the Appname, SDK will ignore it.
*'''Default Privacy Url:''' Return default US privacy url instead of “nil” or blank string for userOptOutURLString.
*'''Event Data Reporting:''' Sending event data in milliseconds compared to seconds for more granular reporting.
*'''Minor Playhead Error:''' SDK will no longer send view ping if the first playhead position is 0 and if the playhead position is not incrementing. SDK will check if the playhead position will increment from 0 and then only send the view ping.

=== DCR and DTVR ===
Affected content types are DCR and DTVR.

*'''Viewability:''' Viewability is as an online tracking mechanism introduced in Nielsen SDK for representing the visibility of a video in the player along a playback that are actually viewed by the customers.
*'''Simplified SDK API:''' This will allow clients to have a simple interface to pass metadata to the sdk and reduce the number of api calls. This feature will currently be available for AppSDK only. New API (trackEvent) is introduced to simplify SDK integration for clients. New API will be implemented as a wrapper for the existing SDK API. Clients will be able to use either new or old SDK API.
*'''Bug Fix For DTVR:''' Fix for DTVR short ping having at parameter as “timer” instead of “sfview” during channel change scenario. iOS fix for 1 trans ping per ID3 tag.
*'''Stop Event Requirement Change:''' ST event will be reported at the end of the content, on End API call regardless of playhead position and channel change.
*'''Session Id Change:''' Updated the Session id format to align the AppSDK with the DAR/Browser SDK logic which generates 39 chars sessionid/uaid.

== Release 5.1.1.29 ==
*Genre parameter will be a part of DCR pings and the value will be reflected as part of c44 parameter.
*Merged adModel and adLoadType flags
*Fix for stop event data carried to next session’s duration ping

== Release 5.1.1.25 ==
*Enhanced support for Digital Audio
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.23 ==
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.19 ==
*Fix for muting background music apps

== Release 5.1.1.18 ==
*Minor bug fixes and performance improvement

== Release 5.1.1.17 ==
*Added “seconds” place to the launch ping
*Ability to opt-out using “Limit Ad Tracking” feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the ‘Limit Ad Tracking’ flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.9 ==
*Fixed Linker error duplicate symbols for Reachability notification in iOS.

== Release 5.1.1.7 ==
*Support for iOS 10
*Usage of stop API call is made optional when switching between content or advertising occurs.
*General bug fix and performance improvements

== Release 5.1.1.5 ==
*Sending event level (button press data) data to census collections.
*Support for Pause timeout (from 30 minutes to 5 minutes)
*Changes in OTT when switching from mobile to Chromecast
*Self-error Reporting for iOS SDK
*General bug fix and performance improvements

== Release 5.1.0.5 ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Changes to use of stop API
*Support for OTT measurement
*Support for Pause timeout
*Offline viewing
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature
*Introduced new API updateOTT to report current OTT status.

== Release 4.0.0.8 ==
*Support for Nielsen DCR product (Digital Content Ratings)
**All the products should be migrated to the latest SDK.
**This SDK distribution does not have a native library component or shared object.
*Support for Nielsen App static measurement
*Support for Ad measurement
*Removal of Native C++ code
*Removed singleton restriction
*Support for iOS 9 and iOS 9 PIP mode
*General bug fix and performance improvements

iOS SDK Release Notes

2018-01-18T17:54:39Z

KimBritt: title

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

== Release 6.0.0.1 (12-14-2017) ==
=== All Products ===
The below updates apply to all products. They do not require code changes. Please check your product's implementation guide for detailed instructions on how to implement best measurement of your product.
*'''Appname Removal:''' Client will no longer need to pass Appname as part of SDK initialization because SDK will be retrieving the name from the application Info.plist file for iOS. Even if client continues to pass the Appname, SDK will ignore it.
*'''Default Privacy Url:''' Return default US privacy url instead of “nil” or blank string for userOptOutURLString.
*'''Event Data Reporting:''' Sending event data in milliseconds compared to seconds for more granular reporting.
*'''Minor Playhead Error:''' SDK will no longer send view ping if the first playhead position is 0 and if the playhead position is not incrementing. SDK will check if the playhead position will increment from 0 and then only send the view ping.

=== Changes Affecting DCR and DTVR (not Digital Audio) ===
Affected content types are DCR and DTVR.

*'''Viewability:''' Viewability is as an online tracking mechanism introduced in Nielsen SDK for representing the visibility of a video in the player along a playback that are actually viewed by the customers.
*'''Simplified SDK API:''' This will allow clients to have a simple interface to pass metadata to the sdk and reduce the number of api calls. This feature will currently be available for AppSDK only. New API (trackEvent) is introduced to simplify SDK integration for clients. New API will be implemented as a wrapper for the existing SDK API. Clients will be able to use either new or old SDK API.
*'''Bug Fix For DTVR:''' Fix for DTVR short ping having at parameter as “timer” instead of “sfview” during channel change scenario. iOS fix for 1 trans ping per ID3 tag.
*'''Stop Event Requirement Change:''' ST event will be reported at the end of the content, on End API call regardless of playhead position and channel change.
*'''Session Id Change:''' Updated the Session id format to align the AppSDK with the DAR/Browser SDK logic which generates 39 chars sessionid/uaid.

== Release 5.1.1.29 ==
*Genre parameter will be a part of DCR pings and the value will be reflected as part of c44 parameter.
*Merged adModel and adLoadType flags
*Fix for stop event data carried to next session’s duration ping

== Release 5.1.1.25 ==
*Enhanced support for Digital Audio
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.23 ==
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.19 ==
*Fix for muting background music apps

== Release 5.1.1.18 ==
*Minor bug fixes and performance improvement

== Release 5.1.1.17 ==
*Added “seconds” place to the launch ping
*Ability to opt-out using “Limit Ad Tracking” feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the ‘Limit Ad Tracking’ flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.9 ==
*Fixed Linker error duplicate symbols for Reachability notification in iOS.

== Release 5.1.1.7 ==
*Support for iOS 10
*Usage of stop API call is made optional when switching between content or advertising occurs.
*General bug fix and performance improvements

== Release 5.1.1.5 ==
*Sending event level (button press data) data to census collections.
*Support for Pause timeout (from 30 minutes to 5 minutes)
*Changes in OTT when switching from mobile to Chromecast
*Self-error Reporting for iOS SDK
*General bug fix and performance improvements

== Release 5.1.0.5 ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Changes to use of stop API
*Support for OTT measurement
*Support for Pause timeout
*Offline viewing
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature
*Introduced new API updateOTT to report current OTT status.

== Release 4.0.0.8 ==
*Support for Nielsen DCR product (Digital Content Ratings)
**All the products should be migrated to the latest SDK.
**This SDK distribution does not have a native library component or shared object.
*Support for Nielsen App static measurement
*Support for Ad measurement
*Removal of Native C++ code
*Removed singleton restriction
*Support for iOS 9 and iOS 9 PIP mode
*General bug fix and performance improvements

iOS SDK Release Notes

2018-01-18T17:53:15Z

KimBritt: removed for static

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

== Release 6.0.0.1 (12-14-2017) ==
=== Changes Affecting All Products ===
The below updates apply to all products. They do not require code changes. Please check your product's implementation guide for detailed instructions on how to implement best measurement of your product.
*'''Appname Removal:''' Client will no longer need to pass Appname as part of SDK initialization because SDK will be retrieving the name from the application Info.plist file for iOS. Even if client continues to pass the Appname, SDK will ignore it.
*'''Default Privacy Url:''' Return default US privacy url instead of “nil” or blank string for userOptOutURLString.
*'''Event Data Reporting:''' Sending event data in milliseconds compared to seconds for more granular reporting.
*'''Minor Playhead Error:''' SDK will no longer send view ping if the first playhead position is 0 and if the playhead position is not incrementing. SDK will check if the playhead position will increment from 0 and then only send the view ping.

=== Changes Affecting DCR and DTVR (not Digital Audio) ===
Affected content types are DCR and DTVR.

*'''Viewability:''' Viewability is as an online tracking mechanism introduced in Nielsen SDK for representing the visibility of a video in the player along a playback that are actually viewed by the customers.
*'''Simplified SDK API:''' This will allow clients to have a simple interface to pass metadata to the sdk and reduce the number of api calls. This feature will currently be available for AppSDK only. New API (trackEvent) is introduced to simplify SDK integration for clients. New API will be implemented as a wrapper for the existing SDK API. Clients will be able to use either new or old SDK API.
*'''Bug Fix For DTVR:''' Fix for DTVR short ping having at parameter as “timer” instead of “sfview” during channel change scenario. iOS fix for 1 trans ping per ID3 tag.
*'''Stop Event Requirement Change:''' ST event will be reported at the end of the content, on End API call regardless of playhead position and channel change.
*'''Session Id Change:''' Updated the Session id format to align the AppSDK with the DAR/Browser SDK logic which generates 39 chars sessionid/uaid.

== Release 5.1.1.29 ==
*Genre parameter will be a part of DCR pings and the value will be reflected as part of c44 parameter.
*Merged adModel and adLoadType flags
*Fix for stop event data carried to next session’s duration ping

== Release 5.1.1.25 ==
*Enhanced support for Digital Audio
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.23 ==
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.19 ==
*Fix for muting background music apps

== Release 5.1.1.18 ==
*Minor bug fixes and performance improvement

== Release 5.1.1.17 ==
*Added “seconds” place to the launch ping
*Ability to opt-out using “Limit Ad Tracking” feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the ‘Limit Ad Tracking’ flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.9 ==
*Fixed Linker error duplicate symbols for Reachability notification in iOS.

== Release 5.1.1.7 ==
*Support for iOS 10
*Usage of stop API call is made optional when switching between content or advertising occurs.
*General bug fix and performance improvements

== Release 5.1.1.5 ==
*Sending event level (button press data) data to census collections.
*Support for Pause timeout (from 30 minutes to 5 minutes)
*Changes in OTT when switching from mobile to Chromecast
*Self-error Reporting for iOS SDK
*General bug fix and performance improvements

== Release 5.1.0.5 ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Changes to use of stop API
*Support for OTT measurement
*Support for Pause timeout
*Offline viewing
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature
*Introduced new API updateOTT to report current OTT status.

== Release 4.0.0.8 ==
*Support for Nielsen DCR product (Digital Content Ratings)
**All the products should be migrated to the latest SDK.
**This SDK distribution does not have a native library component or shared object.
*Support for Nielsen App static measurement
*Support for Ad measurement
*Removal of Native C++ code
*Removed singleton restriction
*Support for iOS 9 and iOS 9 PIP mode
*General bug fix and performance improvements

iOS SDK Release Notes

2018-01-18T17:50:29Z

KimBritt: online

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

== Release 6.0.0.1 (12-14-2017) ==
=== Changes Affecting All Products ===
The below updates apply to all products. They do not require code changes. Please check your product's implementation guide for detailed instructions on how to implement best measurement of your product.
*'''Appname Removal:''' Client will no longer need to pass Appname as part of SDK initialization because SDK will be retrieving the name from the application Info.plist file for iOS. Even if client continues to pass the Appname, SDK will ignore it.
*'''Default Privacy Url:''' Return default US privacy url instead of “nil” or blank string for userOptOutURLString.
*'''Event Data Reporting:''' Sending event data in milliseconds compared to seconds for more granular reporting.
*'''Minor Playhead Error:''' SDK will no longer send view ping if the first playhead position is 0 and if the playhead position is not incrementing. SDK will check if the playhead position will increment from 0 and then only send the view ping.

=== Changes Affecting DCR and DTVR (not Digital Audio) ===
Affected content types are DCR and DTVR, which measure video and static pages, and online television respectively.

*'''Viewability:''' Viewability is as an online tracking mechanism introduced in Nielsen SDK for representing the visibility of a video in the player along a playback that are actually viewed by the customers.
*'''Simplified SDK API:''' This will allow clients to have a simple interface to pass metadata to the sdk and reduce the number of api calls. This feature will currently be available for AppSDK only. New API (trackEvent) is introduced to simplify SDK integration for clients. New API will be implemented as a wrapper for the existing SDK API. Clients will be able to use either new or old SDK API.
*'''Bug Fix For DTVR:''' Fix for DTVR short ping having at parameter as “timer” instead of “sfview” during channel change scenario. iOS fix for 1 trans ping per ID3 tag.
*'''Stop Event Requirement Change:''' ST event will be reported at the end of the content, on End API call regardless of playhead position and channel change.
*'''Session Id Change:''' Updated the Session id format to align the AppSDK with the DAR/Browser SDK logic which generates 39 chars sessionid/uaid.

== Release 5.1.1.29 ==
*Genre parameter will be a part of DCR pings and the value will be reflected as part of c44 parameter.
*Merged adModel and adLoadType flags
*Fix for stop event data carried to next session’s duration ping

== Release 5.1.1.25 ==
*Enhanced support for Digital Audio
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.23 ==
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.19 ==
*Fix for muting background music apps

== Release 5.1.1.18 ==
*Minor bug fixes and performance improvement

== Release 5.1.1.17 ==
*Added “seconds” place to the launch ping
*Ability to opt-out using “Limit Ad Tracking” feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the ‘Limit Ad Tracking’ flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.9 ==
*Fixed Linker error duplicate symbols for Reachability notification in iOS.

== Release 5.1.1.7 ==
*Support for iOS 10
*Usage of stop API call is made optional when switching between content or advertising occurs.
*General bug fix and performance improvements

== Release 5.1.1.5 ==
*Sending event level (button press data) data to census collections.
*Support for Pause timeout (from 30 minutes to 5 minutes)
*Changes in OTT when switching from mobile to Chromecast
*Self-error Reporting for iOS SDK
*General bug fix and performance improvements

== Release 5.1.0.5 ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Changes to use of stop API
*Support for OTT measurement
*Support for Pause timeout
*Offline viewing
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature
*Introduced new API updateOTT to report current OTT status.

== Release 4.0.0.8 ==
*Support for Nielsen DCR product (Digital Content Ratings)
**All the products should be migrated to the latest SDK.
**This SDK distribution does not have a native library component or shared object.
*Support for Nielsen App static measurement
*Support for Ad measurement
*Removal of Native C++ code
*Removed singleton restriction
*Support for iOS 9 and iOS 9 PIP mode
*General bug fix and performance improvements

iOS SDK Release Notes

2018-01-18T17:48:27Z

KimBritt: Updated Release Notes for audio clients

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

== Release 6.0.0.1 (12-14-2017) ==
=== Changes Affecting All Products ===
The below updates apply to all products. They do not require code changes. Please check your product's implementation guide for detailed instructions on how to implement best measurement of your product.
*'''Appname Removal:''' Client will no longer need to pass Appname as part of SDK initialization because SDK will be retrieving the name from the application Info.plist file for iOS. Even if client continues to pass the Appname, SDK will ignore it.
*'''Default Privacy Url:''' Return default US privacy url instead of “nil” or blank string for userOptOutURLString.
*'''Event Data Reporting:''' Sending event data in milliseconds compared to seconds for more granular reporting.
*'''Minor Playhead Error:''' SDK will no longer send view ping if the first playhead position is 0 and if the playhead position is not incrementing. SDK will check if the playhead position will increment from 0 and then only send the view ping.

=== Changes Affecting DCR and DTVR (not Digital Audio) ===
Affected content types are DCR and DTVR, which measure video and static pages, and television respectively.

*'''Viewability:''' Viewability is as an online tracking mechanism introduced in Nielsen SDK for representing the visibility of a video in the player along a playback that are actually viewed by the customers.
*'''Simplified SDK API:''' This will allow clients to have a simple interface to pass metadata to the sdk and reduce the number of api calls. This feature will currently be available for AppSDK only. New API (trackEvent) is introduced to simplify SDK integration for clients. New API will be implemented as a wrapper for the existing SDK API. Clients will be able to use either new or old SDK API.
*'''Bug Fix For DTVR:''' Fix for DTVR short ping having at parameter as “timer” instead of “sfview” during channel change scenario. iOS fix for 1 trans ping per ID3 tag.
*'''Stop Event Requirement Change:''' ST event will be reported at the end of the content, on End API call regardless of playhead position and channel change.
*'''Session Id Change:''' Updated the Session id format to align the AppSDK with the DAR/Browser SDK logic which generates 39 chars sessionid/uaid.

== Release 5.1.1.29 ==
*Genre parameter will be a part of DCR pings and the value will be reflected as part of c44 parameter.
*Merged adModel and adLoadType flags
*Fix for stop event data carried to next session’s duration ping

== Release 5.1.1.25 ==
*Enhanced support for Digital Audio
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.23 ==
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.19 ==
*Fix for muting background music apps

== Release 5.1.1.18 ==
*Minor bug fixes and performance improvement

== Release 5.1.1.17 ==
*Added “seconds” place to the launch ping
*Ability to opt-out using “Limit Ad Tracking” feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the ‘Limit Ad Tracking’ flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.9 ==
*Fixed Linker error duplicate symbols for Reachability notification in iOS.

== Release 5.1.1.7 ==
*Support for iOS 10
*Usage of stop API call is made optional when switching between content or advertising occurs.
*General bug fix and performance improvements

== Release 5.1.1.5 ==
*Sending event level (button press data) data to census collections.
*Support for Pause timeout (from 30 minutes to 5 minutes)
*Changes in OTT when switching from mobile to Chromecast
*Self-error Reporting for iOS SDK
*General bug fix and performance improvements

== Release 5.1.0.5 ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Changes to use of stop API
*Support for OTT measurement
*Support for Pause timeout
*Offline viewing
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature
*Introduced new API updateOTT to report current OTT status.

== Release 4.0.0.8 ==
*Support for Nielsen DCR product (Digital Content Ratings)
**All the products should be migrated to the latest SDK.
**This SDK distribution does not have a native library component or shared object.
*Support for Nielsen App static measurement
*Support for Ad measurement
*Removal of Native C++ code
*Removed singleton restriction
*Support for iOS 9 and iOS 9 PIP mode
*General bug fix and performance improvements

File:Browser Stages2.png

2017-12-28T18:39:04Z

KimBritt: KimBritt uploaded a new version of File:Browser Stages2.png

audio browser stages

File:Browser Stages2.png

2017-12-28T18:37:11Z

KimBritt:

audio browser stages

DCR Podcasts in Digital

2017-12-20T20:19:30Z

KimBritt: channelName not required

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Podcasts]]
{{CategoryIcon|DA.png|Podcasts}}
 
__TOC__

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

#Contact your Nielsen Account Representative to discuss the way you would like your podcasts reported (Classified)
#Your TAM will provide new appIds 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|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 SDK 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 ===
Call [[play]] when the user taps the '''Play''' button to start the content.. The channelName parameter is not required.

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

{| 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>

'''Usage Sequence and API'''
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"
|-
! Action !! 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
|-
| Listening || <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.
|}

Continue to call [[playheadPosition]] every two seconds until a pause / stop / another ''loadMetadata'' is called when the user selects a different program.

'''With Preroll, Midroll, Postroll Ads'''
'''Please note:''' The below examples include ad pod information. These ads are not ads served as part of the originator's programming (studio-recorded ads). These ads are hosted independently from the podcast content file.

When applicable, Playhead should be passed for the entire duration of ad pod, if the ad pod details are passed as part of [[loadMetadata]].

{| class="wikitable"
|-
! Action !! 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" | Listening || <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 ==
No changes are necessary because 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T17:02:31Z

KimBritt: whitespace 4

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Podcasts]]
{{CategoryIcon|DA.png|Podcasts}}
 
__TOC__

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

#Contact your Nielsen Account Representative to discuss the way you would like your podcasts reported (Classified)
#Your TAM will provide new appIds 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|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 SDK 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.

{| 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>

'''Usage Sequence and API'''
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"
|-
! Action !! 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
|-
| Listening || <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.
|}

Continue to call [[playheadPosition]] every two seconds until a pause / stop / another ''loadMetadata'' is called when the user selects a different program.

'''With Preroll, Midroll, Postroll Ads'''
'''Please note:''' The below examples include ad pod information. These ads are not ads served as part of the originator's programming (studio-recorded ads). These ads are hosted independently from the podcast content file.

When applicable, Playhead should be passed for the entire duration of ad pod, if the ad pod details are passed as part of [[loadMetadata]].

{| class="wikitable"
|-
! Action !! 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" | Listening || <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 ==
No changes are necessary because 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:53:27Z

KimBritt: whitespace 4

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Podcasts]]
{{CategoryIcon|DA.png|Podcasts}}
 
__TOC__

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

{| 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>

'''Usage Sequence and API'''
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"
|-
! Action !! 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
|-
| Listening || <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.
|}

Continue to call [[playheadPosition]] every two seconds until a pause / stop / another ''loadMetadata'' is called when the user selects a different program.

'''With Preroll, Midroll, Postroll Ads'''
'''Please note:''' The below examples include ad pod information. These ads are not ads served as part of the originator's programming (studio-recorded ads). These ads are hosted independently from the podcast content file.

When applicable, Playhead should be passed for the entire duration of ad pod, if the ad pod details are passed as part of [[loadMetadata]].

{| class="wikitable"
|-
! Action !! 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" | Listening || <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 ==
No changes are necessary because 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:52:05Z

KimBritt: whitespace 3

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Podcasts]]
{{CategoryIcon|DA.png|Podcasts}}
 
__TOC__

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

{| 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>

'''Usage Sequence and API'''
{| class="wikitable"
|-
! Action !! 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
|-
| Listening || <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.
|}

Continue to call [[playheadPosition]] every two seconds until a pause / stop / another ''loadMetadata'' is called when the user selects a different program.

'''Please note:''' The below examples include ad pod information. These ads are not ads served as part of the originator's programming (studio-recorded ads). These ads are hosted independently from the podcast content file.

When applicable, 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.

'''With Preroll, Midroll, Postroll Ads'''
{| class="wikitable"
|-
! Action !! 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" | Listening || <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 ==
No changes are necessary because 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:49:48Z

KimBritt: no changes

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Podcasts]]
{{CategoryIcon|DA.png|Podcasts}}
 
__TOC__

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

{| 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>

'''Usage Sequences and API Examples'''
{| class="wikitable"
|-
! Action !! 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
|-
| Listening || <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.
|}

Continue to call [[playheadPosition]] every two seconds until a pause / stop / another ''loadMetadata'' is called when the user selects a different program.

'''Please note:''' The below examples include ad pod information. These ads are not ads served as part of the originator's programming (studio-recorded ads). These ads are hosted independently from the podcast content file.

When applicable, 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"
|-
! Action !! 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 ==
No changes are necessary because 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:49:02Z

KimBritt: whitespace 2

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Podcasts]]
{{CategoryIcon|DA.png|Podcasts}}
 
__TOC__

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

{| 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>

'''Usage Sequences and API Examples'''
{| class="wikitable"
|-
! Action !! 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
|-
| Listening || <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.
|}

Continue to call [[playheadPosition]] every two seconds until a pause / stop / another ''loadMetadata'' is called when the user selects a different program.

'''Please note:''' The below examples include ad pod information. These ads are not ads served as part of the originator's programming (studio-recorded ads). These ads are hosted independently from the podcast content file.

When applicable, 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"
|-
! Action !! 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:46:34Z

KimBritt: whitespace

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Podcasts]]
{{CategoryIcon|DA.png|Podcasts}}
 
__TOC__

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

{| 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.
|}

Continue to call [[playheadPosition]] every two seconds until a pause / stop / another ''loadMetadata'' is called when the user selects a different program.

'''Please note:''' The below examples include ad pod information. These ads are not ads served as part of the originator's programming (studio-recorded ads). These ads are hosted independently from the podcast content file.

When applicable, 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:44:21Z

KimBritt: ad pods

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Podcasts]]
{{CategoryIcon|DA.png|Podcasts}}
 
__TOC__

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

{| 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.
The below examples include ad pod information. These ads are not ads served as part of the originator's programming (studio-recorded ads). These ads are hosted independently from the podcasts.

When applicable, 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:39:05Z

KimBritt: bold

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Podcasts]]
{{CategoryIcon|DA.png|Podcasts}}
 
__TOC__

== 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|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 SDK 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:37:58Z

KimBritt: sdk

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Podcasts]]
{{CategoryIcon|DA.png|Podcasts}}
 
__TOC__

== 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|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 SDK 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:37:37Z

KimBritt: podcast category

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Podcasts]]
{{CategoryIcon|DA.png|Podcasts}}
 
__TOC__

== 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|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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:37:16Z

KimBritt: category

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Podcasts]]
{{CategoryIcon|DA.png|Digital Audio}}
 
__TOC__

== 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|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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:35:49Z

KimBritt: link subtitle

{{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|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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:35:12Z

KimBritt: title

{{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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:33:44Z

KimBritt: changes

{{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 [[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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:09:46Z

KimBritt: examples 3

{{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 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 [[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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:06:58Z

KimBritt: podcast list

{{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 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 [[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.

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

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

=== API Parameters Example ===
Convert the API calls below to the OS and language requirements for your platform.

Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "KABC-FM Morning Show"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:05:47Z

KimBritt: parms update

{{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 with the DCR content type.

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

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

=== API Parameters Example ===
Convert the API calls below to the OS and language requirements for your platform.

Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "KABC-FM Morning Show"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:03:58Z

KimBritt: initialization

{{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 with the DCR content type.

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

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

=== API Parameters Example ===
Convert the API calls below to the OS and language requirements for your platform.

Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "KABC-FM Morning Show"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"assetid": "pod345-67483",
"program": "KABC MorningShow",
"title": "20171125: HR1",
"length": "3600",
"segB": "CustomSegmentValueB", // station call letters and band are optional here
"segC": "CustomSegmentValueC",
"isfullepisode": "y",
"airdate": "20171125 06:00:00",
"adloadtype": "2",
"pipmode":"false",
"progen":"GV"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T16:00:15Z

KimBritt: radio drm

{{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 with the DCR content type.

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

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

=== API Parameters Example ===
Convert the API calls below to the OS and language requirements for your platform.

Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "KABC-FM Morning Show"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"assetid": "pod345-67483",
"program": "KABC MorningShow",
"title": "20171125: HR1",
"length": "3600",
"segB": "CustomSegmentValueB", // station call letters and band are optional here
"segC": "CustomSegmentValueC",
"isfullepisode": "y",
"airdate": "20171125 06:00:00",
"adloadtype": "2",
"pipmode":"false",
"progen":"GV"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T15:18:29Z

KimBritt: end blockquote

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

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

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

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

=== API Parameters Example ===
Convert the API calls below to the OS and language requirements for your platform.

Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "KABC-FM Morning Show"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"assetid": "pod345-67483",
"program": "KABC MorningShow",
"title": "20171125: HR1",
"length": "3600",
"segB": "CustomSegmentValueB", // station call letters and band are optional here
"segC": "CustomSegmentValueC",
"isfullepisode": "y",
"airdate": "20171125 06:00:00",
"adloadtype": "2",
"pipmode":"false",
"progen":"GV"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T15:17:32Z

KimBritt: bold content type

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

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

# 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.
#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 ==
=== 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.
<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’ details ("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.
<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>

=== API Parameters Example ===
Convert the API calls below to the OS and language requirements for your platform.

Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "KABC-FM Morning Show"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"assetid": "pod345-67483",
"program": "KABC MorningShow",
"title": "20171125: HR1",
"length": "3600",
"segB": "CustomSegmentValueB", // station call letters and band are optional here
"segC": "CustomSegmentValueC",
"isfullepisode": "y",
"airdate": "20171125 06:00:00",
"adloadtype": "2",
"pipmode":"false",
"progen":"GV"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T15:15:50Z

KimBritt: quote type

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

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

# 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.
#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 ==
=== 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 'content' [[Digital Measurement Metadata]]. The CMS data 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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

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

=== API Parameters Example ===
Convert the API calls below to the OS and language requirements for your platform.

Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "KABC-FM Morning Show"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"assetid": "pod345-67483",
"program": "KABC MorningShow",
"title": "20171125: HR1",
"length": "3600",
"segB": "CustomSegmentValueB", // station call letters and band are optional here
"segC": "CustomSegmentValueC",
"isfullepisode": "y",
"airdate": "20171125 06:00:00",
"adloadtype": "2",
"pipmode":"false",
"progen":"GV"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T15:14:50Z

KimBritt: examples

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

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

# 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.
#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 ==
=== 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 'content' [[Digital Measurement Metadata]]. The CMS data 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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

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

=== API Parameters Example ===
Convert the API calls below to the OS and language requirements for your platform.

Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "KABC-FM Morning Show"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"assetid": "pod345-67483",
"program": "KABC MorningShow",
"title": "20171125: HR1",
"length": "3600",
"segB": "CustomSegmentValueB", // station call letters and band are optional here
"segC": "CustomSegmentValueC",
"isfullepisode": "y",
"airdate": "20171125 06:00:00",
"adloadtype": "2",
“pipmode”:“false”,
"progen":"GV"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T15:02:58Z

KimBritt:

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

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

# 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.
#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 ==
=== 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 'content' and 'ad' [[Digital Measurement Metadata]]. The CMS data 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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

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

=== 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.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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
|-
| 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.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

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]]'''
|}

DCR Podcasts in Digital

2017-12-13T15:00:41Z

KimBritt: updated url

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

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

# 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 ==
=== 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 'content' and 'ad' [[Digital Measurement Metadata]]. The CMS data 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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

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

=== 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.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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
|-
| 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.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

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]]'''
|}

DCR Podcasts in Digital

2017-12-13T15:00:14Z

KimBritt: changes for podcasts

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

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

# 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.
#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 ==
=== 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 'content' and 'ad' [[Digital Measurement Metadata]]. The CMS data 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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

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

=== 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.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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
|-
| 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.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

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]]'''
|}

DCR Podcasts in Digital

2017-12-13T14:59:31Z

KimBritt: the

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

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

# 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#Parameters]] 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 ==
=== 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 'content' and 'ad' [[Digital Measurement Metadata]]. The CMS data 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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

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

=== 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.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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
|-
| 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.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

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]]'''
|}

DCR Podcasts in Digital

2017-12-13T14:58:24Z

KimBritt: spelling

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

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

# 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#Parameters]] 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 ==
=== 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.
<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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

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

=== 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.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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
|-
| 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.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

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]]'''
|}

DCR Podcasts in Digital

2017-12-13T14:58:04Z

KimBritt: steps

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

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

# Send a list of yoru podcasts or programs to your TAM
#Update the parameters you use to call the SDK play and playheadPosition. Reference the appropriate [[Podcasts#Parameters]] 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 ==
=== 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.
<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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

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

=== 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.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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
|-
| 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.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

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]]'''
|}

DCR Podcasts in Digital

2017-12-13T14:52:36Z

KimBritt: no viewability

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category: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.
<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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

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

=== 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.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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
|-
| 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.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

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]]'''
|}

DCR Podcasts in Digital

2017-12-13T14:50:31Z

KimBritt:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category: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.
<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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

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

=== 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.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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
|-
| 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.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

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>

== The Viewability Metric ==
The viewability metric introduced in the Nielsen AppSDK represents the visibility of a video in the player along a playback. If you decide to implement the Nielsen Viewability Module, the SDK will track the viewability of the targeted player/element, log the viewable percentage, and record in seconds the time the player/element was in that viewable state. Please refer to Implementing [[Implementing Viewability with AppSDK|Viewability with AppSDK.]]

== Interruptions during playback ==
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.
* Start sending pings – [[loadMetadata]] and [[playheadPosition]] for the new viewing session, once the playback resumes.
Please see the [[Digital Measurement FAQ]] for more details

== 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T14:49:20Z

KimBritt: podcasts 2

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category: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.
<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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

=== 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.
|}
<nowiki>**</nowiki>''Only one of these parameters is mandatory''

''' playheadPosition Syntax Example for iOS'''
<syntaxhighlight lang="objective-c"> CMTime curTime=[player currentTime];
long pos=CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];</syntaxhighlight>

=== 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.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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
|-
| 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.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

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>

== The Viewability Metric ==
The viewability metric introduced in the Nielsen AppSDK represents the visibility of a video in the player along a playback. If you decide to implement the Nielsen Viewability Module, the SDK will track the viewability of the targeted player/element, log the viewable percentage, and record in seconds the time the player/element was in that viewable state. Please refer to Implementing [[Implementing Viewability with AppSDK|Viewability with AppSDK.]]

== Interruptions during playback ==
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.
* Start sending pings – [[loadMetadata]] and [[playheadPosition]] for the new viewing session, once the playback resumes.
Please see the [[Digital Measurement FAQ]] for more details

== 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T14:45:53Z

KimBritt: example on-demand

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category: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 ===
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.
<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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

=== playheadPosition (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
|-
| Video On Demand (VOD)** || Position taken from beginning of the content in seconds. || Client-defined || Yes || Current player position from beginning of the content.
|}
<nowiki>**</nowiki>''Only one of these parameters is mandatory''

=== On-demand Syntax ===
<syntaxhighlight lang="objective-c"> CMTime curTime=[player currentTime];
long pos=CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];</syntaxhighlight>

=== playheadPosition (Ad) ===
Use [[playheadPosition]] to pass the position of the playhead while the advertisement is being played.
<syntaxhighlight lang="objective-c"> – (void) playheadPosition: (long long) playheadPos</syntaxhighlight>

{| class="wikitable"
|-
! Key !! Description !! Values !! Required? (Y/N) !! Example
|-
| Ad || Position taken from beginning of the ad in seconds || Client-defined || Yes || Seconds since tart of the ad
|}

'''Ad Content'''
<syntaxhighlight lang="objective-c"> CMTime curTime=[adplayer currentTime];
long pos=CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];</syntaxhighlight>
<blockquote>'''Note:''' The playhead positions for ad and content should be maintained separately.</blockquote>

=== stop ===
[[stop]] must be called on the following events:
* At the end of ad
* In case of interruptions during playback like flight mode, Wi-Fi toggle, etc.

Call [[loadMetadata]] and [[playheadPosition]] when the stream resumes.

Call [[play]] when starting the new stream.

=== end ===
[[end]] must be called on the following events:
*End of playback
*Channel change

=== 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.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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
|-
| 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.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

Call [[playheadPosition]] every one second 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>

== The Viewability Metric ==
The viewability metric introduced in the Nielsen AppSDK represents the visibility of a video in the player along a playback. If you decide to implement the Nielsen Viewability Module, the SDK will track the viewability of the targeted player/element, log the viewable percentage, and record in seconds the time the player/element was in that viewable state. Please refer to Implementing [[Implementing Viewability with AppSDK|Viewability with AppSDK.]]

== Interruptions during playback ==
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.
* Start sending pings – [[loadMetadata]] and [[playheadPosition]] for the new viewing session, once the playback resumes.
Please see the [[Digital Measurement FAQ]] for more details

== 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T14:42:41Z

KimBritt: titles

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category: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 ===
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.
<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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

=== playheadPosition (Content) ===
Use [[playheadPosition]] to pass the position of the playhead while the content is being played.
<syntaxhighlight lang="objective-c"> – (void) playheadPosition: (long long) playheadPos</syntaxhighlight>
{| class="wikitable"
|-
! # !! Key !! Description !! Values !! Required? (Y/N) !! Example
|-
| 1 || Live** || UTC of the live content || Client-defined || Yes || Seconds since 1970
|-
| 2 || Video On Demand (VOD)** || Position taken from beginning of the content in seconds. || Client-defined || Yes || Current player position from beginning of the content.
|}
<nowiki>**</nowiki>''Only one of these parameters is mandatory''
<blockquote>'''Note:''' If playhead is not available from audio / video measurement, allow the app to start a timer (1-5 seconds) and send playhead position to SDK based on the timer event. Once the actual playhead is available, let the app send the proper playhead position. This allows the SDK to calculate and provide a closer value for duration.</blockquote>

'''Buffering state'''
* Do not supply playhead position while the content is being buffered.
* If the content is in buffering state continuously for more than 30 seconds, call [[stop]] API.

'''Live Content'''
<syntaxhighlight lang="objective-c"> long long pos = [[NSDate date] timeIntervalSince1970];
[nAppApiObject playheadPosition:pos];</syntaxhighlight>

'''On-demand Content'''
<syntaxhighlight lang="objective-c"> CMTime curTime=[player currentTime];
long pos=CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];</syntaxhighlight>

=== playheadPosition (Ad) ===
Use [[playheadPosition]] to pass the position of the playhead while the advertisement is being played.
<syntaxhighlight lang="objective-c"> – (void) playheadPosition: (long long) playheadPos</syntaxhighlight>

{| class="wikitable"
|-
! Key !! Description !! Values !! Required? (Y/N) !! Example
|-
| Ad || Position taken from beginning of the ad in seconds || Client-defined || Yes || Seconds since tart of the ad
|}

'''Ad Content'''
<syntaxhighlight lang="objective-c"> CMTime curTime=[adplayer currentTime];
long pos=CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];</syntaxhighlight>
<blockquote>'''Note:''' The playhead positions for ad and content should be maintained separately.</blockquote>

=== stop ===
[[stop]] must be called on the following events:
* At the end of ad
* In case of interruptions during playback like flight mode, Wi-Fi toggle, etc.

Call [[loadMetadata]] and [[playheadPosition]] when the stream resumes.

Call [[play]] when starting the new stream.

=== end ===
[[end]] must be called on the following events:
*End of playback
*Channel change

=== 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.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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
|-
| 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.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

Call [[playheadPosition]] every one second 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>

== The Viewability Metric ==
The viewability metric introduced in the Nielsen AppSDK represents the visibility of a video in the player along a playback. If you decide to implement the Nielsen Viewability Module, the SDK will track the viewability of the targeted player/element, log the viewable percentage, and record in seconds the time the player/element was in that viewable state. Please refer to Implementing [[Implementing Viewability with AppSDK|Viewability with AppSDK.]]

== Interruptions during playback ==
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.
* Start sending pings – [[loadMetadata]] and [[playheadPosition]] for the new viewing session, once the playback resumes.
Please see the [[Digital Measurement FAQ]] for more details

== 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T14:41:14Z

KimBritt:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category: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.

== Initialize SDK ==
Initialize App SDK as soon as the application is launched. Refer to [[iOS SDK API Reference#Initialization|iOS SDK API Reference - Initialization]] for details on initializing an AppSDK object and the parameters required.

== Configure API calls ==
=== play ===
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.
<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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

=== playheadPosition (Content) ===
Use [[playheadPosition]] to pass the position of the playhead while the content is being played.
<syntaxhighlight lang="objective-c"> – (void) playheadPosition: (long long) playheadPos</syntaxhighlight>
{| class="wikitable"
|-
! # !! Key !! Description !! Values !! Required? (Y/N) !! Example
|-
| 1 || Live** || UTC of the live content || Client-defined || Yes || Seconds since 1970
|-
| 2 || Video On Demand (VOD)** || Position taken from beginning of the content in seconds. || Client-defined || Yes || Current player position from beginning of the content.
|}
<nowiki>**</nowiki>''Only one of these parameters is mandatory''
<blockquote>'''Note:''' If playhead is not available from audio / video measurement, allow the app to start a timer (1-5 seconds) and send playhead position to SDK based on the timer event. Once the actual playhead is available, let the app send the proper playhead position. This allows the SDK to calculate and provide a closer value for duration.</blockquote>

'''Buffering state'''
* Do not supply playhead position while the content is being buffered.
* If the content is in buffering state continuously for more than 30 seconds, call [[stop]] API.

'''Live Content'''
<syntaxhighlight lang="objective-c"> long long pos = [[NSDate date] timeIntervalSince1970];
[nAppApiObject playheadPosition:pos];</syntaxhighlight>

'''On-demand Content'''
<syntaxhighlight lang="objective-c"> CMTime curTime=[player currentTime];
long pos=CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];</syntaxhighlight>

=== playheadPosition (Ad) ===
Use [[playheadPosition]] to pass the position of the playhead while the advertisement is being played.
<syntaxhighlight lang="objective-c"> – (void) playheadPosition: (long long) playheadPos</syntaxhighlight>

{| class="wikitable"
|-
! Key !! Description !! Values !! Required? (Y/N) !! Example
|-
| Ad || Position taken from beginning of the ad in seconds || Client-defined || Yes || Seconds since tart of the ad
|}

'''Ad Content'''
<syntaxhighlight lang="objective-c"> CMTime curTime=[adplayer currentTime];
long pos=CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];</syntaxhighlight>
<blockquote>'''Note:''' The playhead positions for ad and content should be maintained separately.</blockquote>

=== stop ===
[[stop]] must be called on the following events:
* At the end of ad
* In case of interruptions during playback like flight mode, Wi-Fi toggle, etc.

Call [[loadMetadata]] and [[playheadPosition]] when the stream resumes.

Call [[play]] when starting the new stream.

=== end ===
[[end]] must be called on the following events:
*End of playback
*Channel change

=== 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.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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
|-
| 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.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

Call [[playheadPosition]] every one second 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>

== The Viewability Metric ==
The viewability metric introduced in the Nielsen AppSDK represents the visibility of a video in the player along a playback. If you decide to implement the Nielsen Viewability Module, the SDK will track the viewability of the targeted player/element, log the viewable percentage, and record in seconds the time the player/element was in that viewable state. Please refer to Implementing [[Implementing Viewability with AppSDK|Viewability with AppSDK.]]

== Interruptions during playback ==
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.
* Start sending pings – [[loadMetadata]] and [[playheadPosition]] for the new viewing session, once the playback resumes.
Please see the [[Digital Measurement FAQ]] for more details

== 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T14:38:56Z

KimBritt: /* Prerequisites */

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

== Prerequisites ==
This document assumes you have implemented Digital Audio with Live AM/FM stream measurement.

== Import Library ==
Refer to [[iOS SDK API Reference#Importing Frameworks|iOS SDK API Reference - Importing Frameworks]] for information on importing libraries.
* The latest version of App SDK allows instantiating multiple instances of App SDK object and can be used simultaneously without any issues.

== Initialize SDK ==
Initialize App SDK as soon as the application is launched. Refer to [[iOS SDK API Reference#Initialization|iOS SDK API Reference - Initialization]] for details on initializing an AppSDK object and the parameters required.

== Configure API calls ==
=== play ===
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.
<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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

=== playheadPosition (Content) ===
Use [[playheadPosition]] to pass the position of the playhead while the content is being played.
<syntaxhighlight lang="objective-c"> – (void) playheadPosition: (long long) playheadPos</syntaxhighlight>
{| class="wikitable"
|-
! # !! Key !! Description !! Values !! Required? (Y/N) !! Example
|-
| 1 || Live** || UTC of the live content || Client-defined || Yes || Seconds since 1970
|-
| 2 || Video On Demand (VOD)** || Position taken from beginning of the content in seconds. || Client-defined || Yes || Current player position from beginning of the content.
|}
<nowiki>**</nowiki>''Only one of these parameters is mandatory''
<blockquote>'''Note:''' If playhead is not available from audio / video measurement, allow the app to start a timer (1-5 seconds) and send playhead position to SDK based on the timer event. Once the actual playhead is available, let the app send the proper playhead position. This allows the SDK to calculate and provide a closer value for duration.</blockquote>

'''Buffering state'''
* Do not supply playhead position while the content is being buffered.
* If the content is in buffering state continuously for more than 30 seconds, call [[stop]] API.

'''Live Content'''
<syntaxhighlight lang="objective-c"> long long pos = [[NSDate date] timeIntervalSince1970];
[nAppApiObject playheadPosition:pos];</syntaxhighlight>

'''On-demand Content'''
<syntaxhighlight lang="objective-c"> CMTime curTime=[player currentTime];
long pos=CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];</syntaxhighlight>

=== playheadPosition (Ad) ===
Use [[playheadPosition]] to pass the position of the playhead while the advertisement is being played.
<syntaxhighlight lang="objective-c"> – (void) playheadPosition: (long long) playheadPos</syntaxhighlight>

{| class="wikitable"
|-
! Key !! Description !! Values !! Required? (Y/N) !! Example
|-
| Ad || Position taken from beginning of the ad in seconds || Client-defined || Yes || Seconds since tart of the ad
|}

'''Ad Content'''
<syntaxhighlight lang="objective-c"> CMTime curTime=[adplayer currentTime];
long pos=CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];</syntaxhighlight>
<blockquote>'''Note:''' The playhead positions for ad and content should be maintained separately.</blockquote>

=== stop ===
[[stop]] must be called on the following events:
* At the end of ad
* In case of interruptions during playback like flight mode, Wi-Fi toggle, etc.

Call [[loadMetadata]] and [[playheadPosition]] when the stream resumes.

Call [[play]] when starting the new stream.

=== end ===
[[end]] must be called on the following events:
*End of playback
*Channel change

=== 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.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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
|-
| 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.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

Call [[playheadPosition]] every one second 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>

== The Viewability Metric ==
The viewability metric introduced in the Nielsen AppSDK represents the visibility of a video in the player along a playback. If you decide to implement the Nielsen Viewability Module, the SDK will track the viewability of the targeted player/element, log the viewable percentage, and record in seconds the time the player/element was in that viewable state. Please refer to Implementing [[Implementing Viewability with AppSDK|Viewability with AppSDK.]]

== Interruptions during playback ==
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.
* Start sending pings – [[loadMetadata]] and [[playheadPosition]] for the new viewing session, once the playback resumes.
Please see the [[Digital Measurement FAQ]] for more details

== 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T14:38:04Z

KimBritt: /* Technical Guides */

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

== Prerequisites ==
To start using the App SDK, the following details are required:
* '''App ID (appid):''' Unique ID assigned to the player/site and configured by product.
* '''sfcode:''' Unique identifier for the environment that the SDK should point to.
* '''Nielsen SDK''' and '''Sample Player''': A part of the downloaded package
If you do not have any of these pre-requisites or if you have any questions, please contact our SDK sales support team.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

== Import Library ==
Refer to [[iOS SDK API Reference#Importing Frameworks|iOS SDK API Reference - Importing Frameworks]] for information on importing libraries.
* The latest version of App SDK allows instantiating multiple instances of App SDK object and can be used simultaneously without any issues.

== Initialize SDK ==
Initialize App SDK as soon as the application is launched. Refer to [[iOS SDK API Reference#Initialization|iOS SDK API Reference - Initialization]] for details on initializing an AppSDK object and the parameters required.

== Configure API calls ==
=== play ===
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.
<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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

=== playheadPosition (Content) ===
Use [[playheadPosition]] to pass the position of the playhead while the content is being played.
<syntaxhighlight lang="objective-c"> – (void) playheadPosition: (long long) playheadPos</syntaxhighlight>
{| class="wikitable"
|-
! # !! Key !! Description !! Values !! Required? (Y/N) !! Example
|-
| 1 || Live** || UTC of the live content || Client-defined || Yes || Seconds since 1970
|-
| 2 || Video On Demand (VOD)** || Position taken from beginning of the content in seconds. || Client-defined || Yes || Current player position from beginning of the content.
|}
<nowiki>**</nowiki>''Only one of these parameters is mandatory''
<blockquote>'''Note:''' If playhead is not available from audio / video measurement, allow the app to start a timer (1-5 seconds) and send playhead position to SDK based on the timer event. Once the actual playhead is available, let the app send the proper playhead position. This allows the SDK to calculate and provide a closer value for duration.</blockquote>

'''Buffering state'''
* Do not supply playhead position while the content is being buffered.
* If the content is in buffering state continuously for more than 30 seconds, call [[stop]] API.

'''Live Content'''
<syntaxhighlight lang="objective-c"> long long pos = [[NSDate date] timeIntervalSince1970];
[nAppApiObject playheadPosition:pos];</syntaxhighlight>

'''On-demand Content'''
<syntaxhighlight lang="objective-c"> CMTime curTime=[player currentTime];
long pos=CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];</syntaxhighlight>

=== playheadPosition (Ad) ===
Use [[playheadPosition]] to pass the position of the playhead while the advertisement is being played.
<syntaxhighlight lang="objective-c"> – (void) playheadPosition: (long long) playheadPos</syntaxhighlight>

{| class="wikitable"
|-
! Key !! Description !! Values !! Required? (Y/N) !! Example
|-
| Ad || Position taken from beginning of the ad in seconds || Client-defined || Yes || Seconds since tart of the ad
|}

'''Ad Content'''
<syntaxhighlight lang="objective-c"> CMTime curTime=[adplayer currentTime];
long pos=CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];</syntaxhighlight>
<blockquote>'''Note:''' The playhead positions for ad and content should be maintained separately.</blockquote>

=== stop ===
[[stop]] must be called on the following events:
* At the end of ad
* In case of interruptions during playback like flight mode, Wi-Fi toggle, etc.

Call [[loadMetadata]] and [[playheadPosition]] when the stream resumes.

Call [[play]] when starting the new stream.

=== end ===
[[end]] must be called on the following events:
*End of playback
*Channel change

=== 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.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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
|-
| 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.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

Call [[playheadPosition]] every one second 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>

== The Viewability Metric ==
The viewability metric introduced in the Nielsen AppSDK represents the visibility of a video in the player along a playback. If you decide to implement the Nielsen Viewability Module, the SDK will track the viewability of the targeted player/element, log the viewable percentage, and record in seconds the time the player/element was in that viewable state. Please refer to Implementing [[Implementing Viewability with AppSDK|Viewability with AppSDK.]]

== Interruptions during playback ==
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.
* Start sending pings – [[loadMetadata]] and [[playheadPosition]] for the new viewing session, once the playback resumes.
Please see the [[Digital Measurement FAQ]] for more details

== 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]]'''
|}

DCR Podcasts in Digital

2017-12-13T14:37:24Z

KimBritt: /* SDK - Video */

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

== Prerequisites ==
To start using the App SDK, the following details are required:
* '''App ID (appid):''' Unique ID assigned to the player/site and configured by product.
* '''sfcode:''' Unique identifier for the environment that the SDK should point to.
* '''Nielsen SDK''' and '''Sample Player''': A part of the downloaded package
If you do not have any of these pre-requisites or if you have any questions, please contact our SDK sales support team.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

== Import Library ==
Refer to [[iOS SDK API Reference#Importing Frameworks|iOS SDK API Reference - Importing Frameworks]] for information on importing libraries.
* The latest version of App SDK allows instantiating multiple instances of App SDK object and can be used simultaneously without any issues.

== Initialize SDK ==
Initialize App SDK as soon as the application is launched. Refer to [[iOS SDK API Reference#Initialization|iOS SDK API Reference - Initialization]] for details on initializing an AppSDK object and the parameters required.

== Configure API calls ==
=== play ===
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.
<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’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>

=== playheadPosition (Content) ===
Use [[playheadPosition]] to pass the position of the playhead while the content is being played.
<syntaxhighlight lang="objective-c"> – (void) playheadPosition: (long long) playheadPos</syntaxhighlight>
{| class="wikitable"
|-
! # !! Key !! Description !! Values !! Required? (Y/N) !! Example
|-
| 1 || Live** || UTC of the live content || Client-defined || Yes || Seconds since 1970
|-
| 2 || Video On Demand (VOD)** || Position taken from beginning of the content in seconds. || Client-defined || Yes || Current player position from beginning of the content.
|}
<nowiki>**</nowiki>''Only one of these parameters is mandatory''
<blockquote>'''Note:''' If playhead is not available from audio / video measurement, allow the app to start a timer (1-5 seconds) and send playhead position to SDK based on the timer event. Once the actual playhead is available, let the app send the proper playhead position. This allows the SDK to calculate and provide a closer value for duration.</blockquote>

'''Buffering state'''
* Do not supply playhead position while the content is being buffered.
* If the content is in buffering state continuously for more than 30 seconds, call [[stop]] API.

'''Live Content'''
<syntaxhighlight lang="objective-c"> long long pos = [[NSDate date] timeIntervalSince1970];
[nAppApiObject playheadPosition:pos];</syntaxhighlight>

'''On-demand Content'''
<syntaxhighlight lang="objective-c"> CMTime curTime=[player currentTime];
long pos=CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];</syntaxhighlight>

=== playheadPosition (Ad) ===
Use [[playheadPosition]] to pass the position of the playhead while the advertisement is being played.
<syntaxhighlight lang="objective-c"> – (void) playheadPosition: (long long) playheadPos</syntaxhighlight>

{| class="wikitable"
|-
! Key !! Description !! Values !! Required? (Y/N) !! Example
|-
| Ad || Position taken from beginning of the ad in seconds || Client-defined || Yes || Seconds since tart of the ad
|}

'''Ad Content'''
<syntaxhighlight lang="objective-c"> CMTime curTime=[adplayer currentTime];
long pos=CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];</syntaxhighlight>
<blockquote>'''Note:''' The playhead positions for ad and content should be maintained separately.</blockquote>

=== stop ===
[[stop]] must be called on the following events:
* At the end of ad
* In case of interruptions during playback like flight mode, Wi-Fi toggle, etc.

Call [[loadMetadata]] and [[playheadPosition]] when the stream resumes.

Call [[play]] when starting the new stream.

=== end ===
[[end]] must be called on the following events:
*End of playback
*Channel change

=== 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.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"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"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.

{| 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
|-
| 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.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

Call [[playheadPosition]] every one second 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>

== The Viewability Metric ==
The viewability metric introduced in the Nielsen AppSDK represents the visibility of a video in the player along a playback. If you decide to implement the Nielsen Viewability Module, the SDK will track the viewability of the targeted player/element, log the viewable percentage, and record in seconds the time the player/element was in that viewable state. Please refer to Implementing [[Implementing Viewability with AppSDK|Viewability with AppSDK.]]

== Interruptions during playback ==
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.
* Start sending pings – [[loadMetadata]] and [[playheadPosition]] for the new viewing session, once the playback resumes.
Please see the [[Digital Measurement FAQ]] for more details

== 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;" |
! 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]]'''
|}

{| 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]]
|}