libpgs/dist/pgs/displaySet.d.ts

Renderer for graphical subtitles (PGS) in the browser.

import { BigEndianBinaryReader } from "../utils/bigEndianBinaryReader";
import { PresentationCompositionSegment } from "./presentationCompositionSegment";
import { PaletteDefinitionSegment } from "./paletteDefinitionSegment";
import { ObjectDefinitionSegment } from "./objectDefinitionSegment";
import { WindowDefinitionSegment } from "./windowDefinitionSegment";
/**
 * The PGS display set holds all data for the current subtitle update at a given timestamp.
 */
export declare class DisplaySet {
    presentationTimestamp: number;
    decodingTimestamp: number;
    presentationComposition?: PresentationCompositionSegment;
    paletteDefinitions: PaletteDefinitionSegment[];
    objectDefinitions: ObjectDefinitionSegment[];
    windowDefinitions: WindowDefinitionSegment[];
    /**
     * Reads a display set from the given binary reader. The current data is cleared.
     * @param reader The binary reader to read from.
     * @param includeHeader If true, the magic-number and timestamps are read. If false, reading starts at the first
     * segment.
     */
    read(reader: BigEndianBinaryReader, includeHeader: boolean): Promise<void>;
}