Class LottieClip

Hierarchy (view full)

Clip<Sprite, ClipStyle<Sprite>>
- LottieClip

Index

Constructors

constructor

Properties

animationController id sprite state style

Constructors

constructor

new LottieClip(options): LottieClip
Parameters
- options: LottieClipOptions
Returns LottieClip
Overrides Clip.constructor
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:64

Properties

`Readonly` animationController

animationController: __class<Sprite, ClipStyle<Sprite>>

id

id: string

sprite

sprite: Sprite

state

state: ClipState

style

style: ClipStyle<Sprite>

Methods

addEffect

addEffect(effect): void
Parameters
- effect: Effect
Returns void
Inherited from Clip.addEffect
- Defined in src/modules/clip/Clip.ts:647

addFilter

addFilter(filter): void
Parameters
- filter: Filter
Returns void
Inherited from Clip.addFilter
- Defined in src/modules/clip/Clip.ts:623

clearAllCustomData

clearAllCustomData(): void
Returns void
Inherited from Clip.clearAllCustomData
- Defined in src/modules/clip/Clip.ts:503

clone

clone(): LottieClip
Returns LottieClip
Overrides Clip.clone
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:300

destroy

destroy(): void
Returns void
Overrides Clip.destroy
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:305

generateNewId

generateNewId(): void
Returns void
Inherited from Clip.generateNewId
- Defined in src/modules/clip/Clip.ts:575

getAllCustomData

getAllCustomData(): undefined | Map<string, unknown>
Returns undefined | Map<string, unknown>
Inherited from Clip.getAllCustomData
- Defined in src/modules/clip/Clip.ts:511

getCustomData

getCustomData(key): unknown
Parameters
- key: string
Returns unknown
Inherited from Clip.getCustomData
- Defined in src/modules/clip/Clip.ts:492

getDuration

getDuration(): number
Returns number
Inherited from Clip.getDuration
- Defined in src/modules/clip/Clip.ts:594

getEffectById

getEffectById(effectId): undefined | Effect
Parameters
- effectId: string
Returns undefined | Effect
Inherited from Clip.getEffectById
- Defined in src/modules/clip/Clip.ts:602

getEffects

getEffects(): Effect[]
Returns Effect[]
Inherited from Clip.getEffects
- Defined in src/modules/clip/Clip.ts:562

getEndTime

getEndTime(): number
Returns number
Inherited from Clip.getEndTime
- Defined in src/modules/clip/Clip.ts:534

getFilterById

getFilterById(filterId): undefined | Filter
Parameters
- filterId: string
Returns undefined | Filter
Inherited from Clip.getFilterById
- Defined in src/modules/clip/Clip.ts:598

getFilters

getFilters(): Filter[]
Returns Filter[]
Inherited from Clip.getFilters
- Defined in src/modules/clip/Clip.ts:558

getHasTransition

getHasTransition(): boolean
Returns boolean
Inherited from Clip.getHasTransition
- Defined in src/modules/clip/Clip.ts:610

getId

getId(): string
Returns string
Inherited from Clip.getId
- Defined in src/modules/clip/Clip.ts:524

getIsProcessing

getIsProcessing(): boolean
Returns boolean
Inherited from Clip.getIsProcessing
- Defined in src/modules/clip/Clip.ts:619

getLeftBound

getLeftBound(): number
Returns number
Inherited from Clip.getLeftBound
- Defined in src/modules/clip/Clip.ts:546

getLeftTrim

getLeftTrim(): number
Returns number
Inherited from Clip.getLeftTrim
- Defined in src/modules/clip/Clip.ts:538

getMediaId

getMediaId(): undefined | string
Returns undefined | string
Inherited from Clip.getMediaId
- Defined in src/modules/clip/Clip.ts:614

getProperties

getProperties(): Record<string, {
    label: string;
    name: string;
    type: TEXT;
}>
Returns Record<string, {
    label: string;
    name: string;
    type: TEXT;
}>
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:245

getProperty

getProperty(property): {
    label: string;
    name: string;
    type: TEXT;
}
Parameters
- property: string
Returns {
    label: string;
    name: string;
    type: TEXT;
}
- label: string
- name: string
- type: TEXT
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:249

getPropertyValue

getPropertyValue(property): any
Parameters
- property: string
Returns any
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:253

getRightBound

getRightBound(): number
Returns number
Inherited from Clip.getRightBound
- Defined in src/modules/clip/Clip.ts:550

getRightTrim

getRightTrim(): number
Returns number
Inherited from Clip.getRightTrim
- Defined in src/modules/clip/Clip.ts:542

getStartTime

getStartTime(): number
Returns number
Inherited from Clip.getStartTime
- Defined in src/modules/clip/Clip.ts:529

getSubtitlesId

getSubtitlesId(): undefined | string
Returns undefined | string
Inherited from Clip.getSubtitlesId
- Defined in src/modules/clip/Clip.ts:724

getSubtitlesOffset

getSubtitlesOffset(): number
Returns number
Inherited from Clip.getSubtitlesOffset
- Defined in src/modules/clip/Clip.ts:728

getTrimmedDuration

getTrimmedDuration(): number
Returns number
Inherited from Clip.getTrimmedDuration
- Defined in src/modules/clip/Clip.ts:554

getType

getType(): string
Returns string
Inherited from Clip.getType
- Defined in src/modules/clip/Clip.ts:571

hasCustomData

hasCustomData(key): boolean
Parameters
- key: string
Returns boolean
Inherited from Clip.hasCustomData
- Defined in src/modules/clip/Clip.ts:496

hasSprite

hasSprite(): boolean
Returns boolean
Inherited from Clip.hasSprite
- Defined in src/modules/clip/Clip.ts:823

init

init(layerId): Promise<void>
Parameters
- layerId: string
Returns Promise<void>
Overrides Clip.init
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:73

isActive

isActive(currentTime): boolean
Parameters
- currentTime: number
Returns boolean
Inherited from Clip.isActive
- Defined in src/modules/clip/Clip.ts:697

isReady

isReady(): boolean
Returns boolean
Inherited from Clip.isReady
- Defined in src/modules/clip/Clip.ts:520

moveBy

moveBy(amount): void
Parameters
- amount: number
Returns void
Inherited from Clip.moveBy
- Defined in src/modules/clip/Clip.ts:566

offload

offload(): void
Returns void
Overrides Clip.offload
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:298

onPause

onPause(currentTime): void
Parameters
- currentTime: number
Returns void
Inherited from Clip.onPause
- Defined in src/modules/clip/Clip.ts:680

onPlay

onPlay(currentTime): Promise<void>
Parameters
- currentTime: number
Returns Promise<void>
Inherited from Clip.onPlay
- Defined in src/modules/clip/Clip.ts:676

onRenderDone

onRenderDone(canceled): Promise<void>
Parameters
- canceled: boolean
Returns Promise<void>
Inherited from Clip.onRenderDone
- Defined in src/modules/clip/Clip.ts:693

onRenderStart

onRenderStart(options): Promise<void>
Parameters
- options: ExportOptions
Returns Promise<void>
Inherited from Clip.onRenderStart
- Defined in src/modules/clip/Clip.ts:689

onResize

onResize(width, height): void
Parameters
- width: number
- height: number
Returns void
Inherited from Clip.onResize
- Defined in src/modules/clip/Clip.ts:684

preload

preload(currentTime): void
Parameters
- currentTime: number
Returns void
Overrides Clip.preload
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:269

removeEffect

removeEffect(effectId): void
Parameters
- effectId: string
Returns void
Inherited from Clip.removeEffect
- Defined in src/modules/clip/Clip.ts:658

removeFilter

removeFilter(filterId): void
Parameters
- filterId: string
Returns void
Inherited from Clip.removeFilter
- Defined in src/modules/clip/Clip.ts:634

removeSubtitles

removeSubtitles(): void
Returns void
Inherited from Clip.removeSubtitles
- Defined in src/modules/clip/Clip.ts:715

render

render(currentTime): null
Parameters
- currentTime: number
Returns null
Inherited from Clip.render
- Defined in src/modules/clip/Clip.ts:736

replaceFillColor

replaceFillColor(layerId, color): void
Parameters
- layerId: string | number
- color: number[]
Returns void
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:359

replaceImage

replaceImage(layerId, url): void
Parameters
- layerId: string | number
- url: string
Returns void
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:416

replaceText

replaceText(layerId, text): void
Parameters
- layerId: string | number
- text: string
Returns void
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:326

resetAllAnimationProperties

resetAllAnimationProperties(): void
Returns void
Inherited from Clip.resetAllAnimationProperties
- Defined in src/modules/clip/Clip.ts:368

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;
    };
    assetsUrl?: string;
    customData?: [string, unknown][];
    dataUrl: string;
    duration: number;
    effects: unknown[];
    filters: {
        id: string;
        options: {
            lutUrl: string;
        };
        sourceId: string;
    }[];
    id: string;
    leftTrim: number;
    mediaDataId?: string;
    propertiesUrl?: string;
    rightTrim: number;
    startTime: number;
    style?: unknown;
    subtitlesId?: string;
    subtitlesOffset: number;
    text?: string;
    type: string;
    warpMode: WarpModeEnum;
}
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;
    };
    assetsUrl?: string;
    customData?: [string, unknown][];
    dataUrl: string;
    duration: number;
    effects: unknown[];
    filters: {
        id: string;
        options: {
            lutUrl: string;
        };
        sourceId: string;
    }[];
    id: string;
    leftTrim: number;
    mediaDataId?: string;
    propertiesUrl?: string;
    rightTrim: number;
    startTime: number;
    style?: unknown;
    subtitlesId?: string;
    subtitlesOffset: number;
    text?: string;
    type: string;
    warpMode: WarpModeEnum;
}
- Optional 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;
  }
  - Optional 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;
    }
    - Optional amplification?: number
    - inOutOfRange: OutOfRangeEnum
    - name: string
    - Optional offset?: number
    - outOutOfRange: OutOfRangeEnum
    - propertyAnimations: {
          inOutOfRange: OutOfRangeEnum;
          keyframes: {
              easing: EasingEnum;
              relativeProperty?: string;
              space: AnimationSpaceEnum;
              time: number;
              value: string | number;
          }[];
          outOutOfRange: OutOfRangeEnum;
          property: string;
      }[]
    - Optional speed?: number
  - Optional 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;
    }
    - Optional amplification?: number
    - inOutOfRange: OutOfRangeEnum
    - name: string
    - Optional offset?: number
    - outOutOfRange: OutOfRangeEnum
    - propertyAnimations: {
          inOutOfRange: OutOfRangeEnum;
          keyframes: {
              easing: EasingEnum;
              relativeProperty?: string;
              space: AnimationSpaceEnum;
              time: number;
              value: string | number;
          }[];
          outOutOfRange: OutOfRangeEnum;
          property: string;
      }[]
    - Optional speed?: number
  - Optional 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;
    }
    - Optional amplification?: number
    - inOutOfRange: OutOfRangeEnum
    - name: string
    - Optional offset?: number
    - outOutOfRange: OutOfRangeEnum
    - propertyAnimations: {
          inOutOfRange: OutOfRangeEnum;
          keyframes: {
              easing: EasingEnum;
              relativeProperty?: string;
              space: AnimationSpaceEnum;
              time: number;
              value: string | number;
          }[];
          outOutOfRange: OutOfRangeEnum;
          property: string;
      }[]
    - Optional speed?: number
  - Optional animationInDuration?: number
  - Optional animationLoopCount?: number
  - Optional animationOutDuration?: number
  - Optional loopSmoothing?: number
- Optional assetsUrl?: string
- Optional customData?: [string, unknown][]
- dataUrl: string
- duration: number
- effects: unknown[]
- filters: {
      id: string;
      options: {
          lutUrl: string;
      };
      sourceId: string;
  }[]
- id: string
- leftTrim: number
- Optional mediaDataId?: string
- Optional propertiesUrl?: string
- rightTrim: number
- startTime: number
- Optional style?: unknown
- Optional subtitlesId?: string
- subtitlesOffset: number
- Optional text?: string
- type: string
- warpMode: WarpModeEnum
Overrides Clip.serialize
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:437

setAllCustomData

setAllCustomData(data): void
Parameters
- data: Map<string, unknown>
Returns void
Inherited from Clip.setAllCustomData
- Defined in src/modules/clip/Clip.ts:507

setCustomData

setCustomData(key, value, overwrite?): boolean
Parameters
- key: string
- value: unknown
- overwrite: boolean = true
Returns boolean
Inherited from Clip.setCustomData
- Defined in src/modules/clip/Clip.ts:479

setHasTransition

setHasTransition(hasTransition): void
Parameters
- hasTransition: boolean
Returns void
Inherited from Clip.setHasTransition
- Defined in src/modules/clip/Clip.ts:606

setLeftTrim

setLeftTrim(trim): void
Parameters
- trim: number
Returns void
Inherited from Clip.setLeftTrim
- Defined in src/modules/clip/Clip.ts:584

setProperty

setProperty(property, value): void
Parameters
- property: string
- value: unknown
Returns void
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:229

setRightTrim

setRightTrim(trim): void
Parameters
- trim: number
Returns void
Inherited from Clip.setRightTrim
- Defined in src/modules/clip/Clip.ts:589

setStartTime

setStartTime(startTime): void
Parameters
- startTime: number
Returns void
Inherited from Clip.setStartTime
- Defined in src/modules/clip/Clip.ts:579

setSubtitles

setSubtitles(subtitlesId, offset?): void
Parameters
- subtitlesId: string
- offset: number = 0
Returns void
Inherited from Clip.setSubtitles
- Defined in src/modules/clip/Clip.ts:706

setSubtitlesOffset

setSubtitlesOffset(offset): void
Parameters
- offset: number
Returns void
Inherited from Clip.setSubtitlesOffset
- Defined in src/modules/clip/Clip.ts:732

update

update(currentTime): void
Parameters
- currentTime: number
Returns void
Overrides Clip.update
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:288

updateMediaData

updateMediaData(newMediaId?): Promise<boolean>
Parameters
- Optional newMediaId: string
Returns Promise<boolean>
Inherited from Clip.updateMediaData
- Defined in src/modules/clip/Clip.ts:807

updateVisibility

updateVisibility(currentTime): void
Parameters
- currentTime: number
Returns void
Overrides Clip.updateVisibility
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:273

`Static` deserialize

deserialize(payload): LottieClip
Parameters
- payload: object
Returns LottieClip
Overrides Clip.deserialize
- Defined in src/modules/clip/clips/lottie/LottieClip.ts:445

Class LottieClip

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LottieClip

Properties

Readonly animationController

id

sprite

state

style

Methods

addEffect

Parameters

Returns void

addFilter

Parameters

Returns void

clearAllCustomData

Returns void

clone

Returns LottieClip

destroy

Returns void

generateNewId

Returns void

getAllCustomData

Returns undefined | Map<string, unknown>

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

getMediaId

Returns undefined | string

getProperties

Returns Record<string, { label: string; name: string; type: TEXT; }>

getProperty

Parameters

Returns { label: string; name: string; type: TEXT; }

label: string

name: string

type: TEXT

getPropertyValue

Parameters

Returns any

getRightBound

Returns number

getRightTrim

Returns number

getStartTime

Returns number

getSubtitlesId

`Readonly` animationController

Returns Record<string, {
label: string;
name: string;
type: TEXT;
}>

Returns {
label: string;
name: string;
type: TEXT;
}

`Optional` amplification?: number