概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## kinugasa.contents.sound
クラス SoundBuilder

    java.lang.Object
      kinugasa.contents.sound.SoundBuilder

すべての実装されたインタフェース:
  java.io.Serializable, Nameable

    public final class SoundBuilder

extends java.lang.Object
implements java.io.Serializable, Nameable

キャッシュつきサウンドのインスタンスを作成するためのビルダです.
WAVEファイルを使用する際の、最も一般的な構築クラスとなります。

バージョン:
  1.0.0 - 2013/01/13_18:48:59
作成者:
  Dra0211
関連項目:
  直列化された形式

フィールドの概要
`private java.io.File` | `file` ファイルインスタンス.
`private LoopPoint` | `loopPoint` ループ設定.
`private float` | `masterGain` マスターゲインの値.
`private java.lang.String` | `name`
`private boolean` | `newFile` 新規インスタンスで作成するか.
`private float` | `pan` パンの設定.
`private ReverbModel` | `reverbModel` リバーブ設定.
`private float` | `sampleRate` 再生時のサンプルレート.
`private static long` | `serialVersionUID`
`private float` | `volume` ボリューム.

コンストラクタの概要
`SoundBuilder(java.lang.String filePath)` 新しいCachedSoundを作成するためのビルダを構築します.

メソッドの概要
`CachedSound` | `builde()` 現在の設定で新しいCachedSoundを作成します.
`boolean` | `equals(java.lang.Object obj)`
`java.io.File` | `getFile()` 作成される予定のサウンドのファイルを取得します.
`LoopPoint` | `getLoopPoint()` 設定されている値を返します.
`float` | `getMasterGain()` 設定されている値を返します.
`java.lang.String` | `getName()` このインスタンスの一意的な名前を取得します.
`float` | `getPan()` 設定されている値を返します.
`ReverbModel` | `getReverbModel()` 設定されている値を返します.
`float` | `getSampleRate()` 設定されている値を返します.
`float` | `getVolume()` 設定されている値を返します.
`int` | `hashCode()`
`boolean` | `isNewFile()` 設定されている値を返します.
`SoundBuilder` | `newFile()` このメソッドを呼び出すとCachedSoundのキャッシュデータを使用せず、 新しいサウンドインスタンスを作成します.
`SoundBuilder` | `setLoopPoint(int from, int to)` ループ位置を設定します.
`SoundBuilder` | `setLoopPoint(LoopPoint loopPoint)` ループ位置を設定します.
`SoundBuilder` | `setMasterGain(float masterGain)` サウンドのマスターゲインを設定します.
`SoundBuilder` | `setName(java.lang.String name)`
`SoundBuilder` | `setPan(float pan)` ステレオサウンドのパン位置を設定します.
`SoundBuilder` | `setReverbModel(ReverbModel reverbModel)` サウンドのリバーブを設定します.
`SoundBuilder` | `setSampleRate(float sampleRate)` サウンドの再生時のサンプルレートを設定します.
`SoundBuilder` | `setVolume(float volume)` サウンドの音量を設定します.
`java.lang.String` | `toString()`

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

フィールドの詳細

### serialVersionUID

    private static final long serialVersionUID

関連項目:
  定数フィールド値

### file

    private java.io.File file

  ファイルインスタンス.

### loopPoint

    private LoopPoint loopPoint

  ループ設定.

### reverbModel

    private ReverbModel reverbModel

  リバーブ設定.

### masterGain

    private float masterGain

  マスターゲインの値.

### volume

    private float volume

  ボリューム.

### pan

    private float pan

  パンの設定.

### sampleRate

    private float sampleRate

  再生時のサンプルレート.

### newFile

    private boolean newFile

  新規インスタンスで作成するか.

### name

    private java.lang.String name

コンストラクタの詳細

### SoundBuilder

    public SoundBuilder(java.lang.String filePath)
                 throws ContentsFileNotFoundException

  新しいCachedSoundを作成するためのビルダを構築します.

  パラメータ:
    `filePath` - ファイルパス.
  例外:
    `ContentsFileNotFoundException` - ファイルが存在しない場合に投げられる.

メソッドの詳細

### setLoopPoint

    public SoundBuilder setLoopPoint(LoopPoint loopPoint)

  ループ位置を設定します.

  パラメータ:
    `loopPoint` - ループ位置.
  戻り値:
    このビルダのインスタンス.

### setLoopPoint

    public SoundBuilder setLoopPoint(int from,
                                     int to)

  ループ位置を設定します.

  パラメータ:
    `from` - ループ位置.
    `to` - ループ位置.
  戻り値:
    このビルダのインスタンス.

### setMasterGain

    public SoundBuilder setMasterGain(float masterGain)

  サウンドのマスターゲインを設定します. これはボリュームがサポートされていない環境で音量を設定することができます.

  パラメータ:
    `masterGain` - ゲインの値.0.0fで無音になる.
  戻り値:
    このビルダのインスタンス.

### setPan

    public SoundBuilder setPan(float pan)

  ステレオサウンドのパン位置を設定します. この機能はサポートされていない可能性があります.

  パラメータ:
    `pan` - 中心を0.0、左右を1.0とした場合のパン位置.
  戻り値:
    このビルダのインスタンス.

### setVolume

    public SoundBuilder setVolume(float volume)

  サウンドの音量を設定します. この機能はサポートされていない可能性があります.音量の調節はマスターゲインを使用してください.

  パラメータ:
    `volume` - 音量.
  戻り値:
    このビルダのインスタンス.

### setReverbModel

    public SoundBuilder setReverbModel(ReverbModel reverbModel)

  サウンドのリバーブを設定します. この機能はサポートされていない可能性があります.

  パラメータ:
    `reverbModel` - リバーブの設定.
  戻り値:
    このビルダのインスタンス.

### setSampleRate

    public SoundBuilder setSampleRate(float sampleRate)

  サウンドの再生時のサンプルレートを設定します. この機能はサポートされていない可能性があります.

  パラメータ:
    `sampleRate` - 再生時のサンプルレート.
  戻り値:
    このビルダのインスタンス.

### newFile

    public SoundBuilder newFile()

  このメソッドを呼び出すとCachedSoundのキャッシュデータを使用せず、 新しいサウンドインスタンスを作成します.

  戻り値:
    このビルダのインスタンス.

### setName

    public SoundBuilder setName(java.lang.String name)

### getFile

    public java.io.File getFile()

  作成される予定のサウンドのファイルを取得します. このメソッドの戻り値のファイルは存在が保証されます.

  戻り値:
    ファイルインスタンス.

### getLoopPoint

    public LoopPoint getLoopPoint()

  設定されている値を返します.

  戻り値:
    ループ位置.

### getMasterGain

    public float getMasterGain()

  設定されている値を返します.

  戻り値:
    ゲインの値.

### isNewFile

    public boolean isNewFile()

  設定されている値を返します.

  戻り値:
    キャッシュを使用せずに新しいインスタンスを作成する場合はTRUEを返す.

### getPan

    public float getPan()

  設定されている値を返します.

  戻り値:
    パンの設定.

### getReverbModel

    public ReverbModel getReverbModel()

  設定されている値を返します.

  戻り値:
    リバーブの設定.

### getSampleRate

    public float getSampleRate()

  設定されている値を返します.

  戻り値:
    再生時のサンプルレート.

### getVolume

    public float getVolume()

  設定されている値を返します.

  戻り値:
    音量.

### builde

    public CachedSound builde()

  現在の設定で新しいCachedSoundを作成します.

  戻り値:
    AudioDataの実装を返す.

### equals

    public boolean equals(java.lang.Object obj)

  オーバーライド:
    クラス `java.lang.Object` 内の `equals`

### hashCode

    public int hashCode()

  オーバーライド:
    クラス `java.lang.Object` 内の `hashCode`

### getName

    public java.lang.String getName()

  インタフェース `Nameable` の記述:
  このインスタンスの一意的な名前を取得します. 名前はゲームの実行中変更されてはなりません。

  定義:
    インタフェース `Nameable` 内の `getName`
  戻り値:
    このインスタンスを識別できる一意的な名前を返します。名前はユーザやプレイヤーが指定する可能性があるため 意味のある文字列を推奨します。

### toString

    public java.lang.String toString()

  オーバーライド:
    クラス `java.lang.Object` 内の `toString`

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド