Constructor Detail

• Builder

  public Builder(String customerKey,
                 ConvivaContentMetadata contentMetadata)

  Creates a builder for the Conviva configuration.

  Parameters:

  customerKey - The customer key. (NonNull)

  contentMetadata - The ConvivaContentMetadata which will be sent to Conviva. (NonNull)

Method Detail

• heartbeatInterval

  public ConvivaConfiguration.Builder heartbeatInterval(int heartbeatInterval)

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

  Parameters:

  heartbeatInterval - The heartbeat interval, in seconds.

• gatewayUrl

  public ConvivaConfiguration.Builder gatewayUrl(String gatewayUrl)

  Sets the URL of your Conviva gateway.

  Parameters:

  gatewayUrl - The gateway url. (NonNull)

• manualSessionControl

  public ConvivaConfiguration.Builder manualSessionControl(boolean manualSessionControl)

  Sets whether THEOplayer is in control of the Conviva session.

  Parameters:

  manualSessionControl - Whether THEOplayer is in control.

  Remarks:

       - 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 Value:

  False, THEOplayer is in control of the Conviva session.

• build

  public ConvivaConfiguration build()

  Builds the Conviva configuration.