Class TextClip

Hierarchy (View Summary)

Clip<TextSprite, TextStyle>
- TextClip

Index

Constructors

constructor

Properties

animationController id sprite state style text

Methods

Constructors

constructor

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

Properties

`Readonly`animationController

animationController: (Anonymous class)<TextSprite, TextStyle>

id

id: string

sprite

sprite: TextSprite

state

state: ClipState

style

style: TextStyle

text

text: string

Methods

addClipMask

addClipMask(
clip: Clip<Sprite, ClipStyle<Sprite>>,
options?: MaskOptions,
): undefined | MaskFilter
Parameters
- clip: Clip<Sprite, ClipStyle<Sprite>>
- Optionaloptions: MaskOptions
Returns undefined | MaskFilter
Inherited from Clip.addClipMask
- Defined in src/modules/clip/Clip.ts:1003

addEffect

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

addFilter

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

clearAllCustomData

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

clone

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

destroy

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

generateNewId

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

getAllCustomData

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

getCustomData

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

getDuration

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

getEffectById

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

getEffects

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

getEndTime

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

getFilterById

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

getFilters

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

getHasTransition

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

getId

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

getIsProcessing

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

getLeftBound

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

getLeftTrim

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

getMasks

getMasks(): MaskFilter[]
Returns MaskFilter[]
Inherited from Clip.getMasks
- Defined in src/modules/clip/Clip.ts:619

getMediaId

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

getRightBound

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

getRightTrim

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

getStartTime

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

getSubtitlesId

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

getSubtitlesOffset

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

getText

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

getTrimmedDuration

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

getType

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

getVisible

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

hasCustomData

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

hasSprite

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

init

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

isActive

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

isReady

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

moveBy

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

offload

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

onPause

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

onPlay

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

onRenderDone

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

onRenderStart

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

onResize

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

preload

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

removeClipMask

removeClipMask(clip: Clip<Sprite, ClipStyle<Sprite>>): void
Parameters
- clip: Clip<Sprite, ClipStyle<Sprite>>
Returns void
Inherited from Clip.removeClipMask
- Defined in src/modules/clip/Clip.ts:1022

removeEffect

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

removeFilter

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

removeSubtitles

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

render

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

resetAllAnimationProperties

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

seek

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

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;
    };
    clipMasks?: { clipId: string; id: string; wrapMode: MaskWrapModeEnum }[];
    customData?: [string, unknown][];
    duration: number;
    effects: {
        id: string;
        options: {
            fragmentSrc?: string;
            frameHeight: number;
            frameWidth: number;
            textureHeight: number;
            textureWidth: number;
            uniforms?: Record<string, unknown>;
        };
        sourceId: string;
    }[];
    filters: { id: string; options: { lutUrl: string }; sourceId: string }[];
    id: string;
    isVisible: boolean;
    leftTrim: number;
    mediaDataId?: 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;
    };
    clipMasks?: { clipId: string; id: string; wrapMode: MaskWrapModeEnum }[];
    customData?: [string, unknown][];
    duration: number;
    effects: {
        id: string;
        options: {
            fragmentSrc?: string;
            frameHeight: number;
            frameWidth: number;
            textureHeight: number;
            textureWidth: number;
            uniforms?: Record<string, unknown>;
        };
        sourceId: string;
    }[];
    filters: { id: string; options: { lutUrl: string }; sourceId: string }[];
    id: string;
    isVisible: boolean;
    leftTrim: number;
    mediaDataId?: string;
    rightTrim: number;
    startTime: number;
    style?: unknown;
    subtitlesId?: string;
    subtitlesOffset: number;
    text: string;
    type: string;
    wrapMode?: CLAMP | REPEAT | PING_PONG | EMPTY;
}
Overrides Clip.serialize
- Defined in src/modules/clip/clips/text/TextClip.ts:163

setAllCustomData

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

setAnimationText

setAnimationText(text: string): void
Parameters
- text: string
Returns void
- Defined in src/modules/clip/clips/text/TextClip.ts:93

setCustomData

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

setHasTransition

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

setLeftTrim

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

setRightTrim

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

setStartTime

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

setSubtitles

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

setSubtitlesId

setSubtitlesId(subtitlesId: string): void
Parameters
- subtitlesId: string
Returns void
Inherited from Clip.setSubtitlesId
- Defined in src/modules/clip/Clip.ts:850

setSubtitlesOffset

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

setText

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

setVisible

setVisible(visible: boolean): void
Parameters
- visible: boolean
Returns void
Inherited from Clip.setVisible
- Defined in src/modules/clip/Clip.ts:1029

update

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

updateMediaData

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

updateVisibility

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

`Static`deserialize

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

Class TextClip

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TextClip

Properties

ReadonlyanimationController

id

sprite

state

style

text

Methods

addClipMask

Parameters

Returns undefined | MaskFilter

addEffect

Parameters

Returns void

addFilter

Parameters

Returns void

clearAllCustomData

Returns void

clone

Returns TextClip

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

getMasks

Returns MaskFilter[]

getMediaId

Returns undefined | string

getRightBound

Returns number

getRightTrim

Returns number

getStartTime

Returns number

getSubtitlesId

Returns undefined | string

getSubtitlesOffset

Returns number

getText

Returns string

`Readonly`animationController