JW Player Plugin iOS - Revision history

Admin at 21:51, 20 October 2017

2017-10-20T21:51:41Z

← Older revision		Revision as of 21:51, 20 October 2017
Line 10:		Line 10:
	\|SDKVersion=5.1.0.5		\|SDKVersion=5.1.0.5
	\|supportedAdFrameworks=VMAP and VAST		\|supportedAdFrameworks=VMAP and VAST
			\|downloadLink=https://engineeringportal.nielsen.com/w/downloads/digital/plugins/jwplayer/ios/Nielsen-App-SDK-JW-Player-Plugin-iOS-1.1.0.zip
	}}		}}

Admin at 20:36, 31 August 2017

2017-08-31T20:36:53Z

← Older revision		Revision as of 20:36, 31 August 2017
Line 10:		Line 10:
	\|SDKVersion=5.1.0.5		\|SDKVersion=5.1.0.5
	\|supportedAdFrameworks=VMAP and VAST		\|supportedAdFrameworks=VMAP and VAST
	~~\|downloadLink=https://engineeringforum.nielsen.com/sdk/developers/SDKdownloads/Nielsen-App-SDK-Brightcove-Plugin-iOS-1.3.0.zip~~
	}}		}}

Admin at 20:31, 31 August 2017

2017-08-31T20:31:10Z

← Older revision		Revision as of 20:31, 31 August 2017
Line 5:		Line 5:

	{{PluginInfobox		{{PluginInfobox
	\|pluginImage=~~BrightcoveIcon~~		\|pluginImage=JWPlayerIcon
	\|osImage=macOSIcon		\|osImage=macOSIcon
	\|playerVersion=2.1		\|playerVersion=2.1

Admin at 20:29, 31 August 2017

2017-08-31T20:29:22Z

← Older revision		Revision as of 20:29, 31 August 2017
Line 4:		Line 4:
	'''Nielsen App SDK Plugin for JW Player''' interacts with Nielsen App SDK to provide with necessary data for streaming measurement based on the SDK events received from the JW Player SDK.		'''Nielsen App SDK Plugin for JW Player''' interacts with Nielsen App SDK to provide with necessary data for streaming measurement based on the SDK events received from the JW Player SDK.

	~~'''Supported Ad Frameworks'''~~		{{PluginInfobox
	* VAST		\|pluginImage=BrightcoveIcon
			\|osImage=macOSIcon
			\|playerVersion=2.1
			\|SDKVersion=5.1.0.5
			\|supportedAdFrameworks=VMAP and VAST
			\|downloadLink=https://engineeringforum.nielsen.com/sdk/developers/SDKdownloads/Nielsen-App-SDK-Brightcove-Plugin-iOS-1.3.0.zip
			}}

	==Plugin Implementation ==		==Plugin Implementation ==

Admin: /* Opt-Out */

2017-07-26T21:50:48Z

Opt-Out

← Older revision		Revision as of 21:50, 26 July 2017
Line 96:		Line 96:
	This API gets the current Nielsen opt-out state of AppSDK. Call this API to retrieve the Opt-Out or Opt-In state. Refer to the [[Digital Measurement Onboarding ]] in the Nielsen SDK Documentation for more information and example.		This API gets the current Nielsen opt-out state of AppSDK. Call this API to retrieve the Opt-Out or Opt-In state. Refer to the [[Digital Measurement Onboarding ]] in the Nielsen SDK Documentation for more information and example.

	* For App SDK 5.1.1.17 and above, the opt-out page can be displayed in a WebView / external browser using the optOutURL exposed by the plugin.		* For App SDK 5.1.1.17 and above, the opt-out page can be displayed in a WebView / external browser using the [[optOutURL]] exposed by the plugin.
	* For App SDK 5.1.1.16 and earlier, display the opt-out page in a WebView using the optOutURL exposed by the plugin and pass the response from user back to Nielsen using the userOptOut.		* For App SDK 5.1.1.16 and earlier, display the opt-out page in a WebView using the optOutURL exposed by the plugin and pass the response from user back to Nielsen using the [[userOptOut]]. For more details, refer to [[iOS SDK API Reference#iOS Opt-Out Implementation]].

	== SampleApp ==		== SampleApp ==

Admin3 at 21:18, 26 July 2017

2017-07-26T21:18:22Z

← Older revision		Revision as of 21:18, 26 July 2017
Line 41:		Line 41:

	===Nielsen App SDK Plugin Package Installation===		===Nielsen App SDK Plugin Package Installation===

	For FreeWheel ad support		For FreeWheel ad support
	* Unzip the NielsenJWPlayerPluginForiOS.zip		* Unzip the NielsenJWPlayerPluginForiOS.zip
Line 88:		Line 89:

	=== Opt-Out ===		=== Opt-Out ===

	The updateOTT method is used to notify App SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).		The updateOTT method is used to notify App SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).

Admin3: Added Version 1.2.0

2017-07-26T21:16:30Z

Added Version 1.2.0

← Older revision		Revision as of 21:16, 26 July 2017
Line 109:		Line 109:
	\|-		\|-
	\| Nielsen AppSDK Plugin for JWPLayer (VAST) \|\| 1.1.0 \|\| 06/20/2016 \|\| Reflects changes as per latest Nielsen App SDK v5.1.0.5		\| Nielsen AppSDK Plugin for JWPLayer (VAST) \|\| 1.1.0 \|\| 06/20/2016 \|\| Reflects changes as per latest Nielsen App SDK v5.1.0.5
			\|-
			\| Nielsen AppSDK Plugin for JWPLayer (VAST) \|\| 1.2.0 \|\| 07/27/2016 \|\| Reflects changes as per latest Nielsen App SDK v5.1.1.19
	\|}		\|}

Admin3: Changed OTT

2017-07-26T21:15:01Z

Changed OTT

← Older revision		Revision as of 21:15, 26 July 2017
Line 88:		Line 88:

	=== Opt-Out ===		=== Opt-Out ===
	The ~~app needs~~ to ~~provide a way for~~ the ~~user to optout of metering~~. ~~This~~ is ~~done by displaying Opt-Out page and passing the user's response back to Nielsen, as described in the [[Digital Measurement Onboarding ]]~~ of ~~the Nielsen SDK Documentation. The plugin exposes the 'NielsenAppApi', userOptOut and optOutURLString methods that are needed to interact with Opt-Out page~~.		The updateOTT method is used to notify App SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).

	<syntaxhighlight lang="objective-c">-(~~BOOL~~)~~optOutStatus~~;</syntaxhighlight>		<syntaxhighlight lang="objective-c">- (void) updateOTT:(id)ottInfo;;</syntaxhighlight>

	This API gets the current Nielsen opt-out state of AppSDK. Call this API to retrieve the Opt-Out or Opt-In state. Refer to the [[Digital Measurement Onboarding ]] in the Nielsen SDK Documentation for more information and example.		This API gets the current Nielsen opt-out state of AppSDK. Call this API to retrieve the Opt-Out or Opt-In state. Refer to the [[Digital Measurement Onboarding ]] in the Nielsen SDK Documentation for more information and example.

			* For App SDK 5.1.1.17 and above, the opt-out page can be displayed in a WebView / external browser using the optOutURL exposed by the plugin.
			* For App SDK 5.1.1.16 and earlier, display the opt-out page in a WebView using the optOutURL exposed by the plugin and pass the response from user back to Nielsen using the userOptOut.

	== SampleApp ==		== SampleApp ==

Admin3 at 21:12, 26 July 2017

2017-07-26T21:12:39Z

← Older revision		Revision as of 21:12, 26 July 2017
Line 88:		Line 88:

	=== Opt-Out ===		=== Opt-Out ===
	The app needs to provide a way for the user to optout of metering. This is done by displaying Opt-Out page and passing the user's response back to Nielsen, as described in the [[Digital Measurement Onboarding ]] of the Nielsen SDK Documentation. The plugin exposes the 'NielsenAppApi', userOptOut and optOutURLString methods that are needed to interact with Opt-Out page.<syntaxhighlight lang="objective-c">-(BOOL)optOutStatus;</syntaxhighlight>		The app needs to provide a way for the user to optout of metering. This is done by displaying Opt-Out page and passing the user's response back to Nielsen, as described in the [[Digital Measurement Onboarding ]] of the Nielsen SDK Documentation. The plugin exposes the 'NielsenAppApi', userOptOut and optOutURLString methods that are needed to interact with Opt-Out page.

			<syntaxhighlight lang="objective-c">-(BOOL)optOutStatus;</syntaxhighlight>

	This API gets the current Nielsen opt-out state of AppSDK. Call this API to retrieve the Opt-Out or Opt-In state. Refer to the [[Digital Measurement Onboarding ]] in the Nielsen SDK Documentation for more information and example.		This API gets the current Nielsen opt-out state of AppSDK. Call this API to retrieve the Opt-Out or Opt-In state. Refer to the [[Digital Measurement Onboarding ]] in the Nielsen SDK Documentation for more information and example.

Admin3: Updating code example

2017-07-26T21:10:43Z

Updating code example

← Older revision		Revision as of 21:10, 26 July 2017
Line 55:		Line 55:

	Perform the following steps in the app view controller, where the player is initialized		Perform the following steps in the app view controller, where the player is initialized
	* Import Plugin<syntaxhighlight lang="objective-c">#import "NielsenJWPlayerPlugin.h"</~~syntaxhighligh~~>		* Import Plugin<syntaxhighlight lang="objective-c">#import "NielsenJWPlayerPlugin.h"</syntaxhighlight>
	* Add Property<syntaxhighlight lang="objective-c">@property (nonatomic, strong) NielsenJWPlayerPlugin *nielsenJWPlayerPlugin;</syntaxhighlight>Instantiate the plugin and register it with an instance of 'JWPlayerController' based on the app information provided by Nielsen.<syntaxhighlight lang="objective-c">self.nielsenJWPlayerPlugin = [[NielsenJWPlayerPlugin alloc]
	~~initWithAppInfo~~:@{@"appid": @"MY_APP_ID",		* Add Property<syntaxhighlight lang="objective-c">@property (nonatomic, strong) NielsenJWPlayerPlugin *nielsenJWPlayerPlugin;</syntaxhighlight>
	@"appversion": @"MY_APP_VERSION",
	@"appname": @"MY_APP_NAME",		* Instantiate the plugin and register it with an instance of 'JWPlayerController' based on the app information provided by Nielsen.
	@"sfcode": @"MY_SFCODE"};		<syntaxhighlight lang="objective-c">self.nielsenJWPlayerPlugin = [[NielsenJWPlayerPlugin alloc]
			initWithPlayer: player appInfo:@
			{
			@"appid": @"MY_APP_ID",
			@"appversion": @"MY_APP_VERSION",
			@"appname": @"MY_APP_NAME",
			@"sfcode": @"MY_SFCODE"
			};
	self.nielsenJWPlayerPlugin.dataSource = self;		self.nielsenJWPlayerPlugin.dataSource = self;
	self.player.delegate = self.nielsenJWPlayerPlugin;</syntaxhighlight>		self.player.delegate = self.nielsenJWPlayerPlugin;
	* Implement 'NielsenJWPlayerDataSource' delegate by adding the method as mentioned below:<syntaxhighlight lang="objective-c">– (NSDictionary *)contentMetadata;</syntaxhighlight>Plugin will call this method to fetch content metadata for the video.		</syntaxhighlight>
			* Implement 'NielsenJWPlayerDataSource' delegate by adding the method as mentioned below:
			<syntaxhighlight lang="objective-c">– (NSDictionary *)contentMetadata;</syntaxhighlight>
			Plugin will call this method to fetch content metadata for the video.

	Refer to the Reference Guide in the Nielsen SDK Documentation on the exact format of this dictionary. Set any key-value pair from the content metadata with an exception of 'length', 'type' and 'title', which are pre-set already.		Refer to the Reference Guide in the Nielsen SDK Documentation on the exact format of this dictionary. Set any key-value pair from the content metadata with an exception of 'length', 'type' and 'title', which are pre-set already.

	* Add the following line of code (optional):<syntaxhighlight lang="objective-c">– (NSDictionary *)channelInfo;</syntaxhighlight>		* Add the following line of code (optional):
			<syntaxhighlight lang="objective-c">– (NSDictionary *)channelInfo;</syntaxhighlight>
	Plugin calls this method to request for channel information associated with the video.		Plugin calls this method to request for channel information associated with the video.