Class AudioSource

Represents an audio src in the Wonderland Engine, allowing playback of audio files.

Hierarchy

  • Component
    • AudioSource

Properties

autoplay coneInnerAngle coneOuterAngle coneOuterGain distanceModel emitter isStationary loop maxDistance refDistance rolloffFactor spatial src volume TypeName

Accessors

isPlaying maxVolume

Methods

changeAudioSource onDeactivate onDestroy play setAudioChannel setVolumeDuringPlayback start stop onRegister

Properties

autoplay

autoplay: boolean

Whether to autoplay the sound.

coneInnerAngle

coneInnerAngle: number

The inner angle of the audio cone.

coneOuterAngle

coneOuterAngle: number

The outer angle of the audio cone.

coneOuterGain

coneOuterGain: number

The outer gain of the audio cone.

distanceModel

distanceModel: DistanceModelType

The distance model used for spatial audio.

Readonlyemitter

emitter: Emitter<[PlayState]> = ...

The emitter will notify all subscribers when a state change occurs.

See

PlayState

isStationary

isStationary: boolean

Set this property if the object will never move. Disabling position updates each frame saves CPU time.

loop

loop: boolean

Whether to loop the sound.

maxDistance

maxDistance: number

The maximum distance for audio falloff.

refDistance

refDistance: number

The reference distance for audio falloff.

rolloffFactor

rolloffFactor: number

The rolloff factor for audio falloff.

spatial

spatial: PanningType

Select the panning method.

Warning

Enabling HRTF (Head-Related Transfer Function) is computationally more intensive than regular panning!

src

src: string

Path to the audio file that should be played.

volume

volume: number

Volume of the audio source.

Remarks

This will only take effect audio that has not started playing yet. Is the audio already playing, use setVolumeDuringPlayback()

See

setVolumeDuringPlayback

StaticTypeName

TypeName: string = 'audio-source'

The type name for this component.

Accessors

isPlaying

  • get isPlaying(): boolean

  • Checks if the audio src is currently playing.

    Returns boolean

maxVolume

  • get maxVolume(): number

  • Returns number

    Deprecated

    Use #volume instead

  • set maxVolume(v): void

  • Parameters

    • v: number

    Returns void

    Deprecated

    Use #volume instead

Methods

changeAudioSource

  • changeAudioSource(path): Promise<void>

  • Change out the source.

    Parameters

    • path: string

      Path to the audio file.

    Returns Promise<void>

onDeactivate

  • onDeactivate(): void

  • Called when the component is deactivated. Stops the audio playback.

    Returns void

onDestroy

  • onDestroy(): void

  • Called when the component is destroyed. Stops the audio playback and removes the src from cache.

    Returns void

play

  • play(buffer?): Promise<void>

  • Plays the audio associated with this audio src.

    Parameters

    • buffer: AudioBuffer = ...

      Optional parameter that will set the raw audio buffer that should be played. Defaults to internal audio buffer that is set with given audio path.

    Returns Promise<void>

    Remarks

    Is this audio-source currently playing, playback will be restarted.

setAudioChannel

  • setAudioChannel(am, channel): void

  • Parameters

    Returns void

setVolumeDuringPlayback

  • setVolumeDuringPlayback(v, t?): void

  • Changes the volume during playback.

    Parameters

    • v: number

      Volume that source should have.

    • t: number = 0

      Optional parameter that specifies the time it takes for the volume to reach its specified value in seconds (Default is 0).

    Returns void

start

  • start(): Promise<void>

  • Initializes the audio src component. If autoplay is enabled, the audio will start playing as soon as the file is loaded.

    Returns Promise<void>

stop

  • stop(): void

  • Stops the audio associated with this audio src.

    Returns void

StaticonRegister

  • onRegister(engine): void

  • Called when this component class is registered.

    Parameters

    • engine: WonderlandEngine

    Returns void

    Example

    This callback can be used to register dependencies of a component, e.g., component classes that need to be registered in order to add them at runtime with Object3D.addComponent, independent of whether they are used in the editor.

    class Spawner extends Component {
        static TypeName = 'spawner';

        static onRegister(engine) {
            engine.registerComponent(SpawnedComponent);
        }

        // You can now use addComponent with SpawnedComponent
    }

    Example

    This callback can be used to register different implementations of a component depending on client features or API versions.

    // Properties need to be the same for all implementations!
    const SharedProperties = {};

    class Anchor extends Component {
        static TypeName = 'spawner';
        static Properties = SharedProperties;

        static onRegister(engine) {
            if(navigator.xr === undefined) {
                /* WebXR unsupported, keep this dummy component */
                return;
            }
            /* WebXR supported! Override already registered dummy implementation
             * with one depending on hit-test API support */
            engine.registerComponent(window.HitTestSource === undefined ?
                AnchorWithoutHitTest : AnchorWithHitTest);
        }

        // This one implements no functions
    }

Settings

Member Visibility

On This Page

Properties
Accessors
Methods