Plugin : Audio helper

Author:Rex.Rainbow

Download

Properties

Audio effect

  • Use audio effect to do fading.
    • Options : ["No","Yes"]

Actions

Playback

Action:Play

  • Play an audio file with fade-in.
    • Audio file ( audio ) : Choose the audio file to play.
    • Loop ( Combo ) : Whether or not to initially play the sound in a loop (repeating).
      • Options : ["not looping","looping"]
    • End volume ( number or string ) : Mapping from (1~0) to (0db~-60db) with linear interpolation. Or set volume in dB by string like "0dB"
    • Tag (optional) ( string ) : A tag, which can be anything you like, to use to reference this sound in future.
    • Fade-in time ( number ) : The duration of fade-in, in second.
    • Start volume ( number or string ) : Mapping from (1~0) to (0db~-60db) with linear interpolation. Or set volume in dB by string like "0dB"

Action:Stop

  • Stop a sound from playing with fade-out.
    • Tag ( string ) : The tag identifying the sound to stop. Leave empty to affect the last played sound.
    • Fade-out ( number ) : The duration of fade-out, in second.
    • Stop volume ( number or string ) : Mapping from (1~0) to (0db~-60db) with linear interpolation. Or set volume in dB by string like "0dB"

Action:Play (by name)

  • Play an audio file using a string for the filename with fade.
    • Folder ( Combo ) : Choose the folder which contains the audio file.
      • Options : ["Sounds","Music"]
    • Audio file name ( string ) : A string with the name of the audio file to play, without the file extension. For example, to play myfile.ogg, use only "myfile".
    • Loop ( Combo ) : Whether or not to initially play the sound in a loop (repeating).
      • Options : ["not looping","looping"]
    • End volume ( number or string ) : Mapping from (1~0) to (0db~-60db) with linear interpolation. Or set volume in dB by string like "0dB"
    • Tag (optional) ( string ) : A tag, which can be anything you like, to use to reference this sound in future.
    • Fade-in time ( number ) : The duration of fade-in, in second.
    • Start volume ( number or string ) : Mapping from (1~0) to (0db~-60db) with linear interpolation. Or set volume in dB by string like "0dB"

Action:Set paused

  • Pause or resume audio with a given tag with fade.
    • Tag ( string ) : The audio tag to pause or resume.
    • State ( Combo ) : Whether to pause or resume the sound with the given tag.
      • Options : ["Pause","Resume"]
    • Fade ( number ) : The duration of fade, in second.

Preload

Action:Preload

  • Download an audio file from the server without playing it. This ensures it will play immediately.
    • Audio file ( string ) : Audio file string

Volume

Action:Set volume

  • Set the volume (loudness) of a sound with fade.
    • Tag ( string ) : The tag identifying the sound to loop. Leave empty to affect the last played sound.
    • Volume ( number or string ) : Mapping from (1~0) to (0db~-60db) with linear interpolation. Or set volume in dB by string like "0dB"
    • Fade ( number ) : The duration of fade, in second.

Expressions

Conditions

Fading

Condition:Is fading

  • Return true if an audio is fading.
    • Tag ( string ) : A tag, which can be anything you like, to use to reference this sound in future.