Class GifClip

Readonly animationController

id

sprite

state

style

addEffect

• addEffect(effect): void

• Parameters

  • effect: Effect

  Returns void

addFilter

• addFilter(filter): void

• Parameters

  • filter: Filter

  Returns void

clearAllCustomData

• clearAllCustomData(): void

• Returns void

generateNewId

• generateNewId(): void

• Returns void

getAllCustomData

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

• Returns undefined | Map<string, unknown>

getCustomData

• getCustomData(key): unknown

• Parameters

  • key: string

  Returns unknown

getDuration

• getDuration(): number

• Returns number

getEffectById

• getEffectById(effectId): undefined | Effect

• Parameters

  • effectId: string

  Returns undefined | Effect

getEffects

• getEffects(): Effect[]

• Returns Effect[]

getEndTime

• getEndTime(): number

• Returns number

getFilterById

• getFilterById(filterId): 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

getMediaId

• getMediaId(): undefined | string

• Returns undefined | 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

hasCustomData

• hasCustomData(key): boolean

• Parameters

  • key: string

  Returns boolean

hasSprite

• hasSprite(): boolean

• Returns boolean

isActive

• isActive(currentTime): boolean

• Parameters

  • currentTime: number

  Returns boolean

isReady

• isReady(): boolean

• Returns boolean

moveBy

• moveBy(amount): void

• Parameters

  • amount: number

  Returns void

onRenderDone

• onRenderDone(canceled): Promise<void>

• Parameters

  • canceled: boolean

  Returns Promise<void>

onRenderStart

• onRenderStart(options): Promise<void>

• Parameters

  • options: ExportOptions

  Returns Promise<void>

onResize

• onResize(width, height): void

• Parameters

  • width: number
  • height: number

  Returns void

removeEffect

• removeEffect(effectId): void

• Parameters

  • effectId: string

  Returns void

removeFilter

• removeFilter(filterId): void

• Parameters

  • filterId: string

  Returns void

removeSubtitles

• removeSubtitles(): void

• Returns void

render

• render(currentTime): null

• Parameters

  • currentTime: number

  Returns null

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;
      };
      customData?: [string, unknown][];
      duration: number;
      effects: unknown[];
      filters: {
          id: string;
          options: {
              lutUrl: string;
          };
          sourceId: string;
      }[];
      id: string;
      leftTrim: number;
      mediaDataId?: 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;
      };
      customData?: [string, unknown][];
      duration: number;
      effects: unknown[];
      filters: {
          id: string;
          options: {
              lutUrl: string;
          };
          sourceId: string;
      }[];
      id: string;
      leftTrim: number;
      mediaDataId?: 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 customData?: [string, unknown][]

  • duration: number

  • effects: unknown[]

  • filters: {
        id: string;
        options: {
            lutUrl: string;
        };
        sourceId: string;
    }[]

  • id: string

  • leftTrim: number

  • Optional mediaDataId?: string

  • rightTrim: number

  • startTime: number

  • Optional style?: unknown

  • Optional subtitlesId?: string

  • subtitlesOffset: number

  • Optional text?: string

  • type: string

  • warpMode: WarpModeEnum

setAllCustomData

• setAllCustomData(data): void

• Parameters

  • data: Map<string, unknown>

  Returns void

setCustomData

• setCustomData(key, value, overwrite?): boolean

• Parameters

  • key: string
  • value: unknown
  • overwrite: boolean = true

  Returns boolean

setHasTransition

• setHasTransition(hasTransition): void

• Parameters

  • hasTransition: boolean

  Returns void

setLeftTrim

• setLeftTrim(trim): void

• Parameters

  • trim: number

  Returns void

setRightTrim

• setRightTrim(trim): void

• Parameters

  • trim: number

  Returns void

setStartTime

• setStartTime(startTime): void

• Parameters

  • startTime: number

  Returns void

setSubtitles

• setSubtitles(subtitlesId, offset?): void

• Parameters

  • subtitlesId: string
  • offset: number = 0

  Returns void

setSubtitlesOffset

• setSubtitlesOffset(offset): void

• Parameters

  • offset: number

  Returns void

Static deserialize

• deserialize(data): Clip<Sprite, ClipStyle<Sprite>>

• Parameters

  • data: object

  Returns Clip<Sprite, ClipStyle<Sprite>>