Interface SpatialAudio

Base class for objects representing Script data.

Example

Unassigned
interface SpatialAudio {
    directivityEffect: DirectivityEffect;
    distanceEffect: DistanceEffect;
    enabled: boolean;
    positionEffect: PositionEffect;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

directivityEffect distanceEffect enabled positionEffect

Methods

getTypeName isOfType isSame

Properties

ReadonlydirectivityEffect

directivityEffect: DirectivityEffect

Directivity effect settings.

ReadonlydistanceEffect

distanceEffect: DistanceEffect

Distance effect settings.

enabled

enabled: boolean

Sets whether spatial audio is enabled or not.

ReadonlypositionEffect

positionEffect: PositionEffect

Position effect settings.

Methods

getTypeName

isOfType

  • isOfType(type): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

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

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods