play: Difference between revisions
From Engineering Client Portal
No edit summary |
(- Digital Audio) |
||
| (7 intermediate revisions by 4 users not shown) | |||
| 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. | The SDK is started by calling the <code>play</code> API with the <code>channelName</code> parameter and <code>mediaURL</code> parameters. | ||
* | * <code>channelName</code> is an optional parameter you can pass when: | ||
**The user taps the '''Play''' button on the player (OR) | **The user taps the '''Play''' button on the player (OR) | ||
**An audio stream restarts automatically | **An audio stream restarts automatically | ||
*Pass descriptive stream information through this parameter | *Pass descriptive stream information through this parameter | ||
**<code>channelName</code> in play API is required for Digital in TV Ratings and can have free form text. | |||
**<code>channelName</code> in play API is required for | |||
== Syntax == | == Syntax == | ||
<syntaxhighlight lang="swift">[ | <syntaxhighlight lang="swift"> [nielsenAppApi play:(JSONObject channelInfo)];</syntaxhighlight> | ||
== Input Parameters == | == Input Parameters == | ||
| Line 31: | Line 26: | ||
NSDictionary *appInformation = @ | NSDictionary *appInformation = @ | ||
{ | { | ||
@ | @"channelName":@"TheMovieTitle", | ||
@ | @"mediaURL":@"" | ||
}; | }; | ||
</syntaxhighlight> | </syntaxhighlight> | ||
''' | '''DCR''' | ||
<syntaxhighlight lang="swift"> | <syntaxhighlight lang="swift"> | ||
NSDictionary *appInformation = @ | NSDictionary *appInformation = @ | ||
{ | { | ||
@ | @"channelName":@"", | ||
@ | @"mediaURL":@"http://www.nielseninternet.com/BBB/prog_index.m3u8" | ||
}; | }; | ||
</syntaxhighlight> | </syntaxhighlight> | ||
|} | |||
== Output Parameters == | |||
{| class="wikitable" | |||
|- | |||
! Output Parameters (Return value) !! Description | |||
|- | |||
| void || | |||
|} | |} | ||
Latest revision as of 22:22, 14 May 2019
Engineering Portal 
Digital iOS SDK API Reference play
The SDK is started by calling the play API with the channelName parameter and mediaURL parameters.
channelNameis 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
channelNamein play API is required for Digital in TV Ratings and can have free form text.
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 |