Class SoundComponentElement

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

Hierarchy (View Summary)

ComponentElement
- SoundComponentElement

Index

Accessors

component distanceModel enabled maxDistance pitch positional refDistance rollOffFactor volume

Methods

_onReady ready

Accessors

component

get component(): null | SoundComponent
Gets the underlying PlayCanvas sound component.

Returns null | SoundComponent
The sound component.
Overrides ComponentElement.component
- Defined in src/components/sound-component.ts:49

distanceModel

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.
- Defined in src/components/sound-component.ts:68
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
- Defined in src/components/sound-component.ts:57

enabled

get enabled(): boolean
Gets the enabled state of the component.

Returns boolean
The enabled state of the component.
Inherited from ComponentElement.enabled
- Defined in src/components/component.ts:80
set enabled(value: boolean): void
Sets the enabled state of the component.
Parameters
- value: boolean
  The enabled state of the component.
Returns void
Inherited from ComponentElement.enabled
- Defined in src/components/component.ts:69

maxDistance

get maxDistance(): number
Gets the maximum distance from the listener at which audio falloff stops.

Returns number
The max distance.
- Defined in src/components/sound-component.ts:87
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
- Defined in src/components/sound-component.ts:76

pitch

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

Returns number
The pitch.
- Defined in src/components/sound-component.ts:106
set pitch(value: number): void
Sets the pitch of the sound.
Parameters
- value: number
  The pitch.
Returns void
- Defined in src/components/sound-component.ts:95

positional

get positional(): boolean
Gets the positional flag of the sound.

Returns boolean
The positional flag.
- Defined in src/components/sound-component.ts:125
set positional(value: boolean): void
Sets the positional flag of the sound.
Parameters
- value: boolean
  The positional flag.
Returns void
- Defined in src/components/sound-component.ts:114

refDistance

get refDistance(): number
Gets the reference distance for reducing volume as the sound source moves further from the listener.

Returns number
The ref distance.
- Defined in src/components/sound-component.ts:144
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
- Defined in src/components/sound-component.ts:133

rollOffFactor

get rollOffFactor(): number
Gets the factor used in the falloff equation.

Returns number
The roll-off factor.
- Defined in src/components/sound-component.ts:163
set rollOffFactor(value: number): void
Sets the factor used in the falloff equation. Defaults to 1.
Parameters
- value: number
  The roll-off factor.
Returns void
- Defined in src/components/sound-component.ts:152

volume

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

Returns number
The volume.
- Defined in src/components/sound-component.ts:182
set volume(value: number): void
Sets the volume of the sound.
Parameters
- value: number
  The volume.
Returns void
- Defined in src/components/sound-component.ts:171

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 ComponentElement._onReady
- Defined in src/async-element.ts:32

ready

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

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

Class SoundComponentElement

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

component

Returns null | SoundComponent

distanceModel

Returns "linear" | "exponential" | "inverse"

Parameters

Returns void

enabled

Returns boolean

Parameters

Returns void

maxDistance

Returns number

Parameters

Returns void

pitch

Returns number

Parameters

Returns void

positional

Returns boolean

Parameters

Returns void

refDistance

Returns number

Parameters

Returns void

rollOffFactor

Returns number

Parameters

Returns void

volume

Returns number

Parameters

Returns void

Methods

Protected_onReady

Returns void

ready

Returns Promise<SoundComponentElement>

Settings

On This Page

`Protected`_onReady