Audio

The module that carries out music and sound processing.

Module Methods

Audio.setup_midi (RGSS3)

Prepares MIDI playback by DirectMusic.

A method of the processing at startup in RGSS2 for enabling execution at any time.

MIDI playback is possible without calling this method, but in Windows Vista or later, a delay of 1 to 2 seconds will result at playback.

Audio.bgm_play(filename[, volume[, pitch[, pos]]]) (RGSS3)

Starts BGM playback. Specifies the file name, volume, pitch, and playback starting position in that order.

The playback starting position (RGSS3) is only valid for ogg or wav files.

Also automatically searches files included in RGSS-RTP. File extensions may be omitted.

Audio.bgm_stop

Stops BGM playback.

Audio.bgm_fade(time)

Starts BGM fadeout. time is the length of the fadeout in milliseconds.

Audio.bgm_pos (RGSS3)

Gets the playback position of the BGM. Only valid for ogg or wav files. Returns 0 when not valid.

Audio.bgs_play(filename[, volume[, pitch[, pos]]]) (RGSS3)

Starts BGS playback. Specifies the file name, volume, pitch, and playback starting position in that order.

The playback starting position (RGSS3) is only valid for ogg or wav files.

Also automatically searches files included in RGSS-RTP. File extensions may be omitted.

Audio.bgs_stop

Stops BGS playback.

Audio.bgs_fade(time)

Starts BGS fadeout. time is the length of the fadeout in milliseconds.

Audio.bgs_pos (RGSS3)

Gets the playback position of the BGS. Only valid for ogg or wav files. Returns 0 when not valid.

Audio.me_play(filename[, volume[, pitch]])

Starts ME playback. Sets the file name, volume, and pitch in turn.

Also automatically searches files included in RGSS-RTP. File extensions may be omitted.

When ME is playing, the BGM will temporarily stop. The timing of when the BGM restarts is slightly different from RGSS1.

Audio.me_stop

Stops ME playback.

Audio.me_fade(time)

Starts ME fadeout. time is the length of the fadeout in milliseconds.

Audio.se_play(filename[, volume[, pitch]])

Starts SE playback. Sets the file name, volume, and pitch in turn.

Also automatically searches files included in RGSS-RTP. File extensions may be omitted.

When attempting to play the same SE more than once in a very short period, they will automatically be filtered to prevent choppy playback.

Audio.se_stop

Stops all SE playback.