JavaTM 2
Platform
Std. Ed. v1.4.0

javax.sound.sampled
インタフェース Line

既知のサブインタフェースの一覧:
Clip, DataLine, Mixer, Port, SourceDataLine, TargetDataLine

public interface Line

Line インタフェースは、モノラルチャネルまたは多重チャネルのオーディオ送りを表します。ラインは、ミキサー、入出力ポート、ミキサーへのデータ入出力パスなどの、デジタルオーディオ「パイプライン」の 1 要素です。

ラインはゲイン、パン、リーバーブなどをコントロールすることができます。コントロール自体は、基底 Control クラスを拡張するクラスのインスタンスです。Line インタフェースはラインをコントロールするためのアクセス用メソッドを 2 つ提供します。getControls はセット全体を返し、getControl は指定された単一のコントロールを返します。

ラインは時間によってさまざまな状態で存在します。ラインが開くと、ライン自体のためにシステムリソースが確保され、ラインが閉じると、これらのリソースは他のオブジェクトまたはアプリケーションのために解放されます。isOpen() メソッドにより、ラインが開いているか閉じているかを確認できます。ただしラインが開いていても、データを処理しているとは限りません。データ処理は通常、SourceDataLine.writeTargetDataLine.read などのサブインタフェースのメソッドによって開始されます。

オブジェクトを登録して、ラインの状態が変化するたびに通知を受け取ることができます。オブジェクトは、単一のメソッド update で構成される LineListener interface インタフェースを実装している必要があります。このメソッドはラインの開閉時に呼び出されます。ラインが DataLine である場合は、開始および停止時に呼び出されます。

オブジェクトを登録して複数のラインを監視することができます。オブジェクトが update メソッドで受信するイベントは、どのラインがイベントを作成したのか、それはどのタイプのイベントか (OPENCLOSESTART、または STOP)、およびイベント発生時ラインがどれだけのサンプルフレームを処理し終わっているかを指定します。

開閉などの一定のライン操作は、ラインが共有オーディオリソースであるときに特権を持たないコードによって呼び出された場合、セキュリティ例外を生成することがあります。

導入されたバージョン:
1.3
関連項目:
LineEvent

入れ子クラスの概要
static class Line.Info
          Line.Info オブジェクトは、ラインに関する情報を含んでいます。
 
メソッドの概要
 void addLineListener(LineListener listener)
          リスナーにこのラインを追加します。
 void close()
          ラインを閉じ、ラインで使用していたシステムリソースを解放できることを示します。
 Control getControl(Control.Type control)
          指定されたタイプのコントロールがある場合、そのコントロールを取得します。
 Control[] getControls()
          このラインに関連するコントロールのセットを取得します。
 Line.Info getLineInfo()
          このラインを説明する Line.Info オブジェクトを取得します。
 boolean isControlSupported(Control.Type control)
          指定されたタイプのコントロールをラインがサポートしているかどうかを示します。
 boolean isOpen()
          ラインが開いているかどうか、つまり現在はサウンドを再生または収集していなくてもシステムリソースを確保し操作可能であるかどうかを示します。
 void open()
          ラインを開き、必要なシステムリソースを獲得して操作可能になっていることを示します。
 void removeLineListener(LineListener listener)
          このラインのリスナーのリストから、指定されたリスナーを削除します。
 

メソッドの詳細

getLineInfo

public Line.Info getLineInfo()
このラインを説明する Line.Info オブジェクトを取得します。

戻り値:
ラインの説明

open

public void open()
          throws LineUnavailableException
ラインを開き、必要なシステムリソースを獲得して操作可能になっていることを示します。この操作が完了すると、ラインは開くものとしてマークされ、OPEN イベントがラインのリスナーにディスパッチされます。

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

ラインの種類によっては、リソースの割り当てに影響を与える設定可能なプロパティを持っているものもあります。たとえば、DataLine は特定のフォーマットおよびバッファサイズで開く必要があります。こうしたラインは、open メソッド、または望ましい設定をアプリケーションで指定できるメソッドを追加するなどして、これらのプロパティを設定する機能を提供します

このメソッドは引数をとらず、現在の設定でラインを開きます。これは、SourceDataLine および TargetDataLine オブジェクトの場合、ラインがデフォルト設定で開くことを意味します。しかし Clip の場合、バッファサイズはデータをロードするときに決定されます。このメソッドではロードするデータをアプリケーションで指定できないので、このメソッドはクリップのリソースにゼロフレームのデータを割り当てます。続いてデータをそのクリップにロードする手段はありません。したがって、この代わりに、Clip インタフェースに備わっている open メソッドの 1 つを使って、データを Clip にロードします。

例外:
LineUnavailableException - リソースの制約のためにラインを開けない場合
SecurityException - セキュリティ上の制約のためにラインを開けない場合
関連項目:
close(), isOpen(), LineEvent, DataLine, Clip.open(AudioFormat, byte[], int, int), Clip.open(AudioInputStream)

close

public void close()
ラインを閉じ、ラインで使用していたシステムリソースを解放できることを示します。この操作が完了すると、ラインは閉じるものとしてマークされ、CLOSE イベントがラインのリスナーにディスパッチされます。

例外:
SecurityException - セキュリティ上の制約のためにラインを閉じることができない場合
関連項目:
open(), isOpen(), LineEvent

isOpen

public boolean isOpen()
ラインが開いているかどうか、つまり現在はサウンドを再生または収集していなくてもシステムリソースを確保し操作可能であるかどうかを示します。

戻り値:
ラインが開いている場合は true、そうでない場合は false
関連項目:
open(), close()

getControls

public Control[] getControls()
このラインに関連するコントロールのセットを取得します。コントロールがない場合は、このメソッドは長さ 0 の配列を返します。

戻り値:
コントロールの配列
関連項目:
getControl(javax.sound.sampled.Control.Type)

isControlSupported

public boolean isControlSupported(Control.Type control)
指定されたタイプのコントロールをラインがサポートしているかどうかを示します。

パラメータ:
control - サポートが照会されるコントロールのタイプ
戻り値:
指定されたタイプのコントロールの少なくとも 1 つがサポートされている場合は true、そうでない場合は false

getControl

public Control getControl(Control.Type control)
指定されたタイプのコントロールがある場合、そのコントロールを取得します。

パラメータ:
control - 要求されたコントロールのタイプ
戻り値:
指定されたタイプのコントロール
例外:
IllegalArgumentException - 指定されたタイプのコントロールがサポートされていない場合
関連項目:
getControls(), isControlSupported(Control.Type control)

addLineListener

public void addLineListener(LineListener listener)
リスナーにこのラインを追加します。ラインの状態が変化するたびに、リスナーの update() メソッドが呼び出され、変化を説明する update() オブジェクトが示されます。

パラメータ:
listener - リスナーとしてこのラインに追加するオブジェクト
関連項目:
removeLineListener(javax.sound.sampled.LineListener), LineListener.update(javax.sound.sampled.LineEvent), LineEvent

removeLineListener

public void removeLineListener(LineListener listener)
このラインのリスナーのリストから、指定されたリスナーを削除します。

パラメータ:
listener - 削除するリスナー
関連項目:
addLineListener(javax.sound.sampled.LineListener)

JavaTM 2
Platform
Std. Ed. v1.4.0

バグの報告と機能のリクエスト
これ以外の API リファレンスおよび開発者用ドキュメントについては、 Java 2 SDK SE 開発者用ドキュメントを参照してください。 開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、 およびコード実例が含まれています。

Java、Java 2D、および JDBC は米国ならびにその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.