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()