applican

マイページに戻る

GameSound

ゲーム向きの音声再生を行います。

機能

BGMを読み込む 【 loadBGM 】

BGMを再生をする行う 【 playBGM 】

BGMを一時停止する 【 pauseBGM 】

BGMを終了する 【 stopBGM 】

BGMのボリュームを設定する 【 setBGMVolume 】

全BGMを終了する 【 stopAllBGM 】

全BGMをメモリから解放する 【 releaseAllBGM 】

SEを読み込む 【 loadSE 】

SEを再生する 【 playSE 】

SEを一時停止する 【 pauseSE 】

SEを終了する 【 stopSE 】

SEボリュームを設定する 【 setSEVolume 】

全SEを終了する 【 stopAllSE 】

全SEをメモリから解放する 【 releaseAllSE 】

利用用途

アプリ内でのゲーム用BGM再生やBGMコントロール機能を実装したい場合、こちらの機能をご利用ください。

【対応ランタイムバージョン】

ランタイムのバージョン毎に最適化したサンプルをダウンロードしてご使用ください。

サンプル GameSound
サンプル GameSound
サンプル GameSound
サンプル GameSound

メソッド

loadBGM

メソッド説明

loadBGM(Array bgmList, Function loadBGMSuccess, Function loadBGMError)

BGM読み込みを開始します。

パラメータ

bgmList : Array BGMリスト
loadBGMSuccess : Function 成功時のコールバック
loadBGMError : Function 失敗時のコールバック

Return

void

サンプルコード

var bgmList = [
	{track:0, src:"gamesound/bgm1.mp3"},
	{track:1, src:"gamesound/bgm2.mp3"},
	{track:2, src:"gamesound/bgm3.mp3"},
	{track:3, src:"gamesound/bgm4.mp3"}
];

applican.gamesound.loadBGM(bgmList, loadBGMSuccess, loadBGMError);

function loadBGMSuccess(){
}

function loadBGMError(err){
	alert(err.code);
}

補足

  • 失敗時のコールバックはエラーコードが渡されます。
  • BGMリストで指定した音声データをすべて正常に読み込むと成功時のコールバックが呼ばれます。
  • BGMリストは、trackとsrcの配列を指定します。
  • 指定可能なtrackは0~3です。上記の例は4トラック全てまとめて読み込んでいますが、一部のみ読み込むことも可能です。
  • 既にデータを読み込んでいるトラックを指定して読み込みをすると、古いデータはメモリから解放したうえで、指定したトラックに音声データを読み込みます。
  • BGMに指定できる音声データはmp3です。長さに制限はありません。
  • 厳密な音声データ仕様は機種やOSバージョンに依存します。
  • web.zipに同梱した音声データを指定する場合はwebフォルダ配下からのパスを指定します。インターネット上のコンテンツを指定する場合はhttp://xxx/xxx/bgm.mp3のように指定します。

playBGM

メソッド説明

playBGM(Object option)

BGM再生を行います。

パラメータ

option : Object オプションにはトラック番号と、BGMをループするかどうかを指定できます。

Return

void

サンプルコード

var options = {};
options.track = track;
options.loop = true;
applican.gamesound.playBGM(options);

pauseBGM

メソッド説明

pauseBGM(Number index)

BGM一時停止を行います。

パラメータ

index : Number トラック番号

Return

void

stopBGM

メソッド説明

stopBGM(Number index)

BGM終了を行います。

パラメータ

index : Number トラック番号

Return

void

setBGMVolume

メソッド説明

setBGMVolume(Number index, Number volume)

BGMボリューム設定を行います。

パラメータ

index : Number トラック番号
volume : Number ボリューム値は0~100を指定します。

Return

void

stopAllBGM

メソッド説明

stopAllBGM()

全BGMを終了します。

Return

void

releaseAllBGM

メソッド説明

releaseAllBGM()

全BGMをメモリから解放します。

Return

void

loadSE

メソッド説明

loadSE(Array seList, Function loadSESuccess, Function loadSEError)

SE読み込みを開始します。

パラメータ

seList : Array SEリスト
loadSESuccess : Function 成功時のコールバック
loadSEError : Function 失敗時のコールバック

Return

void

サンプルコード

var seList = [
	{track:0, src:"gamesound/se1.wav"},
	{track:1, src:"gamesound/se2.wav"},
	{track:2, src:"gamesound/se3.wav"}
];

applican.gamesound.loadSE(seList, loadSESuccess, loadSEError);

function loadSESuccess(){
}

function loadSEError(err){
	alert(err.code);
}

補足

  • 失敗時のコールバックはエラーコードが渡されます。
  • SEリストで指定した音声データをすべて正常に読み込むと成功時のコールバックが呼ばれます。
  • SEリストは、trackとsrcの配列を指定します。
  • 指定可能なtrackは0~11です。上記の例は3トラック分をまとめて読み込んでいます。
  • SEに指定できる音声データはwavです。長さは10秒までです。
  • 厳密な音声データ仕様は機種やOSバージョンに依存します。
  • web.zipに同梱した音声データを指定する場合はwebフォルダ配下からのパスを指定します。インターネット上のコンテンツを指定する場合はhttp://xxx/xxx/se.wavのように指定します。

playSE

メソッド説明

playSE(Number index)

SE再生を行います。

パラメータ

index : Number トラック番号

Return

void

pauseSE

メソッド説明

pauseSE (Number index)

SEを一時停止します。

パラメータ

index : Number トラック番号

Return

void

stopSE

メソッド説明

stopSE (Number index)

SEを終了します。

パラメータ

index : Number トラック番号

Return

void

setSEVolume

メソッド説明

setSEVolume(Number index, Number volume)

SEボリューム設定を行います。

パラメータ

index : Number トラック番号
volume : Number ボリューム値は0~100を指定します。

Return

void

stopAllSE

メソッド説明

stopAllSE()

全SEを終了します。

Return

void

releaseAllSE

メソッド説明

releaseAllSE()

全SEをメモリから解放します。

Return

void