javax.sound.sampled

インタフェースTargetDataLine

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

AutoCloseable、DataLine、Line

public interface TargetDataLine
extends DataLine

ターゲット・データ・ラインは、オーディオ・データをそこから読み込めるタイプのDataLineです。もっとも一般的な例は、データをオーディオ・キャプチャ・デバイスから取得するデータ・ラインです。デバイスはターゲット・データ・ラインに書き込むミキサーとして実装されます。

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

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

TargetDataLineインタフェースは、ターゲット・データ・ラインのバッファから取得したデータを読み込むメソッドを提供します。オーディオを録音するアプリケーションは、バッファがオーバーフローしないようにターゲット・データ・ラインからデータをすばやく読み込みます。オーバーフローすると、取得したデータに不連続部(クリック音に聞こえる)が生じることがあります。アプリケーションでは、DataLineインタフェースで定義されているavailableメソッドを使用して、データ・ラインのバッファで現在キューに入っているデータの量を判別できます。バッファがオーバーフローを起こした場合、キューに入っているもっとも古いデータが破棄されて新しいデータに置き換えられます。

導入されたバージョン:

1.3

関連項目:

Mixer、DataLine、SourceDataLine

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

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

DataLine.Info

メソッドのサマリー

修飾子と型	メソッドと説明
void	open(AudioFormat format) 指定されたフォーマットでラインを開き、ラインが必要なシステム・リソースを獲得して操作可能になるようにします。
void	open(AudioFormat format, int bufferSize) 指定されたフォーマットと指定されたバッファ・サイズでラインを開き、ラインが必要なシステム・リソースを獲得して操作可能になるようにします。
int	read(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

read

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

データ・ラインの入力バッファからオーディオ・データを読み込みます。要求されたバイト数が、指定された配列の指定されたオフセット位置(バイト単位)を始点として読み込まれます。このメソッドは、要求された量のデータを読込み終えるまでブロックされます。ただし、要求された量が読み込まれる前にデータ・ラインがクローズ、停止、排出、またはフラッシュされると、メソッドのブロックが解除され、それまでに読み込まれたバイト数が返されます。

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

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

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

パラメータ:

b - このメソッドが返るときの、要求された入力データを含むバイト配列

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

len - 読込み要求されたバイト数

戻り値:

実際に読み込まれるバイト数

例外:

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

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

関連項目:

SourceDataLine.write(byte[], int, int), DataLine.available()