Type Alias SoundComponent

SoundComponent: {
    distanceModel: string;
    enabled: boolean;
    maxDistance: number;
    pitch: number;
    positional: boolean;
    refDistance: number;
    rollOffFactor: number;
    slots: {
        [key: string]: {
            asset: number;
            autoPlay: boolean;
            duration: number;
            loop: boolean;
            name: string;
            overlap: boolean;
            pitch: number;
            startTime: number;
            volume: number;
        };
    };
    volume: number;
}

Sound Component Properties.

Type declaration

distanceModel: string
Algorithm to use for audio volume falloff. Can be: "inverse", "linear", "exponential".
Default
```
"linear"
```
enabled: boolean
Whether the component is enabled.
Default
```
true
```
maxDistance: number
Maximum distance at which audio falloff stops.
Default
```
10000
```
pitch: number
The pitch for audio playback. Multiplied with slot pitch values.
Default
```
1
```
positional: boolean
If true, audio is played as 3D sound.
Default
```
true
```
refDistance: number
Reference distance for reducing audio volume.
Default
```
1
```
rollOffFactor: number
Rate at which the audio volume falls off.
Default
```
1
```
slots: {
    [key: string]: {
        asset: number;
        autoPlay: boolean;
        duration: number;
        loop: boolean;
        name: string;
        overlap: boolean;
        pitch: number;
        startTime: number;
        volume: number;
    };
}
Dictionary of sound slots, each controlling playback of an audio asset.
volume: number
Overall volume modifier for the component.
Default
```
1
```

Type Alias SoundComponent

Type declaration

distanceModel: string

Default

enabled: boolean

Default

maxDistance: number

Default

pitch: number

Default

positional: boolean

Default

refDistance: number

Default

rollOffFactor: number

Default

slots: { [key: string]: { asset: number; autoPlay: boolean; duration: number; loop: boolean; name: string; overlap: boolean; pitch: number; startTime: number; volume: number; };}

volume: number

Default

Settings

slots: {
[key: string]: {
asset: number;
autoPlay: boolean;
duration: number;
loop: boolean;
name: string;
overlap: boolean;
pitch: number;
startTime: number;
volume: number;
};
}