Difference between revisions of "play"

From Engineering Client Portal

Line 14: Line 14:
  
 
== Syntax ==
 
== Syntax ==
<syntaxhighlight lang="swift">[endpoint]/[appid]/[sessionID]/a?b=[payload]</syntaxhighlight>
+
<syntaxhighlight lang="swift"> [nielsenAppApi play:(JSONObject channelInfo)];</syntaxhighlight>
  
 
== Input Parameters ==
 
== Input Parameters ==

Revision as of 21:39, 1 November 2017

Engineering Portal breadcrumbArrow.png Digital breadcrumbArrow.png iOS SDK API Reference breadcrumbArrow.png play

The SDK is started by calling the play API with the channelName parameter and mediaURL parameters.

  • channelName is an optional parameter you can pass when:
    • The user taps the Play button on the player (OR)
    • An audio stream restarts automatically
  • Pass descriptive stream information through this parameter
    • The channel name field is a 32-character field containing the name of the program or feed such as: “WENZ-FM”, “The Dove-Tampa”, “Hot 107.9”, or “Aerosmith Radio”.
    • channelName in play API is required for Digital in TV Ratings and can have free form text.
    • channelName parameter is optional for Digital Audio and Digital Content Ratings.


Syntax

 [nielsenAppApi play:(JSONObject channelInfo)];

Input Parameters

Parameter Description
channelName Free-form text up to 32 characters
mediaURL Media URL value for the content that is being played

DTVR

NSDictionary *appInformation = @
{
  @"channelName":@"TheMovieTitle",
  @"mediaURL":@""
};

DCR

NSDictionary *appInformation = @
{
  @"channelName":@"",
  @"mediaURL":@"http://www.nielseninternet.com/BBB/prog_index.m3u8"
};

Output Parameters

Output Parameters (Return value) Description
void