Interface TextClipOptions

interface TextClipOptions {
    duration?: number;
    effects?: Effect[];
    filters?: Filter[];
    id?: string;
    leftTrim?: number;
    mediaDataId?: string;
    rightTrim?: number;
    startTime?: number;
    style?: Partial<{
        alpha: number;
        backgroundColor: null | string;
        clipId: string;
        color: string;
        cornerRadius?: [number, number, number, number];
        fontFamily: string;
        fontSize: number;
        fontStyle: "normal" | "italic" | "oblique";
        fontWeight: "normal" | "bold" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900";
        height?: number;
        mediaDataId?: string;
        position: [number, number];
        relativeCornerRadius: boolean;
        rotation: number;
        scale: [number, number];
        textAlign: "left" | "center" | "right" | "justify";
        width?: number;
        zIndex: number;
    }>;
    subtitlesId?: string;
    subtitlesOffset?: number;
    text?: string;
    type?: string;
}

Hierarchy (view full)

Properties

duration? effects? filters? id? leftTrim? mediaDataId? rightTrim? startTime? style? subtitlesId? subtitlesOffset? text? type?

Properties

Optional duration

duration?: number

Optional effects

effects?: Effect[]

Optional filters

filters?: Filter[]

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;
    backgroundColor: null | string;
    clipId: string;
    color: string;
    cornerRadius?: [number, number, number, number];
    fontFamily: string;
    fontSize: number;
    fontStyle: "normal" | "italic" | "oblique";
    fontWeight: "normal" | "bold" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900";
    height?: number;
    mediaDataId?: string;
    position: [number, number];
    relativeCornerRadius: boolean;
    rotation: number;
    scale: [number, number];
    textAlign: "left" | "center" | "right" | "justify";
    width?: number;
    zIndex: number;
}>

Type declaration

  • alpha: number
  • backgroundColor: null | string
  • clipId: string
  • color: string
  • Optional cornerRadius?: [number, number, number, number]
  • fontFamily: string
  • fontSize: number
  • fontStyle: "normal" | "italic" | "oblique"
  • fontWeight: "normal" | "bold" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900"
  • Optional height?: number
  • Optional mediaDataId?: string
  • position: [number, number]
  • relativeCornerRadius: boolean
  • rotation: number
  • scale: [number, number]
  • textAlign: "left" | "center" | "right" | "justify"
  • Optional width?: number
  • zIndex: number

Optional subtitlesId

subtitlesId?: string

Optional subtitlesOffset

subtitlesOffset?: number

Optional text

text?: string

Optional type

type?: string

Settings

Member Visibility

Theme

On This Page

durationeffectsfiltersidleftTrimmediaDataIdrightTrimstartTimestylesubtitlesIdsubtitlesOffsettexttype

Generated using TypeDoc