Interface HtmlTextClipOptions

interface HtmlTextClipOptions {
    duration?: number;
    effects?: Effect[];
    filters?: Filter[];
    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;
    leftTrim?: number;
    mediaDataId?: string;
    rightTrim?: number;
    startTime?: number;
    style?: Partial<{
        alpha: number;
        clipId: string;
        cornerRadius?: [number, number, number, number];
        height?: number;
        mediaDataId?: string;
        position: [number, number];
        relativeCornerRadius: boolean;
        rotation: number;
        scale: [number, number];
        width?: number;
        zIndex: number;
    }>;
    subtitlesId?: string;
    subtitlesOffset?: number;
    type?: string;
}

Hierarchy (view full)

Properties

duration? effects? filters? fonts? htmlStyle? htmlText id? leftTrim? mediaDataId? rightTrim? startTime? style? subtitlesId? subtitlesOffset? type?

Properties

Optional duration

duration?: number

Optional effects

effects?: Effect[]

Optional filters

filters?: Filter[]

Optional fonts

fonts?: string[]

Optional htmlStyle

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

Type declaration

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

htmlText

htmlText: string

Optional id

id?: string

Optional leftTrim

leftTrim?: number

Optional mediaDataId

mediaDataId?: string

Optional rightTrim

rightTrim?: number

Optional startTime

startTime?: number

Optional style

style?: Partial<{
    alpha: number;
    clipId: string;
    cornerRadius?: [number, number, number, number];
    height?: number;
    mediaDataId?: string;
    position: [number, number];
    relativeCornerRadius: boolean;
    rotation: number;
    scale: [number, number];
    width?: number;
    zIndex: number;
}>

Type declaration

  • alpha: number
  • clipId: string
  • Optional cornerRadius?: [number, number, number, number]
  • Optional height?: number
  • Optional mediaDataId?: string
  • position: [number, number]
  • relativeCornerRadius: boolean
  • rotation: number
  • scale: [number, number]
  • Optional width?: number
  • zIndex: number

Optional subtitlesId

subtitlesId?: string

Optional subtitlesOffset

subtitlesOffset?: number

Optional type

type?: string

Settings

Member Visibility

Theme

On This Page

durationeffectsfiltersfontshtmlStylehtmlTextidleftTrimmediaDataIdrightTrimstartTimestylesubtitlesIdsubtitlesOffsettype

Generated using TypeDoc