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

    Class SoundComponentElement

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

    Engine component: SoundComponent (sound).

    Hierarchy (View Summary)

    Index
    closestApp closestEntity component distanceModel enabled maxDistance pitch positional refDistance rollOffFactor volume
    _onReady _resetReady getInitialComponentData initComponent 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(): EntityBaseElement | null

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

      Returns EntityBaseElement | null

      The closest entity-fronting 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. Signals at most once per readiness cycle: a repeat call before _resetReady has re-armed the promise does nothing.

      Returns void

    Protected_resetReady

    • _resetReady(): void

      Returns the ready promise to its pending state. Subclasses should call this when the resource their readiness announced is torn down (typically from disconnectedCallback), so that a later re-initialization can signal readiness again. Does nothing while the promise is still pending — an in-flight waiter carries over to the next readiness cycle rather than being stranded on a promise nothing will ever resolve.

      Returns void

    • Returns the data the component is created with. Overridden by subclasses to supply the initial values of their cached properties.

      Returns {
          distanceModel: "linear" | "exponential" | "inverse";
          maxDistance: number;
          pitch: number;
          positional: boolean;
          refDistance: number;
          rollOffFactor: number;
          volume: number;
      }

      The initial component data.

    • Returns a promise that resolves with this element when it's ready. This is the low-level primitive underlying whenReady, which is the recommended way to wait for elements.

      Readiness tracks the element's current lifecycle: once a ready element is torn down (for example by removing it from the document), this returns a fresh promise that resolves when the element is next ready. A promise obtained earlier stays resolved — call this again after re-inserting an element rather than reusing a promise from before its removal.

      Returns Promise<SoundComponentElement>

      A promise that resolves with this element when it's ready.

    Settings
    Member Visibility

    On This Page
    Accessors
    Methods