Update AdImmunityConfig documentation

bitmovin · Sep 27, 2024 · fa36802 · fa36802
1 parent 6811871
commit fa36802
Showing 1 changed file with 8 additions and 6 deletions.
diff --git 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;
 
  /**