ParaScriptingAudio1.h

//-----------------------------------------------------------------------------
// Copyright (C) 2004 - 2006 ParaEngine Dev Studio, All Rights Reserved.
// Date:    2006.8
// Description: API for Audio Engine. 
//-----------------------------------------------------------------------------
#pragma once
#include <string>

using namespace std;

namespace ParaScripting
{
    class PE_CORE_DECL ParaAudio
    {
    public:

        static bool IsAudioEngineEnabled();
        static void EnableAudioEngine();
        static void DisableAudioEngine();

        static void SetVolume(float fVolume);

        static float GetVolume();

        static void PauseCategory(const char * strCategoryName);
        static void ResumeCategory(const char * strCategoryName);
        static void StopCategory(const char * strCategoryName);
        static void EnableAudioBank(const char * strBankName);

        static void DisableAudioBank(const char * strBankName);

        static int LoadSoundBank(const char* filename);

        static int UnLoadSoundBank(const char* filename);

        static int LoadInMemoryWaveBank(const char* filename);

        static int UnLoadInMemoryWaveBank(const char* filename);

        static int LoadStreamWaveBank(const char* filename);

        static int UnLoadStreamWaveBank(const char* filename);

        static string GetCurrentAudioBankName();
        static void SetAudioStereo();
        static void SetAudio5Point1();
        static int GetAudioFormat();

        static void PlayBGMusic( const char * strBGMusicName );
        static void PauseBGMusic( );
        static void ResumeBGMusic( );
        static void StopBGMusic( );
        static bool IsBGMusicEnabled();
        static void EnableBGMusic( );
        static void DisableBGMusic( );
        static float GetBGMusicVolume( );
        static void SetBGMusicVolume( const float fVolume );

        static void PlayDialog( const char * strDialogName , const char * strScript );
        static void SkipDialog( );
        static void PauseDialog( );
        static void ResumeDialog( );
        static void StopDialog( );
        static bool IsDialogEnabled();
        static void EnableDialog( );
        static void DisableDialog( );
        static float GetDialogVolume( );
        static void SetDialogVolume( const float fVolume );

        static void PlayAmbientSound( const char * strAmbientSoundName );
        static void PauseAmbientSound( const char * strAmbientSoundName );
        static void ResumeAmbientSound( const char * strAmbientSoundName );
        static void StopAmbientSound( const char * strAmbientSoundName );
        static bool IsAmbientSoundEnabled();
        static void EnableAmbientSound( );
        static void DisableAmbientSound( );
        static float GetAmbientSoundVolume( );
        static void SetAmbientSoundVolume( const float fVolume );

        static void PlayUISound( const char * strUISoundName );
        static float GetUISoundVolume( );
        static void SetUISoundVolume( const float fVolume );

        static void PlayStatic3DSound( const char * str3DSoundName, const char * assetName, float x, float y, float z);
        static void PauseStatic3DSound( const char * assetName );
        static void ResumeStatic3DSound( const char * assetName );
        static void StopStatic3DSound( const char * assetName );
        static void PlayDynamic3DSound( const char * str3DSoundName, const char * objectName );
        static float Get3DSoundVolume( );
        static void Set3DSoundVolume( const float fVolume );

        static void PlayInteractiveSound( const char * strInteractiveSoundName );
        static float GetInteractiveSoundVolume( );
        static void SetInteractiveSoundVolume( const float fVolume );

        //static void PlayUISound( const char * strSoundAssetName );

        //static void EnableAudioEngine(bool enable);

        //static bool IsAudioEngineEnabled();

        //
        // code driven audio functions. for file based wave file only.
        //

        static bool PlayWaveFile(const char* szWavePath,int nLoopCount);
        static bool PlayWaveFile1(const char* szWavePath);
        static bool StopWaveFile(const char* szWavePath, bool bImmediateStop);
        static bool StopWaveFile1(const char* szWavePath);

        static bool ReleaseWaveFile(const char* szWavePath);

        //
        // recording related
        //

        static const char* GetRecordingDeviceEnum();

        static const char* GetRecordingFormatEnum();

        static bool SetRecordingOutput(const char* sOutputFile, int nDeviceIndex, int nWaveFormatIndex);

        static bool BeginRecording();


        static bool PauseOrResumeRecording(int nState);


        static bool StopRecording();

        static bool IsRecording();

        static bool IsRecordingPaused();

        static const char* GetLastRecordedData(int nTimeLength);
    };

}