スクリプトによる AudioMixer の音量制御方法

　スクリプトからの AudioMixer へ命令を出し、ゲーム内で動的にボリュームを制御することが可能です。
ただし、スクリプト内に命令を用意するだけでは制御ができず、正しい設定ができていないと、下記のようなエラーメッセージが表示されます。

　この手順では AudioMixer の設定を順番に行った上で、必要なスクリプトを用意していく実装を行います。

　特にスライダーと組み合わせて利用することが多いため、下記のような形での実装を目標にしておくとよいでしょう。

実装動画

１．AudioMixer の設定

　スクリプトで AudioMixer の設定を動的に変更するためには、事前に AudioMixer の設定が必要になります。

　スクリプトから操作したい AudioMixer を選択し、インスペクターにある Attenuation の上で右クリックをしてメニューを表示します。
　
　メニュー内の【Expose 'Volume(of Master) ' to script】を選択します。

　すると Volume の表示の横に → が表示されます。
この表示が出れば、スクリプトからの切り替え設定ができています。

　もしも以前の状態に戻したい場合には、再度同じ位置で右クリックしてメニューを表示し
【Unexpose】を選択すると → が消え、元のようにスクリプトからは制御ができない状態に戻すことができます。

２．AudioMixer ウインドウの設定

　続いて、AudioMixer ウインドウで設定を行います。
設定したい AudioMixer を選択している状態で AudioMixer ウインドウを表示します。

　下記の場合であれば、Master の AudioMixerGroup を選択している状態です。

　【１】の手順を行っていると、AudioMixer ウインドウの右上の端に【Exposed Parameters】の項目が表示されています。
設定している AudioMixerGroup の数だけ () 内の数字が設定されます。この手順であれば、Exposed Parameters(1) となっています。

　Exposed Parameters(1) 部分はプルダウンメニューになっています。
この部分は任意の名称を設定できる箇所であり、かつ、スクリプトからの命令を受ける際の指定文字列にもなります。
よって、わかりやすい名称にしておくことが重要です。

　こちらのプルダウンメニューをクリックして My Exposed Param Volume (of Master) の部分をダブルクリックします。

　そうすると名前を変更することができますので、My Exposed Param 部分を消して、代わりに Master と入力します。
この文字列を使い、スクリプトからの AudioMaster へ命令を出すことになります。

　表示が Master Volume (of Master) に変わります。

　
　これで設定完了です。

　ここまでの設定を行わずにスクリプトにだけ命令を用意した場合、冒頭のようなエラーメッセージが表示されて制御が失敗します。

３．サンプルスクリプト

　ここでは２つのスクリプトを用意しています。

　１つは ConstData スクリプトです。
このスクリプトで用意するクラスは定数用のクラスになります。
よって、クラス自体も static で用意し、いずれのクラスからでも定数を利用できる状態として作成しておきます。

　クラス内に定義するメンバ変数も const として宣言を行うため、定数値として認識されるようにします。

１．ConstData クラス

ConstData.cs

<= クリックすると開きます

/// <summary>
/// 定数情報の登録用クラス
/// </summary>
public static class ConstData
{
    public const float DEFAULT_MASTER_VOLUME = 0.7f;
    public const string MASTER_AUDIO_NAME = "Master";   // AudioMixer の AudioGroup の名前で指定できる。AudioMixer 側のスクリプトでの制御許可の設定が必要
}

　上記の処理において

　public const string MASTER_AUDIO_NAME = "Master";

　この部分の文字列の値として【２】で AudioMixer ウインドウで設定した文字列を記述しておきます。

　AudioMixer 側に命令を出す際には常に同じ値を利用するので、そういったケースの場合には
スクリプトごとに変数を用意するのではなく、定数値として ConstData のような定数用のクラスを作成して利用するようにしてください。

２．SoundManager クラス

　続いて、BGM や SE といった音楽用の制御用のクラスである SoundManager を作成します。
こちらでは音楽の再生・停止を行うとともに、AudioMixer への紐づけも用意しておいて
動的にボリュームの制御を行うためのメソッドを用意しておきます。

　音楽の再生、SE の再生などはいずれのクラスからでも命令を実行できると利便性が高くなりますので、
SoundManager クラスはシングルトンクラスとして定義しておくとよいでしょう。
あるいは DI コンテナを利用して依存性注入を行うとよいです。

　なお今回は AudioMixer についての実装のため、音楽の再生・停止などの処理は記述していません。
そちらについては、別の記事を参考にして実装を行ってください。

　　→　SoundManagerでゲーム内の音源を管理する

SoundManager.cs

<= クリックすると開きます

using System.Collections;
using UnityEngine;
using UnityEngine.Audio;
using DG.Tweening;

/// <summary>
/// 音管理クラス
/// </summary>
public class SoundManager : MonoBehaviour {

    public static SoundManager instance;

    // BGM
    [SerializeField]
　　private AudioSource[] BGMsources = new AudioSource[2];

　　// SE
　　private AudioSource[] SEsources = new AudioSource[24];

    // SE用AudioMixer
    public AudioMixerGroup[] audioMixerGroups;

    private float masterVolume;
　　private readonly float linearToDecibelScalingFactor = 20.0f;  // 音量（linearVolume）をデシベル（dB）に変換するための係数


    public void Awake() {
        if (instance == null) {
            instance = this;
            DontDestroyOnLoad(this.gameObject);

            // ゲームの初期設定
            Init(ConstData.DEFAULT_MASTER_VOLUME);
        } else {
            Destroy(this.gameObject);
        }
    }

    /// <summary>
    /// 初期設定
    /// </summary>
    /// <param name="newMasterVolume"></param>
    public void Init (float newMasterVolume) {

        // TODO BGM、SEなどの初期設定

        // SE AudioSource
        for (int i = 0 ; i < SEsources.Length ; i++ ){
	　　SEsources[i] = gameObject.AddComponent<AudioSource>();
            SEsources[i].outputAudioMixerGroup = audioMixerGroups[0];
        }

        // 初期音量設定
        SetMasterVolume(newMasterVolume);

        DOTween.Init();
    }

    /// <summary>
    /// マスターボリュームの設定値更新
    /// </summary>
    /// <param name="newVolume"></param>
    public void SetMasterVolume(float newVolume) {
        masterVolume = newVolume;
    }

    /// <summary>
    /// 指定した AudioGroup の音量変更
    /// Slider の値(0 - 1.0f)を AudioMixer のデジベルに変換して適用
    /// </summary>
    /// <param name="mixerGroupName"></param>
    /// <param name="linearVolume"></param>
    public void SetLinearVolumeToMixerGroup(string mixerGroupName, float linerVolume) {
        float decibel = linearToDecibelScalingFactor * Mathf.Log10(linerVolume);

        if (float.IsNegativeInfinity(decibel)) {
            decibel = -96f;  // 無音は -80f ではなくて -96f にする
        }

        audioMixerGroups[0].audioMixer.SetFloat(mixerGroupName, decibel);
    }

    /// <summary>
    /// 指定した AudioGroup の音量を float で取得
    /// </summary>
    /// <param name="mixerGroupName"></param>
    /// <returns></returns>
    public float GetLinearVolumeFromMixerGroup(string mixerGroupName) {
        float decibel;

        // Master
        audioMixerGroups[0].audioMixer.GetFloat(mixerGroupName, out decibel);

        return Mathf.Pow(10f, decibel / linearToDecibelScalingFactor);
    }

　下記は参考用のインスペクター画像になります。

３．＜補間処理を使う場合＞

　AudioMixer.SetFloat メソッドは、指定した AudioGroup のボリュームを設定するためのものです。
第2引数に指定した値が、そのままボリューム値として設定されます。補間処理は適用されません。

audioMixerGroups[0].audioMixer.SetFloat(mixerGroupName, decibel);

　補間処理を行いたい場合は、DOTween などのライブラリを使用することで実現できます。

　以下は、DOTween を使用したサンプルコードです。
　

using DG.Tweening;
using UnityEngine;
using UnityEngine.Audio;

public class AudioMixerController : MonoBehaviour
{
    [SerializeField] private AudioMixer audioMixer;
    [SerializeField] private string mixerGroupName;
    [SerializeField] private float duration;

    public void SetLinearVolumeToMixerGroup(string mixerGroupName, float linerVolume) {
        float decibel = 20.0f * Mathf.Log10(linerVolume);

        if (float.IsNegativeInfinity(decibel)) {
            decibel = -96f;  // 無音は -80f ではなくて -96f にする
        }

　　　　// DOTween を利用して補間処理を行う
        audioMixerGroups[0].DOSetFloat(mixerGroupName, decibel, duration);
    }
}

参考サイト

Github ハトネコエ様
オーディオのフェードイン・フェードアウト：DOTween 使用（ブログ公開用）
https://gist.github.com/nekonenene/3643fe8e958fc8b...

４．Slider との連携

　ゲームではよく、スライダー部分を変更することでボリューム制御と紐づけるパターンが多いです。
そちらについてはほかにも詳細に説明している記事がありますので、参考にしてください。

　ここでは、UIManager クラスを作成して、表示と制御を一緒に行う例を提示しておきます。
あくまでも実装例ですので１つのクラスにまとめていますが、今後の学習のため、
こちらを元に MV(R)P パターンで書き直すことにチャレンジしてみましょう。

UIManager

<= クリックすると開きます。

using UnityEngine;
using UnityEngine.UI;
using DG.Tweening;
using UniRx;

public class UIView : MonoBehaviour
{
    [SerializeField]
    private Slider volumeSlider;

    [SerializeField]
    private Text txtVolumeValue;



    void Start() {
        // デバッグ用
        SetUp();
    }

    /// <summary>
    /// 初期設定
    /// </summary>
    public void SetUp() {
        // Slider の OnValueChangedAsObservable を購読
        volumeSlider.OnValueChangedAsObservable()
            .Subscribe(x =>
            {
                SoundManager.instance.SetLinearVolumeToMixerGroup(ConstData.MASTER_AUDIO_NAME, x);
                UpdateVolumeValue(x); 
            })
            .AddTo(gameObject);

        // スライダーの Value に現在のボリューム設定
        volumeSlider.value = SoundManager.instance.masterVolume;
    }

    /// <summary>
    /// ボリュームの ％ 表示の更新
    /// </summary>
    /// <param name="value"></param>
    private void UpdateVolumeValue(float value) {
        txtVolumeValue.text = (value * 100).ToString("F0");
    }
}

　AudioMixer とスライダーとの連携を行うことで
それぞれの画面を一緒に見ることで、AudioMixer とスライダーが同期していることを確認できます。

実装動画

　動作検証はわかりやすい形で行っていくことを心掛けてください。
　
　以上で完成です。
お疲れ様でした！

５．そのほか

１．複数のスライダー

　今回の実装では、Master に合わせてすべてのボリュームを制御する方法で実装していますが、
他にも BGM 用のスライダーを用意して、BGM のボリュームのみを制御する方法も可能です。

　今回学習した内容を応用することで実装可能ですのでチャレンジしてみてください。

２．複数のダッキング設定

　SE と同時にボイスを再生する場合、ボイスを優先して鳴らしたいケースが多いと思います。
その場合には、BGM の AudioMixerGroup に設定したダッキングの情報を SE にも設定することで実現できます。

　想定される挙動は次のようになります。
各 AudioMixerGroup へのダッキング設定とスレッショルドの設定を行うことが重要です。

・SE が鳴っている間、BGM のボリュームを自動的に下げる
　　　→　①BGM に Duck Volume を設定する。Threshold の設定値を -20 ～ -25 位に設定する
　　　　　②SE に Send を設定する。Send 先を BGM に設定する

　SE から音源が流れてきたとき、同時に BGM が流れている場合には、スレッショルドの値に収まるように BGM のボリュームを抑えることができます。

・ボイスが鳴っている間、BGM と SE のボリュームを自動的に下げる
　　　→　①SE に Duck Volume を設定する。Threshold の設定値を -20 ～ -25 位に設定する
　　　　　②ボイス に Send を２つ設定する。Send 先を BGM と SE にそれぞれ設定する

　このように設定しておくことで、ボイスが流れたとき、SE と BGM に情報が伝達され、
各 AudioMixerGroup はそれぞれのスレッショルドの範囲内に収まるようにボリュームの制限をしてくれます。

このページを編集するこのページを元に新規ページを作成

印刷する

コメント（0）

スクリプトによる AudioMixer の音量制御方法 - i-school 先頭へ

コメントをかく

名前	ユーザIDを使用しないで書き込む	ユーザーIDを使う	ログインする
画像コード	画像に記載されている文字を下のフォームに入力してください。
備考	「http://」を含む投稿は禁止されています。
本文
利用規約をご確認のうえご記入下さい

i-school