Constructor Detail

• ConvivaConfiguration.Builder

  ConvivaConfiguration.Builder(String customerKey, ConvivaContentMetadata contentMetadata)

  Creates a builder for the Conviva configuration.

  Parameters:

  customerKey - The customer key.

  contentMetadata - The ConvivaContentMetadata which will be sent to Conviva.

Method Detail

• heartbeatInterval

  @NonNull() ConvivaConfiguration.Builder heartbeatInterval(int heartbeatInterval)

  Sets the interval at which metrics are reported, in seconds.

  Parameters:

  heartbeatInterval - The heartbeat interval, in seconds.

• gatewayUrl

  @NonNull() ConvivaConfiguration.Builder gatewayUrl(@NonNull() String gatewayUrl)

  Sets the URL of your Conviva gateway.

  Parameters:

  gatewayUrl - The gateway url.

• manualSessionControl

  @NonNull() ConvivaConfiguration.Builder manualSessionControl(boolean manualSessionControl)

  Sets whether THEOplayer is in control of the Conviva session.

  • When the property returns 'false', the player will automatically create a Conviva session when playback is started and cleanup the session when playback reaches the end of the content.
  • When the property returns 'true', the player will not perform automatic session creation and cleanup.

  Default: false, THEOplayer is in control of the Conviva session.

  Parameters:

  manualSessionControl - Whether THEOplayer is in control.

• build

  @NonNull() ConvivaConfiguration build()

  Builds the Conviva configuration.