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

Accessors

asset autoPlay duration loop name overlap pitch startTime volume

Methods

Properties

soundSlot

soundSlot: SoundSlot = null

The sound slot.

Accessors

asset

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

Returns string
The asset.
- Defined in submodules/web-components/src/components/sound-slot.ts:91
set asset(value: string): void
Sets the asset of the sound slot.
Parameters
- value: string
  The asset.
Returns void
- Defined in submodules/web-components/src/components/sound-slot.ts:77

autoPlay

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

Returns boolean
The auto play flag.
- Defined in submodules/web-components/src/components/sound-slot.ts:110
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 submodules/web-components/src/components/sound-slot.ts:99

duration

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

Returns number
The duration.
- Defined in submodules/web-components/src/components/sound-slot.ts:129
set duration(value: number): void
Sets the duration of the sound slot.
Parameters
- value: number
  The duration.
Returns void
- Defined in submodules/web-components/src/components/sound-slot.ts:118

loop

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

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

name

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

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

overlap

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

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

pitch

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

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

startTime

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

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

volume

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

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

Methods

`Protected`_onReady

_onReady(): void
Called when the element is fully initialized and ready. Subclasses should call this when they're ready.

Returns void
Inherited from AsyncElement._onReady
- Defined in submodules/web-components/src/async-element.ts:32

ready

ready(): Promise<SoundSlotElement>
Returns a promise that resolves with this element when it's ready.

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