Class: Lumino::GameAudio

Inherits:
Object
  • Object
show all
Defined in:
LuminoRubyDoc.rb

Overview

ゲーム向け音声再生のユーティリティクラスです。

Instance Method Summary (collapse)

Instance Method Details

- (Object) play_bgm(filePath, volume = 1.0, pitch = 1.0, fadeTime = 0.0)

BGM を演奏します。

 

BGM はひとつだけ演奏することができ、ループ再生します。
新しい BGM を演奏ようとした場合、再生中の BGM は停止します。
フェードイン時間を指定した場合はクロスフェードしながら音声を切り替えます。

Parameters:

  • filePath (String)

    ファイルパス

  • volume (Float) (defaults to: 1.0)

    ボリューム (0.0~1.0)

  • pitch (Float) (defaults to: 1.0)

    ピッチ (0.5~2.0)

  • fadeTime (Float) (defaults to: 0.0)

    フェードインにかける時間 (秒)



1376
1377
# File 'LuminoRubyDoc.rb', line 1376

def play_bgm
end

- (Object) play_bgm_mem(data, dataSize, volume = 1.0, pitch = 1.0, fadeTime = 0.0)

メモリ上の音声ファイルデータを使用して BGM を演奏します。

Parameters:

  • data (String)

    メモリ上の音声ファイルデータ

  • dataSize (Integer)

    データサイズ (バイト単位)

  • volume (Float) (defaults to: 1.0)

    ボリューム (0.0~1.0)

  • pitch (Float) (defaults to: 1.0)

    ピッチ (0.5~2.0)

  • fadeTime (Float) (defaults to: 0.0)

    フェードインにかける時間 (秒)



1385
1386
# File 'LuminoRubyDoc.rb', line 1385

def play_bgm_mem
end

- (Object) play_bgs(filePath, volume = 1.0, pitch = 1.0, fadeTime = 0.0)

BGS を演奏します。

 

BGS は風や滝の音などの環境音です。
BGM と同様、ひとつだけ演奏することができ、ループ再生します。

Parameters:

  • filePath (String)

    ファイルパス

  • volume (Float) (defaults to: 1.0)

    ボリューム (0.0~1.0)

  • pitch (Float) (defaults to: 1.0)

    ピッチ (0.5~2.0)

  • fadeTime (Float) (defaults to: 0.0)

    フェードインにかける時間 (秒)



1401
1402
# File 'LuminoRubyDoc.rb', line 1401

def play_bgs
end

- (Object) play_bgs_mem(data, dataSize, volume = 1.0, pitch = 1.0, fadeTime = 0.0)

メモリ上の音声ファイルデータから BGS を演奏します。

Parameters:

  • data (String)

    メモリ上の音声ファイルデータ

  • dataSize (Integer)

    データサイズ (バイト単位)

  • volume (Float) (defaults to: 1.0)

    ボリューム (0.0~1.0)

  • pitch (Float) (defaults to: 1.0)

    ピッチ (0.5~2.0)

  • fadeTime (Float) (defaults to: 0.0)

    フェードインにかける時間 (秒)



1410
1411
# File 'LuminoRubyDoc.rb', line 1410

def play_bgs_mem
end

- (Object) play_me(filePath, volume = 1.0, pitch = 1.0)

ME を演奏します。

 

ME  レベルアップやアイテム取得時のファンファーレ等の効果音楽です。
ME はひとつだけ演奏することができ、ループ再生せずに一度だけ演奏されます。
BGM が再生中であれば一時停止し、ME 終了後に再開させます。

Parameters:

  • filePath (String)

    ファイルパス

  • volume (Float) (defaults to: 1.0)

    ボリューム (0.0~1.0)

  • pitch (Float) (defaults to: 1.0)

    ピッチ (0.5~2.0)



1426
1427
# File 'LuminoRubyDoc.rb', line 1426

def play_me
end

- (Object) play_me_mem(data, dataSize, volume = 1.0, pitch = 1.0)

メモリ上の音声ファイルデータから ME を演奏します。

Parameters:

  • data (String)

    メモリ上の音声ファイルデータ

  • dataSize (Integer)

    データサイズ (バイト単位)

  • volume (Float) (defaults to: 1.0)

    ボリューム (0.0~1.0)

  • pitch (Float) (defaults to: 1.0)

    ピッチ (0.5~2.0)



1434
1435
# File 'LuminoRubyDoc.rb', line 1434

def play_me_mem
end

- (Object) play_se(filePath, volume = 1.0, pitch = 1.0)

SE を演奏します。

 

SE はゲーム中の効果音です。 SE は同時に複数再生することができ、同じ音声を演奏した場合は 重ねがけされて演奏されます。

Parameters:

  • filePath (String)

    ファイルパス

  • volume (Float) (defaults to: 1.0)

    ボリューム (0.0~1.0)

  • pitch (Float) (defaults to: 1.0)

    ピッチ (0.5~2.0)



1447
1448
# File 'LuminoRubyDoc.rb', line 1447

def play_se
end

- (Object) play_se3d(filePath, position, distance, volume = 1.0, pitch = 1.0) - (Object) play_se3d(filePath, x, y, z, distance, volume = 1.0, pitch = 1.0)

SE を演奏します。(3D サウンド)

Overloads:

  • - (Object) play_se3d(filePath, position, distance, volume = 1.0, pitch = 1.0)

    SE を演奏します。(3D サウンド)

    Parameters:

    • filePath (String)

      ファイルパス

    • position (Lumino::Vector3)

      3D 空間上の座標

    • distance (Float)

      減衰距離

    • volume (Float) (defaults to: 1.0)

      ボリューム (0.0~1.0)

    • pitch (Float) (defaults to: 1.0)

      ピッチ (0.5~2.0)

  • - (Object) play_se3d(filePath, x, y, z, distance, volume = 1.0, pitch = 1.0)

    SE を演奏します。(3D サウンド)

    Parameters:

    • filePath (String)

      ファイルパス

    • x (Float)

      3D 空間上の X 座標

    • y (Float)

      3D 空間上の Y 座標

    • z (Float)

      3D 空間上の Z 座標

    • distance (Float)

      減衰距離

    • volume (Float) (defaults to: 1.0)

      ボリューム (0.0~1.0)

    • pitch (Float) (defaults to: 1.0)

      ピッチ (0.5~2.0)



1466
1467
# File 'LuminoRubyDoc.rb', line 1466

def play_se3d
end

- (Object) play_se3d_mem(data, dataSize, position, distance, volume = 1.0, pitch = 1.0) - (Object) play_se3d_mem(data, dataSize, x, y, z, distance, volume = 1.0, pitch = 1.0)

メモリ上の音声ファイルデータから SE を演奏します。 (3D サウンド)

Overloads:

  • - (Object) play_se3d_mem(data, dataSize, position, distance, volume = 1.0, pitch = 1.0)

    メモリ上の音声ファイルデータから SE を演奏します。 (3D サウンド)

    Parameters:

    • data (String)

      メモリ上の音声ファイルデータ

    • dataSize (Integer)

      データサイズ (バイト単位)

    • position (Lumino::Vector3)

      3D 空間上の座標

    • distance (Float)

      減衰距離

    • volume (Float) (defaults to: 1.0)

      ボリューム (0.0~1.0)

    • pitch (Float) (defaults to: 1.0)

      ピッチ (0.5~2.0)

  • - (Object) play_se3d_mem(data, dataSize, x, y, z, distance, volume = 1.0, pitch = 1.0)

    メモリ上の音声ファイルデータから SE を演奏します。(3D サウンド)

    Parameters:

    • data (String)

      メモリ上の音声ファイルデータ

    • dataSize (Integer)

      データサイズ (バイト単位)

    • x (Float)

      3D 空間上の X 座標

    • y (Float)

      3D 空間上の Y 座標

    • z (Float)

      3D 空間上の Z 座標

    • distance (Float)

      減衰距離

    • volume (Float) (defaults to: 1.0)

      ボリューム (0.0~1.0)

    • pitch (Float) (defaults to: 1.0)

      ピッチ (0.5~2.0)



1495
1496
# File 'LuminoRubyDoc.rb', line 1495

def play_se3d_mem
end

- (Object) play_se_mem(data, dataSize, volume = 1.0, pitch = 1.0)

メモリ上の音声データから SE を演奏します。

Parameters:

  • data (String)

    メモリ上の音声ファイルデータ

  • dataSize (Integer)

    データサイズ (バイト単位)

  • volume (Float) (defaults to: 1.0)

    ボリューム (0.0~1.0)

  • pitch (Float) (defaults to: 1.0)

    ピッチ (0.5~2.0)



1474
1475
# File 'LuminoRubyDoc.rb', line 1474

def play_se_mem
end

- (Object) set_bgm_volume(volume, fadeTime = 0.0)

再生中のBGMの音量を設定します。(フェードアウト中は無効)

Parameters:

  • volume (Float)

    ボリューム (0.0~1.0)

  • fadeTime (Float) (defaults to: 0.0)

    フェードアウトにかける時間 (秒)



1505
1506
# File 'LuminoRubyDoc.rb', line 1505

def set_bgm_volume
end

- (Object) set_bgs_volume(volume, fadeTime = 0.0)

再生中のBGSの音量を設定します。(フェードアウト中は無効)

Parameters:

  • volume (Float)

    ボリューム (0.0~1.0)

  • fadeTime (Float) (defaults to: 0.0)

    フェードアウトにかける時間 (秒)



1511
1512
# File 'LuminoRubyDoc.rb', line 1511

def set_bgs_volume
end

- (Object) stop_bgm(fadeTime = 0.0)

BGM の演奏を停止します。

Parameters:

  • fadeTime (Float) (defaults to: 0.0)

    フェードアウトにかける時間 (秒)



1390
1391
# File 'LuminoRubyDoc.rb', line 1390

def stop_bgm
end

- (Object) stop_bgs(fadeTime = 0.0)

BGS の演奏を停止します。、

Parameters:

  • fadeTime (Float) (defaults to: 0.0)

    フェードアウトにかける時間 (秒)



1415
1416
# File 'LuminoRubyDoc.rb', line 1415

def stop_bgs
end

- (Object) stop_me

ME の演奏を停止します。



1438
1439
# File 'LuminoRubyDoc.rb', line 1438

def stop_me
end

- (Object) stop_se

すべての SE の演奏を停止します。



1499
1500
# File 'LuminoRubyDoc.rb', line 1499

def stop_se
end