@osbjs/osbjs/dist/Core/Components/Sample.d.ts

a minimalist osu! storyboarding framework

import { SampleLayer } from '../Enums';
import { Component } from './Component';
export declare class Sample extends Component {
    layer: SampleLayer;
    path: string;
    volume: number;
    startTime: number;
    name: string;
    /**
     *
     * @param startTime Time in milliseconds/timestamp that the sound should start playing.
     * @param layer The layer you want the sound to be on.
     * @param path Path to the audio file relative to the beatmap folder.
     * @param volume Volume (1-100) of the sound file.
     */
    constructor(startTime: number | string, layer: SampleLayer, path: AudioPath, volume?: number);
    getOsbString(): string;
    registerComponents(): void;
}
export declare type AudioPath = `${string}.mp3` | `${string}.ogg` | `${string}.wav`;