Play, pause, and stop by queue

summary

Use cues to play, pause, and stop sounds.

Operating environment

Prerequisites

Operating environment

How to work with the sample

substance

Note: These tips are based on XNA Game Studio 2.0.

field

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

You have declared a cue that you want to use to play, pause, or stop a sound.

Retrieving Queues

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

To retrieve a cue, use the GetCue method from the SoundBank. The name passed in the argument specifies the name of the queue that you set up when you created it in XACT.

SoundBank.GetCue method

Retrieves a cue from a soundbank.

Playing Sounds

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

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

To play the sound, use the "Cue.Play" method. However, after playback is complete, it cannot be played back with the Cue.Play method. You can determine if playback is complete by using the "Cue.IsPrepared" property, so if playback is complete, use the SoundBank.GetCue method to retrieve the cue again.

Cue.Play method

Start playing the sound in the ready cue.

Pause the sound

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

To play the sound, use the "Cue.Pause" method. In the sample, we get the "Cue.IsPlaying" property to see if it is playing, and if it is playing, we pause it.

Cue.Pause method

Pauses the sound that is playing.

Resume from a sound pause

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

To resume a paused sound from the beginning, use the Cue.Resume method. In the sample, the "Cue.IsPause" property is used to determine whether it is paused.

Cue.Resume method

Resume a queue that is paused.

Stop the sound

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

To stop the sound that is playing, use the "Cue.Stop" method. This method can be used during playback or pause. There are two "AudioStopOptions" enumerations to pass in the arguments, but either one can be used.

Cue.Stop method

Stops the queue that is playing.

All Codes

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);
        }
    }
}