Timeline Studio API Documentation - v0.26.0
    Preparing search index...

    Interface EffectsProviderAPI

    API для работы с ресурсами

    interface EffectsProviderAPI {
        clearCache(type?: ResourceType): void;
        clearSourceCache(source: ResourceSource): void;
        getCacheSize(): number;
        getEffects(source?: ResourceSource): VideoEffect[];
        getFilters(source?: ResourceSource): VideoFilter[];
        getLoadingState(): LoadingState;
        getResourceById(type: ResourceType, id: string): any;
        getResources<T extends any>(
            type: ResourceType,
            source?: ResourceSource,
        ): T[];
        getResourcesByCategory<T extends any>(
            type: ResourceType,
            category: string,
        ): T[];
        getResourcesByComplexity<T extends any>(
            type: ResourceType,
            complexity: string,
        ): T[];
        getResourcesByTags<T extends any>(type: ResourceType, tags: string[]): T[];
        getSourceConfig(source: ResourceSource): SourceConfig;
        getStats(): ResourceStats;
        getTransitions(source?: ResourceSource): Transition[];
        invalidateCache(): void;
        isSourceLoaded(source: ResourceSource): boolean;
        loadSource(source: ResourceSource): Promise<LoadResult<any[]>>;
        onError(
            callback: (error: string, source?: ResourceSource) => void,
        ): () => void;
        onLoadingStateChange(callback: (state: LoadingState) => void): () => void;
        onResourcesUpdate(
            callback: (type: ResourceType, resources: any[]) => void,
        ): () => void;
        preloadCategory(
            type: ResourceType,
            category: string,
        ): Promise<LoadResult<any[]>>;
        refreshSource(source: ResourceSource): Promise<LoadResult<any[]>>;
        searchResources<T extends any>(
            type: ResourceType,
            options: SearchOptions,
        ): T[];
        updateSourceConfig(
            source: ResourceSource,
            config: Partial<SourceConfig>,
        ): void;
    }
    Index

    Methods

    clearCache clearSourceCache getCacheSize getEffects getFilters getLoadingState getResourceById getResources getResourcesByCategory getResourcesByComplexity getResourcesByTags getSourceConfig getStats getTransitions invalidateCache isSourceLoaded loadSource onError onLoadingStateChange onResourcesUpdate preloadCategory refreshSource searchResources updateSourceConfig

    Methods

    Settings

    Member Visibility

    On This Page

    Methods