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:923

Reference to a sound.

Properties​

value​

value: AssetRef<Sound>;

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

UUID of the referenced sound.

volume​

volume: Float;

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

Volume from 0.0f to 1.0.

Default Value​

1;

pan​

pan: Float;

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

Pan. -1.0 is left, 1.0 is right.

Default Value​

0;

playSpeed​

playSpeed: Float;

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

The speed at which the sound will play. 1.0 is normal.

Default Value​

1;

minDistance​

minDistance: Float;

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

If distance from audio souce is < minDistance, audio is at max volume.

Default Value​

5;

maxDistance​

maxDistance: Float;

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

If distance from audio souce is >= maxDistance, audio is inaudible.

Default Value​

50;

dopplerFactor​

dopplerFactor: Float;

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

Reduce or enhance the doppler effect.

Default Value​

1;

attenuationRolloffFactor​

attenuationRolloffFactor: Float;

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

Attenuation rolloff factor.

Default Value​

1;

attenuationModel​

attenuationModel: UInt8;

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

Attenuation Model.

Default Value​

0;

inaudibleBehavior​

inaudibleBehavior: UInt8;

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

Behavior of a sound when it becomes inaudible.

Default Value​

0;

playState​

playState: UInt8;

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

The play state of the sound.

Default Value​

0;

looping​

looping: boolean;

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

Whether or not the sound loops.

Default Value​

false;

autoPlayOnStart​

autoPlayOnStart: boolean;

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

Whether or not the sound plays automatically when the simulation starts.

Default Value​

false;