Class Clip<T, K>

Type Parameters

T extends Sprite = Sprite
K extends ClipStyle = ClipStyle

Hierarchy (View Summary)

Clip

Index

Constructors

constructor

new Clip<
    T extends Sprite = Sprite,
    K extends ClipStyle<Sprite> = ClipStyle<Sprite>,
>(
    options: ClipOptions,
): Clip<T, K>
Type Parameters
- T extends Sprite = Sprite
- K extends ClipStyle<Sprite> = ClipStyle<Sprite>
Parameters
- options: ClipOptions
Returns Clip<T, K>

Properties

`Readonly`animationController

animationController: (Anonymous class)<T>

id

id: string

sprite

sprite: T

state

state: ClipState

style

style: K

Methods

addClipMask

addClipMask(clip: Clip, options?: MaskOptions): undefined | MaskFilter
Parameters
- clip: Clip
- Optionaloptions: MaskOptions
Returns undefined | MaskFilter

addEffect

addEffect(effect: Effect): Effect
Parameters
- effect: Effect
Returns Effect
addEffect(effectId: string, properties?: Record<string, any>): Effect
Parameters
- effectId: string
- Optionalproperties: Record<string, any>
Returns Effect

addFilter

addFilter(filter: Filter): Filter
Parameters
- filter: Filter
Returns Filter
addFilter(filterId: string): Filter
Parameters
- filterId: string
Returns Filter

clearAllCustomData

clearAllCustomData(): void
Returns void

clone

clone(): Clip<Sprite, ClipStyle<Sprite>>
Returns Clip<Sprite, ClipStyle<Sprite>>

destroy

destroy(): void
Returns void

discardProcessing

discardProcessing(): void
Returns void

generateNewId

generateNewId(): void
Returns void

getAllCustomData

getAllCustomData(): undefined | Map<string, unknown>
Returns undefined | Map<string, unknown>

getBlendMode

getBlendMode(): BlendModeEnum
Returns BlendModeEnum

getCustomData

getCustomData(key: string): unknown
Parameters
- key: string
Returns unknown

getDuration

getDuration(): number
Returns number

getEffectById

getEffectById(effectId: string): undefined | Effect
Parameters
- effectId: string
Returns undefined | Effect

getEffects

getEffects(): Effect[]
Returns Effect[]

getEndTime

getEndTime(): number
Returns number

getFilterById

getFilterById(filterId: string): undefined | Filter
Parameters
- filterId: string
Returns undefined | Filter

getFilters

getFilters(): Filter[]
Returns Filter[]

getHasTransition

getHasTransition(): boolean
Returns boolean

getId

getId(): string
Returns string

getIsProcessing

getIsProcessing(): boolean
Returns boolean

getLeftBound

getLeftBound(): number
Returns number

getLeftTrim

getLeftTrim(): number
Returns number

getMasks

getMasks(): MaskFilter[]
Returns MaskFilter[]

getMediaId

getMediaId(): undefined | string
Returns undefined | string

getName

getName(): string
Returns string

getRightBound

getRightBound(): number
Returns number

getRightTrim

getRightTrim(): number
Returns number

getStartTime

getStartTime(): number
Returns number

getSubtitlesId

getSubtitlesId(): undefined | string
Returns undefined | string

getSubtitlesOffset

getSubtitlesOffset(): number
Returns number

getTrimmedDuration

getTrimmedDuration(): number
Returns number

getType

getType(): string
Returns string

getVisible

getVisible(): boolean
Returns boolean

getWrapMode

getWrapMode(): WrapModeEnum
Returns WrapModeEnum

hasCustomData

hasCustomData(key: string): boolean
Parameters
- key: string
Returns boolean

hasName

hasName(): boolean
Returns boolean

hasSprite

hasSprite(): boolean
Returns boolean

hitTest

hitTest(
point: { cursorX: number; cursorY: number },
ignoreVisibility?: boolean,
): boolean
Parameters
- point: { cursorX: number; cursorY: number }
- OptionalignoreVisibility: boolean
Returns boolean

init

init(layerId: string): Promise<void>
Parameters
- layerId: string
Returns Promise<void>

isActive

isActive(currentTime: number): boolean
Parameters
- currentTime: number
Returns boolean

isReady

isReady(): boolean
Returns boolean

moveBy

moveBy(amount: number): void
Parameters
- amount: number
Returns void

onPause

onPause(currentTime: number): Promise<void>
Parameters
- currentTime: number
Returns Promise<void>

onPlay

onPlay(currentTime: number): Promise<void>
Parameters
- currentTime: number
Returns Promise<void>

onRenderDone

onRenderDone(canceled: boolean): Promise<void>
Parameters
- canceled: boolean
Returns Promise<void>

onRenderStart

onRenderStart(options: ExportOptions): Promise<void>
Parameters
- options: ExportOptions
Returns Promise<void>

onResize

onResize(width: number, height: number): Promise<void>
Parameters
- width: number
- height: number
Returns Promise<void>

postRender

postRender(currentTime: number): void
Parameters
- currentTime: number
  The current time of the timeline
Returns void
Description
This is called after all the clips have been rendered in the preview, useful if you want to change some other clip states after rendering

preload

preload(currentTime: number): void
Parameters
- currentTime: number
Returns void

removeAllEffectsByEffectId

removeAllEffectsByEffectId(effectId: string): void
Parameters
- effectId: string
Returns void

removeClipMask

removeClipMask(clip: Clip): void
Parameters
- clip: Clip
Returns void

removeEffect

removeEffect(id: string): void
Parameters
- id: string
Returns void

removeFilter

removeFilter(id: string): void
Parameters
- id: string
Returns void

removeSubtitles

removeSubtitles(): void
Returns void

render

render(currentTime: number): void
Parameters
- currentTime: number
Returns void

resetAllAnimationProperties

resetAllAnimationProperties(): void
Returns void

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;
    };
    blendMode?: NORMAL
    | ADD
    | SCREEN
    | MULTIPLY;
    clipMasks?: { clipId: string; id: string; wrapMode: MaskWrapModeEnum }[];
    customData?: [string, unknown][];
    duration: number;
    effects: any[];
    filters: {
        clipId?: string;
        filterId: string;
        id: string;
        intensity: number;
        provider: string;
    }[];
    id: string;
    isVisible: boolean;
    leftTrim: number;
    mediaDataId?: string;
    name?: 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;
    };
    blendMode?: NORMAL
    | ADD
    | SCREEN
    | MULTIPLY;
    clipMasks?: { clipId: string; id: string; wrapMode: MaskWrapModeEnum }[];
    customData?: [string, unknown][];
    duration: number;
    effects: any[];
    filters: {
        clipId?: string;
        filterId: string;
        id: string;
        intensity: number;
        provider: string;
    }[];
    id: string;
    isVisible: boolean;
    leftTrim: number;
    mediaDataId?: string;
    name?: string;
    rightTrim: number;
    startTime: number;
    style?: unknown;
    subtitlesId?: string;
    subtitlesOffset: number;
    text?: string;
    type: string;
    wrapMode?: CLAMP
    | REPEAT
    | PING_PONG
    | EMPTY;
}

setAllCustomData

setAllCustomData(data: Map<string, unknown>): void
Parameters
- data: Map<string, unknown>
Returns void

setBlendMode

setBlendMode(blendMode: BlendModeEnum): void
Parameters
- blendMode: BlendModeEnum
Returns void

setCustomData

setCustomData(key: string, value: unknown, overwrite?: boolean): boolean
Parameters
- key: string
- value: unknown
- overwrite: boolean = true
Returns boolean

setHasTransition

setHasTransition(hasTransition: boolean): void
Parameters
- hasTransition: boolean
Returns void

setLeftTrim

setLeftTrim(trim: number): void
Parameters
- trim: number
Returns void

setName

setName(name: string): void
Parameters
- name: string
Returns void

setRightTrim

setRightTrim(trim: number): void
Parameters
- trim: number
Returns void

setStartTime

setStartTime(startTime: number): void
Parameters
- startTime: number
Returns void

setSubtitles

setSubtitles(subtitlesId: string, offset?: number): void
Parameters
- subtitlesId: string
- offset: number = 0
Returns void

setSubtitlesId

setSubtitlesId(subtitlesId: string): void
Parameters
- subtitlesId: string
Returns void

setSubtitlesOffset

setSubtitlesOffset(offset: number): void
Parameters
- offset: number
Returns void

setVisible

setVisible(visible: boolean): void
Parameters
- visible: boolean
Returns void

setWrapMode

setWrapMode(wrapMode: WrapModeEnum): void
Parameters
- wrapMode: WrapModeEnum
Returns void

update

update(currentTime: number): void
Parameters
- currentTime: number
Returns void

updateMediaData

updateMediaData(newMediaId?: string): Promise<boolean>
Parameters
- OptionalnewMediaId: string
Returns Promise<boolean>

updateVisibility

updateVisibility(currentTime: number): void
Parameters
- currentTime: number
Returns void

`Static`deserialize

deserialize(data: object): Clip<Sprite, ClipStyle<Sprite>>
Parameters
- data: object
Returns Clip<Sprite, ClipStyle<Sprite>>

Class Clip<T, K>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Clip<T, K>

Properties

ReadonlyanimationController

id

sprite

state

style

Methods

addClipMask

Parameters

Returns undefined | MaskFilter

addEffect

Parameters

Returns Effect

Parameters

Returns Effect

addFilter

Parameters

Returns Filter

Parameters

Returns Filter

clearAllCustomData

Returns void

clone

Returns Clip<Sprite, ClipStyle<Sprite>>

destroy

Returns void

discardProcessing

Returns void

generateNewId

Returns void

getAllCustomData

Returns undefined | Map<string, unknown>

getBlendMode

Returns BlendModeEnum

getCustomData

Parameters

Returns unknown

getDuration

Returns number

getEffectById

Parameters

Returns undefined | Effect

getEffects

Returns Effect[]

getEndTime

Returns number

getFilterById

Parameters

Returns undefined | Filter

getFilters

Returns Filter[]

getHasTransition

Returns boolean

getId

Returns string

getIsProcessing

Returns boolean

getLeftBound

Returns number

getLeftTrim

Returns number

getMasks

Returns MaskFilter[]

getMediaId

Returns undefined | string

getName

Returns string

getRightBound

`Readonly`animationController