va5 online demo
ここには、va5のサンプルコード例を掲載しています。
ここのサンプルコードは、このページにてブラウザのjsコンソールを開いてコピペする事で即座に動作を試す事ができます。
また、このページでは以下のjs定義がなされており、コンソールから sound1 music1 等を参照する事ができます。
var sound1 = "./kick.m4a";
var sound2 = "./piin.m4a";
var music1 = "./cntr2.m4a";
var music2 = "./dandd.m4a";
va5.setConfig("is-pause-on-background", true);
va5.setConfig("is-output-error-log", true);
va5.setConfig("is-output-debug-log", true);
最短利用
SEを鳴らす
va5.se("./kick.m4a")
va5.se(sound1)
va5.se({path:sound2})
ループBGMを鳴らす
va5.bgm("./cntr2.m4a")
va5.bgm(music1)
va5.bgm({path:music2})
BGMをフェードアウト停止させる
va5.stopBgm()
va5.bgm()
va5.bgm(null)
非ループBGMを鳴らす
va5.bgm(music1, {playEndSec:0})
va5.bgm("./cntr2.m4a#__NL")
(※この "#" を使う書き方は非推奨。そうではなく、ファイル名自体を変更し、拡張子直前の位置に "__NL" の指定を入れるのがよいです。この場合はファイル名を cntr2__NL.m4a とする事になります。NL前のアンダーバーは半角二個です)
再生パラメータ指定
BGM再生時のパラメータを指定する
va5.bgm(music1, {volume:0.5, pitch:0.5, pan:-1.0, fadeinSec:1.5})
va5.bgm({path:music2, channel:"extra_bgm"})
BGM停止するチャンネルとフェードアウト秒数を指定する
va5.stopBgm("extra_bgm", 2.5)
全体設定項目を変更する
va5.setConfig("volume-master", 0.5)
全体設定項目の現在値を参照する
va5.getConfig("volume-master")
プリロードとアンロード
音源をバックグラウンドでプリロード予約する
va5.load(music1)
va5.load({path:music1})
va5.load(music2, function () { console.log("va5.isError() ", va5.isError(music2)); })
va5.load("./not-found.m4a", function () { console.log("va5.isError() ", va5.isError("./not-found.m4a")); })
(プリロードせずに再生する事も可能です。その場合は内部で勝手にプリロードを行い、ロードが完了してから再生が行われます)
(※第二引数に関数を指定した場合、既にプリロード済なら即座に関数が実行されます。まだの場合はプリロード完了後に関数が実行されますがプリロードが失敗したりキャンセルされた場合にも実行されるので、成功したかどうかが重要な場合は必ず va5.isError() 等で成功した事を確認してください)
プリロード実行が失敗していないか判断する
va5.load(music2, function () { console.log("va5.isError() ", va5.isError(music2)); })
va5.load("./not-found.m4a", function () { console.log("va5.isError() ", va5.isError("./not-found.m4a")); })
(まだプリロードが完了していない場合や、そもそもプリロードしていないファイルを判定した場合は偽値が返ります)
プリロード中かどうか判断する
va5.load(music1); console.log("va5.isLoading() ", va5.isLoading(music1))
プリロード処理がキャンセルされたか判断する
console.log("va5.isCancelled() ", va5.isCancelled(music1))
(※そもそもプリロードしていないファイルを判定した場合にも真値が返ります)
(キャンセルは通常は発生しませんが、後述のunloadを実行するとタイミングによっては発生します)
ロードされた音源をアンロードする
va5.unload(music1)
va5.unload({path:music2})
(va5は再生対象の音源を内部で保持し続けるので音源の量が多い場合はメモリを消費します。これを避けるには、再生する必要のなくなった音源をアンロードする必要があります)
(一度アンロードした後も、また再生しようとすれば再度ロード処理が行われて正常に再生されます)
(※再生中の音源をアンロードすると途中で再生が強制終了されます)
音源がプリロード中/再生中でない場合に限りアンロードする
va5.unloadIfUnused(music1)
va5.unloadIfUnused({path:music2})
ロードされた全音源をアンロードする
va5.unloadAll()
(※再生中の音源をアンロードすると途中で再生が強制終了されます)
再生中でない音源を全てアンロードする
va5.unloadAllIfUnused()
(※全音源を一つずつチェックして処理する関係で少し重いです、注意)
高度な機能
BGMチャンネルを指定し、再生中のBGMの現在の再生位置(秒)を取得(音ゲー向き)
va5.getBgmPos()
va5.getBgmPos("extra_bgm")
(※まだまだ他にも多数の機能があります、詳細はリファレンスを参照)
ボイス再生
ボイス再生する
va5.voice(sound1, {channel:"キャラ名"})
va5.voice({path:sound2, channel:"キャラ名"})
(オプションについてはBGMと大体同じ)
(voiceでは「同じキャラの台詞同士は同時に二つ重ねて再生できない(片方のみになる)」「違うキャラの台詞同士は同時に二つ以上重ねて再生できる」という要件を満たせるよう、常にchannel指定を行う事を推奨します)
ボイス停止する(channelとフェードアウト秒数を指定する)
va5.stopVoice("キャラ名", 0)
