# Audio组件

使用Audio组件可以为实体添加声音效果。

import { Audio, Entity } from '@tx3d/core';

// 创建一个空实体
const entity = engine.createEntity();

// 添加Audio组件
const audio = entity.addComponent( Audio, {

    audio: 'assets/audios/SuperMarioBros.mp3',
    loop: true,
    autoplay: true,
    positional: true

} );

1
2
3
4
5
6
7
8
9
10
11
12
13
14

提示

Audio组件初始化参数，详见AudioParameters。

# 属性

🌏 volume 音量控制

// 获取音量
const volume = audio.volume;

// 设置音量
audio.volume = 0.75;

1
2
3
4
5

注意

volume取值在[ 0.0 ~ 1.0 ]区间

🌏 loop 是否循环播放

// 获取是否循环播放
const loop = audio.loop;

// 设置是否循环播放
audio.loop = false;

1
2
3
4
5

🌏 isPlaying 是否正在播放，只读。

// 获取是否正在播放
const isPlaying = audio.isPlaying;

1
2

# 接口

🌏 play 播放音频

// 播放引擎
audio.play();

1
2

🌏 pause 暂停播放音频

// 暂停播放音频
audio.pause();

1
2

🌏 stop 停止播放音频

// 停止播放音频
audio.stop();

1
2

← Annotation组件 Bar组件 →