@advjs/monorepo / client / useAudioStore

Function: useAudioStore()

useAudioStore(pinia?, hot?): Store<"audio", Pick<{ curBgm: ReturnedValue; isMusicMuted: Ref<boolean, boolean>; isSoundMuted: Ref<boolean, boolean>; musicVolume: Ref<number, number>; popDown: ReturnedValue; popUpOff: ReturnedValue; popUpOn: ReturnedValue; reset: () => void; setBgm: (url) => void; soundVolume: Ref<number, number>; toggleBgm: () => void; toggleMusicMuted: (value?) => boolean; toggleSoundMuted: (value?) => boolean; }, "curBgm" | "isMusicMuted" | "isSoundMuted" | "musicVolume" | "soundVolume" | "popDown" | "popUpOff" | "popUpOn">, Pick<{ curBgm: ReturnedValue; isMusicMuted: Ref<boolean, boolean>; isSoundMuted: Ref<boolean, boolean>; musicVolume: Ref<number, number>; popDown: ReturnedValue; popUpOff: ReturnedValue; popUpOn: ReturnedValue; reset: () => void; setBgm: (url) => void; soundVolume: Ref<number, number>; toggleBgm: () => void; toggleMusicMuted: (value?) => boolean; toggleSoundMuted: (value?) => boolean; }, never>, Pick<{ curBgm: ReturnedValue; isMusicMuted: Ref<boolean, boolean>; isSoundMuted: Ref<boolean, boolean>; musicVolume: Ref<number, number>; popDown: ReturnedValue; popUpOff: ReturnedValue; popUpOn: ReturnedValue; reset: () => void; setBgm: (url) => void; soundVolume: Ref<number, number>; toggleBgm: () => void; toggleMusicMuted: (value?) => boolean; toggleSoundMuted: (value?) => boolean; }, "reset" | "setBgm" | "toggleBgm" | "toggleMusicMuted" | "toggleSoundMuted">>

Defined in: packages/client/stores/audio.ts:12

audio system store

Parameters

pinia?

Pinia instance to retrieve the store

null | Pinia

hot?

StoreGeneric

dev only hot module replacement

Returns

Store<"audio", Pick<{ curBgm: ReturnedValue; isMusicMuted: Ref<boolean, boolean>; isSoundMuted: Ref<boolean, boolean>; musicVolume: Ref<number, number>; popDown: ReturnedValue; popUpOff: ReturnedValue; popUpOn: ReturnedValue; reset: () => void; setBgm: (url) => void; soundVolume: Ref<number, number>; toggleBgm: () => void; toggleMusicMuted: (value?) => boolean; toggleSoundMuted: (value?) => boolean; }, "curBgm" | "isMusicMuted" | "isSoundMuted" | "musicVolume" | "soundVolume" | "popDown" | "popUpOff" | "popUpOn">, Pick<{ curBgm: ReturnedValue; isMusicMuted: Ref<boolean, boolean>; isSoundMuted: Ref<boolean, boolean>; musicVolume: Ref<number, number>; popDown: ReturnedValue; popUpOff: ReturnedValue; popUpOn: ReturnedValue; reset: () => void; setBgm: (url) => void; soundVolume: Ref<number, number>; toggleBgm: () => void; toggleMusicMuted: (value?) => boolean; toggleSoundMuted: (value?) => boolean; }, never>, Pick<{ curBgm: ReturnedValue; isMusicMuted: Ref<boolean, boolean>; isSoundMuted: Ref<boolean, boolean>; musicVolume: Ref<number, number>; popDown: ReturnedValue; popUpOff: ReturnedValue; popUpOn: ReturnedValue; reset: () => void; setBgm: (url) => void; soundVolume: Ref<number, number>; toggleBgm: () => void; toggleMusicMuted: (value?) => boolean; toggleSoundMuted: (value?) => boolean; }, "reset" | "setBgm" | "toggleBgm" | "toggleMusicMuted" | "toggleSoundMuted">>