javax.microedition.media.control
インタフェース VolumeControl

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

Control

public interface VolumeControl
extends Control

VolumeControl は Player のオーディオ・ボリューム（音量）を制御するためのインタフェースです。

ボリューム設定

このインタフェースは、出力音量を 0 から 100 の範囲の整数値で指定することができます。

ボリュームを指定する基準

ボリュームの基準は均等段階で指定します。 0 は無音を表し、100 が最も大きなボリュームを示す、0 から 100 までの範囲で指定します。 直線的な増加値を生み出すための割り当ては実装に依存します。

ミュート（無音）

ミュートのオンまたオフの設定をしても、getLevel が返すボリューム・レベルは変化しません。 ミュートが true ならば、Player はオーディオ信号をまったく生成しません。 ミュートが false ならばオーディオ信号は生成され、ボリュームは復元します。

音量変更イベント

VolumeControl の状態が変化するときには、PlayerListener を通じて VOLUME_CHANGED イベントを通知します。

関連項目:

Control, Player, PlayerListener

setMute

void setMute(boolean mute)

この VolumeControl に関連する Player のミュート状態を設定します。

既にミュート状態にある Player に対して setMute(true) を呼び出しても無視します。現在ミュート状態ではない Player に対して setMute(false) を呼び出しても同様です。 ミュートのオンまたオフの設定をしても、getLevel が返すボリューム・レベルは変化しません。

setMute がミュート状態に変化を起こすと、PlayerListener を通じて VOLUME_CHANGED イベントを通知します。

パラメータ:

mute - ミュート状態にする場合は true を、ミュート状態を解除する場合は false を渡します。

関連項目:

isMuted()

isMuted

boolean isMuted()

この VolumeControl に関連するミュート状態を取得します。

戻り値:

ミュート状態ならば true を、そうでなければ false を返します。

関連項目:

setMute(boolean)

setLevel

int setLevel(int level)

0 から 100 の範囲の値による、直線的なポイントスケール（さかき注：それぞれのポイント 0 から 100 までの 101 ポイントの範囲によるそれぞれの段階）を使用してボリュームを設定します。

0 は沈黙です； 100 は、この VolumeControl がサポートする中で最も大きな音を示します。 0 未満あるいは 100 以上の level が指定されると、level はそれぞれ 0 または 100 とみなします。

ボリューム・レベルが setLevel によって変化するならば、PlayerListener を通じて VOLUME_CHANGED イベントを通知します。

パラメータ:

level - 新しく設定するボリューム・レベルを渡します。

戻り値:

実際にレベルとして設定した値を返します。

関連項目:

getLevel()

getLevel

int getLevel()

現在設定されているボリューム・レベルを取得します。

Player が REALIZED 状態（オーディオ・デバイスは初期化されていません）であり setLevel がまだ呼び出されていない（つまりオーディオ・デバイスもオブジェクト設定上もレベルを設定されておらず未定状態）ならば、getLevel は -1 を返します。

戻り値:

現在のボリューム・レベルまたは -1 を返します。

関連項目:

setLevel(int)