PFSoundPlayer (MZPlatform Component API)

java.lang.Object
- jp.go.aist.dmrc.platform.beans.media.PFSoundPlayer

すべての実装されたインタフェース:

java.io.Serializable, PFComponent, PFXMLSerializable
```
public class PFSoundPlayer
extends java.lang.Object
implements PFComponent, PFXMLSerializable
```
音声再生コンポーネント。ビープ音の発生と音声ファイル(wav,mid)の再生が可能。

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

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

コンストラクタ
コンストラクタと説明
`PFSoundPlayer()` デフォルトコンストラクタ

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`void`	`beep()` ビープ音を発生させる。
`void`	`finishMidiSynthesizer()` シンセサイザーを終了する。
`int`	`getComponentID()` コンポーネントIDを取得する。
`java.lang.String`	`getComponentKey()` コンポーネントキーを取得する。
`PFMultiLocaleString`	`getComponentKeys()` 全ロケール分のコンポーネントキーを返す。
`java.lang.String`	`getComponentName()` コンポーネント名称を取得する。
`java.lang.String`	`getComponentPublicName()` コンポーネント公開名を取得する.
`java.lang.String`	`getComponentString()` コンポーネントの文字列表現を取得する。
`PFObjectList`	`getWaveDataList(byte[] wave)` 音声データのバイト配列を整数のリストに変換する。
`boolean`	`isAllowPullTransfer()` 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
`boolean`	`isAllowPushTransfer()` 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
`boolean`	`isAllowRemoteInvocation()` 他PFからのコンポーネント連携要求に対する可否属性を取得する.
`void`	`localeUpdated()` ロケール変更に対応する。
`void`	`noteOffMidiSynthesizer(int note)` シンセサイザーで音を鳴らし終える。
`void`	`noteOnMidiSynthesizer(int note)` シンセサイザーで音を鳴らし始める。
`void`	`noteOnMidiSynthesizer(int note, int velocity)` シンセサイザーで音を鳴らし始める。
`void`	`play(byte[] wave)` 音声データを再生する。
`void`	`play(byte[] wave, float sampleRate)` 音声データを再生する。
`void`	`play(java.lang.String fileName)` 音声ファイルを再生する。
`void`	`playWaveFile(java.lang.String wavfileName)` WAVファイルを再生する。
`void`	`readXML(PFXMLLoader in)` コンポーネントのXML入力.
`void`	`setAllowPullTransfer(boolean flag)` 他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
`void`	`setAllowPushTransfer(boolean flag)` 他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
`void`	`setAllowRemoteInvocation(boolean flag)` 他PFからのコンポーネント連携要求に対する可否属性を設定する.
`void`	`setComponentID(int id)` コンポーネントIDを設定する。
`void`	`setComponentKey(java.lang.String key)` コンポーネントのキー情報を設定する
`void`	`setComponentKeys(PFMultiLocaleString keys)` 全ロケール分のコンポーネントキーを設定する。
`void`	`setComponentPublicName(java.lang.String publicName)` コンポーネント公開名を設定する.
`void`	`startMidiSynthesizer()` シンセサイザーを開始する。
`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()
```
    コンポーネント名称を取得する。
    
    定義:
    
    getComponentName インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント名
    
    関連項目:
    
    PFComponent.getComponentName()
  - getComponentKey
```
public java.lang.String getComponentKey()
```
    コンポーネントキーを取得する。
    
    定義:
    
    getComponentKey インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネントキー文字列
    
    関連項目:
    
    PFComponent.getComponentKey()
  - setComponentKey
```
public void setComponentKey(java.lang.String key)
```
    コンポーネントのキー情報を設定する
    
    定義:
    
    setComponentKey インタフェース内 PFComponent
    
    パラメータ:
    
    key - 設定するコンポーネントのキー
    
    関連項目:
    
    PFComponent.setComponentKey(java.lang.String)
  - getComponentKeys
```
public PFMultiLocaleString getComponentKeys()
```
    全ロケール分のコンポーネントキーを返す。
    
    戻り値:
    
    全ロケール分のコンポーネントキー
  - setComponentKeys
```
public void setComponentKeys(PFMultiLocaleString keys)
```
    全ロケール分のコンポーネントキーを設定する。
    
    パラメータ:
    
    keys - 全ロケール分のコンポーネントキー
  - getComponentID
```
public int getComponentID()
```
    コンポーネントIDを取得する。
    
    定義:
    
    getComponentID インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネントID
    
    関連項目:
    
    PFComponent.getComponentID()
  - setComponentID
```
public void setComponentID(int id)
```
    コンポーネントIDを設定する。
    コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。
    
    定義:
    
    setComponentID インタフェース内 PFComponent
    
    パラメータ:
    
    id - 設定するコンポーネントID
    
    関連項目:
    
    PFComponent.setComponentID(int)
  - getComponentString
```
public java.lang.String getComponentString()
```
    コンポーネントの文字列表現を取得する。
    形式："Component Name" [ ID : "ID" ]
    
    定義:
    
    getComponentString インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネントの文字列表現を返す。
    
    関連項目:
    
    PFComponent.getComponentString()
  - getComponentPublicName
```
public java.lang.String getComponentPublicName()
```
    コンポーネント公開名を取得する.
    
    定義:
    
    getComponentPublicName インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント公開名
  - setComponentPublicName
```
public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException
```
    コンポーネント公開名を設定する.
    空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。また、既存コンポーネントとの重複も認めない.
    
    定義:
    
    setComponentPublicName インタフェース内 PFComponent
    
    パラメータ:
    
    publicName - 設定するコンポーネント公開名
    
    例外:
    
    PFComponentException - 規約に反する名前が設定されようとした場合
  - isAllowRemoteInvocation
```
public boolean isAllowRemoteInvocation()
```
    他PFからのコンポーネント連携要求に対する可否属性を取得する.
    
    定義:
    
    isAllowRemoteInvocation インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント連携要求可否属性
  - setAllowRemoteInvocation
```
public void setAllowRemoteInvocation(boolean flag)
```
    他PFからのコンポーネント連携要求に対する可否属性を設定する.
    
    定義:
    
    setAllowRemoteInvocation インタフェース内 PFComponent
    
    パラメータ:
    
    flag - コンポーネント連携要求に対する可否
  - isAllowPullTransfer
```
public boolean isAllowPullTransfer()
```
    他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
    
    定義:
    
    isAllowPullTransfer インタフェース内 PFComponent
    
    戻り値:
    
    Pull型コンポーネント転送要求可否属性
  - setAllowPullTransfer
```
public void setAllowPullTransfer(boolean flag)
```
    他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
    
    定義:
    
    setAllowPullTransfer インタフェース内 PFComponent
    
    パラメータ:
    
    flag - Pull型コンポーネント転送要求に対する可否
  - isAllowPushTransfer
```
public boolean isAllowPushTransfer()
```
    他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
    
    定義:
    
    isAllowPushTransfer インタフェース内 PFComponent
    
    戻り値:
    
    Push型コンポーネント転送要求可否属性
  - setAllowPushTransfer
```
public void setAllowPushTransfer(boolean flag)
```
    他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
    
    定義:
    
    setAllowPushTransfer インタフェース内 PFComponent
    
    パラメータ:
    
    flag - Push型コンポーネント転送要求に対する可否
  - readXML
```
public void readXML(PFXMLLoader in)
```
    コンポーネントのXML入力.
    
    定義:
    
    readXML インタフェース内 PFXMLSerializable
    
    パラメータ:
    
    in - XML入力ユーティリティ
  - writeXML
```
public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
```
    コンポーネントのXML出力.
    
    定義:
    
    writeXML インタフェース内 PFXMLSerializable
    
    パラメータ:
    
    out - XML出力ユーティリティ
    
    例外:
    
    java.io.IOException
  - localeUpdated
```
public void localeUpdated()
```
    ロケール変更に対応する。
    
    定義:
    
    localeUpdated インタフェース内 PFComponent
    
    関連項目:
    
    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()
```
    音声ファイルの再生を停止する。
  - getWaveDataList
```
public PFObjectList getWaveDataList(byte[] wave)
```
    音声データのバイト配列を整数のリストに変換する。
    
    パラメータ:
    
    wave - 音声データの配列
    
    戻り値:
    
    リスト
  - play
```
public void play(byte[] wave)
```
    音声データを再生する。サンプルレートは44100で固定。
    
    パラメータ:
    
    wave - 音声データの配列
  - play
```
public void play(byte[] wave,
                 float sampleRate)
```
    音声データを再生する。
    
    パラメータ:
    
    wave - 音声データの配列
    
    sampleRate - サンプルレート
  - startMidiSynthesizer
```
public void startMidiSynthesizer()
                          throws PFComponentException
```
    シンセサイザーを開始する。 javax.sound.midiパッケージの機能を利用。
    
    例外:
    
    PFComponentException
  - noteOnMidiSynthesizer
```
public void noteOnMidiSynthesizer(int note,
                                  int velocity)
```
    シンセサイザーで音を鳴らし始める。先にシンセサイザーを開始する必要がある。 javax.sound.midiパッケージの機能を利用。
    
    パラメータ:
    
    note - 音番号(0から127まで、60=中央のC音)
    
    velocity - キーを押す速度
  - noteOnMidiSynthesizer
```
public void noteOnMidiSynthesizer(int note)
```
    シンセサイザーで音を鳴らし始める。先にシンセサイザーを開始する必要がある。 javax.sound.midiパッケージの機能を利用。
    
    パラメータ:
    
    note - 音番号(0から127まで、60=中央のC音)
  - noteOffMidiSynthesizer
```
public void noteOffMidiSynthesizer(int note)
```
    シンセサイザーで音を鳴らし終える。 javax.sound.midiパッケージの機能を利用。
    
    パラメータ:
    
    note - 音番号(0から127まで、60=中央のC音)
  - finishMidiSynthesizer
```
public void finishMidiSynthesizer()
```
    シンセサイザーを終了する。 javax.sound.midiパッケージの機能を利用。

クラス PFSoundPlayer

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

PFSoundPlayer

メソッドの詳細

getComponentName

getComponentKey

setComponentKey

getComponentKeys

setComponentKeys

getComponentID

setComponentID

getComponentString

getComponentPublicName

setComponentPublicName

isAllowRemoteInvocation

setAllowRemoteInvocation

isAllowPullTransfer

setAllowPullTransfer

isAllowPushTransfer

setAllowPushTransfer

readXML

writeXML

localeUpdated

beep

playWaveFile

play

stop

getWaveDataList

play

play

startMidiSynthesizer

noteOnMidiSynthesizer

noteOnMidiSynthesizer

noteOffMidiSynthesizer

finishMidiSynthesizer