Preparing search index...

    Manages audio playback and spatial audio properties for a scene object.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    audioTrack: AudioTrackAsset

    The audio track asset to play.

    The distance attenuation curve type for spatial audio.

    enableAutoplayLoop: boolean

    Whether the audio loops automatically on playback.

    enabled: boolean

    Whether the component is active.

    enableDirectivityEffect: boolean

    Whether directivity effect is applied to spatial audio.

    enableDistanceEffect: boolean

    Whether distance-based attenuation affects audio volume.

    enableMixToSnap: boolean

    Whether audio mixes to Snapchat audio output.

    enablePositionEffect: boolean

    Whether object position affects spatial audio rendering.

    enableSpatialAudio: boolean

    Whether spatial audio processing is enabled.

    id: Uuid

    The unique id of the entity.

    maxDistance: number

    Maximum distance for spatial audio attenuation.

    meta: Meta

    Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

    minDistance: number

    Minimum distance before full-volume spatial audio.

    name: string

    Name of the component.

    recordVolume: number

    Volume level for recording audio output.

    sceneObject: SceneObject

    Scene object this component is attached to.

    type: string

    The entity's type.

    volume: number

    Playback volume level (0-1).

    Methods

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean