Sound

lumin. Sound

Methods

decode() → {boolean}

Decode property accessor. Signifies whether the audio resource should be decoded or not.

Returns:

The decode property value.

Type
boolean

loop() → {boolean}

Loop property accessor.

Returns:

The loop property value.

Type
boolean

mute() → {boolean}

Mute property accessor.

Returns:

The mute property value.

Type
boolean

name() → {string}

Name property accessor.

Returns:

The name property value.

Type
string

pitch() → {number}

Pitch property accessor.

Returns:

The pitch property value.

Type
number

resource() → {BigInt}

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

Returns:

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

Type
BigInt

resources() → {Array.<BigInt>}

Resources property accessor.

Returns:

The resources property value.

Type
Array.<BigInt>

setDecode(decode)

Decode property accessor. Signifies whether the audio resource should be decoded or not.

Parameters:
Name Type Description
decode boolean

The decode property value.

setLoop(loop)

Loop property accessor.

Parameters:
Name Type Description
loop boolean

The loop property value.

setMute(mute)

Mute property accessor.

Parameters:
Name Type Description
mute boolean

The mute property value.

setName(name)

Name property accessor.

Parameters:
Name Type Description
name string

The name property value.

setPitch(pitch)

Pitch property accessor.

Parameters:
Name Type Description
pitch number

The pitch property value.

setResources(resources)

Resources property accessor.

Parameters:
Name Type Description
resources Array.<BigInt>

The resources property value.

setSpatial(spatial)

Spatial property accessor.

Parameters:
Name Type Description
spatial boolean

The spatial property value.

setStream(stream)

Stream property accessor. Signifies whether the audio resource should be streamed or not.

Parameters:
Name Type Description
stream boolean

The stream property value.

setVolume(volume)

Volume property accessor.

Parameters:
Name Type Description
volume number

The volume property value.

spatial() → {boolean}

Spatial property accessor.

Returns:

The spatial property value.

Type
boolean

stream() → {boolean}

Stream property accessor. Signifies whether the audio resource should be streamed or not.

Returns:

The stream property value.

Type
boolean

volume() → {number}

Volume property accessor.

Returns:

The volume property value.

Type
number