Constructor
new AudioClipPlayer(options)
- Source:
Parameters:
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
Properties
|
Extends
Methods
(static) accept(sound) → {Object|undefined}
- Source:
Determine whether this player can play the given sound.
Parameters:
Name | Type | Description |
---|---|---|
sound |
module:sound.Sound | the sound object, which should be an AudioClip |
Returns:
an instance of AudioClipPlayer if sound is an AudioClip or undefined otherwise
- Type
- Object | undefined
getDuration() → {number}
- Source:
- Overrides:
Get the duration of the AudioClip, in seconds.
Returns:
the duration of the clip, in seconds
- Type
- number
play(loops, fadeDurationopt)
- Source:
- Overrides:
Start playing the sound.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
loops |
number | how many times to repeat the track after it has played once. If loops == -1, the track will repeat indefinitely until stopped. |
||
fadeDuration |
number |
<optional> |
17
|
how long should the fading in last in ms |
setDuration(duration_s)
- Source:
- Overrides:
Set the duration of the audio clip.
Parameters:
Name | Type | Description |
---|---|---|
duration_s |
number | the duration of the clip in seconds |
setLoops(loops)
- Source:
- Overrides:
Set the number of loops.
Parameters:
Name | Type | Description |
---|---|---|
loops |
number | how many times to repeat the clip after it has played once. If loops == -1, the clip will repeat indefinitely until stopped. |
setVolume(volume, muteopt)
- Source:
- Overrides:
Set the volume of the playback.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
volume |
number | the volume of the playback (must be between 0.0 and 1.0) |
||
mute |
boolean |
<optional> |
false
|
whether or not to mute the playback |
stop(fadeDurationopt)
- Source:
- Overrides:
Stop playing the sound immediately.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
fadeDuration |
number |
<optional> |
17
|
how long the fading out should last, in ms |