类 SoundManager

En

The SoundManager is a sound management class. It provides control methods for playing background music and sound effects.

  • The engine has two default sound schemes: WebAudio and H5Audio.
  • For playing sound effects, WebAudio is prioritized. If WebAudio is not available, H5Audio is used. H5Audio may have compatibility issues on some devices (such as inability to mix sounds or playback delays).
  • For playing background music, H5Audio is used (using WebAudio would significantly increase memory usage and cause a delay as it needs to wait for the sound to load completely before playing).
  • It is recommended to use mp3 format for background music and wav or mp3 format for sound effects (if packaging as an app, only wav format can be used for sound effects).

Zh

SoundManager 是一个声音管理类。提供了对背景音乐、音效的播放控制方法。

  • 引擎默认有两套声音方案：WebAudio和H5Audio。
  • 播放音效时，优先使用WebAudio播放声音，如果WebAudio不可用，则用H5Audio播放。H5Audio在部分机器上有兼容问题（比如不能混音，播放有延迟等）。
  • 播放背景音乐时，则使用H5Audio播放（使用WebAudio会增加特别大的内存，并且要等加载完毕后才能播放，有延迟）。
  • 建议背景音乐用mp3类型，音效用wav或者mp3类型（如果打包为app，音效只能用wav格式）。

构造函数

constructor

属性

_bgMusic _musicChannel autoReleaseSound musicVolume playbackRate soundVolume

访问器

autoStopMusic musicMuted muted soundMuted useAudioMusic

方法

addChannel destroySound disposeSoundIfNotUsed disposeSoundLater playMusic playSound removeChannel setMusicVolume setSoundVolume stopAll stopAllSound stopMusic stopSound

构造函数

constructor

属性

静态_bgMusic

_bgMusic: string = null

En

The current background music URL.

Zh

当前背景音乐 URL。

静态_musicChannel

_musicChannel: SoundChannel = null

En

The current background music channel.

Zh

当前背景音乐声道。

静态autoReleaseSound

autoReleaseSound: boolean = true

En

Automatically delete sound effects after playing.default value is true.

Zh

音效播放后自动删除。默认值是 true。

静态musicVolume

musicVolume: number = 1

En

Background music volume. default value is 1.

Zh

背景音乐音量。默认值为1。

静态playbackRate

playbackRate: number = 1

En

Sound playback rate. default value is 1.

Zh

声音播放速率。默认值为1。

静态soundVolume

soundVolume: number = 1

En

Sound effect volume. default value is 1.

Zh

音效音量。默认值为1。

访问器

静态autoStopMusic

静态musicMuted

静态muted

静态soundMuted

静态useAudioMusic

方法

静态addChannel

静态destroySound

静态disposeSoundIfNotUsed

静态disposeSoundLater

静态playMusic

  • playMusic(
        url: string,
        loops?: number,
        complete?: Handler,
        startTime?: number,
    ): SoundChannel

    参数

    • url: string

      The URL of the sound file.

    • loops: number = 0

      The number of times to loop the music. 0 means infinite loop.

    • complete: Handler = null

      The callback function when the music playback is complete. The result parameter is true if playback is completed, false/undefined if triggered by stop.

    • startTime: number = 0

      The start time of the music playback.

    返回 SoundChannel

    A SoundChannel object, through which you can control the sound and get sound information.

    En

    Play background music. Only one background music can be played at a time. If this method is called while background music is already playing, the previous music will be stopped before playing the current one.

    Zh

    播放背景音乐。背景音乐同时只能播放一个，如果在播放背景音乐时再次调用本方法，会先停止之前的背景音乐，再播放当前的背景音乐。

静态playSound

  • playSound(
        url: string,
        loops?: number,
        complete?: Handler,
        soundClass?: new () => any,
        startTime?: number,
        volume?: number,
    ): SoundChannel

    参数

    • url: string

      The URL of the sound file.

    • loops: number = 1

      The number of times to loop the sound. 0 means infinite loop.

    • complete: Handler = null

      The callback function when the sound playback is complete. It should be a Handler object.

    • soundClass: new () => any = null

      The sound class to use for playback. If null, it will be automatically selected.

    • startTime: number = 0

      The start time of the sound playback.

    • 可选volume: number

      The volume of the sound. The range is from 0 to 1.

    返回 SoundChannel

    A SoundChannel object, through which you can control the sound and get sound information.

    En

    Play a sound effect. Multiple sound effects can be played simultaneously.

    Zh

    播放音效。音效可以同时播放多个。

静态removeChannel

静态setMusicVolume

  • setMusicVolume(volume: number): void

    参数

    • volume: number

      The volume. Initial value is 1. Volume range is from 0 (mute) to 1 (maximum volume).

    返回 void

    En

    Set the volume of background music. Volume range is from 0 (mute) to 1 (maximum volume).

    Zh

    设置背景音乐音量。音量范围从 0（静音）至 1（最大音量）。

静态setSoundVolume

  • setSoundVolume(volume: number, url?: string): void

    参数

    • volume: number

      The volume. Initial value is 1. Volume range is from 0 (mute) to 1 (maximum volume).

    • url: string = null

      (default = null) The URL of the sound file. If null, it sets the volume for all sound effects (excluding background music). If not null, it sets the volume for the specified sound (background music or sound effect).

    返回 void

    En

    Set the volume of sounds. Depending on the parameters, it can set the volume for a specific sound (background music or sound effect) or all sound effects (excluding background music).

    Zh

    设置声音音量。根据参数不同，可以分别设置指定声音（背景音乐或音效）音量或者所有音效（不包括背景音乐）音量。

静态stopAll

  • stopAll(): void

    返回 void

    En

    Stop playing all sounds (including background music and sound effects).

    Zh

    停止播放所有声音（包括背景音乐和音效）。

静态stopAllSound

静态stopMusic

静态stopSound

  • stopSound(url: string): void

    参数

    • url: string

      The URL of the sound file.

    返回 void

    En

    Stop playing a specific sound. This method can stop the playback of any sound (including background music and sound effects) by providing the corresponding sound file address.

    Zh

    停止声音播放。此方法能够停止任意声音的播放（包括背景音乐和音效），只需传入对应的声音播放地址。

显示设置

成员可见性

目录

构造函数
属性
访问器
方法