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


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

 snd@Snd

 snd@Snd.fin



サウンドのリソースを解放するメソッドです。

func fin()

計算量:
既にリソースが解放されているとき、このメソッドは何もしません。
リソースはsnd@Sndクラスのインスタンスが解放されるときに自動で解放されますが、解放のタイミングをコントロールしたいときにこのメソッドを使います。

 snd@Snd.freq



サウンドの周波数を設定するメソッドです。

func freq(value: float)

value本来の周波数からの倍率(0.1以上、2.0以下)
valueを0.5に設定すると本来の半分の速度で再生され、2.0に設定すると本来の倍速で再生されます。
発生条件ビルド例外コード
valueが0.1以上2.0以下の範囲外dbgのみ0xE9170006

 snd@Snd.getPos



サウンドの再生位置を取得するメソッドです。

func getPos(): float

戻り値再生位置[秒]

 snd@Snd.len



サウンドの長さを取得するメソッドです。

func len(): float

戻り値サウンドの長さ[秒]

 snd@Snd.pan



サウンドのパンを設定するメソッドです。

func pan(value: float)

valueパン(-1.0以上、1.0以下)
valueを-1.0に設定すると左のチャンネルからのみ音が鳴り、1.0に設定すると右のチャンネルからのみ音が鳴ります。 初期値は0.0で、ちょうど中央から音が鳴ります。
発生条件ビルド例外コード
valueが-1.0以上1.0以下の範囲外dbgのみ0xE9170006

 snd@Snd.play



サウンドを1回だけ再生するメソッドです。

func play()

 snd@Snd.playLoop



サウンドをループ再生するメソッドです。

func playLoop()

 snd@Snd.playing



サウンドが再生中かどうかを取得するメソッドです。

func playing(): bool

戻り値再生中ならtrue、停止中ならfalse

 snd@Snd.setPos



サウンドの再生位置を設定するメソッドです。

func setPos(value: float)

value再生位置[秒]
発生条件ビルド例外コード
valueが0.0未満もしくはサウンドの長さ以上dbgのみ0xE9170006

 snd@Snd.stop



サウンドを停止するメソッドです。

func stop()

 snd@Snd.volume



サウンドの音量を設定するメソッドです。

func volume(value: float)

value音量(0.0以上、1.0以下)
発生条件ビルド例外コード
valueが0.0以上1.0以下の範囲外dbgのみ0xE9170006

 snd@getMainVolume

全体の音量を取得する関数です。

func getMainVolume(): float

戻り値全体の音量(0.0以上、1.0以下)

 snd@makeSnd

サウンドクラスのインスタンスをファイルから生成する関数です。

func makeSnd(path: []char): snd@Snd

pathサウンドのファイルパス(.wav、.ogg)
戻り値サウンドクラスのインスタンス。 ファイルが開けない場合nullが返る
「.ogg」形式のファイルを読み込む場合、事前に一度ogg@init関数を呼ぶ必要があります。
発生条件ビルド例外コード
ファイルの拡張子が「.wav、.ogg」以外dbgのみ0xE9170006
pathのファイルが開けないdbgおよびrls0xE9170007
サウンドの生成に失敗dbgおよびrls0xE9170009

 snd@setMainVolume

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

func setMainVolume(value: float)

value全体の音量(0.0以上、1.0以下)
各サウンドの最終的な音量は、各サウンドに設定された音量と全体の音量の積で決定されます。
全体の音量はアプリ起動時には1.0に設定されています。
発生条件ビルド例外コード
valueが0.0以上1.0以下の範囲外dbgのみ0xE9170006
1631940670jaf