@osbjs/components/dist/Lyrics.d.ts

osbjs pre-built components

import { Component } from '@osbjs/osbjs';
import { IColor } from '@osbjs/txtgen';
export declare class Lyrics extends Component {
    name: string;
    folderPath: string;
    osbFolderPath: string;
    options: LyricsOptions;
    private _textureGenerator;
    private _subtitleCollection;
    constructor(folderPath: string, osbFolderPath: string, subtitlePath: string, options?: LyricsOptions, registerFontOptions?: FontOptions);
    generate(): void;
    private _generatePerChar;
    private _generatePerLine;
}
export interface LyricsOptions {
    fadeDuration: number;
    opacity: number;
    fontName: string;
    fontSize: number;
    fontScale: number;
    perCharacter: boolean;
    y: number;
    additive: boolean;
    color: IColor;
}
export interface FontOptions {
    fontPath: string;
    family: string;
}