Interface ServerSideAdIntegrationController

A controller to be used by your ServerSideAdIntegrationHandler to update the state of your custom server-side ad integration.

See

Ads.registerServerSideIntegration

interface ServerSideAdIntegrationController {
    adBreaks: readonly AdBreak[];
    ads: readonly Ad[];
    content: ReadonlyContentPlayer;
    integration: CustomAdIntegrationKind;
    beginAd(ad: Ad): void;
    createAd(init: AdInit, adBreak?: AdBreak): Ad;
    createAdBreak(init: AdBreakInit): AdBreak;
    endAd(ad: Ad): void;
    endAdBreak(adBreak: AdBreak): void;
    error(error: Error): void;
    fatalError(error: Error, code?: ErrorCode): void;
    removeAd(ad: Ad): void;
    removeAdBreak(adBreak: AdBreak): void;
    removeAllAds(): void;
    skipAd(ad: Ad): void;
    updateAd(ad: Ad, init: Partial<AdInit>): void;
    updateAdBreak(adBreak: AdBreak, init: Partial<AdBreakInit>): void;
    updateAdProgress(ad: Ad, progress: number): void;
}

Hierarchy (View Summary)

CustomAdIntegrationController
- ServerSideAdIntegrationController

Index

Properties

`Readonly`adBreaks

adBreaks: readonly AdBreak[]

The scheduled ad breaks managed by this integration.

Remarks

Use createAdBreak and removeAdBreak to add or remove ad breaks.

`Readonly`ads

ads: readonly Ad[]

The scheduled ads managed by this integration.

Remarks

Use createAd and removeAd to add or remove ads.

`Readonly`content

content: ReadonlyContentPlayer

The playback state of the content.

Use this instead of ChromelessPlayer.currentTime and friends to decide when to load or play ads, so your integration never observes the playback state of a linear ad from another integration.

`Readonly`integration

integration: CustomAdIntegrationKind

The identifier for this integration, as it was passed to Ads.registerServerSideIntegration or Ads.registerClientSideIntegration.

Methods

beginAd

beginAd(ad: Ad): void
Begin the given ad.
Parameters
- ad: Ad
Returns void
Remarks
- The ad will be added to Ads.currentAds.
- An AdsEventMap.adbegin event will be fired.
Inherited from CustomAdIntegrationController.beginAd

createAd

createAd(init: AdInit, adBreak?: AdBreak): Ad
Create a new ad.
Parameters
- init: AdInit
  The initial properties to be set on the created ad.
- OptionaladBreak: AdBreak
  If given, appends the ad to the given existing AdBreak. Otherwise, appends the ad to a new or existing AdBreak with the configured AdInit.timeOffset.
Returns Ad
Remarks
- The ad will be added to Ads.scheduledAds.
Inherited from CustomAdIntegrationController.createAd

createAdBreak

createAdBreak(init: AdBreakInit): AdBreak
Create a new ad break.

This can be used to indicate where ad breaks can be expected in advance, before populating those ad breaks with ads.
Parameters
- init: AdBreakInit
  The initial properties to be set on the created ad break.
Returns AdBreak
Remarks
- The ad break will be added to adBreaks and Ads.scheduledAdBreaks.
Throws
Error If there is already an existing ad break with the given AdBreakInit.timeOffset.
Inherited from CustomAdIntegrationController.createAdBreak

endAd

endAd(ad: Ad): void
End the given ad.
Parameters
- ad: Ad
Returns void
Remarks
- The ad will be removed from Ads.currentAds.
- If the ad was currently playing, an AdsEventMap.adend event will be fired.
Inherited from CustomAdIntegrationController.endAd

endAdBreak

endAdBreak(adBreak: AdBreak): void
End the given ad break.

An ad break begins implicitly when the first of its ads is begun.
Parameters
- adBreak: AdBreak
  The ad break to be ended.
Returns void
Remarks
- Any of its ads that are still playing will first be ended.
- An AdsEventMap.adbreakend event and an AdsEventMap.adbreakchange event will be fired.
- The ad break stays in adBreaks, but is removed from Ads.scheduledAdBreaks. Its ads that were not begun stay in Ads.scheduledAds.
- To remove the ad break, call removeAdBreak afterwards. This does not end the ad break again.
- If one of its remaining ads is begun later, the ad break begins again and is added back to Ads.scheduledAdBreaks.
- If the ad break is not currently playing, this does nothing.
Inherited from CustomAdIntegrationController.endAdBreak

error

error(error: Error): void
Fire an aderror event on the player.

This does not stop playback.
Parameters
- error: Error
  The error.
Returns void

Inherited from CustomAdIntegrationController.error

fatalError

fatalError(error: Error, code?: ErrorCode): void
Fire a fatal error event on the player.

This stops playback immediately. Use ChromelessPlayer.source to load a new source.
Parameters
- error: Error
  The error.
- Optionalcode: ErrorCode
  The error code. By default, this is set to ErrorCode.AD_ERROR.
Returns void

Inherited from CustomAdIntegrationController.fatalError

removeAd

removeAd(ad: Ad): void
Remove the given ad.
Parameters
- ad: Ad
Returns void
Remarks
- The ad will be removed from Ads.currentAds and Ads.scheduledAds.
- If the ad was currently playing, it will first be ended.
Inherited from CustomAdIntegrationController.removeAd

removeAdBreak

removeAdBreak(adBreak: AdBreak): void
Remove the given ad break and all of its ads.
Parameters
- adBreak: AdBreak
  The ad break to be removed.
Returns void
Remarks
- The ad break will be removed from adBreaks and Ads.scheduledAdBreaks.
- Any remaining ads in the ad break will be removed.
Inherited from CustomAdIntegrationController.removeAdBreak

removeAllAds

removeAllAds(): void
Remove all ads and ad breaks.

Returns void
Remarks
- This is a shorthand for calling removeAdBreak on all ad breaks in adBreaks.
Inherited from CustomAdIntegrationController.removeAllAds

skipAd

skipAd(ad: Ad): void
Skip the given ad.
Parameters
- ad: Ad
Returns void
Remarks
- The ad will be removed from Ads.currentAds.
- If the ad was currently playing, an AdsEventMap.adskip event will be fired.
Inherited from CustomAdIntegrationController.skipAd

updateAd

updateAd(ad: Ad, init: Partial<AdInit>): void
Update the given ad.
Parameters
- ad: Ad
  The ad to be updated.
- init: Partial<AdInit>
  The properties to be updated on the ad.
Returns void

Inherited from CustomAdIntegrationController.updateAd

updateAdBreak

updateAdBreak(adBreak: AdBreak, init: Partial<AdBreakInit>): void
Update the given ad break.
Parameters
- adBreak: AdBreak
  The ad break to be updated.
- init: Partial<AdBreakInit>
  The properties to be updated on the ad break.
Returns void

Inherited from CustomAdIntegrationController.updateAdBreak

updateAdProgress

updateAdProgress(ad: Ad, progress: number): void
Update the playback progression of the given ad.
Parameters
- ad: Ad
  The ad to be updated.
- progress: number
  The playback progress, as a number between 0 (at the start of the ad) and 1 (at the end of the ad).
Returns void
Remarks
- The player will fire progression events such as AdsEventMap.adfirstquartile, AdsEventMap.admidpoint and AdsEventMap.adthirdquartile.
Throws
Error If the ad is not started.
Inherited from CustomAdIntegrationController.updateAdProgress

Interface ServerSideAdIntegrationController

See

Hierarchy (View Summary)

Index

Properties

Methods

Properties

ReadonlyadBreaks

Remarks

Readonlyads

Remarks

Readonlycontent

Readonlyintegration

Methods

beginAd

Parameters

Returns void

Remarks

createAd

Parameters

Returns Ad

Remarks

createAdBreak

Parameters

Returns AdBreak

Remarks

Throws

endAd

Parameters

Returns void

Remarks

endAdBreak

Parameters

Returns void

Remarks

error

Parameters

Returns void

fatalError

Parameters

Returns void

removeAd

Parameters

Returns void

Remarks

removeAdBreak

Parameters

Returns void

Remarks

removeAllAds

Returns void

Remarks

skipAd

Parameters

Returns void

Remarks

updateAd

Parameters

Returns void

updateAdBreak

Parameters

Returns void

updateAdProgress

Parameters

Returns void

Remarks

Throws

Settings

On This Page

`Readonly`adBreaks

`Readonly`ads

`Readonly`content

`Readonly`integration