Class SubtitlesManager

Constructors

constructor

Methods

convertSRTToSubtitles destroy extractSubtitlesFromVideo getHighlightAnimation getHighlightTextStyle getMainTextStyle getTextMode init serialize setHighlightAnimation setHighlightedTextStyle setMainTextStyle setTextMode update updateSubtitlesClips deserialize

Constructors

constructor

Methods

convertSRTToSubtitles

destroy

extractSubtitlesFromVideo

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;
    }

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;
    }

getTextMode

init

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;
        };
        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;
        };
        textMode: "full"
        | "partial";
    }

setHighlightAnimation

setHighlightedTextStyle

  • setHighlightedTextStyle(
        style: {
            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: {
          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: {
            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: {
          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

setTextMode

update

updateSubtitlesClips

Staticdeserialize

Settings

Member Visibility

On This Page

Constructors
Methods