SaintSonic - An Easy Audio Engine

version. 2007/04/08
author. Saint'en Tear / VVani
http://stear.biz/

API List

• SaintSonic_EnginePtr SSW_Initialize ( uint32_t SamplingRate = 44100 , uint8_t Channels = 2 , uint8_t UnitBits = 16 , int32_t BufferSize_ms = 50 )
• void SSW_Finish ( SaintSonic_EnginePtr pEngine )
• SaintSonic_SoundId SSW_PlaySound ( SaintSonic_EnginePtr pEngine , char* Filename )
• int16_t SSW_PauseSound ( SaintSonic_EnginePtr pEngine , SaintSonic_SoundId SoundId )
• int16_t SSW_PauseSound ( SaintSonic_EnginePtr pEngine , SaintSonic_SoundId SoundId )
• int16_t SSW_SeekSound ( SaintSonic_EnginePtr pEngine , SaintSonic_SoundId SoundId , int32_t Position_ms , bool isAbsolute = true )
• int16_t SSW_AddLoopInfo ( SaintSonic_EnginePtr pEngine , SaintSonic_SoundId SoundId , int32_t From_ms = int.max , int32_t To_ms = 0 , int32_t Count = int.max )
• int16_t SSW_SeekSound ( SaintSonic_EnginePtr pEngine , SaintSonic_SoundId SoundId , float Volume )
• int16_t SSW_SetFade ( SaintSonic_EnginePtr pEngine , SaintSonic_SoundId SoundId , int32_t Time_ms , float First , float Final )

API Reference

• SaintSonic_EnginePtr SSW_Initialize ( uint32_t SamplingRate = 44100 , uint8_t Channels = 2 , uint8_t UnitBits = 16 , int32_t BufferSize_ms = 50 )
  SaintSonicを初期化します。その際にサンプリングレートやステレオ・モノラルなどの設定も出来ます。
  また、初期化されたオーディオエンジンのポインタを返します。
  失敗するとnullが返ります。
  • uint32_t SamplingRate
    音声出力時及びサウンドバッファに使われる音声データのサンプリングレートです。単位はHzです。
  • uint8_t Channels
    音声出力時及びサウンドバッファに使われる音声データのチャンネル数です。
    現状では1か2にしか対応していません。
  • uint8_t UnitBits
    音声出力時及びサウンドバッファに使われる音声データの量子化ビット数です。
    現状では8か16にしか対応していません。
  • int32_t BufferSize_ms
    サウンドバッファの長さです。単位はmsです。この値をマイナスにした場合、サウンドバッファの長さをバイト数で指定します。
    この値が小さすぎるとマシンのスペックによっては音の切れが発生します。
    また大きければ大きいほど、クロスフェードなどの滑らかさが悪くなります。
• void SSW_Finish ( SaintSonic_EnginePtr pEngine )
  初期化したエンジンの終了処理をします。
  アプリケーション終了前には必ず行ってください。
  • SaintSonic_EnginePtr pEngine
    SSW_Initializeで得たエンジンへのポインタです。
• SaintSonic_SoundId SSW_PlaySound ( SaintSonic_EnginePtr pEngine , char* Filename )
  サウンドを鳴らします。サウンドのボリュームやパンの変更に使うSaintSonic_SoundIdを返します。
  失敗するとマイナスの値が返ります。
  • SaintSonic_EnginePtr pEngine
    SSW_Initializeで得たエンジンへのポインタです。
  • char* Filename
    再生するファイルの名前です。D言語からだと型はchar[]になります。
• int16_t SSW_PauseSound ( SaintSonic_EnginePtr pEngine , SaintSonic_SoundId SoundId )
  サウンドを一時停止します。
  サウンドを途中再生させる場合にはSSW_ResumeSoundを使います。
  失敗すると0以外の値が返ります。
  • SaintSonic_EnginePtr pEngine
    SSW_Initializeで得たエンジンへのポインタです。
  • SaintSonic_SoundId SoundId
    SSW_PlaySoundで得たサウンドIDです。
• int16_t SSW_PauseSound ( SaintSonic_EnginePtr pEngine , SaintSonic_SoundId SoundId )
  一時停止させたサウンドを再生します。
  失敗すると0以外の値が返ります。
  • SaintSonic_EnginePtr pEngine
    SSW_Initializeで得たエンジンへのポインタです。
  • SaintSonic_SoundId SoundId
    SSW_PlaySoundで得たサウンドIDです。
• int16_t SSW_SeekSound ( SaintSonic_EnginePtr pEngine , SaintSonic_SoundId SoundId , int32_t Position_ms , bool isAbsolute = true )
  サウンドをシークします。
  失敗すると0以外の値が返ります。
  • SaintSonic_EnginePtr pEngine
    SSW_Initializeで得たエンジンへのポインタです。
  • SaintSonic_SoundId SoundId
    SSW_PlaySoundで得たサウンドIDです。
  • int32_t Position_ms
    シークポイントをmsで指定します。
  • bool isAbsolute
    絶対的なシークか、相対的なシークかを設定します。trueだと絶対的なシークになります。
• int16_t SSW_AddLoopInfo ( SaintSonic_EnginePtr pEngine , SaintSonic_SoundId SoundId , int32_t From_ms = int.max , int32_t To_ms = 0 , int32_t Count = int.max )
  サウンドをオプションつきでループさせます。
  失敗すると0以外の値が返ります。
  • SaintSonic_EnginePtr pEngine
    SSW_Initializeで得たエンジンへのポインタです。
  • SaintSonic_SoundId SoundId
    SSW_PlaySoundで得たサウンドIDです。
  • int32_t From_ms
    ループのシーク前の位置をmsで指定します。
    サウンドがこの位置まで再生されるとTo_msまでシークします。
  • int32_t To_ms
    ループのシーク後の位置をmsで指定します。
    サウンドがFrom_msまで再生されるとここまでシークします。
  • int32_t Count
    ループの回数です。
• int16_t SSW_SeekSound ( SaintSonic_EnginePtr pEngine , SaintSonic_SoundId SoundId , float Volume )
  サウンドのボリュームを設定します。
  失敗すると0以外の値が返ります。
  • SaintSonic_EnginePtr pEngine
    SSW_Initializeで得たエンジンへのポインタです。
  • SaintSonic_SoundId SoundId
    SSW_PlaySoundで得たサウンドIDです。
  • float Volume
    ボリュームを0～1までの実数で指定します。
• int16_t SSW_SetFade ( SaintSonic_EnginePtr pEngine , SaintSonic_SoundId SoundId , int32_t Time_ms , float First , float Final )
  サウンドをフェードイン・フェードアウトさせます。
  失敗すると0以外の値が返ります。
  • SaintSonic_EnginePtr pEngine
    SSW_Initializeで得たエンジンへのポインタです。
  • SaintSonic_SoundId SoundId
    SSW_PlaySoundで得たサウンドIDです。
  • int32_t Time_ms
    フェードにかかる時間(ms)です。
  • float First
    フェード開始時の音量です。0~1の実数で指定します。
  • float Final
    フェード終了時の音量です。0~1の実数で指定します。