doc: Update manifest documentation

canalplus · Aug 30, 2024 · b428f0e · b428f0e
1 parent c2bf43b
commit b428f0e
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 25 deletions.
diff --git a/src/manifest/classes/adaptation.ts b/src/manifest/classes/adaptation.ts
@@ -49,55 +49,55 @@ export default class Adaptation implements IAdaptationMetadata {
    */
   public manuallyAdded?: boolean;
   /**
-   * @see IRepresentationMetadata
+   * @see IAdaptationMetadata.representations
    */
   public readonly representations: Representation[];
   /**
-   * @see IRepresentationMetadata
+   * @see ITrackType
    */
   public readonly type: ITrackType;
   /**
-   * @see IRepresentationMetadata
+   * @see IAdaptationMetadata.isAudioDescription
    */
   public isAudioDescription?: boolean;
   /**
-   * @see IRepresentationMetadata
+   * @see IAdaptationMetadata.isClosedCaption
    */
   public isClosedCaption?: boolean;
   /**
-   * @see IRepresentationMetadata
+   * @see IAdaptationMetadata.isForcedSubtitles
    */
   public isForcedSubtitles?: boolean;
   /**
-   * @see IRepresentationMetadata
+   * @see IAdaptationMetadata.isSignInterpreted
    */
   public isSignInterpreted?: boolean;
   /**
-   * @see IRepresentationMetadata
+   * @see IAdaptationMetadata.isDub
    */
   public isDub?: boolean;
   /**
-   * @see IRepresentationMetadata
+   * @see IAdaptationMetadata.language
    */
   public language?: string;
   /**
-   * @see IRepresentationMetadata
+   * @see IAdaptationMetadata.normalizedLanguage
    */
   public normalizedLanguage?: string;
   /**
-   * @see IRepresentationMetadata
+   * @see IAdaptationSupportStatus
    */
   public supportStatus: IAdaptationSupportStatus;
   /**
-   * @see IRepresentationMetadata
+   * @see IAdaptationMetadata.isTrickModeTrack
    */
   public isTrickModeTrack?: boolean;
   /**
-   * @see IRepresentationMetadata
+   * @see IAdaptationMetadata.label
    */
   public label?: string;
   /**
-   * @see IRepresentationMetadata
+   * @see IAdaptationMetadata.trickModeTracks
    */
   public readonly trickModeTracks?: Adaptation[];
 

diff --git a/src/manifest/classes/representation.ts b/src/manifest/classes/representation.ts
@@ -37,15 +37,15 @@ class Representation implements IRepresentationMetadata {
   /** ID uniquely identifying the Representation in its parent Adaptation. */
   public readonly id: string;
   /**
-   * @see IRepresentationMetadata
+   * @see IRepresentationMetadata.uniqueId
    */
   public readonly uniqueId: string;
   /**
-   * @see IRepresentationMetadata
+   * @see IRepresentationMetadata.bitrate
    */
   public bitrate: number;
   /**
-   * @see IRepresentationMetadata
+   * @see IRepresentationMetadata.frameRate
    */
   public frameRate?: number;
   /**
@@ -65,39 +65,47 @@ class Representation implements IRepresentationMetadata {
    */
   public cdnMetadata: ICdnMetadata[] | null;
   /**
-   * @see IRepresentationMetadata
+   * @see IRepresentationMetadata.isSpatialAudio
    */
   public isSpatialAudio?: boolean | undefined;
   /**
-   * @see IRepresentationMetadata
+   * @see IRepresentationMetadata.codecs
    */
   public codecs: string[];
   /**
-   * @see IRepresentationMetadata
+   * @see IRepresentationMetadata.mimeType
    */
   public mimeType?: string;
   /**
-   * @see IRepresentationMetadata
+   * @see IRepresentationMetadata.width
    */
   public width?: number;
   /**
-   * @see IRepresentationMetadata
+   * @see IRepresentationMetadata.height
    */
   public height?: number;
   /**
-   * @see IRepresentationMetadata
+   * @see IRepresentationMetadata.contentProtections
    */
   public contentProtections?: IContentProtections;
   /**
-   * @see IRepresentationMetadata
+   * @see IRepresentationMetadata.hdrInfo
    */
   public hdrInfo?: IHDRInformation;
   /**
-   * @see IRepresentationMetadata
+   * @see IRepresentationMetadata.decipherable
+   *
+   * Note that this property should __NEVER__ be updated directly on an
+   * instanciated `Representation`, you are supposed to rely on
+   * `Manifest` methods for this.
    */
   public decipherable?: boolean | undefined;
   /**
-   * @see IRepresentationMetadata
+   * @see IRepresentationMetadata.isSupported
+   *
+   * Note that this property should __NEVER__ be updated directly on an
+   * instanciated `Representation`, you are supposed to rely on
+   * `Manifest` methods for this.
    */
   public isSupported: boolean | undefined;
   /**