play

Engineering Portal Digital iOS SDK API Reference play

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

• Pass the channelName parameter 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”.
  • 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.
• mediaURL is an optional parameter
  • This is the URL for the content (media) that is being played.
  • If mediaURL is 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":@"" }; DCR NSDictionary *appInformation = @ { @"channelName":@"", @"mediaURL":@"http://www.nielseninternet.com/BBB/prog_index.m3u8" };

Output Parameters

Output Parameters (Return value)	Description
void