webchalk-animate - v0.31.0
    Preparing search index...

    Interface TextEditorClipTiming

    An object containing timing-related details about an animation. Returned by TextEditorClip.getTiming.

    • Contains additional properties:
      • TextEditorClipModifiers.durationOrRate | durationOrRate
      • TextEditorClipModifiers.durationOrRateDeletion | durationOrRateDeletion
      • TextEditorClipModifiers.durationOrRateInsertion | durationOrRateInsertion

    TextEditorClip.getTiming

    interface TextEditorClipTiming {
        compoundedPlaybackRate: number;
        delay: number;
        duration: number;
        durationOrRate: number | `${number}wpm` | `${number}cpm`;
        durationOrRateDeletion: number | `${number}wpm` | `${number}cpm`;
        durationOrRateInsertion: number | `${number}wpm` | `${number}cpm`;
        easing: EasingString;
        endDelay: number;
        playbackRate: number;
        startsNextClipToo: boolean;
        startsWithPrevious: boolean;
        timescaleType: "duration" | "rate";
    }

    Hierarchy (View Summary)

    Index

    Properties

    compoundedPlaybackRate delay duration durationOrRate durationOrRateDeletion durationOrRateInsertion easing endDelay playbackRate startsNextClipToo startsWithPrevious timescaleType

    Properties

    compoundedPlaybackRate: number

    The actual playback rate of the animation after the playback rates of any parents are taken into account.

    • Example: If the playbackRate of the parent sequence is 4 and the playbackRate of this clip is 5, the compoundedPlaybackRate will be 4 * 5 = 20.

    AnimClipTiming.playbackRate

    delay: number

    The number of milliseconds the delay phase of the animation takes to complete.

    • This refers to the time before the active phase of the animation starts (i.e., before the animation effect begins).
    duration: number

    The number of milliseconds the active phase of the animation takes to complete.

    • This refers to the actual effect of the animation, not the delay or endDelay.
    durationOrRate: number | `${number}wpm` | `${number}cpm`
    durationOrRateDeletion: number | `${number}wpm` | `${number}cpm`
    durationOrRateInsertion: number | `${number}wpm` | `${number}cpm`
    easing: EasingString

    The rate of the animation's change over time.

    • Accepts a typical <easing-function>, such as "linear", "ease-in", "step-end", "cubic-bezier(0.42, 0, 0.58, 1)", etc.
    • Also accepts autocompleted preset strings (such as "bounce-in", "power-1-out", etc.) that produce preset easing effects using linear functions.
    endDelay: number

    The number of milliseconds the endDelay phase of the animation takes to complete.

    • This refers to the time after the active phase of the animation end (i.e., after the animation effect has finished).
    playbackRate: number

    The base playback rate of the animation (ignoring any multipliers from a parent sequence/timeline).

    • Example: A value of 1 means 100% (the typical playback rate), and 0.5 means 50% speed.
    • Example: If the playbackRate of the parent sequence is 4 and the playbackRate of this clip is 5, the playbackRate property is still 5, but the clip would run at 4 * 5 = 20x speed.
    startsNextClipToo: boolean

    If true, the next clip in the same sequence will play at the same time as this clip.

    • If this clip is not part of a sequence or is at the end of a sequence, this option has no effect.
    startsWithPrevious: boolean

    If true, this clip will play at the same time as the previous clip in the same sequence.

    • If this clip is not part of a sequence or is at the beginning of a sequence, this option has no effect.
    timescaleType: "duration" | "rate"

    The type of timescale the animation clip uses to measure the length of the animation.

    • "duration" indicates that the animation length follows a fixed amount of time.
    • "rate" indicates that the animation length depends on some variable change.

    Settings

    Member Visibility

    On This Page

    Properties