Nagra OTV Analytics Javascript Agent

Global

Type Definitions

agentErrorCallback(error)

Name Type Description
error object

The error object

OtvAnalyticsAgentConfigObject

Properties:
Name Type Description
onError agentErrorCallback

The error callback function

destinations Array.<UAVDestinationConfig>

An array of destination configurations

Note: An empty array will disable UAV reporting.

deviceId string

The unique identifier for the device

accountId string

The account ID for the analytics account

userId string

The unique identifier for the user

appVersion string

The version of the application

OtvAnalyticsWrapperConfigObject

Properties:
Name Type Argument Default Description
insightConfig OtvInsightWrapperConfig

Configuration for the Insight Wrapper. If not configured, Insight will be disabled and metrics and player errors will be reported via UAV Agent. If configured, Insight will take precedence over the UAV Agent for metrics and errors.

samplePeriod number <optional>
20

The period in seconds between sampling of player metrics

OtvInsightWrapperConfigObject

Properties:
Name Type Description
collectorURL string

The URL of the Insight Collector end-point

reportingInterval number

The period in seconds between reporting of player metrics

samplingInterval number

The period in seconds between sampling of player metrics

appName string

The name of the application

appVersion string

The version of the application

deviceType string

The type of device

operatorId string

The ID of the operator

deviceId string

The ID of the device

UAVDestinationAccessConfigObject

Properties:
Name Type Description
url string

The destination end-point URL

token string

The access token for the destination

UAVDestinationConfigObject

Properties:
Name Type Description
name string

The name of the destination

config UAVDestinationAccessConfig

Specific configuration for the destination