文档
核心
元素
声音

声音

⚠️

本页面正在建设中

⚠️

测试功能，可能会有变动

Sound 控制游戏中的声音

静态方法

voice

创建一个语音声音

const voice = Sound.voice({
    src: 'voice.mp3',
});
 
// 等同于
const voice = new Sound({
    src: 'voice.mp3',
    type: SoundType.Voice,
});
  • arg0: Partial<ISoundUserConfig> | string - 声音的配置或声音源，参见 ISoundUserConfig
  • 返回 Sound

bgm

创建一个背景音乐

  • arg0: Partial<ISoundUserConfig> | string - 声音的配置或声音源，参见 ISoundUserConfig
  • 返回 Sound

sound

创建一个声音

  • arg0: Partial<ISoundUserConfig> | string - 声音的配置或声音源，参见 ISoundUserConfig
  • 返回 Sound

公共方法

constructor

重载 1 / 2

重载 2 / 2

  • src?: string - 声音的源文件路径

可链式方法

play

播放声音并等待其结束

提示: 标记为 Bgm 的声音不能直接播放。

const sound = new Sound({
    src: 'sound.mp3',
});
scene.action([
    sound.play(1000), // 播放并淡入 1 秒
]);
  • duration?: number - 淡入淡出持续时间（以毫秒为单位）

stop

停止声音。停止后，声音将回到开头

  • duration?: number - 淡入淡出持续时间（以毫秒为单位）

fade

淡入淡出声音

  • start: number | undefined - 起始音量，从 0 到 1，默认为当前音量
  • end: number - 结束音量，从 0 到 1
  • duration: number - 持续时间（以毫秒为单位）
const sound = new Sound({
    src: 'sound.mp3',
    volume: 0,
});
scene.action([
    sound
        .play()
        .fade(0, 1, 1000), // 淡入 1 秒
]);

setVolume

设置声音的音量

  • volume: number - 音量，从 0 到 1
  • duration?: number - 淡入淡出持续时间（以毫秒为单位）

setRate

设置声音的播放速率

  • rate: number - 速率，基准为 1

pause

暂停声音

  • duration?: number - 淡入淡出持续时间（以毫秒为单位）

resume

恢复播放声音

  • fade?: number - 淡入淡出持续时间（以毫秒为单位）
图片选项