From fa36802e6d7b45f4b6bd7d0ac0db6023e9b2c17c Mon Sep 17 00:00:00 2001 From: Daniel Weinberger Date: Fri, 27 Sep 2024 09:10:25 +0200 Subject: [PATCH] Update AdImmunityConfig documentation --- src/ts/BitmovinYospacePlayerAPI.ts | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/ts/BitmovinYospacePlayerAPI.ts b/src/ts/BitmovinYospacePlayerAPI.ts index 858fd4d..cff344b 100644 --- a/src/ts/BitmovinYospacePlayerAPI.ts +++ b/src/ts/BitmovinYospacePlayerAPI.ts @@ -266,14 +266,16 @@ export interface AdImmunityEndedEvent extends YospaceEventBase { type: YospacePlayerEvent.AdImmunityEnded; } -/** - * @description Ad Immunity Configuration Object - * @property duration - a number indicating the duration of the ad immunity period. 0 disables the feature. - * @property adBreakCheckOffset - a number indicating how far ahead ad immunity should look for ad breaks - * to skip past, in order to mitigate ad frames being displayed before they have time to be seeked past. - */ export interface AdImmunityConfig { + /** + * A number indicating the duration in seconds of the ad immunity period. 0 disables the feature. + */ duration: number; + + /** + * A number indicating how far ahead ad immunity should look for ad breaks to skip past, in order to mitigate ad + * frames being displayed before they have time to be seeked past. + */ adBreakCheckOffset?: number; /**