Class TextClip

Hierarchy (view full)

Clip<TextSprite, TextStyle>
- TextClip

Constructors

constructor

new TextClip(options): TextClip
Parameters
- options: TextClipOptions
Returns TextClip
Overrides Clip.constructor
- Defined in src/modules/clip/clips/text/TextClip.ts:21

Properties

animationController

animationController: __class<TextSprite, TextStyle>

id

id: string

sprite

sprite: TextSprite

state

state: ClipState

style

style: TextStyle

text

text: string

Methods

addEffect

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

addFilter

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

clone

clone(): TextClip
Returns TextClip
Overrides Clip.clone
- Defined in src/modules/clip/clips/text/TextClip.ts:70

destroy

destroy(): void
Returns void
Overrides Clip.destroy
- Defined in src/modules/clip/clips/text/TextClip.ts:74

generateNewId

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

getDuration

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

getEffectById

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

getEffects

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

getEndTime

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

getFilterById

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

getFilters

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

getHasTransition

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

getIsProcessing

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

getLeftBound

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

getLeftTrim

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

getMediaId

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

getRightBound

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

getRightTrim

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

getStartTime

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

getSubtitleText

getSubtitleText(currentTime): undefined | string
Parameters
- currentTime: number
Returns undefined | string
Inherited from Clip.getSubtitleText
- Defined in src/modules/clip/Clip.ts:666

getSubtitlesId

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

getSubtitlesOffset

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

getText

getText(): string
Returns string
- Defined in src/modules/clip/clips/text/TextClip.ts:43

getTrimmedDuration

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

getType

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

hasSprite

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

init

init(layerId): Promise<void>
Parameters
- layerId: string
Returns Promise<void>
Inherited from Clip.init
- Defined in src/modules/clip/Clip.ts:288

isActive

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

isReady

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

moveBy

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

offload

offload(): void
Returns void
Overrides Clip.offload
- Defined in src/modules/clip/clips/text/TextClip.ts:68

onPause

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

onPlay

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

onRenderDone

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

onRenderStart

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

onResize

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

preload

preload(currentTime): void
Parameters
- currentTime: number
Returns void
Overrides Clip.preload
- Defined in src/modules/clip/clips/text/TextClip.ts:58

removeEffect

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

removeFilter

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

removeSubtitles

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

render

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

resetAllAnimationProperties

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

seek

seek(currentTime): void
Parameters
- currentTime: number
Returns void
- Defined in src/modules/clip/clips/text/TextClip.ts:54

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;
    };
    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;
    };
    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;
  }
  - 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
- 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
- text: string
- type: string
- warpMode: WarpModeEnum
Overrides Clip.serialize
- Defined in src/modules/clip/clips/text/TextClip.ts:79

setHasTransition

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

setLeftTrim

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

setRightTrim

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

setStartTime

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

setSubtitles

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

setSubtitlesOffset

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

setText

setText(text?): void
Parameters
- Optional text: string
Returns void
- Defined in src/modules/clip/clips/text/TextClip.ts:47

update

update(currentTime): void
Parameters
- currentTime: number
Returns void
Overrides Clip.update
- Defined in src/modules/clip/clips/text/TextClip.ts:62

updateVisibility

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

`Static` deserialize

deserialize(payload): TextClip
Parameters
- payload: object
Returns TextClip
Overrides Clip.deserialize
- Defined in src/modules/clip/clips/text/TextClip.ts:87

Class TextClip

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TextClip

Properties

animationController

id

sprite

state

style

text

Methods

addEffect

Parameters

Returns void

addFilter

Parameters

Returns void

clone

Returns TextClip

destroy

Returns void

generateNewId

Returns void

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

getIsProcessing

Returns boolean

getLeftBound

Returns number

getLeftTrim

Returns number

getMediaId

Returns undefined | string

getRightBound

Returns number

getRightTrim

Returns number

getStartTime

Returns number

getSubtitleText

Parameters

Returns undefined | string

getSubtitlesId

Returns undefined | string

getSubtitlesOffset

Returns number

getText

Returns string

getTrimmedDuration

Returns number

getType

Returns string

hasSprite

Returns boolean

init

Parameters

Returns Promise<void>

isActive

Parameters

`Optional` amplification?: number

`Optional` offset?: number

propertyAnimations: {
inOutOfRange: OutOfRangeEnum;
keyframes: {
easing: EasingEnum;
relativeProperty?: string;
space: AnimationSpaceEnum;
time: number;
value: string | number;
}[];
outOutOfRange: OutOfRangeEnum;
property: string;
}[]

`Optional` speed?: number

`Optional` amplification?: number

`Optional` offset?: number

propertyAnimations: {
inOutOfRange: OutOfRangeEnum;
keyframes: {
easing: EasingEnum;
relativeProperty?: string;
space: AnimationSpaceEnum;
time: number;
value: string | number;
}[];
outOutOfRange: OutOfRangeEnum;
property: string;
}[]

`Optional` speed?: number

`Optional` amplification?: number

`Optional` offset?: number

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