Interface AudioComponent

Description

Used to play audio in a Lens. You can assign an AudioTrackAsset to play through script or through the AudioComponent's inspector in Lens Studio. See the Playing Audio guide for more information.

Example

//@input Component.AudioComponent audio
// Play once
script.audio.play(1);

// Play forever
script.audio.play(-1);

// If playing, stop
if(script.audio.isPlaying())
{
    script.audio.stop(true);
}

// Set a callback for when the sound stops playing
script.audio.setOnFinish(function()
{
    print("sound finished playing");
});
interface AudioComponent {
    audioTrack: AudioTrackAsset;
    duration: number;
    enabled: boolean;
    fadeInTime: number;
    fadeOutTime: number;
    mixToSnap: boolean;
    position: number;
    recordingVolume: number;
    spatialAudio: SpatialAudio;
    uniqueIdentifier: string;
    volume: number;
    destroy(): void;
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    isOfType(type): boolean;
    isPaused(): boolean;
    isPlaying(): boolean;
    isSame(other): boolean;
    pause(): boolean;
    play(loops): void;
    resume(): boolean;
    setOnFinish(eventCallback): void;
    stop(fade): void;
}

Hierarchy (view full)

Properties

audioTrack duration enabled fadeInTime fadeOutTime mixToSnap position recordingVolume spatialAudio uniqueIdentifier volume

Methods

destroy getSceneObject getTransform getTypeName isOfType isPaused isPlaying isSame pause play resume setOnFinish stop

Properties

audioTrack

audioTrack: AudioTrackAsset

Description

The audio asset currently assigned to play.

Readonly duration

duration: number

Description

The length (in seconds) of the current sound assigned to play.

enabled

enabled: boolean

Description

If disabled, the Component will stop enacting its behavior.

fadeInTime

fadeInTime: number

Description

Length (in seconds) of a volume fade in applied to the beginning of sound playback.

fadeOutTime

fadeOutTime: number

Description

Length (in seconds) of a volume fade out applied to the end of sound playback.

mixToSnap

mixToSnap: boolean

Description

When true, records sound directly into the snap. This mode works only when all Audio Components in the scene are using mix to snap. In this case input from microphone will be ignored.

position

position: number

Description

The current playback time in seconds

recordingVolume

recordingVolume: number

Description

The volume of audio recorded to the snap, from 0 to 1.

Readonly spatialAudio

spatialAudio: SpatialAudio

Description

Spatial Audio settings.

Readonly uniqueIdentifier

uniqueIdentifier: string

volume

volume: number

Description

A volume multiplier for any sounds played by this AudioComponent.

Methods

destroy

  • destroy(): void

  • Returns void

    Description

    Destroys the component.

getSceneObject

getTransform

getTypeName

  • getTypeName(): string

  • Returns string

    Description

    Returns the name of this object's type.

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

    Returns true if the object matches or derives from the passed in type.

isPaused

  • isPaused(): boolean

  • Returns boolean

    Description

    Returns whether the sound is currently paused.

isPlaying

  • isPlaying(): boolean

  • Returns boolean

    Description

    Returns whether the AudioComponent is currently playing sound.

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

pause

  • pause(): boolean

  • Returns boolean

    Description

    Pauses the sound.

play

  • play(loops): void

  • Parameters

    • loops: number

    Returns void

    Description

    Plays the current sound loops number of times. If loops is -1, the sound will repeat forever.

resume

  • resume(): boolean

  • Returns boolean

    Description

    Resumes a paused sound.

setOnFinish

  • setOnFinish(eventCallback): void

  • Parameters

    • eventCallback: ((audioComponent) => void)
        • (audioComponent): void

        • Parameters

          Returns void

    Returns void

    Description

    Sets the callback function to be called whenever this sound stops playing.

stop

  • stop(fade): void

  • Parameters

    • fade: boolean

    Returns void

    Description

    Stops the current sound if already playing.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc