Table of Contents

Interface IAudio

Namespace
VMagicMirror.Buddy

音声の再生に関連するAPIです。

public interface IAudio

Methods

Play(string, float, float, string)

ファイルパスを指定して音声を再生します。

void Play(string path, float volume = 1, float pitch = 1, string key = "")

Parameters

path string

音声データのファイルパス

volume float

音声のボリュームを 0 以上、1 以下の値で指定します。指定しない場合は 1.0f であるものとして扱われます。

pitch float

音声のピッチを、1を基準として指定します。指定しない場合は 1.0f になります。

key string

AudioStarted で実際に音声再生が開始したことを検出するときの一意識別子が必要な場合、その文字列を指定します。指定しない場合は空文字列になります。

Remarks

この関数を呼び出してから音声再生が開始するまでにはディレイが発生する場合があります。 実際に音声の再生が開始したことは AudioStarted イベントで確認できます。

Stop(string)

音声の再生を停止します。

void Stop(string key = "")

Parameters

key string

特定の音声の再生を停止する場合、Play(string, float, float, string)で指定したのと同じ値を指定します。 このサブキャラが再生している全ての音声を停止する場合、空文字列を指定します。 デフォルトでは空文字列が指定されたものとして扱われます。

Remarks

この関数は Play(string, float, float, string) を呼び出していない場合やすでに音声が再生終了している場合にも実行できますが、その場合は何も起こりません。

Events

AudioStarted

Play(string, float, float, string) で指定して音声の再生を開始するときに発火します。

event Action<AudioStartedInfo> AudioStarted

Event Type

Action<AudioStartedInfo>

AudioStopped

Play(string, float, float, string) で指定した音声の再生が停止するときに発火します。

event Action<AudioStoppedInfo> AudioStopped

Event Type

Action<AudioStoppedInfo>