2021年09月18日くいなちゃん


プログラミング言語Kuin」の実行環境がexe用のAPIリファレンスページです。
bgmライブラリは現在、動作環境(-eオプション)が「exe」のときのみ使えます。 他の環境向けに使用するとコンパイルエラーになります。

 bgm@play

BGMを再生する関数です。

func play(path: []char, startPos: float): float

path再生するBGMのファイルパス(.wav、.ogg)
startPos再生開始位置[秒]
戻り値再生中だったBGMの再生位置[秒]。 再生していなかった場合は0.0
再生中だったBGMと同じファイルパスを指定した場合は、何もせずに0.0を返して抜けます。
「.ogg」形式のファイルを読み込む場合、事前に一度ogg@init関数を呼ぶ必要があります。
発生条件ビルド例外コード
ファイルの拡張子が「.wav、.ogg」以外dbgのみ0xE9170006
サウンドの生成に失敗dbgおよびrls0xE9170009
startPosが0.0未満もしくはサウンドの長さ以上dbgのみ0xE9170006

 bgm@playCross

BGMをクロスフェードで再生する関数です。

func playCross(path: []char, startPos: float, fadeTime: int): float

path再生するBGMのファイルパス(.wav、.ogg)
startPos再生開始位置[秒]
fadeTimeフェードにかかる時間(wnd@actを呼ぶ回数)
戻り値再生中だったBGMの再生位置[秒]。 再生していなかった場合は0.0
再生中だったBGMと新しいBGMがなめらかに入れ替わるようにフェードします。
再生中だったBGMと同じファイルパスを指定した場合は、何もせずに0.0を返して抜けます。
「.ogg」形式のファイルを読み込む場合、事前に一度ogg@init関数を呼ぶ必要があります。
wnd@act関数を呼ぶたびにフェード処理が行われます。 fadeTimeに指定した回数だけwnd@actが呼ばれるとフェードが完了します。
発生条件ビルド例外コード
ファイルの拡張子が「.wav、.ogg」以外dbgのみ0xE9170006
サウンドの生成に失敗dbgおよびrls0xE9170009
startPosが0.0未満もしくはサウンドの長さ以上dbgのみ0xE9170006
fadeTimeが1より小さいdbgのみ0xE9170006

 bgm@playFade

BGMをフェードアウトして再生する関数です。

func playFade(path: []char, startPos: float, fadeTime: int): float

path再生するBGMのファイルパス(.wav、.ogg)
startPos再生開始位置[秒]
fadeTimeフェードにかかる時間(wnd@actを呼ぶ回数)
戻り値再生中だったBGMの再生位置[秒]。 再生していなかった場合は0.0
再生中だったBGMがフェードアウトしたのち、新しいBGMが再生されます。
再生中だったBGMと同じファイルパスを指定した場合は、何もせずに0.0を返して抜けます。
「.ogg」形式のファイルを読み込む場合、事前に一度ogg@init関数を呼ぶ必要があります。
wnd@act関数を呼ぶたびにフェード処理が行われます。 fadeTimeに指定した回数だけwnd@actが呼ばれるとフェードが完了します。
startPosが0.0未満もしくはサウンドの長さ以上だった場合、新しいBGMの再生時に例外が発生します。
発生条件ビルド例外コード
ファイルの拡張子が「.wav、.ogg」以外dbgのみ0xE9170006
サウンドの生成に失敗dbgおよびrls0xE9170009
fadeTimeが1より小さいdbgのみ0xE9170006

 bgm@stop

BGMを停止する関数です。

func stop(): float

戻り値再生中だったBGMの再生位置[秒]。 再生していなかった場合は0.0

 bgm@stopFade

BGMをフェードアウトして停止する関数です。

func stopFade(fadeTime: int): float

fadeTimeフェードにかかる時間(wnd@actを呼ぶ回数)
戻り値再生中だったBGMの再生位置[秒]。 再生していなかった場合は0.0
wnd@act関数を呼ぶたびにフェード処理が行われます。 fadeTimeに指定した回数だけwnd@actが呼ばれるとフェードが完了します。
発生条件ビルド例外コード
fadeTimeが1より小さいdbgのみ0xE9170006

 bgm@volume

BGMの音量を設定する関数です。

func volume(value: float)

value音量(0.0以上、1.0以下)
BGMのフェード時には、ここで設定した音量とフェードの音量が乗算されて最終的な音量となります。
発生条件ビルド例外コード
valueが0.0より小さい、もしくは1.0より大きいdbgのみ0xE9170006
1631942983jaf