- java.lang.Object
-
- javafx.scene.media.AudioClip
-
public final class AudioClip extends Object
AudioClip
は、最小の遅延で再生できる音声セグメントを表します。 クリップはMedia
オブジェクトと同様にロードされますが、Media
はそれ自体を再生できないなど、動作が異なります。 また、AudioClip
は即時に使用可能になります。 再生動作は、開始すると、その後の制御は行われません。いずれかの再生メソッドが呼び出された後で動作可能なコントロールはstop()
のみです。AudioClip
は同時に複数回再生することもできます。Media
を使用して同じタスクを実行するには、同時に再生されるサウンドごとに新しいMediaPlayer
オブジェクトを作成する必要があります。 ただし、再生時間の長いサウンドには、Media
オブジェクトがより適しています。 これは、主に、AudioClip
ではサウンド全体の未圧縮のraw音声データがメモリーに格納されるため、音声クリップが長いと、データが非常に大きくなる可能性があるためです。MediaPlayer
では、短時間再生する分の音声データのみが、圧縮解除されてメモリーでプリロールされるため、長いクリップ、特に圧縮されているクリップで、メモリーの使用効率が向上します。
使用例:
AudioClip plonkSound = new AudioClip("http://somehost/path/plonk.aiff"); plonkSound.play();
- 導入されたバージョン:
- JavaFX 2.0
-
-
プロパティのサマリー
プロパティ Type プロパティ 説明 DoubleProperty
balance
クリップの相対的な左および右ボリューム・レベル。IntegerProperty
cycleCount
play()
が呼び出されるときにクリップが再生される回数。DoubleProperty
pan
クリップの相対的な中心。IntegerProperty
priority
他のクリップに関してクリップの相対的な優先度。DoubleProperty
rate
クリップを再生する相対速度。DoubleProperty
volume
クリップを再生する相対的なボリューム・レベル。
-
フィールドのサマリー
フィールド 修飾子と型 フィールド 説明 static int
INDEFINITE
cycleCount
がこの値に設定されている場合、AudioClip
は停止されるまでループし続けます。
-
メソッドのサマリー
すべてのメソッド インスタンス・メソッド 具象メソッド 修飾子と型 メソッド 説明 DoubleProperty
balanceProperty()
クリップの相対的な左および右ボリューム・レベル。IntegerProperty
cycleCountProperty()
play()
が呼び出されるときにクリップが再生される回数。double
getBalance()
このクリップのデフォルトのバランス・レベルを取得します。int
getCycleCount()
デフォルトのサイクル数を取得します。double
getPan()
デフォルトのパン値を取得します。int
getPriority()
デフォルトの再生優先度を取得します。double
getRate()
デフォルトの再生速度を取得します。String
getSource()
このAudioClip
を作成するのに使用されるソースURLを取得します。double
getVolume()
デフォルトのボリューム・レベルを取得します。boolean
isPlaying()
このAudioClip
が再生中かどうかを示します。DoubleProperty
panProperty()
クリップの相対的な中心。void
play()
すべてのデフォルト・パラメータを使用してAudioClip
を再生します。void
play(double volume)
ボリューム以外のすべてのデフォルト・パラメータを使用してAudioClip
を再生します。void
play(double volume, double balance, double rate, double pan, int priority)
指定したパラメータを使用してAudioClip
を再生します。IntegerProperty
priorityProperty()
他のクリップに関してクリップの相対的な優先度。DoubleProperty
rateProperty()
クリップを再生する相対速度。void
setBalance(double balance)
デフォルトのバランス・レベルを設定します。void
setCycleCount(int count)
デフォルトのサイクル数を設定します。void
setPan(double pan)
デフォルトのパン値を設定します。void
setPriority(int priority)
デフォルトの再生優先度を設定します。void
setRate(double rate)
デフォルトの再生速度を設定します。void
setVolume(double value)
デフォルトのボリューム・レベルを設定します。void
stop()
このAudioClip
の再生をすべて即時に停止します。DoubleProperty
volumeProperty()
クリップを再生する相対的なボリューム・レベル。
-
-
-
プロパティの詳細
-
volume
public DoubleProperty volumeProperty
クリップを再生する相対的なボリューム・レベル。 有効な範囲は0.0 (ミュート)から1.0 (フル・ボリューム)です。 値は内部的にこの範囲に固定されるため、この範囲外の値を指定してもそれ以上の効果はありません。 ボリュームは減衰量により制御されるため、1.0より小さい値では、それに従ってサウンド・レベルが下げられます。- 関連項目:
getVolume()
、setVolume(double)
-
balance
public DoubleProperty balanceProperty
クリップの相対的な左および右ボリューム・レベル。 有効な範囲は-1.0から1.0です。-1.0は左のチャンネルをフル・ボリュームにして右のチャンネルをミュートにし、0.0は両方のチャンネルをフル・ボリュームにし、1.0は右のチャンネルをフル・ボリュームにして左のチャンネルをミュートにします。 この範囲外の値は内部的に固定されます。
-
rate
public DoubleProperty rateProperty
クリップを再生する相対速度。 有効な範囲は0.125 (1/8速)から8.0 (8倍速)です。この範囲外の値は内部的に固定されます。 クリップの通常の再生は1.0です。その他の速度を指定すると、それに従ってピッチおよび継続時間に影響します。- 関連項目:
getRate()
、setRate(double)
-
pan
public DoubleProperty panProperty
クリップの相対的な中心。 パン値が0.0の場合はクリップが通常どおりに再生され、パンが-1.0の場合はクリップが完全に左チャンネルにシフトされ、1.0の場合は完全に右チャンネルにシフトされます。 バランスとは異なり、この設定では両方のチャンネルが混合されるため、いずれのチャンネルでもデータは失われません。 モノ・クリップでパンを設定すると、バランスを設定した場合と同じ効果がありますが、CPUオーバーヘッドのコストが大幅に高まるため、この設定はモノ・クリップではお薦めしません。- 関連項目:
getPan()
、setPan(double)
-
priority
public IntegerProperty priorityProperty
他のクリップに関してクリップの相対的な優先度。 この値は、許可されるクリップの最大数を超えている場合に、削除するクリップを決定するために使用されます。 優先度が低いほど、そのクリップが停止され、クリップが占有しているミキサー・チャンネルから削除される可能性が高まります。 有効な範囲は任意の整数で、制約はありません。 すべてのクリップのデフォルトの優先度は、変更されるまではゼロです。 同時に再生できるサウンドの数は、実装および場合によってはシステムによって異なります。
-
cycleCount
public IntegerProperty cycleCountProperty
play()
が呼び出されるときにクリップが再生される回数。 cycleCountが1の場合は1回のみ再生され、cycleCountが2の場合は2回再生される、というように機能します。 有効な範囲は1以上ですが、これをINDEFINITE
に設定すると、stop()
が呼び出されるまでクリップがループし続けます。
-
-
フィールドの詳細
-
INDEFINITE
public static final int INDEFINITE
cycleCount
がこの値に設定されている場合、AudioClip
は停止されるまでループし続けます。 この値はMediaPlayer.INDEFINITE
およびAnimation.INDEFINITE
と同義で、これらの値は相互交換的に使用できます。- 関連項目:
- 定数フィールド値
-
-
コンストラクタの詳細
-
AudioClip
public AudioClip(String source)
指定されたソースURLからロードされたAudioClip
を作成します。- パラメータ:
source
- 音声クリップのロード元のURL文字列。 これは、HTTP、HTTPS、FILE、またはJARソースとすることができます。- 例外:
NullPointerException
- パラメータがnull
の場合。IllegalArgumentException
- パラメータがRFC 2396に違反している場合。MediaException
- メディアのロードに関するその他の問題がある場合。
-
-
メソッドの詳細
-
getSource
public String getSource()
このAudioClip
を作成するのに使用されるソースURLを取得します。- 戻り値:
- コンストラクタに提供されるソースURL
-
setVolume
public final void setVolume(double value)
デフォルトのボリューム・レベルを設定します。 新しい設定は、後続の再生でのみ有効になります。- パラメータ:
value
- このクリップの新しいデフォルト・ボリューム・レベル- 関連項目:
volumeProperty()
-
getVolume
public final double getVolume()
デフォルトのボリューム・レベルを取得します。- 戻り値:
- このクリップのデフォルトのボリューム・レベル
- 関連項目:
volumeProperty()
-
volumeProperty
public DoubleProperty volumeProperty()
クリップを再生する相対的なボリューム・レベル。 有効な範囲は0.0 (ミュート)から1.0 (フル・ボリューム)です。 値は内部的にこの範囲に固定されるため、この範囲外の値を指定してもそれ以上の効果はありません。 ボリュームは減衰量により制御されるため、1.0より小さい値では、それに従ってサウンド・レベルが下げられます。- 関連項目:
getVolume()
、setVolume(double)
-
setBalance
public void setBalance(double balance)
デフォルトのバランス・レベルを設定します。 新しい値は、後続の再生でのみ有効になります。- パラメータ:
balance
- 新しいデフォルト・バランス- 関連項目:
balanceProperty()
-
getBalance
public double getBalance()
このクリップのデフォルトのバランス・レベルを取得します。- 戻り値:
- このクリップのデフォルトのバランス
- 関連項目:
balanceProperty()
-
balanceProperty
public DoubleProperty balanceProperty()
クリップの相対的な左および右ボリューム・レベル。 有効な範囲は-1.0から1.0です。-1.0は左のチャンネルをフル・ボリュームにして右のチャンネルをミュートにし、0.0は両方のチャンネルをフル・ボリュームにし、1.0は右のチャンネルをフル・ボリュームにして左のチャンネルをミュートにします。 この範囲外の値は内部的に固定されます。
-
setRate
public void setRate(double rate)
デフォルトの再生速度を設定します。 新しい値は、後続の再生でのみ有効になります。- パラメータ:
rate
- 新しいデフォルト再生速度- 関連項目:
rateProperty()
-
getRate
public double getRate()
デフォルトの再生速度を取得します。- 戻り値:
- このクリップのデフォルトの再生速度
- 関連項目:
rateProperty()
-
rateProperty
public DoubleProperty rateProperty()
クリップを再生する相対速度。 有効な範囲は0.125 (1/8速)から8.0 (8倍速)です。この範囲外の値は内部的に固定されます。 クリップの通常の再生は1.0です。その他の速度を指定すると、それに従ってピッチおよび継続時間に影響します。- 関連項目:
getRate()
、setRate(double)
-
setPan
public void setPan(double pan)
デフォルトのパン値を設定します。 新しい値は、後続の再生でのみ有効になります。- パラメータ:
pan
- 新しいデフォルト・パン値- 関連項目:
panProperty()
-
getPan
public double getPan()
デフォルトのパン値を取得します。- 戻り値:
- このクリップのデフォルト・パン値
- 関連項目:
panProperty()
-
panProperty
public DoubleProperty panProperty()
クリップの相対的な中心。 パン値が0.0の場合はクリップが通常どおりに再生され、パンが-1.0の場合はクリップが完全に左チャンネルにシフトされ、1.0の場合は完全に右チャンネルにシフトされます。 バランスとは異なり、この設定では両方のチャンネルが混合されるため、いずれのチャンネルでもデータは失われません。 モノ・クリップでパンを設定すると、バランスを設定した場合と同じ効果がありますが、CPUオーバーヘッドのコストが大幅に高まるため、この設定はモノ・クリップではお薦めしません。- 関連項目:
getPan()
、setPan(double)
-
setPriority
public void setPriority(int priority)
デフォルトの再生優先度を設定します。 新しい値は、後続の再生でのみ有効になります。- パラメータ:
priority
- 新しいデフォルト再生優先度- 関連項目:
priorityProperty()
-
getPriority
public int getPriority()
デフォルトの再生優先度を取得します。- 戻り値:
- このクリップのデフォルト再生優先度
- 関連項目:
priorityProperty()
-
priorityProperty
public IntegerProperty priorityProperty()
他のクリップに関してクリップの相対的な優先度。 この値は、許可されるクリップの最大数を超えている場合に、削除するクリップを決定するために使用されます。 優先度が低いほど、そのクリップが停止され、クリップが占有しているミキサー・チャンネルから削除される可能性が高まります。 有効な範囲は任意の整数で、制約はありません。 すべてのクリップのデフォルトの優先度は、変更されるまではゼロです。 同時に再生できるサウンドの数は、実装および場合によってはシステムによって異なります。
-
setCycleCount
public void setCycleCount(int count)
デフォルトのサイクル数を設定します。 新しい値は、後続の再生でのみ有効になります。- パラメータ:
count
- このクリップの新しいデフォルト・サイクル数- 関連項目:
cycleCountProperty()
-
getCycleCount
public int getCycleCount()
デフォルトのサイクル数を取得します。- 戻り値:
- この音声クリップのデフォルトcycleCount
- 関連項目:
cycleCountProperty()
-
cycleCountProperty
public IntegerProperty cycleCountProperty()
play()
が呼び出されるときにクリップが再生される回数。 cycleCountが1の場合は1回のみ再生され、cycleCountが2の場合は2回再生される、というように機能します。 有効な範囲は1以上ですが、これをINDEFINITE
に設定すると、stop()
が呼び出されるまでクリップがループし続けます。
-
play
public void play()
すべてのデフォルト・パラメータを使用してAudioClip
を再生します。
-
play
public void play(double volume)
ボリューム以外のすべてのデフォルト・パラメータを使用してAudioClip
を再生します。 このメソッドでは、クリップのデフォルト・パラメータは変更されません。- パラメータ:
volume
- クリップを再生するボリューム・レベル
-
play
public void play(double volume, double balance, double rate, double pan, int priority)
指定したパラメータを使用してAudioClip
を再生します。 関連するプロパティで指定されている範囲外の値は固定されます。 このメソッドでは、クリップのデフォルト・パラメータは変更されません。- パラメータ:
volume
- このクリップを再生するボリューム・レベル。 有効なボリューム範囲は0.0から1.0です。0.0は実質的にミュートで、1.0はフル・ボリュームです。balance
- ステレオ効果のための左右のバランスまたは相対的なチャンネル・ボリューム。rate
- 再生速度の乗数。1.0の場合は通常の速度で再生され、2.0の場合は速度が2倍になります。pan
- クリップに適用する左および右シフト。 -1.0のパン値は左チャンネルに振切り、1.0は右チャンネルに振切りを意味し、0.0は効果がありません。priority
- 音声効果の優先度。 同時に再生を試みる効果が多すぎる場合、優先度の低い効果から順に除外されます。
-
isPlaying
public boolean isPlaying()
このAudioClip
が再生中かどうかを示します。 これがtrueを返した場合、play()
が1回以上呼び出されており、まだ再生中です。- 戻り値:
- いずれかのミキサー・チャンネルがこのクリップをキューに追加している場合はtrue、それ以外の場合はfalse
-
stop
public void stop()
このAudioClip
の再生をすべて即時に停止します。
-
-