Class Sound

Hierarchy

Sound

Index

Constructors

constructor

Methods

Constructors

constructor

new Sound(): Sound

- Defined in lumin/audio/Sound.d.ts:2
Returns Sound

Methods

decode

decode(): boolean

- Defined in lumin/audio/Sound.d.ts:43
Decode property accessor. Signifies whether the audio resource should be decoded or not.

priv

none

Returns boolean

The decode property value.

loop

loop(): boolean

- Defined in lumin/audio/Sound.d.ts:75
Loop property accessor.

priv

none

Returns boolean

The loop property value.

mute

mute(): boolean

- Defined in lumin/audio/Sound.d.ts:67
Mute property accessor.

priv

none

Returns boolean

The mute property value.

name

name(): string

- Defined in lumin/audio/Sound.d.ts:19
Name property accessor.

priv

none

Returns string

The name property value.

pitch

pitch(): number

- Defined in lumin/audio/Sound.d.ts:59
Pitch property accessor.

priv

none

Returns number

The pitch property value.

resource

resource(): bigint

- Defined in lumin/audio/Sound.d.ts:11
Returns a random resource ID from the list of resource, or INVALID_RESOURCE_ID if there are none.

priv

none

Returns bigint

A random resource ID from the list of resource, or INVALID_RESOURCE_ID if there are none.

resources

resources(): Array<bigint>

- Defined in lumin/audio/Sound.d.ts:27
Resources property accessor.

priv

none

Returns Array<bigint>

The resources property value.

setDecode

setDecode(decode: boolean): void

- Defined in lumin/audio/Sound.d.ts:115
Decode property accessor. Signifies whether the audio resource should be decoded or not.

priv

none

Parameters
- decode: boolean
  
  The decode property value.
Returns void

setLoop

setLoop(loop: boolean): void

- Defined in lumin/audio/Sound.d.ts:147
Loop property accessor.

priv

none

Parameters
- loop: boolean
  
  The loop property value.
Returns void

setMute

setMute(mute: boolean): void

- Defined in lumin/audio/Sound.d.ts:139
Mute property accessor.

priv

none

Parameters
- mute: boolean
  
  The mute property value.
Returns void

setName

setName(name: string): void

- Defined in lumin/audio/Sound.d.ts:91
Name property accessor.

priv

none

Parameters
- name: string
  
  The name property value.
Returns void

setPitch

setPitch(pitch: number): void

- Defined in lumin/audio/Sound.d.ts:131
Pitch property accessor.

priv

none

Parameters
- pitch: number
  
  The pitch property value.
Returns void

setResources

setResources(resources: Array<bigint>): void

- Defined in lumin/audio/Sound.d.ts:99
Resources property accessor.

priv

none

Parameters
- resources: Array<bigint>
  
  The resources property value.
Returns void

setSpatial

setSpatial(spatial: boolean): void

- Defined in lumin/audio/Sound.d.ts:155
Spatial property accessor.

priv

none

Parameters
- spatial: boolean
  
  The spatial property value.
Returns void

setStream

setStream(stream: boolean): void

- Defined in lumin/audio/Sound.d.ts:107
Stream property accessor. Signifies whether the audio resource should be streamed or not.

priv

none

Parameters
- stream: boolean
  
  The stream property value.
Returns void

setVolume

setVolume(volume: number): void

- Defined in lumin/audio/Sound.d.ts:123
Volume property accessor.

priv

none

Parameters
- volume: number
  
  The volume property value.
Returns void

spatial

spatial(): boolean

- Defined in lumin/audio/Sound.d.ts:83
Spatial property accessor.

priv

none

Returns boolean

The spatial property value.

stream

stream(): boolean

- Defined in lumin/audio/Sound.d.ts:35
Stream property accessor. Signifies whether the audio resource should be streamed or not.

priv

none

Returns boolean

The stream property value.

volume

volume(): number

- Defined in lumin/audio/Sound.d.ts:51
Volume property accessor.

priv

none

Returns number

The volume property value.

Generated using TypeDoc