キューによる再生・一時停止・停止

概要

キュー(Cue)を使用してサウンドの再生、一時停止、停止の操作を行います。

動作環境

必須環境

動作確認環境

サンプルの操作方法

内容

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

フィールド

/// <summary>
/// キュー
/// </summary>
private Cue cue = null;

サウンドの再生、一時停止、停止などの操作を行うために使用するキューを宣言しておきます。

キューの取得

// 再生するためのキューを取得します
this.cue = this.soundBank.GetCue("Sample");

キューを取得するには SoundBank から GetCue メソッドを使用して取得します。引数に渡す名前は XACT で作成した際に設定したキューの名前を指定します。

SoundBank.GetCue メソッド

サウンドバンクからキューを取得します。

サウンドの再生

if (!this.cue.IsPrepared)
{
    // 新しいキューを取得します
    this.cue = this.soundBank.GetCue(cue.Name);
}

// 再生開始
this.cue.Play();

サウンドを再生するには「Cue.Play」メソッドを使用します。ただし、再生が完了した後に再度 Cue.Play メソッドで再生することはできません。再生が完了したかは「Cue.IsPrepared」プロパティで判断できるので、再生が完了した場合は SoundBank.GetCue メソッドで再度キューを取得してください。

Cue.Play メソッド

準備が完了したキューでサウンドの再生を開始します。

サウンドの一時停止

else if (this.cue.IsPlaying)
{
    // 一時停止
    this.cue.Pause();
}

サウンドを再生するには「Cue.Pause」メソッドを使用します。サンプルでは再生しているかを「Cue.IsPlaying」プロパティで取得し、再生中なら一時停止するようにしています。

Cue.Pause メソッド

再生中のサウンドを一時停止します。

サウンドの一時停止からの再開

if (this.cue.IsPaused)
{
    // 一時停止から再開する
    this.cue.Resume();
}

一時停止中のサウンドを途中から再開するには「Cue.Resume」メソッドを使用します。サンプルでは一時停止中であるかを「Cue.IsPause」プロパティで取得して判断しています。

Cue.Resume メソッド

一時停止中のキューを再開します。

サウンドの停止

// サウンドを停止します
this.cue.Stop(AudioStopOptions.AsAuthored);

再生中のサウンドを停止するには「Cue.Stop」メソッドを使用します。このメソッドは再生中でも一時停止中でも使用することが可能です。引数に渡す「AudioStopOptions」列挙は２つありますが、どちらでも構いません。

Cue.Stop メソッド

再生中のキューを停止します。

全コード

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 UseCue
{
    /// <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 Cue cue = null;

        /// <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");

            // 再生するためのキューを取得します
            this.cue = this.soundBank.GetCue("Sample");

            // コンポーネントの初期化などを行います
            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 keyboardState = Keyboard.GetState();

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

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

            if ((keyboardState.IsKeyDown(Keys.A) && this.oldKeyboardState.IsKeyUp(Keys.A)) ||
                (gamePadState.Buttons.A == ButtonState.Pressed &&
                    this.oldGamePadState.Buttons.A == ButtonState.Released))
            {
                if (this.cue.IsPaused)
                {
                    // 一時停止から再開する
                    this.cue.Resume();
                }
                else if (this.cue.IsPlaying)
                {
                    // 一時停止
                    this.cue.Pause();
                }
                else
                {
                    if (!this.cue.IsPrepared)
                    {
                        // 新しいキューを取得します
                        this.cue = this.soundBank.GetCue(cue.Name);
                    }

                    // 再生開始
                    this.cue.Play();
                }
            }

            if ((keyboardState.IsKeyDown(Keys.B) && this.oldKeyboardState.IsKeyUp(Keys.B)) ||
                (gamePadState.Buttons.B == ButtonState.Pressed &&
                    this.oldGamePadState.Buttons.B == ButtonState.Released))
            {
                // サウンドを停止します
                this.cue.Stop(AudioStopOptions.AsAuthored);
            }

            // 入力状態を記憶
            this.oldKeyboardState = keyboardState;
            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,
                "A : Play and Pause \r\n" +
                "B : Stop",
                new Vector2(50.0f, 50.0f), Color.White);

            // スプライトの一括描画
            this.spriteBatch.End();
            
            // 登録された DrawableGameComponent を描画する
            base.Draw(gameTime);
        }
    }
}