サウンドのボリュームを変更する

概要

サウンドのボリュームを変更します。

動作環境

必須環境

動作確認環境

サンプルの操作方法

内容

※この Tips は XNA Game Studio 2.0 をベースに説明しています。

フィールド

/// <summary>
/// オーディオカテゴリー
/// </summary>
private AudioCategory audioCategory;

サウンドのボリュームを変更するには「カテゴリー(AudioCategory)」を介して変更します。このカテゴリーは AudioEngine から取得します。

カテゴリーの取得

// XACT で作成してあるカテゴリー名を指定してカテゴリーを取得
this.audioCategory = this.audioEngine.GetCategory("Default");

カテゴリーは「AudioEngine.GetCategory」メソッドを使用して取得します。メソッドに指定する名前は XACT でプロジェクトを作成したときのカテゴリ名です。デフォルトでは「Default」と「Music」が作成されているので、特に編集をしていない場合はどちらかを指定してください。

AudioEngine.GetCategory メソッド

オーディオカテゴリーを取得します。

ボリュームの変更

// ボリュームは 0.0 ～ 2.0 の間に収める
this.volume = MathHelper.Clamp(this.volume, 0.0f, 2.0f);

// ボリュームをセット
this.audioCategory.SetVolume(this.volume);

サウンドのボリュームを変更するには「AudioCategory.SetVolume」メソッドを使用します。引数にはボリュームをセットします。指定できる範囲は 0.0 ～ です。値の基準は以下のようになっています。

AudioCategory.SetVolume メソッド

カテゴリーに結び付けられているすべてのサウンドの音量をセットします。

全コード

using System;
using System.Collections.Generic;
using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Audio;
using Microsoft.Xna.Framework.Content;
using Microsoft.Xna.Framework.GamerServices;
using Microsoft.Xna.Framework.Graphics;
using Microsoft.Xna.Framework.Input;
using Microsoft.Xna.Framework.Net;
using Microsoft.Xna.Framework.Storage;

namespace ChangeSoundVolume
{
    /// <summary>
    /// ゲームメインクラス
    /// </summary>
    public class GameMain : Microsoft.Xna.Framework.Game
    {
        /// <summary>
        /// グラフィックデバイス管理クラス
        /// </summary>
        private GraphicsDeviceManager graphics = null;

        /// <summary>
        /// スプライトのバッチ化クラス
        /// </summary>
        private SpriteBatch spriteBatch = null;

        /// <summary>
        /// スプライトでテキストを描画するためのフォント
        /// </summary>
        private SpriteFont font = null;

        /// <summary>
        /// オーディオエンジン
        /// </summary>
        private AudioEngine audioEngine = null;

        /// <summary>
        /// WaveBank
        /// </summary>
        private WaveBank waveBank = null;

        /// <summary>
        /// SoundBank
        /// </summary>
        private SoundBank soundBank = null;

        /// <summary>
        /// オーディオカテゴリー
        /// </summary>
        private AudioCategory audioCategory;

        /// <summary>
        /// サウンドのボリューム
        /// </summary>
        private float volume = 1.0f;

        /// <summary>
        /// 直線のキーボード入力の状態
        /// </summary>
        private KeyboardState oldKeyboardState = new KeyboardState();

        /// <summary>
        /// 直線のゲームパッド入力の状態
        /// </summary>
        private GamePadState oldGamePadState = new GamePadState();


        /// <summary>
        /// GameMain コンストラクタ
        /// </summary>
        public GameMain()
        {
            // グラフィックデバイス管理クラスの作成
            this.graphics = new GraphicsDeviceManager(this);

            // ゲームコンテンツのルートディレクトリを設定
            this.Content.RootDirectory = "Content";
        }

        /// <summary>
        /// ゲームが始まる前の初期化処理を行うメソッド
        /// グラフィック以外のデータの読み込み、コンポーネントの初期化を行う
        /// </summary>
        protected override void Initialize()
        {
            // オーディオデータの読み込み
            this.audioEngine = new AudioEngine(@"Content\Audio.xgs");
            this.waveBank = new WaveBank(this.audioEngine, @"Content\Wave Bank.xwb");
            this.soundBank = new SoundBank(this.audioEngine, @"Content\Sound Bank.xsb");

            // XACT で作成してあるカテゴリー名を指定してカテゴリーを取得
            this.audioCategory = this.audioEngine.GetCategory("Default");

            // コンポーネントの初期化などを行います
            base.Initialize();
        }

        /// <summary>
        /// ゲームが始まるときに一回だけ呼ばれ
        /// すべてのゲームコンテンツを読み込みます
        /// </summary>
        protected override void LoadContent()
        {
            // テクスチャーを描画するためのスプライトバッチクラスを作成します
            this.spriteBatch = new SpriteBatch(this.GraphicsDevice);

            // フォントをコンテンツパイプラインから読み込む
            this.font = this.Content.Load<SpriteFont>("Font");
        }

        /// <summary>
        /// ゲームが終了するときに一回だけ呼ばれ
        /// すべてのゲームコンテンツをアンロードします
        /// </summary>
        protected override void UnloadContent()
        {
            // TODO: ContentManager で管理されていないコンテンツを
            //       ここでアンロードしてください
        }

        /// <summary>
        /// 描画以外のデータ更新等の処理を行うメソッド
        /// 主に入力処理、衝突判定などの物理計算、オーディオの再生など
        /// </summary>
        /// <param name="gameTime">このメソッドが呼ばれたときのゲーム時間</param>
        protected override void Update(GameTime gameTime)
        {
            // キーボードの情報取得
            KeyboardState keyboargState = Keyboard.GetState();

            // ゲームパッドの情報取得
            GamePadState gamePadState = GamePad.GetState(PlayerIndex.One);

            // Xbox360 コントローラの BACK ボタンを押したときにゲームを終了させます
            if (gamePadState.Buttons.Back == ButtonState.Pressed)
            {
                this.Exit();
            }

            if ((keyboargState.IsKeyDown(Keys.A) && this.oldKeyboardState.IsKeyUp(Keys.A)) ||
                (gamePadState.Buttons.A == ButtonState.Pressed &&
                    this.oldGamePadState.Buttons.A == ButtonState.Released))
            {
                // サウンドを再生
                this.soundBank.PlayCue("Sample");
            }

            // キー操作でボリューム変更
            if (keyboargState.IsKeyDown(Keys.Left))
            {
                this.volume += -1.0f * (float)gameTime.ElapsedGameTime.TotalSeconds;
            }
            if (keyboargState.IsKeyDown(Keys.Right))
            {
                this.volume += 1.0f * (float)gameTime.ElapsedGameTime.TotalSeconds;
            }
            if (gamePadState.IsConnected)
            {
                this.volume += gamePadState.ThumbSticks.Left.X *
                               (float)gameTime.ElapsedGameTime.TotalSeconds;
            }

            // ボリュームは 0.0 ～ 2.0 の間に収める
            this.volume = MathHelper.Clamp(this.volume, 0.0f, 2.0f);

            // ボリュームをセット
            this.audioCategory.SetVolume(this.volume);

            // 入力状態を記憶
            this.oldKeyboardState = keyboargState;
            this.oldGamePadState = gamePadState;

            // 登録された GameComponent を更新する
            base.Update(gameTime);
        }

        /// <summary>
        /// 描画処理を行うメソッド
        /// </summary>
        /// <param name="gameTime">このメソッドが呼ばれたときのゲーム時間</param>
        protected override void Draw(GameTime gameTime)
        {
            // 画面を指定した色でクリアします
            this.GraphicsDevice.Clear(Color.CornflowerBlue);

            // スプライトの描画準備
            this.spriteBatch.Begin();

            // ボリューム
            this.spriteBatch.DrawString(this.font,
                "Volume : " + this.volume,
                new Vector2(50.0f, 50.0f), Color.White);

            // 操作
            this.spriteBatch.DrawString(this.font,
                "A     : Play Sound\r\n" +
                "Left  : Volume Down\r\n" +
                "Right : Volume Up",
                new Vector2(50.0f, 80.0f), Color.White);

            // スプライトの一括描画
            this.spriteBatch.End();

            // 登録された DrawableGameComponent を描画する
            base.Draw(gameTime);
        }
    }
}