PFSoundRecorder (MZPlatform Component API)

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

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

java.io.Serializable, PFComponent, PFXMLSerializable
```
public class PFSoundRecorder
extends java.lang.Object
implements PFComponent, PFXMLSerializable
```
録音を行うコンポーネント。

関連項目:

直列化された形式

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

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

PFSoundRecorder()
コンポーネントを生成する。

コンストラクタ
コンストラクタと説明
`PFSoundRecorder()` コンポーネントを生成する。

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`int`	`getChannels()` チャネル数の取得.
`int`	`getComponentID()` コンポーネントIDを取得する。
`java.lang.String`	`getComponentKey()` コンポーネントキーを取得する。
`PFMultiLocaleString`	`getComponentKeys()` 全ロケール分のコンポーネントキーを返す。
`java.lang.String`	`getComponentName()` コンポーネント名称を取得する。
`java.lang.String`	`getComponentPublicName()` コンポーネント公開名を取得する.
`java.lang.String`	`getComponentString()` コンポーネントの文字列表現を取得する。
`java.lang.String`	`getEncoding()` エンコード形式の取得.
`float`	`getFrameRate()` フレームレートの取得.
`int`	`getFrameSize()` フレームサイズの取得.
`float`	`getSampleRate()` サンプルレートの取得.
`int`	`getSampleSizeInBits()` サンプルごとのビット数の取得.
`boolean`	`isAllowPullTransfer()` 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
`boolean`	`isAllowPushTransfer()` 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
`boolean`	`isAllowRemoteInvocation()` 他PFからのコンポーネント連携要求に対する可否属性を取得する.
`boolean`	`isBigEndian()` データ並びの取得.
`void`	`localeUpdated()` ロケール変更に対応する。
`void`	`readXML(PFXMLLoader in)` XMLを入力する.
`void`	`record(java.lang.String outfile)`
`void`	`record(java.lang.String filename, byte[] wave)` 音声データをファイルに記録する。
`void`	`record(java.lang.String filename, byte[] wave, float sampleRate)` 音声データをファイルに記録する。
`void`	`setAllowPullTransfer(boolean flag)` 他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
`void`	`setAllowPushTransfer(boolean flag)` 他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
`void`	`setAllowRemoteInvocation(boolean flag)` 他PFからのコンポーネント連携要求に対する可否属性を設定する.
`void`	`setBigEndian(boolean bigEndian)` データ並びの設定.
`void`	`setChannels(int channels)` チャネル数の設定.
`void`	`setComponentID(int id)` コンポーネントIDを設定する。
`void`	`setComponentKey(java.lang.String key)` コンポーネントキーを設定する。
`void`	`setComponentKeys(PFMultiLocaleString keys)` 全ロケール分のコンポーネントキーを設定する。
`void`	`setComponentPublicName(java.lang.String publicName)` コンポーネント公開名を設定する.
`void`	`setEncoding(java.lang.String encodeString)` エンコード形式の設定.
`void`	`setFrameRate(float frameRate)` フレームレートの設定.
`void`	`setFrameSize(int frameSize)` フレームサイズの設定.
`void`	`setSampleRate(float sampleRate)` サンプルレートの設定.
`void`	`setSampleSizeInBits(int sampleSizeInBits)` サンプルごとのビット数の設定.
`void`	`stop()`
`void`	`writeXML(PFXMLGenerator out)` XMLを出力する.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - PFSoundRecorder
```
public PFSoundRecorder()
```
    コンポーネントを生成する。
- メソッドの詳細
  - getComponentName
```
public java.lang.String getComponentName()
```
    コンポーネント名称を取得する。
    
    定義:
    
    getComponentName インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント名
  - getComponentKey
```
public java.lang.String getComponentKey()
```
    コンポーネントキーを取得する。
    
    定義:
    
    getComponentKey インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネントキー
  - setComponentKey
```
public void setComponentKey(java.lang.String key)
```
    コンポーネントキーを設定する。
    
    定義:
    
    setComponentKey インタフェース内 PFComponent
    
    パラメータ:
    
    key - コンポーネントキー
  - getComponentKeys
```
public PFMultiLocaleString getComponentKeys()
```
    全ロケール分のコンポーネントキーを返す。
    
    戻り値:
    
    全ロケール分のコンポーネントキー
  - setComponentKeys
```
public void setComponentKeys(PFMultiLocaleString keys)
```
    全ロケール分のコンポーネントキーを設定する。
    
    パラメータ:
    
    keys - 全ロケール分のコンポーネントキー
  - getComponentID
```
public int getComponentID()
```
    コンポーネントIDを取得する。
    
    定義:
    
    getComponentID インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネントID
  - setComponentID
```
public void setComponentID(int id)
```
    コンポーネントIDを設定する。
    コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。
    
    定義:
    
    setComponentID インタフェース内 PFComponent
    
    パラメータ:
    
    id - 設定するコンポーネントID
  - getComponentString
```
public java.lang.String getComponentString()
```
    コンポーネントの文字列表現を取得する。
    形式："Component Name" [ ID : "ID" ]
    
    定義:
    
    getComponentString インタフェース内 PFComponent
    
    戻り値:
    
    文字列表現
  - 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型コンポーネント転送要求に対する可否
  - localeUpdated
```
public void localeUpdated()
```
    ロケール変更に対応する。
    
    定義:
    
    localeUpdated インタフェース内 PFComponent
  - record
```
public void record(java.lang.String outfile)
            throws PFComponentException
```
    例外:
    
    PFComponentException
  - stop
```
public void stop()
```
  - setEncoding
```
public void setEncoding(java.lang.String encodeString)
```
    エンコード形式の設定.
    
    パラメータ:
    
    encoding - エンコード形式
  - getEncoding
```
public java.lang.String getEncoding()
```
    エンコード形式の取得.
    
    戻り値:
    
    エンコード形式
  - setSampleRate
```
public void setSampleRate(float sampleRate)
```
    サンプルレートの設定.
    
    パラメータ:
    
    sampleRate - サンプルレート
  - getSampleRate
```
public float getSampleRate()
```
    サンプルレートの取得.
    
    戻り値:
    
    サンプルレート
  - setSampleSizeInBits
```
public void setSampleSizeInBits(int sampleSizeInBits)
```
    サンプルごとのビット数の設定.
    
    パラメータ:
    
    sampleSizeInBits - サンプルごとのビット数
  - getSampleSizeInBits
```
public int getSampleSizeInBits()
```
    サンプルごとのビット数の取得.
    
    戻り値:
    
    サンプルごとのビット数
  - setChannels
```
public void setChannels(int channels)
```
    チャネル数の設定.
    
    パラメータ:
    
    channels - チャネル数
  - getChannels
```
public int getChannels()
```
    チャネル数の取得.
    
    戻り値:
    
    チャネル数
  - setFrameSize
```
public void setFrameSize(int frameSize)
```
    フレームサイズの設定.
    
    パラメータ:
    
    frameSize - フレームサイズ
  - getFrameSize
```
public int getFrameSize()
```
    フレームサイズの取得.
    
    戻り値:
    
    フレームサイズ
  - setFrameRate
```
public void setFrameRate(float frameRate)
```
    フレームレートの設定.
    
    パラメータ:
    
    frameRate - フレームレート
  - getFrameRate
```
public float getFrameRate()
```
    フレームレートの取得.
    
    戻り値:
    
    フレームレート
  - setBigEndian
```
public void setBigEndian(boolean bigEndian)
```
    データ並びの設定.
    
    パラメータ:
    
    bigEndian - ビッグエンディアンのときtrue
  - isBigEndian
```
public boolean isBigEndian()
```
    データ並びの取得.
    
    戻り値:
    
    ビッグエンディアンのときtrue
  - record
```
public void record(java.lang.String filename,
                   byte[] wave)
```
    音声データをファイルに記録する。サンプルレートは44100で固定。
    
    パラメータ:
    
    filename - ファイル名
    
    wave - 音声データ
  - record
```
public void record(java.lang.String filename,
                   byte[] wave,
                   float sampleRate)
```
    音声データをファイルに記録する。
    
    パラメータ:
    
    filename - ファイル名
    
    wave - 音声データ
    
    sampleRate - サンプルレート
  - writeXML
```
public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
```
    XMLを出力する.
    
    定義:
    
    writeXML インタフェース内 PFXMLSerializable
    
    パラメータ:
    
    out - XML出力ユーティリティ
    
    例外:
    
    java.io.IOException
  - readXML
```
public void readXML(PFXMLLoader in)
```
    XMLを入力する.
    
    定義:
    
    readXML インタフェース内 PFXMLSerializable
    
    パラメータ:
    
    in - XML入力ユーティリティ

クラス PFSoundRecorder

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

メソッドのサマリー

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

コンストラクタの詳細

PFSoundRecorder

メソッドの詳細

getComponentName

getComponentKey

setComponentKey

getComponentKeys

setComponentKeys

getComponentID

setComponentID

getComponentString

getComponentPublicName

setComponentPublicName

isAllowRemoteInvocation

setAllowRemoteInvocation

isAllowPullTransfer

setAllowPullTransfer

isAllowPushTransfer

setAllowPushTransfer

localeUpdated

record

stop

setEncoding

getEncoding

setSampleRate

getSampleRate

setSampleSizeInBits

getSampleSizeInBits

setChannels

getChannels

setFrameSize

getFrameSize

setFrameRate

getFrameRate

setBigEndian

isBigEndian

record

record

writeXML

readXML