use-sound
Version:
### A React Hook for Sound Effects
24 lines (23 loc) • 644 B
TypeScript
/// <reference types="howler" />
export declare type SpriteMap = {
[key: string]: [number, number];
};
export interface HookOptions {
volume?: number;
playbackRate?: number;
interrupt?: boolean;
soundEnabled?: boolean;
sprite?: SpriteMap;
}
export interface PlayOptions {
id?: string;
forceSoundEnabled?: boolean;
playbackRate?: number;
}
export declare type PlayFunction = (options: PlayOptions) => void;
export interface ExposedData {
sound: Howl | null;
stop: (id?: number) => void;
isPlaying: boolean;
}
export declare type ReturnedValue = [PlayFunction, ExposedData];