The Analytics object helps you configure and control analytics pre-integrations within THEOplayer. We currently support the following pre-integrations:

AnalyticsDescription

Property Type Optional Description
integration AnalyticsIntegrationID yes The integration property is used to identify a pre-integration.

The AnalyticsDescription object can be of type ConvivaConfiguration, YouboraOptions, MoatConfiguration, SmartSightConfiguration, StreamOneConfiguration.

ConvivaConfiguration (≥ 2.14.4)

Make sure you load the Conviva library before you initialise a player with Conviva in it.

This library is provided by Conviva.

The ConvivaConfiguration object provides the following properties:

Method Type Optional Description
integration string no Set this property to 'conviva'.
customerKey string no Set this property to your Conviva customer key.
gatewayUrl string no Set this property to your Conviva gateway URL.
heartbeatInterval number  yes Use this property to set the Conviva heartbeat interval in seconds.
contentMetadata ConvivaContentMetadata no Specifies the Conviva metadata.


ConvivaContentMetadata

 

The ConvivaContentMetadataobject provides the following properties:

Method Type Optional Description
assetName string no Set this property to the name of the asset to pass to Conviva.
live boolean no Set this value to true if you are tracking a live stream, or set it to false if you are tracking a VoD.
defaultBitrateKbps string yes Use this property to set a default Bitrate in kbps.
defaultResource string yes Use this property to set a default resource to be logged to Conviva.
duration number yes Use this property to set the duration of the asset to be logged to Conviva.
encodedFrameRate number yes Use this property to set the encoded frame rate.
applicationName string yes Use this property to change the application name logged to Conviva.
viewerId string yes Use this property to set a custom viewer ID over a randomly generated one.
custom object yes Use this property to set custom Conviva tags.

 

YouboraOptions (≥ 2.21.2)

The YouboraOptions object is a dictionary of YOUBORA options. The THEOplayer YOUBORA integration is built upon YOUBORA v6.

The summary below is just an overview of some of the available options. For a detailed overview, please consult the YOUBORA options documentation page:

http://developer.nicepeopleatwork.com/plugins/general/setting-youbora-options/

Make sure to load the YOUBORA library with the THEOplayer adapter before initializing the player with YouboraOptions:

http://developer.nicepeopleatwork.com/plugins/integration/js-browser/theo-player-2-v6/

Note: the integration automatically tracks these content related properties:

  • content.resource
  • content.rendition

 

Method Type Optional Description
integration string no Set this property to 'youbora'.
accountCode string yes Your NicePeopleAtWork account code indicates to YOUBORA Analytics the customer account to which the data is sent. This will be provided by NicePeopleAtWork, if one has not yet been received, please request it from your Customer Engineer or Support Agent.
enableAnalytics boolean yes This parameter indicates whether YOUBORA Analytics is enabled or not.
username number  yes The User ID value associated with your system. Leave it blank if its use is not desired. This will help you to easily identify your users within YOUBORA Analytics.
content.duration number yes/no Set this property to the duration of your content video. This value is optional for livestreams.
content.title string yes Media title: You must set this parameter so as to be able to make searches and filter real time data.
content.isLive boolean yes Set this property to true if you are configuring a livestream. If left empty, Youbora will think that your asset is a VoD.

 

MoatConfiguration (≥ 2.16.7)

The MoatConfiguration object provides the following properties:

Method Type Optional Description
integration string no Set this property to 'moat'.
partnerCode string no Set this property to your Moat partner code.

 

SmartSightConfiguration (≥ 2.33.2)

The SmartSight object provides the following properties:

Method Type Optional Description
integration string no Set this property to 'smartsight'.
customerID string no Set this property to your customer ID.
subscriberID string yes Set this property to your subscriber ID.
domainName string yes Set this property to your domain.
playerName string yes Set this property to your the name of your player. Default is 'THEOplayer'

 

StreamOneConfiguration (≥ 2.32.0)

The StreamOneConfiguration object provides the following properties:

Method Type Optional Description
accountID string no Set this property to your StreamOne Account ID.
itemID string no Set this property to the StreamOne ID of this content item.
itemTitle string no Set this property to the StreamOne title of this content item.

 

Analytics facade (≥ 2.31.2)

Exposes information about the used analytics system on the player facade. The Analytics object provides the following properties:

Object Type Optional
conviva string yes

Conviva facade (≥ 2.31.2)

Information about the Conviva integration. This is currently only supported for Conviva.
Make sure you load the Conviva library before you initialise a player with Conviva in it.

The Conviva  object provides the following properties:

Object Type Optional
client

object The conviva client. For more details about this object, consult the conviva documentation.
contentSessionKey number The conviva content session key. For more details about this value, consult the conviva documentation.