jp.go.aist.dmrc.platform.beans.media
クラス PFSoundPlayer

java.lang.Object
  拡張jp.go.aist.dmrc.platform.beans.media.PFSoundPlayer
すべての実装インタフェース:
PFComponent, PFXMLSerializable, java.io.Serializable

public class PFSoundPlayer
extends java.lang.Object
implements PFComponent, PFXMLSerializable

音声再生コンポーネント。 ビープ音の発生と音声ファイル(wav,mid)の再生が可能。

関連項目:
直列化された形式

コンストラクタの概要
PFSoundPlayer()
          デフォルトコンストラクタ
 
メソッドの概要
 void beep()
          ビープ音を発生させる。
 int getComponentID()
          コンポーネントIDを取得する。
 java.lang.String getComponentKey()
          コンポーネントキーを取得する。
 PFMultiLocaleString getComponentKeys()
          全ロケール分のコンポーネントキーを返す。
 java.lang.String getComponentName()
          コンポーネント名称を取得する。
 java.lang.String getComponentString()
          コンポーネントの文字列表現を取得する。
 void localeUpdated()
          ロケール変更に対応する。
 void play(java.lang.String fileName)
          音声ファイルを再生する。
 void playWaveFile(java.lang.String wavfileName)
          WAVファイルを再生する。
 void readXML(PFXMLLoader in)
          コンポーネントのXML入力.
 void setComponentID(int id)
          コンポーネントIDを設定する。
 void setComponentKey(java.lang.String key)
          コンポーネントのキー情報を設定する
 void setComponentKeys(PFMultiLocaleString keys)
          全ロケール分のコンポーネントキーを設定する。
 void stop()
          音声ファイルの再生を停止する。
 void writeXML(PFXMLGenerator out)
          コンポーネントのXML出力.
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

PFSoundPlayer

public PFSoundPlayer()
デフォルトコンストラクタ

メソッドの詳細

getComponentName

public java.lang.String getComponentName()
コンポーネント名称を取得する。

定義:
インタフェース PFComponent 内の getComponentName
戻り値:
コンポーネント名
関連項目:
PFComponent.getComponentName()

getComponentKey

public java.lang.String getComponentKey()
コンポーネントキーを取得する。

定義:
インタフェース PFComponent 内の getComponentKey
戻り値:
コンポーネントキー文字列
関連項目:
PFComponent.getComponentKey()

setComponentKey

public void setComponentKey(java.lang.String key)
コンポーネントのキー情報を設定する

定義:
インタフェース PFComponent 内の setComponentKey
パラメータ:
key - 設定するコンポーネントのキー
関連項目:
PFComponent.setComponentKey(java.lang.String)

getComponentKeys

public PFMultiLocaleString getComponentKeys()
全ロケール分のコンポーネントキーを返す。

戻り値:
全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)
全ロケール分のコンポーネントキーを設定する。

パラメータ:
keys - 全ロケール分のコンポーネントキー

getComponentID

public int getComponentID()
コンポーネントIDを取得する。

定義:
インタフェース PFComponent 内の getComponentID
戻り値:
コンポーネントID
関連項目:
PFComponent.getComponentID()

setComponentID

public void setComponentID(int id)
コンポーネントIDを設定する。
コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。

定義:
インタフェース PFComponent 内の setComponentID
パラメータ:
id - 設定するコンポーネントID
関連項目:
PFComponent.setComponentID(int)

getComponentString

public java.lang.String getComponentString()
コンポーネントの文字列表現を取得する。
形式:"Component Name" [ ID : "ID" ]

定義:
インタフェース PFComponent 内の getComponentString
戻り値:
コンポーネントの文字列表現を返す。
関連項目:
PFComponent.getComponentString()

readXML

public void readXML(PFXMLLoader in)
コンポーネントのXML入力.

定義:
インタフェース PFXMLSerializable 内の readXML
パラメータ:
in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
コンポーネントのXML出力.

定義:
インタフェース PFXMLSerializable 内の writeXML
パラメータ:
out - XML出力ユーティリティ
例外:
java.io.IOException

localeUpdated

public void localeUpdated()
ロケール変更に対応する。

定義:
インタフェース PFComponent 内の localeUpdated
関連項目:
PFComponent.localeUpdated()

beep

public void beep()
ビープ音を発生させる。


playWaveFile

public void playWaveFile(java.lang.String wavfileName)
                  throws PFException
WAVファイルを再生する。 呼び出し元のスレッドで実行されるため、再生が終了するまで制御が戻らない。

パラメータ:
wavfileName - wavファイル名
例外:
PFException

play

public void play(java.lang.String fileName)
          throws PFException
音声ファイルを再生する。 再生は別スレッドで行われる。 対応しているファイル形式はwav,midiである。

パラメータ:
fileName - 音声ファイル名
例外:
PFException

stop

public void stop()
音声ファイルの再生を停止する。