play: Difference between revisions
From Engineering Client Portal
No edit summary |
No edit summary |
||
| Line 9: | Line 9: | ||
*Pass descriptive stream information through this parameter | *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”. | **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”. | ||
**<code>channelName</code> in play API is required for [[Digital in TV Ratings | **<code>channelName</code> in play API is required for [[Digital in TV Ratings]] and can have freeform text. | ||
**<code>channelName</code> parameter is optional for [[Digital Audio]] and [[Digital Content Ratings | **<code>channelName</code> parameter is optional for [[Digital Audio]] and [[Digital Content Ratings]]. | ||
*mediaURL is an optional parameter | *mediaURL is an optional parameter | ||
**This is the URL for the content (media) that is being played. | **This is the URL for the content (media) that is being played. | ||
| Line 31: | Line 31: | ||
NSDictionary *appInformation = @ | NSDictionary *appInformation = @ | ||
{ | { | ||
@ | @"channelName":@"TheMovieTitle", | ||
@ | @"mediaURL":@"" | ||
}; | }; | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 40: | Line 40: | ||
NSDictionary *appInformation = @ | NSDictionary *appInformation = @ | ||
{ | { | ||
@ | @"channelName":@"", | ||
@ | @"mediaURL":@"http://www.nielseninternet.com/BBB/prog_index.m3u8" | ||
}; | }; | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 14:45, 21 July 2017
The SDK is started by calling the play API with the channelName parameter and mediaURL parameters.
- Pass the
channelNameparameter with the channel name 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”.
channelNamein play API is required for Digital in TV Ratings and can have freeform text.channelNameparameter 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
mediaURLis not available, pass an empty value.
Syntax
[endpoint]/[appid]/[sessionID]/a?b=[payload]
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":@""
};
Digital Audio and DCR NSDictionary *appInformation = @
{
@"channelName":@"",
@"mediaURL":@"http://www.nielseninternet.com/BBB/prog_index.m3u8"
};
|
Output Parameters
| Output Parameters (Return value) | Description |
|---|---|
| void |