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.

ConvivaConfiguration (≥ 2.14.4)

The ConvivaConfiguration object provides the following properties:

Method Type Optional Description
integration ConvivaAnalyticsIntegrationID 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.