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, Expand)

AsyncElement
- SoundSlotElement

Index

Properties

soundSlot

soundSlot: null | SoundSlot = 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:90
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:76

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:109
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:98

duration

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

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

loop

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

Returns boolean
The loop flag.
- Defined in src/components/sound-slot.ts:147
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:136

name

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

Returns string
The name.
- Defined in src/components/sound-slot.ts:166
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:155

overlap

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

Returns boolean
The overlap flag.
- Defined in src/components/sound-slot.ts:185
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:174

pitch

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

Returns number
The pitch.
- Defined in src/components/sound-slot.ts:204
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:193

startTime

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

Returns number
The start time.
- Defined in src/components/sound-slot.ts:223
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:212

volume

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

Returns number
The volume.
- Defined in src/components/sound-slot.ts:242
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:231

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 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 src/async-element.ts:41

Class SoundSlotElement

Hierarchy (View Summary, Expand)

Index

Properties

Accessors

Methods

Properties

soundSlot

Accessors

asset

Returns string

Parameters

Returns void

autoPlay

Returns boolean

Parameters

Returns void

duration

Returns number

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