+
+
+
+
+
+```
+
+Three imports are required to use the videojs-ima module, as seen in the player.js example below.
+
+```javascript
+import videojs from 'video.js';
+import 'videojs-contrib-ads';
+import 'videojs-ima';
+
+var videoOptions = {
+ controls: true,
+ sources: [{
+ src: 'PATH_TO_YOUR_CONTENT_VIDEO',
+ type: 'YOUR_CONTENT_VIDEO_TYPE',
+ }]
+};
+
+var player = videojs('content_video', videoOptions);
+
+var imaOptions = {
+ adTagUrl: 'YOUR_AD_TAG'
+};
+
+player.ima(imaOptions);
+// On mobile devices, you must call initializeAdDisplayContainer as the result
+// of a user action (e.g. button click). If you do not make this call, the SDK
+// will make it for you, but not as the result of a user action. For more info
+// see our examples, all of which are set up to work on mobile devices.
+// player.ima.initializeAdDisplayContainer();
+```
+
+### Alternative Setup
If you don't use npm, you can download the source from the dist/ folder and
include it directly in your project. You'll also need to download the source for
the [videojs-contrib-ads plugin](//github.com/videojs/videojs-contrib-ads).
@@ -98,7 +155,7 @@ the previous snippet. A summary of all settings follows:
| disableCustomPlaybackForIOS10Plus | boolean | Sets whether to disable custom playback on iOS 10+ browsers. If true, ads will play inline if the content video is inline. Defaults to false. |
| forceNonLinearFullSlot | boolean | True to force non-linear AdSense ads to render as linear fullslot.,If set, the content video will be paused and the non-linear text or image ad will be rendered as,fullslot. The content video will resume once the ad has been skipped or closed. |
| id | string | **DEPRECATED** as of v.1.5.0, no longer used or required. |
-| locale | string | Locale for ad localization. This may be any,ISO 639-1 (two-letter) or ISO 639-2,(three-letter) code(4). Defaults to 'en'. |
+| locale | string | Locale for ad localization. The supported locale codes can be found in [Localizing for Language and Locale](//developers.google.com/interactive-media-ads/docs/sdks/html5/localization)|
| nonLinearWidth | number | Desired width of non-linear ads. Defaults to player width. |
| nonLinearHeight | number | Desired height for non-linear ads. Defaults to 1/3 player height. |
| numRedirects | number | Maximum number of VAST redirects before the subsequent redirects will be denied,,and the ad load aborted. The number of redirects directly affects latency and thus user experience.,This applies to all VAST wrapper ads. |
@@ -115,7 +172,7 @@ the previous snippet. A summary of all settings follows: