HomeWeb Components API Reference - v0.10.1
    Preparing search index...

    Class SoundComponentElement

    The SoundComponentElement interface provides properties and methods for manipulating <pc-sounds> elements. The SoundComponentElement interface also inherits the properties and methods of the HTMLElement interface.

    Hierarchy (View Summary)

    Index
    closestApp closestEntity component distanceModel enabled maxDistance pitch positional refDistance rollOffFactor volume
    _onReady ready
    • get closestApp(): AppElement | null

      The nearest ancestor <pc-app> element, or null if this element has no <pc-app> ancestor. The search starts at the parent, so an element never resolves to itself.

      Returns AppElement | null

      The closest app element, or null.

    • get closestEntity(): EntityElement | null

      The nearest ancestor <pc-entity> element, or null if this element has no <pc-entity> ancestor. The search starts at the parent, so an element never resolves to itself.

      Returns EntityElement | null

      The closest entity element, or null.

    • get distanceModel(): "linear" | "exponential" | "inverse"

      Gets which algorithm to use to reduce the volume of the sound as it moves away from the listener.

      Returns "linear" | "exponential" | "inverse"

      The distance model.

    • set distanceModel(value: "linear" | "exponential" | "inverse"): void

      Sets which algorithm to use to reduce the volume of the sound as it moves away from the listener.

      Parameters

      • value: "linear" | "exponential" | "inverse"

        The distance model.

      Returns void

    • get enabled(): boolean

      Gets the enabled state of the component.

      Returns boolean

      The enabled state of the component.

    • set enabled(value: boolean): void

      Sets the enabled state of the component.

      Parameters

      • value: boolean

        The enabled state of the component.

      Returns void

    • get maxDistance(): number

      Gets the maximum distance from the listener at which audio falloff stops.

      Returns number

      The max distance.

    • set maxDistance(value: number): void

      Sets the maximum distance from the listener at which audio falloff stops.

      Parameters

      • value: number

        The max distance.

      Returns void

    • get refDistance(): number

      Gets the reference distance for reducing volume as the sound source moves further from the listener.

      Returns number

      The ref distance.

    • set refDistance(value: number): void

      Sets the reference distance for reducing volume as the sound source moves further from the listener. Defaults to 1.

      Parameters

      • value: number

        The ref distance.

      Returns void

    Protected_onReady

    • _onReady(): void

      Called when the element is fully initialized and ready. Subclasses should call this when they're ready. Resolves the ready promise and dispatches a bubbling, composed ready event.

      Returns void

    Settings
    Member Visibility

    On This Page
    Accessors
    Methods