Class Library

constructor

• new Library(): Library

  Returns Library

builtInEffects

effects

filters

media

subtitles

transitions

addEffect

• addEffect(options: EffectDataOptions): Promise<string>

  Parameters

  • options: EffectDataOptions

  Returns Promise<string>

addFilter

• addFilter(options: FilterDataOptions): Promise<string>

  Parameters

  • options: FilterDataOptions

  Returns Promise<string>

addMedia

• addMedia(
      source: string | Uint8Array<ArrayBufferLike> | File,
      mimeType?: string,
      filename?: string,
  ): Promise<null | string>

  Parameters

  • source: string | Uint8Array<ArrayBufferLike> | File
  • OptionalmimeType: string
  • Optionalfilename: string

  Returns Promise<null | string>

addSerializedMedia

• addSerializedMedia(data: any): Promise<string>

  Parameters

  • data: any

  Returns Promise<string>

addSubtitles

• addSubtitles(subtitles: Subtitles): string

  Parameters

  • subtitles: Subtitles

  Returns string

addTransition

• addTransition(options: TransitionDataOptions): Promise<string>

  Parameters

  • options: TransitionDataOptions

  Returns Promise<string>

clearAllCustomData

• clearAllCustomData(): void

  Returns void

createBuiltInEffects

• createBuiltInEffects(): Promise<void>

  Returns Promise<void>

createFilmstripWorker

• createFilmstripWorker(mediaId: string): Promise<void>

  Parameters

  • mediaId: string

  Returns Promise<void>

deleteMedia

• deleteMedia(id: string): Promise<void>

  Parameters

  • id: string

  Returns Promise<void>

destroy

• destroy(): Promise<void>

  Returns Promise<void>

extractAudioFromMedia

• extractAudioFromMedia(
      mediaId: string,
      audioTrackIndex?: number,
  ): Promise<null | string>

  Parameters

  • mediaId: string
  • audioTrackIndex: number = 0

  Returns Promise<null | string>

getAllCustomData

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

  Returns undefined | Map<string, unknown>

getAllEffectIds

• getAllEffectIds(): string[]

  Returns string[]

getBuiltInEffectIds

• getBuiltInEffectIds(): string[]

  Returns string[]

getCustomData

• getCustomData(key: string): unknown

  Parameters

  • key: string

  Returns unknown

getEffectById

• getEffectById(id: string): undefined | EffectData

  Parameters

  • id: string

  Returns undefined | EffectData

getFilterById

• getFilterById(id: string): undefined | FilterData

  Parameters

  • id: string

  Returns undefined | FilterData

getFilterIds

• getFilterIds(): string[]

  Returns string[]

getMediaById

• getMediaById(id: string): undefined | MediaData

  Parameters

  • id: string

  Returns undefined | MediaData

getRegisteredEffectIds

• getRegisteredEffectIds(): string[]

  Returns string[]

getSubtitlesById

• getSubtitlesById(id: string): undefined | Subtitles

  Parameters

  • id: string

  Returns undefined | Subtitles

getSubtitlesIds

• getSubtitlesIds(): string[]

  Returns string[]

getTransitionById

• getTransitionById(id: string): undefined | TransitionData

  Parameters

  • id: string

  Returns undefined | TransitionData

getTransitionIds

• getTransitionIds(): string[]

  Returns string[]

hasCustomData

• hasCustomData(key: string): boolean

  Parameters

  • key: string

  Returns boolean

init

• init(): Promise<void>

  Returns Promise<void>

isProcessing

• isProcessing(): boolean

  Returns boolean

probeMediaData

• probeMediaData(
      file: string | Uint8Array<ArrayBufferLike> | File,
  ): Promise<null | MediaInfo>

  Parameters

  • file: string | Uint8Array<ArrayBufferLike> | File

  Returns Promise<null | MediaInfo>

removeEffect

• removeEffect(id: string): void

  Parameters

  • id: string

  Returns void

removeFilter

• removeFilter(id: string): void

  Parameters

  • id: string

  Returns void

removeSubtitles

• removeSubtitles(id: string): void

  Parameters

  • id: string

  Returns void

removeTransition

• removeTransition(id: string): void

  Parameters

  • id: string

  Returns void

removeUnusedAssets

• removeUnusedAssets(): Promise<void>

  Returns Promise<void>

removeUnusedEffects

• removeUnusedEffects(): void

  Returns void

removeUnusedFilters

• removeUnusedFilters(): void

  Returns void

removeUnusedMedia

• removeUnusedMedia(): Promise<void>

  Returns Promise<void>

removeUnusedSubtitles

• removeUnusedSubtitles(): void

  Returns void

removeUnusedTransitions

• removeUnusedTransitions(): void

  Returns void

replaceMedia

• replaceMedia(
      id: string,
      file: string | Uint8Array<ArrayBufferLike> | File,
      replaceOptions?: ReplaceMediaOptions,
  ): Promise<boolean>

  Parameters

  • id: string
  • file: string | Uint8Array<ArrayBufferLike> | File
  • OptionalreplaceOptions: ReplaceMediaOptions

  Returns Promise<boolean>

replaceSerializedMedia

• replaceSerializedMedia(data: any): Promise<boolean>

  Parameters

  • data: any

  Returns Promise<boolean>

serialize

• serialize(): {
      customData?: [string, unknown][];
      effects: {
          autoFit?: boolean;
          blendMode?: NORMAL | ADD | SCREEN | MULTIPLY;
          fragmentSrc: string;
          id: string;
          inputTextures?: {
              mipmap?: OFF | ON;
              name: string;
              scaleMode?: NEAREST | LINEAR;
              url: string;
              wrapMode?: CLAMP | REPEAT | MIRRORED_REPEAT;
          }[];
          name: string;
          noTransform?: boolean;
          padding?: number;
          properties: {
              defaultValue: Required<any>;
              description?: string;
              initOnly?: boolean;
              label?: string;
              max?: number | number[];
              min?: number | number[];
              name: string;
              step?: number | number[];
              type: PropertyDescriptionTypeEnum;
          }[];
          provider: string;
      }[];
      filters: { id: string; lutUrl: string; name: string; provider: string }[];
      media: {
          customData?: [string, unknown][];
          filename: string;
          hash?: string;
          id: string;
          mimeType?: string;
          name?: string;
          permanentUrl?: string;
          placeholderClipIds?: string[];
          type: string;
      }[];
      subtitles: {
          duration: number;
          id: string;
          language: string;
          textBlocks: {
              duration: number;
              text: string;
              time: number;
              wordTimings?: number[];
          }[];
      }[];
      transitions: {
          id: string;
          inputTextures?: {
              mipmap?: OFF
              | ON;
              name: string;
              scaleMode?: NEAREST | LINEAR;
              url: string;
              wrapMode?: CLAMP | REPEAT | MIRRORED_REPEAT;
          }[];
          name: string;
          properties: {
              defaultValue: Required<any>;
              description?: string;
              initOnly?: boolean;
              label?: string;
              max?: number | number[];
              min?: number | number[];
              name: string;
              step?: number | number[];
              type: PropertyDescriptionTypeEnum;
          }[];
          provider: string;
          transitionSrc: string;
      }[];
  }

  Returns {
      customData?: [string, unknown][];
      effects: {
          autoFit?: boolean;
          blendMode?: NORMAL | ADD | SCREEN | MULTIPLY;
          fragmentSrc: string;
          id: string;
          inputTextures?: {
              mipmap?: OFF | ON;
              name: string;
              scaleMode?: NEAREST | LINEAR;
              url: string;
              wrapMode?: CLAMP | REPEAT | MIRRORED_REPEAT;
          }[];
          name: string;
          noTransform?: boolean;
          padding?: number;
          properties: {
              defaultValue: Required<any>;
              description?: string;
              initOnly?: boolean;
              label?: string;
              max?: number | number[];
              min?: number | number[];
              name: string;
              step?: number | number[];
              type: PropertyDescriptionTypeEnum;
          }[];
          provider: string;
      }[];
      filters: { id: string; lutUrl: string; name: string; provider: string }[];
      media: {
          customData?: [string, unknown][];
          filename: string;
          hash?: string;
          id: string;
          mimeType?: string;
          name?: string;
          permanentUrl?: string;
          placeholderClipIds?: string[];
          type: string;
      }[];
      subtitles: {
          duration: number;
          id: string;
          language: string;
          textBlocks: {
              duration: number;
              text: string;
              time: number;
              wordTimings?: number[];
          }[];
      }[];
      transitions: {
          id: string;
          inputTextures?: {
              mipmap?: OFF
              | ON;
              name: string;
              scaleMode?: NEAREST | LINEAR;
              url: string;
              wrapMode?: CLAMP | REPEAT | MIRRORED_REPEAT;
          }[];
          name: string;
          properties: {
              defaultValue: Required<any>;
              description?: string;
              initOnly?: boolean;
              label?: string;
              max?: number | number[];
              min?: number | number[];
              name: string;
              step?: number | number[];
              type: PropertyDescriptionTypeEnum;
          }[];
          provider: string;
          transitionSrc: string;
      }[];
  }

setAllCustomData

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

  Parameters

  • data: Map<string, unknown>

  Returns void

setCustomData

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

  Parameters

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

  Returns boolean

storeAllMedia

• storeAllMedia(): Promise<void>

  Returns Promise<void>

  Deprecated

  Use syncAllMedia instead, that will also remove media that are not in the library Stores all media data in the library using the storage controller. Initiates a batch operation, attempts to store each media asynchronously, and ensures that all operations are completed. If any error occurs during the process, it logs the error. Finally, it ends the batch operation.

syncAllMedia

• syncAllMedia(): Promise<void>

  Syncs all media data in the library with the storage controller. Stores all media data in the library using the storage controller. Removes media that are not in the library. Initiates a batch operation, attempts to store each media asynchronously, removes media that are not in the library asynchronously, and ensures that all operations are completed. If any error occurs during the process, it logs the error. Finally, it ends the batch operation.

  Returns Promise<void>

Staticdeserialize

• deserialize(data: object): Library

  Parameters

  • data: object

  Returns Library