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

    Class SoundSlotElement

    The SoundSlotElement interface provides properties and methods for manipulating <pc-sound-slot> elements. The SoundSlotElement interface also inherits the properties and methods of the AsyncElement interface.

    Hierarchy (View Summary)

    Index
    soundSlot
    asset autoPlay closestApp closestEntity duration loop name overlap pitch startTime volume
    _onReady _resetReady ready
    soundSlot: SoundSlot | null = null

    The sound slot.

    • get asset(): string

      Gets the id of the pc-asset to use for the sound slot.

      Returns string

      The asset.

    • set asset(value: string): void

      Sets the id of the pc-asset to use for the sound slot.

      Parameters

      • value: string

        The asset.

      Returns void

    • get autoPlay(): boolean

      Gets the auto play flag of the sound slot.

      Returns boolean

      The auto play flag.

    • set autoPlay(value: boolean): void

      Sets the auto play flag of the sound slot.

      Parameters

      • value: boolean

        The auto play flag.

      Returns void

    • 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 duration(): number | null

      Gets the duration of the sound slot.

      Returns number | null

      The duration.

    • set duration(value: number | null): void

      Sets the duration of the sound slot, in seconds (or null to play the whole clip).

      Parameters

      • value: number | null

        The duration.

      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 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<SoundSlotElement>

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

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods