Class HtmlTextClip

Hierarchy (View Summary)

Constructors

constructor

Properties

animationController fonts htmlSprite htmlText id sprite state style

Methods

addClipMask addEffect addFilter clearAllCustomData clone destroy generateNewId getAllCustomData getCustomData getDuration getEffectById getEffects getEndTime getFilterById getFilters getHasTransition getHtmlStyle getHtmlText getId getIsProcessing getLeftBound getLeftTrim getMasks getMediaId getRightBound getRightTrim getStartTime getSubtitlesId getSubtitlesOffset getTrimmedDuration getType getVisible hasCustomData hasSprite init isActive isReady loadFonts moveBy offload onPause onPlay onRenderDone onRenderStart onResize preload removeClipMask removeEffect removeFilter removeSubtitles render resetAllAnimationProperties serialize setAllCustomData setCustomData setHasTransition setHtmlStyle setHtmlText setLeftTrim setRightTrim setStartTime setSubtitles setSubtitlesId setSubtitlesOffset setVisible update updateMediaData updateVisibility deserialize

Constructors

constructor

Properties

ReadonlyanimationController

animationController: (Anonymous class)<Sprite, ClipStyle<Sprite>>

fonts

fonts: undefined | string[]

htmlSprite

htmlSprite: HTMLText

htmlText

htmlText: string

id

id: string

sprite

sprite: Sprite

state

state: ClipState

style

style: ClipStyle<Sprite>

Methods

addClipMask

addEffect

addFilter

clearAllCustomData

clone

destroy

generateNewId

getAllCustomData

getCustomData

getDuration

getEffectById

getEffects

getEndTime

getFilterById

getFilters

getHasTransition

getHtmlStyle

  • getHtmlStyle(): {
        align: "left"
        | "center"
        | "right"
        | "justify";
        breakWords: boolean;
        color: string;
        dropShadow: boolean;
        dropShadowAlpha: number;
        dropShadowAngle: number;
        dropShadowBlur: number;
        dropShadowColor: string;
        dropShadowDistance: number;
        fontFamily: string;
        fontSize: number;
        fontStyle: "normal" | "italic" | "oblique";
        fontVariant: "normal" | "small-caps";
        fontWeight:
            | "bold"
            | "normal"
            | "bolder"
            | "lighter"
            | "100"
            | "200"
            | "300"
            | "400"
            | "500"
            | "600"
            | "700"
            | "800"
            | "900";
        letterSpacing: number;
        lineHeight: number;
        padding: number;
        stroke: string;
        strokeThickness: number;
        whiteSpace: "pre"
        | "normal"
        | "pre-line";
        wordWrap: boolean;
        wordWrapWidth: number;
    }

  • Returns {
        align: "left" | "center" | "right" | "justify";
        breakWords: boolean;
        color: string;
        dropShadow: boolean;
        dropShadowAlpha: number;
        dropShadowAngle: number;
        dropShadowBlur: number;
        dropShadowColor: string;
        dropShadowDistance: number;
        fontFamily: string;
        fontSize: number;
        fontStyle: "normal" | "italic" | "oblique";
        fontVariant: "normal" | "small-caps";
        fontWeight:
            | "bold"
            | "normal"
            | "bolder"
            | "lighter"
            | "100"
            | "200"
            | "300"
            | "400"
            | "500"
            | "600"
            | "700"
            | "800"
            | "900";
        letterSpacing: number;
        lineHeight: number;
        padding: number;
        stroke: string;
        strokeThickness: number;
        whiteSpace: "pre"
        | "normal"
        | "pre-line";
        wordWrap: boolean;
        wordWrapWidth: number;
    }

getHtmlText

getId

getIsProcessing

getLeftBound

getLeftTrim

getMasks

getMediaId

getRightBound

getRightTrim

getStartTime

getSubtitlesId

getSubtitlesOffset

getTrimmedDuration

getType

getVisible

hasCustomData

hasSprite

init

isActive

isReady

loadFonts

moveBy

offload

onPause

onPlay

onRenderDone

onRenderStart

onResize

preload

removeClipMask

removeEffect

removeFilter

removeSubtitles

render

resetAllAnimationProperties

serialize

  • serialize(): {
        animationController?: {
            animationDataIn?: {
                amplification?: number;
                inOutOfRange: OutOfRangeEnum;
                name: string;
                offset?: number;
                outOutOfRange: OutOfRangeEnum;
                propertyAnimations: {
                    inOutOfRange: OutOfRangeEnum;
                    keyframes: {
                        easing: EasingEnum;
                        relativeProperty?: string;
                        space: AnimationSpaceEnum;
                        time: number;
                        value: string
                        | number;
                    }[];
                    outOutOfRange: OutOfRangeEnum;
                    property: string;
                }[];
                speed?: number;
            };
            animationDataLoop?: {
                amplification?: number;
                inOutOfRange: OutOfRangeEnum;
                name: string;
                offset?: number;
                outOutOfRange: OutOfRangeEnum;
                propertyAnimations: {
                    inOutOfRange: OutOfRangeEnum;
                    keyframes: {
                        easing: EasingEnum;
                        relativeProperty?: string;
                        space: AnimationSpaceEnum;
                        time: number;
                        value: string
                        | number;
                    }[];
                    outOutOfRange: OutOfRangeEnum;
                    property: string;
                }[];
                speed?: number;
            };
            animationDataOut?: {
                amplification?: number;
                inOutOfRange: OutOfRangeEnum;
                name: string;
                offset?: number;
                outOutOfRange: OutOfRangeEnum;
                propertyAnimations: {
                    inOutOfRange: OutOfRangeEnum;
                    keyframes: {
                        easing: EasingEnum;
                        relativeProperty?: string;
                        space: AnimationSpaceEnum;
                        time: number;
                        value: string
                        | number;
                    }[];
                    outOutOfRange: OutOfRangeEnum;
                    property: string;
                }[];
                speed?: number;
            };
            animationInDuration?: number;
            animationLoopCount?: number;
            animationOutDuration?: number;
            loopSmoothing?: number;
        };
        clipMasks?: { clipId: string; id: string; wrapMode: MaskWrapModeEnum }[];
        customData?: [string, unknown][];
        duration: number;
        effects: {
            id: string;
            options: {
                fragmentSrc?: string;
                frameHeight: number;
                frameWidth: number;
                textureHeight: number;
                textureWidth: number;
                uniforms?: Record<string, unknown>;
            };
            sourceId: string;
        }[];
        filters: { id: string; options: { lutUrl: string }; sourceId: string }[];
        fonts?: string[];
        htmlStyle: {
            align: "left" | "center" | "right" | "justify";
            breakWords: boolean;
            color: string;
            dropShadow: boolean;
            dropShadowAlpha: number;
            dropShadowAngle: number;
            dropShadowBlur: number;
            dropShadowColor: string;
            dropShadowDistance: number;
            fontFamily: string;
            fontSize: number;
            fontStyle: "normal" | "italic" | "oblique";
            fontVariant: "normal" | "small-caps";
            fontWeight:
                | "bold"
                | "normal"
                | "bolder"
                | "lighter"
                | "100"
                | "200"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "800"
                | "900";
            letterSpacing: number;
            lineHeight: number;
            padding: number;
            stroke: string;
            strokeThickness: number;
            whiteSpace: "pre"
            | "normal"
            | "pre-line";
            wordWrap: boolean;
            wordWrapWidth: number;
        };
        htmlText: string;
        id: string;
        isVisible: boolean;
        leftTrim: number;
        mediaDataId?: string;
        rightTrim: number;
        startTime: number;
        style?: unknown;
        subtitlesId?: string;
        subtitlesOffset: number;
        text?: string;
        type: string;
        wrapMode?: CLAMP
        | REPEAT
        | PING_PONG
        | EMPTY;
    }

  • Returns {
        animationController?: {
            animationDataIn?: {
                amplification?: number;
                inOutOfRange: OutOfRangeEnum;
                name: string;
                offset?: number;
                outOutOfRange: OutOfRangeEnum;
                propertyAnimations: {
                    inOutOfRange: OutOfRangeEnum;
                    keyframes: {
                        easing: EasingEnum;
                        relativeProperty?: string;
                        space: AnimationSpaceEnum;
                        time: number;
                        value: string | number;
                    }[];
                    outOutOfRange: OutOfRangeEnum;
                    property: string;
                }[];
                speed?: number;
            };
            animationDataLoop?: {
                amplification?: number;
                inOutOfRange: OutOfRangeEnum;
                name: string;
                offset?: number;
                outOutOfRange: OutOfRangeEnum;
                propertyAnimations: {
                    inOutOfRange: OutOfRangeEnum;
                    keyframes: {
                        easing: EasingEnum;
                        relativeProperty?: string;
                        space: AnimationSpaceEnum;
                        time: number;
                        value: string
                        | number;
                    }[];
                    outOutOfRange: OutOfRangeEnum;
                    property: string;
                }[];
                speed?: number;
            };
            animationDataOut?: {
                amplification?: number;
                inOutOfRange: OutOfRangeEnum;
                name: string;
                offset?: number;
                outOutOfRange: OutOfRangeEnum;
                propertyAnimations: {
                    inOutOfRange: OutOfRangeEnum;
                    keyframes: {
                        easing: EasingEnum;
                        relativeProperty?: string;
                        space: AnimationSpaceEnum;
                        time: number;
                        value: string
                        | number;
                    }[];
                    outOutOfRange: OutOfRangeEnum;
                    property: string;
                }[];
                speed?: number;
            };
            animationInDuration?: number;
            animationLoopCount?: number;
            animationOutDuration?: number;
            loopSmoothing?: number;
        };
        clipMasks?: { clipId: string; id: string; wrapMode: MaskWrapModeEnum }[];
        customData?: [string, unknown][];
        duration: number;
        effects: {
            id: string;
            options: {
                fragmentSrc?: string;
                frameHeight: number;
                frameWidth: number;
                textureHeight: number;
                textureWidth: number;
                uniforms?: Record<string, unknown>;
            };
            sourceId: string;
        }[];
        filters: { id: string; options: { lutUrl: string }; sourceId: string }[];
        fonts?: string[];
        htmlStyle: {
            align: "left" | "center" | "right" | "justify";
            breakWords: boolean;
            color: string;
            dropShadow: boolean;
            dropShadowAlpha: number;
            dropShadowAngle: number;
            dropShadowBlur: number;
            dropShadowColor: string;
            dropShadowDistance: number;
            fontFamily: string;
            fontSize: number;
            fontStyle: "normal" | "italic" | "oblique";
            fontVariant: "normal" | "small-caps";
            fontWeight:
                | "bold"
                | "normal"
                | "bolder"
                | "lighter"
                | "100"
                | "200"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "800"
                | "900";
            letterSpacing: number;
            lineHeight: number;
            padding: number;
            stroke: string;
            strokeThickness: number;
            whiteSpace: "pre"
            | "normal"
            | "pre-line";
            wordWrap: boolean;
            wordWrapWidth: number;
        };
        htmlText: string;
        id: string;
        isVisible: boolean;
        leftTrim: number;
        mediaDataId?: string;
        rightTrim: number;
        startTime: number;
        style?: unknown;
        subtitlesId?: string;
        subtitlesOffset: number;
        text?: string;
        type: string;
        wrapMode?: CLAMP
        | REPEAT
        | PING_PONG
        | EMPTY;
    }

setAllCustomData

setCustomData

setHasTransition

setHtmlStyle

  • setHtmlStyle(
        style: {
            align?: "left" | "center" | "right" | "justify";
            breakWords?: boolean;
            color?: string;
            dropShadow?: boolean;
            dropShadowAlpha?: number;
            dropShadowAngle?: number;
            dropShadowBlur?: number;
            dropShadowColor?: string;
            dropShadowDistance?: number;
            fontFamily?: string;
            fontSize?: number;
            fontStyle?: "normal" | "italic" | "oblique";
            fontVariant?: "normal" | "small-caps";
            fontWeight?:
                | "bold"
                | "normal"
                | "bolder"
                | "lighter"
                | "100"
                | "200"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "800"
                | "900";
            letterSpacing?: number;
            lineHeight?: number;
            padding?: number;
            stroke?: string;
            strokeThickness?: number;
            whiteSpace?: "pre"
            | "normal"
            | "pre-line";
            wordWrap?: boolean;
            wordWrapWidth?: number;
        },
        reset?: boolean,
    ): void

  • Parameters

    • style: {
          align?: "left" | "center" | "right" | "justify";
          breakWords?: boolean;
          color?: string;
          dropShadow?: boolean;
          dropShadowAlpha?: number;
          dropShadowAngle?: number;
          dropShadowBlur?: number;
          dropShadowColor?: string;
          dropShadowDistance?: number;
          fontFamily?: string;
          fontSize?: number;
          fontStyle?: "normal" | "italic" | "oblique";
          fontVariant?: "normal" | "small-caps";
          fontWeight?:
              | "bold"
              | "normal"
              | "bolder"
              | "lighter"
              | "100"
              | "200"
              | "300"
              | "400"
              | "500"
              | "600"
              | "700"
              | "800"
              | "900";
          letterSpacing?: number;
          lineHeight?: number;
          padding?: number;
          stroke?: string;
          strokeThickness?: number;
          whiteSpace?: "pre"
          | "normal"
          | "pre-line";
          wordWrap?: boolean;
          wordWrapWidth?: number;
      }
    • reset: boolean = false

    Returns void

setHtmlText

setLeftTrim

setRightTrim

setStartTime

setSubtitles

setSubtitlesId

setSubtitlesOffset

setVisible

update

updateMediaData

updateVisibility

Staticdeserialize

Settings

Member Visibility

On This Page

Constructors
Properties
Methods