Class VideoClip

Hierarchy (View Summary)

Constructors

constructor

Properties

animationController id sprite state style

Methods

addClipMask addEffect addFilter clearAllCustomData clone destroy discardProcessing extractMonoAudioData generateNewId getAllCustomData getAudioSamples getBlendMode getCustomData getDuration getEffectById getEffects getEndTime getFilmstripData getFilmstripDataRange getFilmstripState getFilterById getFilters getHasTransition getId getIsProcessing getLeftBound getLeftRenderBound getLeftTrim getMasks getMediaId getName getRightBound getRightRenderBound getRightTrim getStartTime getSubtitlesId getSubtitlesOffset getTrimmedDuration getType getVisible getVolume getWrapMode hasCustomData hasName hasSprite hitTest init isActive isMuted isReady moveBy onPause onPlay onRenderDone onRenderStart onResize preload removeAllEffectsByEffectId removeClipMask removeEffect removeFilter removeSubtitles render resetAllAnimationProperties serialize setAllCustomData setBlendMode setCustomData setHasTransition setLeftTrim setMuted setName setRightTrim setStartTime setSubtitles setSubtitlesId setSubtitlesOffset setVisible setVolume setWrapMode update updateMediaData updateVisibility deserialize

Constructors

constructor

Properties

ReadonlyanimationController

animationController: (Anonymous class)<Sprite, ClipStyle<Sprite>>

id

id: string

sprite

sprite: Sprite

state

state: ClipState

style

style: ClipStyle<Sprite>

Methods

addClipMask

addEffect

addFilter

clearAllCustomData

clone

destroy

discardProcessing

extractMonoAudioData

  • extractMonoAudioData(
        startTime: number,
        endTime: number,
    ): Promise<null | Float32Array>

  • Parameters

    • startTime: number
    • endTime: number

    Returns Promise<null | Float32Array>

generateNewId

getAllCustomData

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

  • Returns undefined | Map<string, unknown>

getAudioSamples

  • getAudioSamples(startTime: number, duration?: number): null | Float32Array[]

  • Retrieves audio samples for a specified time range relative to the startTime from the associated media data.

    Parameters

    • startTime: number

      The start time in seconds relative to the startTime from which to extract audio samples.

    • Optionalduration: number

      The duration in seconds for which to extract audio samples.

    Returns null | Float32Array[]

    An array of Float32Array representing the audio samples, or null if the media data is unavailable.

getBlendMode

getCustomData

  • getCustomData(key: string): unknown

  • Parameters

    • key: string

    Returns unknown

getDuration

getEffectById

getEffects

getEndTime

getFilmstripData

  • getFilmstripData(): IFilmstripData[]

  • Retrieves the data for the filmstrip associated with this clip.

    Returns IFilmstripData[]

    An array of IFilmstripData objects representing the filmstrip data. If the clip is not associated with any media data or the media data does not have a filmstrip, an empty array is returned.

getFilmstripDataRange

  • getFilmstripDataRange(start: number, end: number): IFilmstripData[]

  • Retrieves a range of data from the filmstrip associated with this clip.

    Parameters

    • start: number

      The start time of the range in seconds, in case it lands between two filmstrip data points returns the lowest.

    • end: number

      The end time of the range in seconds, in case it lands between two filmstrip data points returns the highest.

    Returns IFilmstripData[]

    An array of IFilmstripData objects representing the filmstrip data in the specified range. If the clip is not associated with any media data or the media data does not have a filmstrip, or if the range is invalid, an empty array is returned.

getFilmstripState

  • getFilmstripState(): FilmStripStateEnum

  • Retrieves the current state of the filmstrip extraction process for the associated media data.

    Returns FilmStripStateEnum

    The current state of the filmstrip extraction process. It can be one of the following values:

    • FilmStripStateEnum.NONE: No filmstrip extraction process is currently running.
    • FilmStripStateEnum.PARTIAL: The filmstrip extraction process is partially complete.
    • FilmStripStateEnum.DONE: The filmstrip extraction process is complete.
    • FilmStripStateEnum.ERROR: An error occurred during the filmstrip extraction process.

getFilterById

getFilters

getHasTransition

getId

  • getId(): string

  • Returns string

getIsProcessing

getLeftBound

getLeftRenderBound

  • getLeftRenderBound(): number

  • Returns number

getLeftTrim

getMasks

getMediaId

  • getMediaId(): undefined | string

  • Returns undefined | string

getName

  • getName(): string

  • Returns string

getRightBound

getRightRenderBound

  • getRightRenderBound(): number

  • Returns number

getRightTrim

getStartTime

getSubtitlesId

  • getSubtitlesId(): undefined | string

  • Returns undefined | string

getSubtitlesOffset

getTrimmedDuration

getType

  • getType(): string

  • Returns string

getVisible

getVolume

  • getVolume(): number

  • Returns number

getWrapMode

hasCustomData

  • hasCustomData(key: string): boolean

  • Parameters

    • key: string

    Returns boolean

hasName

  • hasName(): boolean

  • Returns boolean

hasSprite

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

isMuted

  • isMuted(): boolean

  • 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

onResize

  • onResize(width: number, height: number): Promise<void>

  • Parameters

    • width: number
    • height: number

    Returns Promise<void>

preload

  • preload(currentTime: number): void

  • Parameters

    • currentTime: number

    Returns void

removeAllEffectsByEffectId

removeClipMask

removeEffect

  • removeEffect(id: string): void

  • Parameters

    • id: string

    Returns void

removeFilter

  • removeFilter(id: string): void

  • Parameters

    • id: string

    Returns void

removeSubtitles

render

  • render(currentTime: number): null

  • Parameters

    • currentTime: number

    Returns null

resetAllAnimationProperties

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;
        muted?: boolean;
        name?: string;
        rightTrim: number;
        startTime: number;
        style?: unknown;
        subtitlesId?: string;
        subtitlesOffset: number;
        text?: string;
        type: string;
        volume?: number;
        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;
        muted?: boolean;
        name?: string;
        rightTrim: number;
        startTime: number;
        style?: unknown;
        subtitlesId?: string;
        subtitlesOffset: number;
        text?: string;
        type: string;
        volume?: number;
        wrapMode?: CLAMP
        | REPEAT
        | PING_PONG
        | EMPTY;
    }

setAllCustomData

  • setAllCustomData(data: Map<string, unknown>): void

  • Parameters

    • data: Map<string, unknown>

    Returns void

setBlendMode

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

setMuted

  • setMuted(muted: boolean): void

  • Parameters

    • muted: boolean

    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

setVolume

  • setVolume(volume: number): void

  • Parameters

    • volume: number

    Returns void

setWrapMode

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

Staticdeserialize

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
addClipMaskaddEffectaddFilterclearAllCustomDataclonedestroydiscardProcessingextractMonoAudioDatagenerateNewIdgetAllCustomDatagetAudioSamplesgetBlendModegetCustomDatagetDurationgetEffectByIdgetEffectsgetEndTimegetFilmstripDatagetFilmstripDataRangegetFilmstripStategetFilterByIdgetFiltersgetHasTransitiongetIdgetIsProcessinggetLeftBoundgetLeftRenderBoundgetLeftTrimgetMasksgetMediaIdgetNamegetRightBoundgetRightRenderBoundgetRightTrimgetStartTimegetSubtitlesIdgetSubtitlesOffsetgetTrimmedDurationgetTypegetVisiblegetVolumegetWrapModehasCustomDatahasNamehasSpritehitTestinitisActiveisMutedisReadymoveByonPauseonPlayonRenderDoneonRenderStartonResizepreloadremoveAllEffectsByEffectIdremoveClipMaskremoveEffectremoveFilterremoveSubtitlesrenderresetAllAnimationPropertiesserializesetAllCustomDatasetBlendModesetCustomDatasetHasTransitionsetLeftTrimsetMutedsetNamesetRightTrimsetStartTimesetSubtitlessetSubtitlesIdsetSubtitlesOffsetsetVisiblesetVolumesetWrapModeupdateupdateMediaDataupdateVisibilitydeserialize