@advjs/monorepo / @advjs/client / useAdvBgm

Function: useAdvBgm()

useAdvBgm($adv): object

Defined in: packages/client/composables/useAdvBgm.ts:12

adv bgm system & utilities

Parameters

$adv

AdvContext

Returns

isMuted

isMuted: Ref<boolean, boolean>

pauseBgm

pauseBgm: (bgmId) => void

Parameters

bgmId

string

Returns

void

pauseBgmBySrc

pauseBgmBySrc: (src) => void

pause bgm by src

Parameters

src

string

Returns

void

playBgm

playBgm: (bgmId) => void

播放指定的背景音乐

Parameters

bgmId

string

Returns

void

playBgmBySrc

playBgmBySrc: (src) => void

play bgm by src

Parameters

src

string

Returns

void

stopBgm

stopBgm: (bgmId) => void

Parameters

bgmId

string

Returns

void

stopBgmBySrc

stopBgmBySrc: (src) => void

stop bgm by src

Parameters

src

string

Returns

void

stopOtherBgmBySrc

stopOtherBgmBySrc: (src) => void

停止之外的所有背景音乐

Parameters

src

string

Returns

void

mute()

mute(): void

mute

Returns

void

play()

play(): void

Returns

void

stop()

stop(): void

stop all bgms

Returns

void

toggleMute()

toggleMute(): void

切换静音状态

Returns

void

unmute()

unmute(): void

解除静音

Returns

void