javax.sound.sampled

インタフェースSourceDataLine

すべてのスーパー・インタフェース:

AutoCloseable、DataLine、Line

public interface SourceDataLine
extends DataLine

ソース・データ・ラインはデータを書き込めるデータ・ラインです。ソース・データ・ラインはミキサーに対してソースとして動作します。アプリケーションがオーディオ・バイトをソース・データ・ラインに書き込むと、ソース・データ・ラインはバイトのバッファリングを処理し、それをミキサーに配信します。ミキサーはサンプルを他のソースからのサンプルとミックスし、それを出力ポートなどのターゲットに配信します。出力ポートとは、サウンド・カードのオーディオ出力デバイスなどのことです。

このインタフェースの命名規則は、ラインとミキサーの関係を反映しています。アプリケーションから見ると、ソース・データ・ラインはオーディオ・データのターゲットの役割を果たします。

ミキサーからソース・データ・ラインを取得するには、適切なDataLine.Infoオブジェクトを指定してMixerのgetLineメソッドを呼び出します。

SourceDataLineインタフェースは、オーディオ・データをデータ・ラインのバッファに書き込むメソッドを提供します。オーディオを再生またはミックスするアプリケーションは、バッファがアンダーフロー(空白化)しないうちにデータをすばやくソース・データ・ラインに書き込みます。アンダーフローによりオーディオに不連続部(クリック音として聞こえる)が生じることがあります。アプリケーションでは、DataLineインタフェースで定義されているavailableメソッドを使用して、データ・ラインのバッファで現在キューに入っているデータの量を判別できます。ブロックせずにバッファに書き込めるデータ量は、バッファ・サイズとキューに入っているデータ量との差です。アンダーフローのためにオーディオ出力の配信が停止した場合は、STOPイベントが生成されます。オーディオ出力が再開すると、STARTイベントが生成されます。

導入されたバージョン:

1.3

関連項目:

Mixer、DataLine、TargetDataLine

ネストされたクラスのサマリー

インタフェース javax.sound.sampled.DataLineから継承されたネストされたクラス/インタフェース

DataLine.Info

メソッドのサマリー

修飾子と型	メソッドと説明
void	open(AudioFormat format) 指定されたフォーマットでラインを開き、ラインが必要なシステム・リソースを獲得して操作可能になるようにします。
void	open(AudioFormat format, int bufferSize) 指定されたフォーマットと指定されたバッファ・サイズでラインを開き、ラインが必要なシステム・リソースを獲得して操作可能になるようにします。
int	write(byte[] b, int off, int len) このソース・データ・ラインを介してオーディオ・データをミキサーに書き込みます。

インタフェース javax.sound.sampled.DataLineから継承されたメソッド

available, drain, flush, getBufferSize, getFormat, getFramePosition, getLevel, getLongFramePosition, getMicrosecondPosition, isActive, isRunning, start, stop

インタフェース javax.sound.sampled.Lineから継承されたメソッド

addLineListener, close, getControl, getControls, getLineInfo, isControlSupported, isOpen, open, removeLineListener

メソッドの詳細

open

void open(AudioFormat format,
          int bufferSize)
   throws LineUnavailableException

指定されたフォーマットと指定されたバッファ・サイズでラインを開き、ラインが必要なシステム・リソースを獲得して操作可能になるようにします。

バッファ・サイズはバイト単位で指定しますが、サンプル・フレームの整数値を表す必要があります。この要件に適合しないバッファ・サイズを指定してこのメソッドを呼び出すと、IllegalArgumentExceptionがスローされることがあります。開いたラインの実際のバッファ・サイズは、指定したバッファ・サイズとは異なることがあります。実際に設定された値は、続いてDataLine.getBufferSize()を呼び出せば照会できます。

この操作が完了すると、ラインは開いている状態としてマークされ、OPENイベントがラインのリスナーにディスパッチされます。

すでに開いているラインでこのメソッドを呼び出すのは不適切なアクションであるため、IllegalStateExceptionが表示されることがあります。

ラインによっては、一度閉じると再度開くことができない場合があります。こうしたラインを再度開こうとすると、常にLineUnavailableExceptionが表示されます。

パラメータ:

format - 目的のオーディオ形式

bufferSize - 目的のバッファ・サイズ

例外:

LineUnavailableException - リソースの制約のためにラインを開けない場合

IllegalArgumentException - バッファ・サイズがサンプル・フレームの整数値を表さない場合、あるいはformatの指定が不完全または無効な場合

IllegalStateException - ラインがすでに開いている場合

SecurityException - セキュリティの制約のためにラインを開けない場合

関連項目:

open(AudioFormat)、Line.open()、Line.close()、Line.isOpen()、LineEvent

open

void open(AudioFormat format)
   throws LineUnavailableException

指定されたフォーマットでラインを開き、ラインが必要なシステム・リソースを獲得して操作可能になるようにします。

バッファ・サイズは実装により選択されます。バッファ・サイズはバイト単位ですが、サンプル・フレームの整数値であることが必要です。システムが選択したバッファ・サイズは、続いてDataLine.getBufferSize()を呼び出せば照会できます。

この操作が完了すると、ラインは開いている状態としてマークされ、OPENイベントがラインのリスナーにディスパッチされます。

すでに開いているラインでこのメソッドを呼び出すのは不適切なアクションであるため、IllegalStateExceptionが表示されることがあります。

ラインによっては、一度閉じると再度開くことができない場合があります。こうしたラインを再度開こうとすると、常にLineUnavailableExceptionが表示されます。

パラメータ:

format - 目的のオーディオ形式

例外:

LineUnavailableException - リソースの制約のためにラインを開けない場合

IllegalArgumentException - formatの指定が不完全または無効な場合

IllegalStateException - ラインがすでに開いている場合

SecurityException - セキュリティの制約のためにラインを開けない場合

関連項目:

open(AudioFormat, int)、Line.open()、Line.close()、Line.isOpen()、LineEvent

write

int write(byte[] b,
          int off,
          int len)

このソース・データ・ラインを介してオーディオ・データをミキサーに書き込みます。要求されたバイト数のデータが、指定されたオフセットを始点として指定された配列から読み込まれ、データ・ラインのバッファに書き込まれます。現在書き込める量を超えるデータを書き込もうとすると(availableを参照)、要求された量のデータの書込みが終わるまでこのメソッドはブロックされます。これは、書込みを要求されたデータの量がデータ・ラインのバッファ・サイズより大きい場合にも当てはまります。ただし、要求された量の書込みが終わる前にデータ・ラインがクローズ、停止、またはフラッシュされた場合は、メソッドのブロックが解除されて、それまでに書き込まれたバイト数が返されます。

ブロックされずに書き込めるバイト数は、DataLineインタフェースのavailableメソッドを使って確認できます。このバイト数はブロックされずに確実に書き込めますが、追加データを書き込もうとしたときにブロックされるかどうかは確実ではありません。

書き込まれるバイト数は、次のようにサンプル・フレームの整数値を表す必要があります。

[ bytes written ] % [frame size in bytes ] == 0
戻り値は常にこの条件を満たしています。サンプル・フレームの非整数値を表すバイト数を書き込む要求は実行できず、IllegalArgumentExceptionがスローされる場合があります。

パラメータ:

b - データ・ラインに書き込まれるデータを含むバイト配列

len - バイト単位での配列の有効データの長さ(つまり、書込みを要求するバイト単位のデータ量)

off - 配列の先頭からの座標、バイト単位

戻り値:

実際に書き込まれるバイト数

例外:

IllegalArgumentException - 要求されたバイト数がサンプル・フレームの整数値を表さない場合、またはlenが負の値の場合

ArrayIndexOutOfBoundsException - offが負の値の場合、またはoff+lenが配列bの長さより大きい場合。

関連項目:

TargetDataLine.read(byte[], int, int), DataLine.available()