Skip to main content

Editor.Components.AudioComponent

Class

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

Index

Example

const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;

// Create a scene object with an AudioComponent
const obj = scene.createSceneObject('AudioSource');
const audio = obj.addComponent('AudioComponent') as Editor.Components.AudioComponent;

// Configure volume and spatial audio
audio.volume = 0.8;
audio.enableSpatialAudio = true;
audio.minDistance = 1.0;
audio.maxDistance = 50.0;
audio.enableDistanceEffect = true;

console.log(`AudioComponent: volume=${audio.volume}, spatial=${audio.enableSpatialAudio}`);
console.log(` distance: min=${audio.minDistance}, max=${audio.maxDistance}`);

Extends

Properties

audioTrack

audioTrack: AudioTrackAsset

The audio track asset to play.


curveType

curveType: DistanceEffectCurveType

The distance attenuation curve type for spatial audio.


enableAutoplayLoop

enableAutoplayLoop: boolean

Whether the audio loops automatically on playback.


enabled

enabled: boolean

Whether the component is active.

Inherited from

Component.enabled


enableDirectivityEffect

enableDirectivityEffect: boolean

Whether directivity effect is applied to spatial audio.


enableDistanceEffect

enableDistanceEffect: boolean

Whether distance-based attenuation affects audio volume.


enableMixToSnap

enableMixToSnap: boolean

Whether audio mixes to Snapchat audio output.


enablePositionEffect

enablePositionEffect: boolean

Whether object position affects spatial audio rendering.


enableSpatialAudio

enableSpatialAudio: boolean

Whether spatial audio processing is enabled.


hasPrefabChanges

readonly hasPrefabChanges: boolean

Whether this entity differs from its counterpart in the prefab or was added to the prefab instance. Always false outside prefab instances.

Inherited from

Component.hasPrefabChanges


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Component.id


isPrefabInstanceRoot

readonly isPrefabInstanceRoot: boolean

Whether this entity is the root of a prefab instance.

Inherited from

Component.isPrefabInstanceRoot


maxDistance

maxDistance: number

Maximum distance for spatial audio attenuation.


meta

readonly meta: Meta

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

Inherited from

Component.meta


minDistance

minDistance: number

Minimum distance before full-volume spatial audio.


name

name: string

Name of the component.

Inherited from

Component.name


recordVolume

recordVolume: number

Volume level for recording audio output.


sceneObject

readonly sceneObject: SceneObject

Scene object this component is attached to.

Inherited from

Component.sceneObject


type

readonly type: string

The entity's type.

Inherited from

Component.type


volume

volume: number

Playback volume level (0-1).

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

Component.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Component.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

Component.getOwnedEntities


getPrefabInstanceRoot()

getPrefabInstanceRoot(): Prefabable

Returns the nearest prefab instance root that contains this entity, starting with the entity itself, or null if it is not part of a prefab instance.

Returns

Prefabable

Inherited from

Component.getPrefabInstanceRoot


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Component.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Component.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Component.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

Component.isSame