Class SubtitlesManager

Constructors

constructor

Methods

convertSRTToSubtitles destroy extractSubtitlesFromVideo getDisplayContainer getHighlightAnimation getHighlightTextStyle getMainTextContainer getMainTextStyle getPosition getScale getTextMode hitTest init onViewResize serialize setHighlightAnimation setHighlightedTextStyle setMainTextStyle setPosition setScale setTextMode update updateSubtitlesClips deserialize

Constructors

constructor

Methods

convertSRTToSubtitles

destroy

extractSubtitlesFromVideo

getDisplayContainer

getHighlightAnimation

getHighlightTextStyle

  • getHighlightTextStyle(): {
        backgroundColor: string;
        backgroundCornerRadius: number;
        backgroundPadding: number;
        color: string;
        fontFamily: string;
        fontSize: number;
        fontStyle: "normal"
        | "italic"
        | "oblique";
        fontWeight:
            | "bold"
            | "normal"
            | "bolder"
            | "lighter"
            | "100"
            | "200"
            | "300"
            | "400"
            | "500"
            | "600"
            | "700"
            | "800"
            | "900";
        padding: number;
        strokeColor: string;
        strokeThickness: number;
    }

  • Returns {
        backgroundColor: string;
        backgroundCornerRadius: number;
        backgroundPadding: number;
        color: string;
        fontFamily: string;
        fontSize: number;
        fontStyle: "normal" | "italic" | "oblique";
        fontWeight:
            | "bold"
            | "normal"
            | "bolder"
            | "lighter"
            | "100"
            | "200"
            | "300"
            | "400"
            | "500"
            | "600"
            | "700"
            | "800"
            | "900";
        padding: number;
        strokeColor: string;
        strokeThickness: number;
    }

getMainTextContainer

getMainTextStyle

  • getMainTextStyle(): {
        backgroundColor: string;
        backgroundCornerRadius: number;
        backgroundPadding: number;
        color: string;
        fontFamily: string;
        fontSize: number;
        fontStyle: "normal"
        | "italic"
        | "oblique";
        fontWeight:
            | "bold"
            | "normal"
            | "bolder"
            | "lighter"
            | "100"
            | "200"
            | "300"
            | "400"
            | "500"
            | "600"
            | "700"
            | "800"
            | "900";
        leading: number;
        padding: number;
        strokeColor: string;
        strokeThickness: number;
        wordWrap: boolean;
        wordWrapWidth: number;
    }

  • Returns {
        backgroundColor: string;
        backgroundCornerRadius: number;
        backgroundPadding: number;
        color: string;
        fontFamily: string;
        fontSize: number;
        fontStyle: "normal" | "italic" | "oblique";
        fontWeight:
            | "bold"
            | "normal"
            | "bolder"
            | "lighter"
            | "100"
            | "200"
            | "300"
            | "400"
            | "500"
            | "600"
            | "700"
            | "800"
            | "900";
        leading: number;
        padding: number;
        strokeColor: string;
        strokeThickness: number;
        wordWrap: boolean;
        wordWrapWidth: number;
    }

getPosition

getScale

getTextMode

hitTest

init

onViewResize

  • onViewResize(
        oldWidth: number,
        oldHeight: number,
        newWidth: number,
        newHeight: number,
    ): void

  • Parameters

    • oldWidth: number
    • oldHeight: number
    • newWidth: number
    • newHeight: number

    Returns void

serialize

  • serialize(): {
        highlightAnimation: HighlightAnimationEnum;
        highlightAnimationSpeed: number;
        highlightTextStyle: {
            backgroundColor: string;
            backgroundCornerRadius: number;
            backgroundPadding: number;
            color: string;
            fontFamily: string;
            fontSize: number;
            fontStyle: "normal"
            | "italic"
            | "oblique";
            fontWeight:
                | "bold"
                | "normal"
                | "bolder"
                | "lighter"
                | "100"
                | "200"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "800"
                | "900";
            padding: number;
            strokeColor: string;
            strokeThickness: number;
        };
        mainTextStyle: {
            backgroundColor: string;
            backgroundCornerRadius: number;
            backgroundPadding: number;
            color: string;
            fontFamily: string;
            fontSize: number;
            fontStyle: "normal"
            | "italic"
            | "oblique";
            fontWeight:
                | "bold"
                | "normal"
                | "bolder"
                | "lighter"
                | "100"
                | "200"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "800"
                | "900";
            leading: number;
            padding: number;
            strokeColor: string;
            strokeThickness: number;
            wordWrap: boolean;
            wordWrapWidth: number;
        };
        position?: [number, number];
        scale: number;
        textMode: "full" | "partial";
    }

  • Returns {
        highlightAnimation: HighlightAnimationEnum;
        highlightAnimationSpeed: number;
        highlightTextStyle: {
            backgroundColor: string;
            backgroundCornerRadius: number;
            backgroundPadding: number;
            color: string;
            fontFamily: string;
            fontSize: number;
            fontStyle: "normal" | "italic" | "oblique";
            fontWeight:
                | "bold"
                | "normal"
                | "bolder"
                | "lighter"
                | "100"
                | "200"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "800"
                | "900";
            padding: number;
            strokeColor: string;
            strokeThickness: number;
        };
        mainTextStyle: {
            backgroundColor: string;
            backgroundCornerRadius: number;
            backgroundPadding: number;
            color: string;
            fontFamily: string;
            fontSize: number;
            fontStyle: "normal"
            | "italic"
            | "oblique";
            fontWeight:
                | "bold"
                | "normal"
                | "bolder"
                | "lighter"
                | "100"
                | "200"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "800"
                | "900";
            leading: number;
            padding: number;
            strokeColor: string;
            strokeThickness: number;
            wordWrap: boolean;
            wordWrapWidth: number;
        };
        position?: [number, number];
        scale: number;
        textMode: "full" | "partial";
    }

setHighlightAnimation

setHighlightedTextStyle

  • setHighlightedTextStyle(
        style: Partial<
            {
                backgroundColor: string;
                backgroundCornerRadius: number;
                backgroundPadding: number;
                color: string;
                fontFamily: string;
                fontSize: number;
                fontStyle: "normal"
                | "italic"
                | "oblique";
                fontWeight:
                    | "bold"
                    | "normal"
                    | "bolder"
                    | "lighter"
                    | "100"
                    | "200"
                    | "300"
                    | "400"
                    | "500"
                    | "600"
                    | "700"
                    | "800"
                    | "900";
                padding: number;
                strokeColor: string;
                strokeThickness: number;
            },
        >,
        reset?: boolean,
    ): void

  • Parameters

    • style: Partial<
          {
              backgroundColor: string;
              backgroundCornerRadius: number;
              backgroundPadding: number;
              color: string;
              fontFamily: string;
              fontSize: number;
              fontStyle: "normal"
              | "italic"
              | "oblique";
              fontWeight:
                  | "bold"
                  | "normal"
                  | "bolder"
                  | "lighter"
                  | "100"
                  | "200"
                  | "300"
                  | "400"
                  | "500"
                  | "600"
                  | "700"
                  | "800"
                  | "900";
              padding: number;
              strokeColor: string;
              strokeThickness: number;
          },
      >
    • reset: boolean = false

    Returns void

setMainTextStyle

  • setMainTextStyle(
        style: Partial<
            {
                backgroundColor: string;
                backgroundCornerRadius: number;
                backgroundPadding: number;
                color: string;
                fontFamily: string;
                fontSize: number;
                fontStyle: "normal"
                | "italic"
                | "oblique";
                fontWeight:
                    | "bold"
                    | "normal"
                    | "bolder"
                    | "lighter"
                    | "100"
                    | "200"
                    | "300"
                    | "400"
                    | "500"
                    | "600"
                    | "700"
                    | "800"
                    | "900";
                leading: number;
                padding: number;
                strokeColor: string;
                strokeThickness: number;
                wordWrap: boolean;
                wordWrapWidth: number;
            },
        >,
        reset?: boolean,
    ): void

  • Parameters

    • style: Partial<
          {
              backgroundColor: string;
              backgroundCornerRadius: number;
              backgroundPadding: number;
              color: string;
              fontFamily: string;
              fontSize: number;
              fontStyle: "normal"
              | "italic"
              | "oblique";
              fontWeight:
                  | "bold"
                  | "normal"
                  | "bolder"
                  | "lighter"
                  | "100"
                  | "200"
                  | "300"
                  | "400"
                  | "500"
                  | "600"
                  | "700"
                  | "800"
                  | "900";
              leading: number;
              padding: number;
              strokeColor: string;
              strokeThickness: number;
              wordWrap: boolean;
              wordWrapWidth: number;
          },
      >
    • reset: boolean = false

    Returns void

setPosition

setScale

setTextMode

update

updateSubtitlesClips

Staticdeserialize

Settings

Member Visibility

On This Page

Constructors
Methods