マスターボリュームの設定

編集

概要

VolumeAPI はマスターボリューム設定を可能にするAPIです。このAPIを利用することで、ゲームページのボリュームボタンが有効になります。
マスターボリュームはRPGアツマール全体共通のボリューム設定で、RPGツクールMVのゲーム内オプションで設定できる音量パラメータとは異なります。

なにができるのか

機能を実行した際に、次のような操作を行います。

  • ゲームページのボリュームボタンを有効にする
  • マスターボリュームの調整

ボリューム設定

利用想定／利用例

RPGツクールMV製でコアスクリプトv1.5.0以上のゲームの場合、RPGアツマールが挿入する rpgatsumaru.js によって自動的にこの機能を利用しています。
例えば以下のゲームで、この機能を利用してゲーム音量を調整できます。

利用方法

マスターボリューム機能は次の方法で利用できます。

方法場所
ゲームAPI以下の「APIでの利用方法」を参考に、直接APIを呼び出してください

APIでの利用方法

APIを利用したボリューム機能の利用

ボリューム取得API

メソッドwindow.RPGAtsumaru.volume.getCurrentValue()
説明現在のRPGアツマールのマスターボリューム値を取得する。
引数なし
戻り値number 0～1の実数で表されるマスターボリューム
リリース日2017/12/20
更新日2018/10/25

ボリューム変更取得API

メソッドwindow.RPGAtsumaru.volume.changed.subscribe(observer: Observer)
説明
  • RPGアツマールのマスターボリューム情報の変更を取得する。
  • Observer, subscriptionについてはESNextのObservableを参照してください。
引数マスターボリューム情報を受け取るObserver
戻り値subscription
リリース日2017/12/20
更新日2018/10/25

ボリューム変更時コールバックAPI

メソッドwindow.RPGAtsumaru.volume.changed.subscribe(next: (volume: number) => void)
説明window.RPGAtsumaru.volume.changed.subscribe(observer) の引数に、コールバック関数を受け付けられるようにしたもの。
引数マスターボリューム情報を受け取るコールバック
戻り値subscription
リリース日2016/12/20
更新日2018/10/25