@rendley/sdk - v1.14.0
    Preparing search index...

    Class VideoClip

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Methods

    addClipMask addEffect addFilter applyVolume clearAllCustomData clone destroy discardProcessing extractAudioClip extractFrameAsBase64Image extractMonoAudioData generateNewId getAllCustomData getAnimationPropertyValue getAudioSamples getBlendMode getCustomData getDuration getEffectById getEffects getEndTime getFilmstripData getFilmstripDataRange getFilmstripState getFilterById getFilters getFreezeTime getId getInsideTransition getIsProcessing getLayerId getLeftBound getLeftRenderBound getLeftTrim getMasks getMediaId getName getPerservePitch getPlaybackSpeed getRightBound getRightRenderBound getRightTrim getStartTime getSubtitlesId getSubtitlesOffset getTransitionInId getTransitionOutId getTrimmedDuration getType getVisible getVolume getVolumeFadeInCurve getVolumeFadeInDuration getVolumeFadeOutCurve getVolumeFadeOutDuration getWrapMode hasCustomData hasName hasSprite hitTest init isActive isMuted isReady moveBy onPause onPlay onRenderDone onRenderStart onResize postRender preload removeAllEffectsByEffectId removeClipMask removeEffect removeFilter removeFreezeTime removeSubtitles render resetAllAnimationProperties resetAnimationPropertyValue serialize setAllCustomData setAnimationPropertyValue setBlendMode setCustomData setFreezeTime setInsideInTransition setInsideOutTransition setLayerId setLeftTrim setMuted setName setPerservePitch setPlaybackSpeed setRightTrim setStartTime setSubtitles setSubtitlesId setSubtitlesOffset setTransitionInId setTransitionOutId setVisible setVolume setVolumeFadeInCurve setVolumeFadeInDuration setVolumeFadeOutCurve setVolumeFadeOutDuration setWrapMode update updateMediaData updateVisibility deserialize

    Constructors

    Properties

    animationController: AnimationClass
    id: string
    sprite: Sprite
    state: ClipState
    style: ClipStyle

    Methods

    • Returns void

    • Parameters

      • muteAudio: boolean = true
      • createNewMediaData: boolean = true
      • audioTrackIndex: number = 0

      Returns Promise<null | AudioClip>

    • Parameters

      • options: { mimeType: string; quality: number } = ...

      Returns Promise<null | string>

    • Parameters

      • startTime: number
      • endTime: number

      Returns Promise<null | Float32Array<ArrayBufferLike>>

      Use getAudioSamples instead, don't forget to enable them in the settings

    • Returns undefined | Map<string, unknown>

    • Parameters

      • property: string

      Returns string | number

    • 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<ArrayBufferLike>[]

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

    • Parameters

      • key: string

      Returns unknown

    • 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.

    • 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.

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

      Returns MediaProcessStatusEnum

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

    • Returns string

    • Returns number

    • Returns undefined | string

    • Returns string

    • Returns boolean

    • Returns number

    • Returns number

    • Returns undefined | string

    • Returns string

    • Returns number

    • Returns number

    • Returns number

    • Parameters

      • key: string

      Returns boolean

    • Returns boolean

    • Parameters

      • point: { cursorX: number; cursorY: number }
      • OptionalignoreVisibility: boolean

      Returns boolean

    • Parameters

      • layerId: string

      Returns Promise<void>

    • Parameters

      • currentTime: number

      Returns boolean

    • Returns boolean

    • Returns boolean

    • Parameters

      • amount: number

      Returns void

    • Parameters

      • currentTime: number

      Returns Promise<void>

    • Parameters

      • currentTime: number

      Returns Promise<void>

    • Parameters

      • canceled: boolean

      Returns Promise<void>

    • Parameters

      • width: number
      • height: number

      Returns Promise<void>

    • Parameters

      • currentTime: number

        The current time of the timeline

      Returns void

      This is called after all the clips have been rendered in the preview, useful if you want to change some other clip states after rendering

    • Parameters

      • currentTime: number

      Returns void

    • Parameters

      • id: string

      Returns void

    • Parameters

      • id: string

      Returns void

    • Returns void

    • Parameters

      • currentTime: number

      Returns void

    • 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;
          }[];
          freezeTime?: number;
          id: string;
          isVisible: boolean;
          leftTrim: number;
          mediaDataId: string;
          muted?: boolean;
          name?: string;
          perservePitch: boolean;
          playbackSpeed: number;
          rightTrim: number;
          startTime: number;
          style?: unknown;
          subtitlesId?: string;
          subtitlesOffset: number;
          text?: string;
          type: string;
          volume?: number;
          volumeFadeInCurve: FadeCurveEnum;
          volumeFadeInDuration: number;
          volumeFadeOutCurve: FadeCurveEnum;
          volumeFadeOutDuration: number;
          wrapMode?: CLAMP
          | REPEAT
          | PING_PONG
          | EMPTY;
      }

    • Parameters

      • data: Map<string, unknown>

      Returns void

    • Parameters

      • property: string
      • value: any

      Returns void

    • Parameters

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

      Returns boolean

    • Parameters

      • Optionaltime: number

      Returns void

    • Parameters

      • insideTransition: boolean

      Returns void

    • Parameters

      • insideTransition: boolean

      Returns void

    • Parameters

      • layerId: string

      Returns void

    • Parameters

      • trim: number

      Returns void

    • Parameters

      • muted: boolean

      Returns void

    • Parameters

      • name: string

      Returns void

    • Parameters

      • perservePitch: boolean

      Returns void

    • Parameters

      • speed: number
      • perserveLeftBound: boolean = true
      • perserveTrimmedDuration: boolean = false

      Returns void

    • Parameters

      • trim: number

      Returns void

    • Parameters

      • startTime: number

      Returns void

    • Parameters

      • subtitlesId: string
      • offset: number = 0

      Returns void

    • Parameters

      • subtitlesId: string

      Returns void

    • Parameters

      • offset: number

      Returns void

    • Parameters

      • transitionId: null | string

      Returns void

    • Parameters

      • transitionId: null | string

      Returns void

    • Parameters

      • visible: boolean

      Returns void

    • Parameters

      • volume: number

      Returns void

    • Parameters

      • duration: number

      Returns void

    • Parameters

      • duration: number

      Returns void

    • Parameters

      • currentTime: number

      Returns void

    • Parameters

      • currentTime: number

      Returns void