Interface SpatialAudio

Description

Base class for objects representing Script data.

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

Hierarchy (view full)

Properties

directivityEffect distanceEffect enabled positionEffect

Methods

getTypeName isOfType isSame

Properties

Readonly directivityEffect

directivityEffect: DirectivityEffect

Description

Directivity effect settings.

Readonly distanceEffect

distanceEffect: DistanceEffect

Description

Distance effect settings.

enabled

enabled: boolean

Description

Sets whether spatial audio is enabled or not.

Readonly positionEffect

positionEffect: PositionEffect

Description

Position effect settings.

Methods

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.

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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc