Constructor Detail

Method Detail

• setSource

   SourceDescription setSource(SourceDescription source)

  Handler which will be called when a new source is loaded into the player.

  This allows the integration to transform the source description, e.g. by calling an external service to replace the content URL, or by adding a fixed pre-roll linear ad to the list of ads.

  • If this handler throws an error, the player fires a fatal ErrorEvent (as if by calling ServerSideAdIntegrationController.fatalError).

• skipAd

   Unit skipAd(Ad ad)

  Handler which will be called when an ad is requested to be skipped.

  To skip the ad, the handler should call ServerSideAdIntegrationController.skipAd.

  • This is only called for ads whose integration matches ServerSideAdIntegrationController.integration.

  • If this handler is missing, the player will always skip the ad by calling ServerSideAdIntegrationController.skipAd.

  • If this handler throws an error, the player fires a non-fatal AdErrorEvent (as if by calling ServerSideAdIntegrationController.error).

• resetSource

   Unit resetSource()

  Handler which will be called before a new source is loaded into the player, or before the player is destroyed.

  This allows the integration to clean up any source-specific resources, such as scheduled ads or pending HTTP requests.

  • If this handler is missing, the player will remove all remaining ads by calling ServerSideAdIntegrationController.removeAllAds.

  • If this handler throws an error, the player fires a fatal ErrorEvent (as if by calling ServerSideAdIntegrationController.fatalError).

• destroy

   Unit destroy()

  Handler which will be called when the player is destroyed.

  This allows the integration to clean up any resources, such as UI views or event listeners.