プログラム例

SounDecoder Soundsにおけるスタティックサウンド (短い効果音向きのサウンド)は、すべて StaticSound を継承します。それらのクラスのコンストラクタの仕様は実装によって異なりますが、最も簡単なものは次のようにサウンドデバイスとサウンドデコーダを受け取ります。

第1引数には、予め初期化しておいたサウンドデバイスを渡し、第2引数にはこのスタティックサウンドの内容となるデータを返すデコーダを与えます。また、得られたインスタンスは StaticSound にアップキャストしてしまって構わないでしょう。

スタティックサウンドの再生は、 Play() メソッドを呼び出せば始まります。

サウンドデータの最後まで再生されると自動的に停止されますが、再生途中で一時停止を行いたい場合は Stop() メソッドを呼び出します。

Stop() メソッドは一時停止を行います。このメソッドを呼んでも再生位置は保存されたままとなる為、その後で再び Play() メソッドを呼べば、一時停止された場所から再生が再開されます。

スタティックサウンドを作成した直後は、 Play() メソッドで再生を開始した後、最後まで再生すると自動的に停止するようになっています。この動作は、 Looping プロパティをtrueにする事で変えられます。

Looping プロパティをtrueにすると、ループ再生を行うようになり、最後まで再生した後は再び先頭に戻って再生が続けられます。falseにしておくと、最後まで到達したら停止するという既定の動作になります。

Looping プロパティに限らず、ほとんどのプロパティは(ドキュメントで明示的に不可能だと書かれていない限り)サウンドの再生中でも変更が可能です。

スタティックサウンドを使い終わったら、Dispose()メソッドで破棄します。

SounDecoder Soundsにおけるストリーミングサウンド (長いBGM向きのサウンド)は、すべて StreamingSound を継承します。スタティックサウンドと同じく、それらのクラスのコンストラクタの仕様は実装によって異なりますが、最も簡単なものは次のようにサウンドデバイスとサウンドデコーダを受け取ります。

第1引数には、予め初期化しておいたサウンドデバイスを渡し、第2引数にはこのストリーミングサウンドの内容となるデータを返すデコーダを与えます。得られたインスタンスは StreamingSound にアップキャストするのがいいでしょう。

ストリーミングサウンドの再生も、スタティックサウンドの時と全く同じです。 Play() メソッドを呼び出せば始まります。

ストリーミングサウンドの場合でもサウンドデータの最後まで再生されると自動的に停止されますが、再生途中で一時停止を行いたい場合は Stop() メソッドを呼び出します。

Stop() メソッドはここでも一時停止を行うだけです。後で再び Play() メソッドを呼べば、一時停止された場所から再生が再開されます。

ストリーミングサウンドを思い通りに再生するにはまずサウンドパートの概念を理解する必要があるでしょうが、ただ単に一つのサウンドをループ再生したい場合は、ほぼスタティックサウンドの時と同じように行えます。まず、スタティックサウンドと同様に Looping プロパティをtrueに変更します。

更に、次のようなコードを書き加えます。

このコードの詳しい意味についてはここでは触れませんが、これだけ書けばストリーミングサウンド全体をループ再生する事ができます。

ストリーミングサウンドを使い終わったら、Dispose()メソッドで破棄します。

ボリュームの変更は、 Volume プロパティを変更する事で行えます。

音量変化が無い時、 Volume プロパティは値1.0を持ちます。また、0.0を与えると無音になります。勿論、その間の値を与える事もできます。そのような値は、人間の感覚に比例するように──0.5が与えられたなら、1.0の時と比べて半分の大きさだと感じられるように──解釈されます。

ボリュームの最低値は常に0.0ですが、最大値はSounDecoder Soundsの実装によって異なる可能性があります。与える事のできる最大値は、 MaxVolume プロパティで得られます。

パンは、ボリュームと同様にして Pan プロパティで変更できます。

既定では、パンは値0.0を持ち、(基の音源に偏りがなければ)音が中央から聞こえます。-1.0を与えると右チャネルが無音になり、左から聞こえてくるようになります。1.0ではその逆で左チャネルが消え、音が右から聞こえるようになります。ボリュームと同様に、パンは線形のスケールを持ちます──中間値は人間の感覚に比例するように解釈されます。

パンの最低値は常に-1.0で、最大値は常に1.0です。

再生速度の変更には、 Speed プロパティを使います。

既定では再生速度は1.0です。上の例のように1.5にすれば、サウンドは1.5倍速で再生されます。なお、 Speed プロパティを変更すると、再生速度と共に音の高さも変わります。

他のエフェクトと異なり、再生速度の最低値と最大値は、実装ごとに異なる可能性がある事に加え、サウンド(のインスタンス)ごとにも異なる可能性があります。この為、再生速度を変更する際には MinSpeed プロパティや MaxSpeed プロパティを調べながら行う必要があります。

スタティックサウンドの長さは、次のようにして取得する事ができます。

長さはサンプル単位で得られます。もし秒単位に直したいのであれば、そのサウンドのサンプリングレートを取得し、それによって割る必要があります。

再生位置は、 Position プロパティで取得・変更が行えます。

再生位置は、スタティックサウンドの場合現在の位置に到達する為に最低限必要なサンプル数で定義されます。つまり、ループ再生している場合は、サウンドの終わりまで再生して先頭に戻る度に再生位置も0に戻ります。また Position プロパティの値を変更して再生位置を変える場合も、長さを超えないように注意する必要があります。

なお、秒単位で得たい場合は、長さの時と同じように、サンプリングレートで割る必要があります。

スタティックサウンドは、複製してクローンを作る事が可能です。複製するには Clone() メソッドを呼び出します。

クローンの内容は、オリジナルと同じものになります。つまり、 Play() メソッドが呼ばれれば、同じ音が再生されます。また、クローンとオリジナルは別々の再生位置を持つ事ができます。これにより、複数の同じ音を重ねて再生する事ができます。

複数の同じ音を重ねて再生するだけなら、同じ内容のストリームを扱うサウンドデコーダを複数用意して、個別にスタティックサウンドを作成する事によっても可能ですが、クローンを用いる方法はそれと比べてメモリ消費量などの点で有利です。