Class Library

Constructors

Properties

builtInEffects: Record<string, EffectData> = {}
effects: Record<string, EffectData>
filters: Record<string, FilterData>
media: Record<string, MediaData>
subtitles: Record<string, Subtitles>
transitions: Record<string, TransitionData>

Methods

  • Parameters

    • source: string | Uint8Array | File
    • OptionalmimeType: string
    • Optionalfilename: string

    Returns Promise<null | string>

  • Parameters

    • data: any

    Returns Promise<string>

  • Returns Promise<void>

  • Parameters

    • mediaId: string

    Returns Promise<void>

  • Parameters

    • id: string

    Returns Promise<void>

  • Returns Promise<void>

  • Parameters

    • mediaId: string

    Returns Promise<null | string>

  • Returns string[]

  • Returns string[]

  • Returns string[]

  • Parameters

    • id: string

    Returns undefined | MediaData

  • Returns string[]

  • Parameters

    • id: string

    Returns undefined | Subtitles

  • Returns string[]

  • Returns string[]

  • Returns Promise<void>

  • Returns boolean

  • Parameters

    • id: string

    Returns void

  • Parameters

    • id: string

    Returns void

  • Parameters

    • id: string

    Returns void

  • Parameters

    • id: string

    Returns void

  • Returns Promise<void>

  • Returns void

  • Returns void

  • Returns Promise<void>

  • Returns void

  • Returns void

  • Parameters

    • id: string
    • file: string | Uint8Array | File
    • OptionalmimeType: string

    Returns Promise<boolean>

  • Parameters

    • data: any

    Returns Promise<boolean>

  • Returns {
        effects: {
            fragmentSrc: string;
            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;
                label?: string;
                name: string;
                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 }[];
        }[];
        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;
                label?: string;
                name: string;
                type: PropertyDescriptionTypeEnum;
            }[];
            provider: string;
            transitionSrc: string;
        }[];
    }

  • Returns Promise<void>

    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.

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

  • Parameters

    • data: object

    Returns Library