rooks
Version:
Essential React custom hooks ⚓ to super charge your components!
32 lines • 828 B
TypeScript
/**
* useAudio
* @description Audio hook
* @see {@link https://rooks.vercel.app/docs/useAudio}
*/
import { RefCallback } from "react";
type UseAudioOptions = {
autoPlay?: boolean;
isMuted?: boolean;
};
type UseAudioCallbacks = {
onPlay?: () => void;
onPause?: () => void;
onMute?: () => void;
onUnmute?: () => void;
onLoadedMetadata?: () => void;
};
type AudioState = {
isPlaying: boolean;
isMuted: boolean;
};
type AudioControls = {
play: () => void;
pause: () => void;
togglePlay: () => void;
mute: () => void;
unmute: () => void;
toggleMute: () => void;
};
declare function useAudio(options?: UseAudioOptions, callbacks?: UseAudioCallbacks): [RefCallback<HTMLAudioElement>, AudioState, AudioControls];
export { useAudio };
//# sourceMappingURL=useAudio.d.ts.map