Star Ruby Ruby extension library for creating 2D games

音関係を管理するモジュールです。

BGM と効果音

Star Ruby で鳴らせる音の種類には、 BGM と効果音があります。

機能	BGM	効果音
最大同時発音数	1	8
ストリーミング再生	○	×
途中から再生	○	×
ループ	○	×
パンニング	×	○

対応している形式は以下の通りです。

• Ogg Vorbis
• WAV

定数

MAX_SE_COUNT

効果音の最大再生数 (最大同時発音数)。

モジュールメソッド

Audio.bgm_position

BGM の再生位置を表す整数値を取得します。

Audio.bgm_volume

Audio.bgm_volume=(volume)

BGM のボリュームを表す整数値 (0 〜 255) を取得 / 設定します。

Audio.play_bgm(path, options = {})

path のファイルを BGM として再生します。拡張子は省略可能です。

options には Hash を指定します。指定できるキーと値は、以下の通りです。

キー	値	デフォルト値
:loop	ループするか否かを表す真偽値。	false
:position	再生位置を表す値。 Audio.bgm_position で取得できる値を使用します。	0
:volume	ボリューム (0 〜 255)。	255
:time	フェードイン時間 (ミリ秒)。	0

BGM の途中からの再生は、最大 2 秒程度の誤差が生じます。

Audio.play_se(path, options = {})

path のファイルを効果音として再生します。

options には Hash を指定します。指定できるキーと値は、以下の通りです。

キー	値	デフォルト値
:panning	パンニング (-255 〜 255)。	0
:volume	ボリューム (0 〜 255)。	255
:time	フェードイン時間 (ミリ秒)。	0

(Ver 0.1.0 以前では、 :panning の値の範囲は 0 〜 255 です。)

Audio.playing_bgm?

BGM 再生中ならば true を、それ以外の場合は false を返します。

Audio.playing_se_count

現在再生中の効果音の数を取得します。

Audio.stop_all_ses(options = {})

再生中の効果音を全て停止します。

options には Hash を指定します。指定できるキーと値は、以下の通りです。

キー	値	デフォルト値
:time	フェードアウト時間 (ミリ秒)。	0

Audio.stop_bgm(options = {})

BGM を停止します。

options には Hash を指定します。指定できるキーと値は、以下の通りです。

キー	値	デフォルト値
:time	フェードアウト時間 (ミリ秒)。	0