InPlay JWPlayer Install Guide

Overview

The TubeMogul InPlay system consists of 3 main pieces that work together to collect information and transform the data into relevant analytics.

  • InPlay Collection Engine
  • Receiving Grid
  • Graphical Website Portal

The InPlay Collection Engine is designed to be inserted into any Flash Video Player and runs on the client computer as shown in Figure 1. The client code is transparently downloaded as part of the player when a viewer watches a video. It samples data and user interaction, forwarding data back to the Receiving Grid. The data is stored and analyzed in real time and made available through graphs and charts in the Graphical Website Portal.

Customers log into the Graphical Website Portal to view and analyze their data. The Graphical Website Portal interfaces to the backend analytics data stored in the database tier. The customer can analyze and slice his data in easy to understand charts, graphs and funnels. The Graphical Website Portal displays the analytics information in a form that can allow our customer to easily understand how well their business is using video content.

Installation

Player Activation

This installation guide walks through the steps of activating the InPlay client into LongTail Video's JWPlayer. JWPlayer's API provides the ability to use InPlay as a plugin to the player. The InPlay collection is activated by passing in the InPlay SWF file as a plugin to the JWPlayer. There are multiple ways to pass a plugin into JWPlayer, they are covered in the Examples section.

JWPlayer InPlay Plugin
Parameter Description
playerID Player ID

The identifier provided by TubeMogul for this video player. This will be used in the analytics system and uniquely identifies a player.
trackerIDs Tracker IDs

An optional comma-separated list of strings of Tracker IDs obtained from TubeMogul. These can be used to form independent data collection groups, for roll-up in the analytics system along different lines. For example, by CDN provider, website, etc. If no TrackerIDs are supplied, data will only be collected in the default, global tracking context for your account. Tracker IDs provided here are used for all videos viewed in this player.
publisherID

Publisher ID

The value you have assigned internally to the producer of this video. Note that this field is required in order to provide publisher-level statistics via the TubeMogul user interface or APIs.

NOTE: This value is treated as a key for both the video and any associated publisher-level statistics. If it is changed for a given video, a new video and set of publisher statistics will be created! Also, if this value is not provided the 'author' provided to the video or playlist element of the JWPlayer configuration will be used!
videoID

Video ID

The value you have assigned internally to this video. Note that this field is required in order to provide video-level statistics via the TubeMogul user interface or APIs.

NOTE: This value is treated as a key for the video. If it is changed for a given video, a new video will be created!
displayName

Display Name

An alternate name for display in the InPlay web interface. NOTE: If this is not provided, the 'title' provided to the video or playlist element of the JWPlayer configuration will be used.
See the Alternate Display Name section.

Example Player

<OBJECT classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" codebase="http://macromedia.com/cabs/swflash.cab#version=6,0,0,0" ID=flaMovie WIDTH=600 HEIGHT=400>
<EMBED src="http://www.tubemogul.com/static/inplay/docs/examples/jwplayer.swf"
  FlashVars="
    file=http://www.tubemogul.com/static/inplay/docs/examples/86928000.flv
    &dock=true
    &plugins=inplay
    &inplay.playerID=P-8KA-P6Q
    &inplay.trackerIDs=TR-6ON-PWV
    &inplay.publisherID=exampleJWPlayer
    &inplay.videoID=exampleJWPlayerVideo
    &inplay.displayName=exampleJWPlayerDisplayName"
    WIDTH=600 HEIGHT=400
  TYPE="application/x-shockwave-flash">
</EMBED>
</OBJECT>

Test Page Generator

Below you may generate your own test page by supplying the required fields. Note that you must have a valid swfobject.js file if you use a SWFObject embed code!

Embed Type:
Player Location(required):
Video File(required):
Player ID(required):
Tracker IDs(optional):
Publisher ID(optional):
Video ID(optional):
Display Name(optional):

Flashvars

A specific list of flashvars for both LongtailVideo's JWPlayer and the InPlay plugin that can be passed into the player.

JWPlayer Flashvars

All of Longtailvideo's JWPlayer flashvars can be found at the following location:

http://developer.longtailvideo.com/trac/wiki/Player5FlashVars

XML Parameters

Parameters for the InPlay plugin can also be passed in via JWPlayer's XML API. For more details you can visit LongtailVideo's developer page here:

http://developer.longtailvideo.com/trac/wiki/Player5XMLDescriptor

Playlists

The TubeMogul plugin also fully supports playlists. Whenever the player finds the next element in the playlist, InPlay will automatically delete the previous stream and create a new stream using the attributes of the next playlist element. Note that certain fields will be overwritten by TubeMogulLongtail variables shown in the list above. If you plan to supply all of the playlists attributes it is best to only provide a playerID and trackerID.