Skip to main content

Type Alias: SoundRef

type SoundRef = {
  value: AssetRef<Sound>;
  volume: Float;
  pan: Float;
  playSpeed: Float;
  minDistance: Float;
  maxDistance: Float;
  dopplerFactor: Float;
  attenuationRolloffFactor: Float;
  attenuationModel: UInt8;
  inaudibleBehavior: UInt8;
  playState: UInt8;
  looping: boolean;
  autoPlayOnStart: boolean;
};

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/components.d.ts:941

Reference to a sound asset with playback and spatialization controls.

Properties​

value​

value: AssetRef<Sound>;

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/components.d.ts:945

Referenced sound (UUID).

volume​

volume: Float;

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/components.d.ts:950

Playback volume [0..1].

Default Value​

1;

pan​

pan: Float;

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/components.d.ts:955

Stereo pan. −1 = left, 1 = right.

Default Value​

0;

playSpeed​

playSpeed: Float;

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/components.d.ts:960

Playback speed multiplier (1.0 = normal).

Default Value​

1;

minDistance​

minDistance: Float;

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/components.d.ts:965

Distance at which the sound stays at max volume (meters).

Default Value​

5;

maxDistance​

maxDistance: Float;

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/components.d.ts:970

Distance beyond which the sound is inaudible (meters).

Default Value​

50;

dopplerFactor​

dopplerFactor: Float;

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/components.d.ts:975

Scale factor for the Doppler effect.

Default Value​

1;

attenuationRolloffFactor​

attenuationRolloffFactor: Float;

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/components.d.ts:980

Rolloff factor for distance attenuation.

Default Value​

1;

attenuationModel​

attenuationModel: UInt8;

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/components.d.ts:985

Distance attenuation model.

Default Value​

0;

inaudibleBehavior​

inaudibleBehavior: UInt8;

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/components.d.ts:990

Behavior when the sound becomes inaudible.

Default Value​

0;

playState​

playState: UInt8;

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/components.d.ts:995

Playback state.

Default Value​

0;

looping​

looping: boolean;

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/components.d.ts:1000

Whether the sound loops.

Default Value​

false;

autoPlayOnStart​

autoPlayOnStart: boolean;

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/components.d.ts:1005

Autoplay when the simulation starts.

Default Value​

false;