Class SoundSlotElement

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

Hierarchy (View Summary)

AsyncElement
- SoundSlotElement

Index

Properties

soundSlot

soundSlot: SoundSlot | null = null

The sound slot.

Accessors

asset

get asset(): string
Gets the id of the pc-asset to use for the sound slot.

Returns string
The asset.
- Defined in src/components/sound-slot.ts:118
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
- Defined in src/components/sound-slot.ts:104

autoPlay

get autoPlay(): boolean
Gets the auto play flag of the sound slot.

Returns boolean
The auto play flag.
- Defined in src/components/sound-slot.ts:137
set autoPlay(value: boolean): void
Sets the auto play flag of the sound slot.
Parameters
- value: boolean
  The auto play flag.
Returns void
- Defined in src/components/sound-slot.ts:126

closestApp

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.
Inherited from AsyncElement.closestApp
- Defined in src/async-element.ts:28

closestEntity

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.
Inherited from AsyncElement.closestEntity
- Defined in src/async-element.ts:37

duration

get duration(): number | null
Gets the duration of the sound slot.

Returns number | null
The duration.
- Defined in src/components/sound-slot.ts:156
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
- Defined in src/components/sound-slot.ts:145

loop

get loop(): boolean
Gets the loop flag of the sound slot.

Returns boolean
The loop flag.
- Defined in src/components/sound-slot.ts:175
set loop(value: boolean): void
Sets the loop flag of the sound slot.
Parameters
- value: boolean
  The loop flag.
Returns void
- Defined in src/components/sound-slot.ts:164

name

get name(): string
Gets the name of the sound slot.

Returns string
The name.
- Defined in src/components/sound-slot.ts:194
set name(value: string): void
Sets the name of the sound slot.
Parameters
- value: string
  The name.
Returns void
- Defined in src/components/sound-slot.ts:183

overlap

get overlap(): boolean
Gets the overlap flag of the sound slot.

Returns boolean
The overlap flag.
- Defined in src/components/sound-slot.ts:213
set overlap(value: boolean): void
Sets the overlap flag of the sound slot.
Parameters
- value: boolean
  The overlap flag.
Returns void
- Defined in src/components/sound-slot.ts:202

pitch

get pitch(): number
Gets the pitch of the sound slot.

Returns number
The pitch.
- Defined in src/components/sound-slot.ts:232
set pitch(value: number): void
Sets the pitch of the sound slot.
Parameters
- value: number
  The pitch.
Returns void
- Defined in src/components/sound-slot.ts:221

startTime

get startTime(): number
Gets the start time of the sound slot.

Returns number
The start time.
- Defined in src/components/sound-slot.ts:251
set startTime(value: number): void
Sets the start time of the sound slot.
Parameters
- value: number
  The start time.
Returns void
- Defined in src/components/sound-slot.ts:240

volume

get volume(): number
Gets the volume of the sound slot.

Returns number
The volume.
- Defined in src/components/sound-slot.ts:270
set volume(value: number): void
Sets the volume of the sound slot.
Parameters
- value: number
  The volume.
Returns void
- Defined in src/components/sound-slot.ts:259

Methods

`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
Inherited from AsyncElement._onReady
- Defined in src/async-element.ts:46

ready

ready(): Promise<SoundSlotElement>
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.

Returns Promise<SoundSlotElement>
A promise that resolves with this element when it's ready.
Inherited from AsyncElement.ready
- Defined in src/async-element.ts:56

Class SoundSlotElement

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

soundSlot

Accessors

asset

Returns string

Parameters

Returns void

autoPlay

Returns boolean

Parameters

Returns void

closestApp

Returns AppElement | null

closestEntity

Returns EntityElement | null

duration

Returns number | null

Parameters

Returns void

loop

Returns boolean

Parameters

Returns void

name

Returns string

Parameters

Returns void

overlap

Returns boolean

Parameters

Returns void

pitch

Returns number

Parameters

Returns void

startTime

Returns number

Parameters

Returns void

volume

Returns number

Parameters

Returns void

Methods

Protected_onReady

Returns void

ready

Returns Promise<SoundSlotElement>

Settings

On This Page

`Protected`_onReady