Class SoundComponentElement

Represents a sound component in the PlayCanvas engine.

Hierarchy (view full)

ComponentElement
- SoundComponentElement

Index

Accessors

component enabled pitch positional volume

Accessors

component

get component(): SoundComponent
Gets the sound component.

Returns SoundComponent
The sound component.
Overrides ComponentElement.component
- Defined in submodules/web-components/src/components/sound-component.ts:33

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 submodules/web-components/src/components/component.ts:89
set enabled(value): 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 submodules/web-components/src/components/component.ts:78

pitch

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

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

positional

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

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

volume

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

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