play: Difference between revisions

Revision as of 17:41, 2 October 2017

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.

[endpoint]/[appid]/[sessionID]/a?b=[payload]

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 (Return value)	Description
void

@@ Line 4: / Line 4: @@
 The SDK is started by calling the <code>play</code> API with the <code>channelName</code> parameter and <code>mediaURL</code> parameters.
-*Pass the <code>channelName</code> parameter with the channel name when
+* <code>channelName</code> is an optional parameter you can pass when:
 **The user taps the '''Play''' button on the player (OR)
 **An audio stream restarts automatically
@@ Line 11: / Line 11: @@
 **<code>channelName</code> in play API is required for Digital in TV Ratings and can have free form text.
 **<code>channelName</code> parameter is optional for [[Digital Audio]] and Digital Content Ratings.
-*mediaURL is an optional parameter
-**This is the URL for the content (media) that is being played.
-**If <code>mediaURL</code> is not available, pass an empty value.
 == Syntax ==