Version

menu_open

include/AK/SoundEngine/Common/AkSoundEngine.h

Go to the documentation of this file.
00001 /*******************************************************************************
00002 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
00003 released in source code form as part of the SDK installer package.
00004 
00005 Commercial License Usage
00006 
00007 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
00008 may use this file in accordance with the end user license agreement provided 
00009 with the software or, alternatively, in accordance with the terms contained in a
00010 written agreement between you and Audiokinetic Inc.
00011 
00012 Apache License Usage
00013 
00014 Alternatively, this file may be used under the Apache License, Version 2.0 (the 
00015 "Apache License"); you may not use this file except in compliance with the 
00016 Apache License. You may obtain a copy of the Apache License at 
00017 http://www.apache.org/licenses/LICENSE-2.0.
00018 
00019 Unless required by applicable law or agreed to in writing, software distributed
00020 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
00021 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
00022 the specific language governing permissions and limitations under the License.
00023 
00024   Version: <VERSION>  Build: <BUILDNUMBER>
00025   Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.
00026 *******************************************************************************/
00027 
00028 // AkSoundEngine.h
00029 
00032 
00033 
00034 #ifndef _AK_SOUNDENGINE_H_
00035 #define _AK_SOUNDENGINE_H_
00036 
00037 #include <AK/SoundEngine/Common/AkSoundEngineExport.h>
00038 #include <AK/SoundEngine/Common/AkTypes.h>
00039 #include <AK/SoundEngine/Common/IAkPlugin.h>
00040 #include <AK/SoundEngine/Common/AkCallback.h>
00041 
00042 #ifdef AK_WIN
00043 #include <AK/SoundEngine/Platforms/Windows/AkWinSoundEngine.h>
00044 
00045 #elif defined (AK_MAC_OS_X)
00046 #include <AK/SoundEngine/Platforms/Mac/AkMacSoundEngine.h>
00047 
00048 #elif defined (AK_IOS)
00049 #include <AK/SoundEngine/Platforms/iOS/AkiOSSoundEngine.h>
00050 
00051 #elif defined (AK_XBOX360)
00052 #include <AK/SoundEngine/Platforms/XBox360/AkXBox360SoundEngine.h>
00053 
00054 #elif defined (AK_XBOXONE)
00055 #include <AK/SoundEngine/Platforms/XboxOne/AkXboxOneSoundEngine.h>
00056 
00057 #elif defined (__PPU__) || defined (__SPU__)
00058 #include <AK/SoundEngine/Platforms/PS3/AkPs3SoundEngine.h>
00059 
00060 #elif defined (AK_WII_FAMILY)
00061 #include <AK/SoundEngine/Platforms/WiiFamily/AkWiiSoundEngine.h>
00062 
00063 #elif defined (AK_VITA)
00064 #include <AK/SoundEngine/Platforms/Vita/AkVitaSoundEngine.h>
00065 
00066 #elif defined( AK_3DS )
00067 #include <AK/SoundEngine/Platforms/3DS/Ak3DSSoundEngine.h>
00068 
00069 #elif defined( AK_ANDROID )
00070 #include <AK/SoundEngine/Platforms/Android/AkAndroidSoundEngine.h>
00071 
00072 #elif defined( AK_NACL )
00073 #include <AK/SoundEngine/Platforms/nacl/AkNaclSoundEngine.h>
00074 
00075 #elif defined (AK_PS4)
00076 #include <AK/SoundEngine/Platforms/PS4/AkPS4SoundEngine.h>
00077 
00078 #elif defined( AK_LINUX )
00079 #include <AK/SoundEngine/Platforms/Linux/AkLinuxSoundEngine.h>
00080 
00081 #elif defined( AK_EMSCRIPTEN )
00082 #include <AK/SoundEngine/Platforms/Emscripten/AkEmscriptenSoundEngine.h>
00083 
00084 #elif defined( AK_QNX  )
00085 #include <AK/SoundEngine/Platforms/QNX/AkQNXSoundEngine.h>
00086 
00087 #elif defined( AK_NX )
00088 #include <AK/SoundEngine/Platforms/NX/AkNXSoundEngine.h>
00089 
00090 #else
00091 #error AkSoundEngine.h: Undefined platform
00092 #endif
00093 
00094 #ifndef AK_ASSERT_HOOK
00095 
00096 
00097 
00098     AK_CALLBACK( void, AkAssertHook)( 
00099         const char * in_pszExpression,  
00100         const char * in_pszFileName,    
00101         int in_lineNumber               
00102         );
00103     #define AK_ASSERT_HOOK
00104 #endif
00105 
00115 typedef AKRESULT ( * AkBackgroundMusicChangeCallbackFunc )(
00116     bool in_bBackgroundMusicMuted,  
00117     void* in_pCookie 
00118     );
00119 
00121 struct AkOutputSettings
00122 {
00123     AkPanningRule   ePanningRule;   
00124 
00125 
00126 
00127     AkChannelConfig channelConfig;  
00128 
00129 
00130     AkUniqueID audioDeviceShareset; 
00131 
00132 
00133 
00134 
00135 
00136 };
00137 
00144 struct AkInitSettings
00145 {
00146     AkAssertHook        pfnAssertHook;              
00147 
00148     AkUInt32            uMaxNumPaths;               
00149     AkUInt32            uDefaultPoolSize;           
00150     AkReal32            fDefaultPoolRatioThreshold; 
00151     AkUInt32            uCommandQueueSize;          
00152     AkMemPoolId         uPrepareEventMemoryPoolID;  
00153     bool                bEnableGameSyncPreparation; 
00154     AkUInt32            uContinuousPlaybackLookAhead;   
00155 
00156 
00157     AkUInt32            uNumSamplesPerFrame;        
00158 
00159     AkUInt32            uMonitorPoolSize;           
00160     AkUInt32            uMonitorQueuePoolSize;      
00161     
00162     AkOutputSettings    settingsMainOutput;         
00163     AkUInt32            uMaxHardwareTimeoutMs;      
00164 
00165     bool                bUseSoundBankMgrThread;     
00166     bool                bUseLEngineThread;          
00167 
00168     AkBackgroundMusicChangeCallbackFunc BGMCallback; 
00169     void*               BGMCallbackCookie;          
00170     AkOSChar *          szPluginDLLPath;            
00171 };
00172 
00174 struct AkSourceSettings
00175 {
00176     AkUniqueID  sourceID;                           
00177     AkUInt8*    pMediaMemory;                       
00178     AkUInt32    uMediaSize;                         
00179 };
00180 
00182 struct AkAudioSettings
00183 {
00184     AkUInt32            uNumSamplesPerFrame;        
00185     AkUInt32            uNumSamplesPerSecond;       
00186 };
00187 
00189 struct AkSourcePosition
00190 {
00191     AkUniqueID  audioNodeID;                        
00192     AkUniqueID  mediaID;                            
00193     AkTimeMs    msTime;                             
00194 };
00195 
00197 namespace AK
00198 {
00199     class IReadBytes;
00200     class IWriteBytes;
00201 
00204     namespace SoundEngine
00205     {
00208 
00209 
00217         AK_EXTERNAPIFUNC( bool, IsInitialized )();
00218 
00242         AK_EXTERNAPIFUNC( AKRESULT, Init )(
00243             AkInitSettings *            in_pSettings,           
00244             AkPlatformInitSettings *    in_pPlatformSettings    
00245             );
00246 
00253         AK_EXTERNAPIFUNC( void, GetDefaultInitSettings )(
00254             AkInitSettings &            out_settings            
00255             );
00256 
00274         AK_EXTERNAPIFUNC( void, GetDefaultPlatformInitSettings )(
00275             AkPlatformInitSettings &    out_platformSettings    
00276             );
00277         
00286         AK_EXTERNAPIFUNC( void, Term )();
00287 
00293         AK_EXTERNAPIFUNC( AKRESULT, GetAudioSettings )(
00294             AkAudioSettings &   out_audioSettings   
00295             );
00296 
00309         AK_EXTERNAPIFUNC( AkChannelConfig, GetSpeakerConfiguration )(
00310             AkAudioOutputType   in_eOutputType = AkOutput_Main, 
00311             AkUInt32            in_iOutputID = 0            
00312             );
00313 
00321         AK_EXTERNAPIFUNC( AKRESULT, GetPanningRule )(
00322             AkPanningRule &     out_ePanningRule,           
00323             AkAudioOutputType   in_eOutputType = AkOutput_Main, 
00324             AkUInt32            in_iOutputID = 0            
00325             );
00326 
00330         AK_EXTERNAPIFUNC( AKRESULT, SetPanningRule )( 
00331             AkPanningRule       in_ePanningRule,            
00332             AkAudioOutputType   in_eOutputType = AkOutput_Main, 
00333             AkUInt32            in_iOutputID = 0            
00334             );
00335 
00358         AK_EXTERNAPIFUNC( AKRESULT, GetSpeakerAngles )(
00359             AkReal32 *          io_pfSpeakerAngles,         
00360             AkUInt32 &          io_uNumAngles,              
00361             AkReal32 &          out_fHeightAngle,           
00362             AkAudioOutputType   in_eOutputType = AkOutput_Main, 
00363             AkUInt32            in_iOutputID = 0            
00364             );
00365         
00380         AK_EXTERNAPIFUNC( AKRESULT, SetSpeakerAngles )(
00381             AkReal32 *          in_pfSpeakerAngles,         
00382             AkUInt32            in_uNumAngles,              
00383             AkReal32            in_fHeightAngle,            
00384             AkAudioOutputType   in_eOutputType = AkOutput_Main, 
00385             AkUInt32            in_iOutputID = 0            
00386             );
00387 
00394         AK_EXTERNAPIFUNC( AKRESULT, SetVolumeThreshold )( 
00395             AkReal32 in_fVolumeThresholdDB 
00396             );
00397 
00404         AK_EXTERNAPIFUNC( AKRESULT, SetMaxNumVoicesLimit )( 
00405             AkUInt16 in_maxNumberVoices 
00406             );
00407                 
00409 
00412 
00413 
00421         AK_EXTERNAPIFUNC( AKRESULT, RenderAudio )( 
00422             bool in_bAllowSyncRender = true             
00423             );
00424 
00426 
00429 
00430 
00433         AK_EXTERNAPIFUNC(AK::IAkGlobalPluginContext *, GetGlobalPluginContext)();
00434 
00452         AK_EXTERNAPIFUNC( AKRESULT, RegisterPlugin )( 
00453             AkPluginType in_eType,                      
00454             AkUInt32 in_ulCompanyID,                    
00455             AkUInt32 in_ulPluginID,                     
00456             AkCreatePluginCallback in_pCreateFunc,      
00457             AkCreateParamCallback in_pCreateParamFunc   
00458             );
00459 
00467         AK_EXTERNAPIFUNC( AKRESULT, RegisterPluginDLL ) (
00468             const AkOSChar* in_DllName                  
00469             );
00470         
00487         AK_EXTERNAPIFUNC( AKRESULT, RegisterCodec )( 
00488             AkUInt32 in_ulCompanyID,                        
00489             AkUInt32 in_ulCodecID,                          
00490             AkCreateFileSourceCallback in_pFileCreateFunc,  
00491             AkCreateBankSourceCallback in_pBankCreateFunc   
00492             );
00493 
00506         AK_EXTERNAPIFUNC(AKRESULT, RegisterGlobalCallback)(
00507             AkGlobalCallbackFunc in_pCallback,              
00508             AkUInt32 in_eLocation = AkGlobalCallbackLocation_BeginRender, 
00509             void * in_pCookie = NULL                        
00510             );
00511 
00521         AK_EXTERNAPIFUNC(AKRESULT, UnregisterGlobalCallback)(
00522             AkGlobalCallbackFunc in_pCallback,              
00523             AkUInt32 in_eLocation = AkGlobalCallbackLocation_BeginRender 
00524             );
00525 
00527 
00528 #ifdef AK_SUPPORT_WCHAR
00529 
00530 
00531 
00532 
00549         AK_EXTERNAPIFUNC( AkUInt32, GetIDFromString )( const wchar_t* in_pszString );
00550 #endif //AK_SUPPORT_WCHAR
00551 
00568         AK_EXTERNAPIFUNC( AkUInt32, GetIDFromString )( const char* in_pszString );
00569 
00571 
00574 
00575 
00593         AK_EXTERNAPIFUNC( AkPlayingID, PostEvent )(
00594             AkUniqueID in_eventID,                          
00595             AkGameObjectID in_gameObjectID,                 
00596             AkUInt32 in_uFlags = 0,                         
00597             AkCallbackFunc in_pfnCallback = NULL,           
00598             void * in_pCookie = NULL,                       
00599             AkUInt32 in_cExternals = 0,                     
00600             AkExternalSourceInfo *in_pExternalSources = NULL,
00601             AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID
00602             );
00603 
00604 #ifdef AK_SUPPORT_WCHAR
00605 
00606 
00607 
00608 
00609 
00610 
00611 
00612 
00613 
00614 
00615 
00616 
00617 
00618 
00619 
00620 
00621 
00622         AK_EXTERNAPIFUNC( AkPlayingID, PostEvent )(
00623             const wchar_t* in_pszEventName,                 
00624             AkGameObjectID in_gameObjectID,                 
00625             AkUInt32 in_uFlags = 0,                         
00626             AkCallbackFunc in_pfnCallback = NULL,           
00627             void * in_pCookie = NULL,                       
00628             AkUInt32 in_cExternals = 0,                     
00629             AkExternalSourceInfo *in_pExternalSources = NULL,
00630             AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID
00631             );
00632 #endif //AK_SUPPORT_WCHAR
00633 
00651         AK_EXTERNAPIFUNC( AkPlayingID, PostEvent )(
00652             const char* in_pszEventName,                    
00653             AkGameObjectID in_gameObjectID,                 
00654             AkUInt32 in_uFlags = 0,                         
00655             AkCallbackFunc in_pfnCallback = NULL,           
00656             void * in_pCookie = NULL,                       
00657             AkUInt32 in_cExternals = 0,                     
00658             AkExternalSourceInfo *in_pExternalSources = NULL,
00659             AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID
00660             );
00661 
00662         
00666         enum AkActionOnEventType
00667         {
00668             AkActionOnEventType_Stop    = 0,            
00669             AkActionOnEventType_Pause   = 1,            
00670             AkActionOnEventType_Resume  = 2,            
00671             AkActionOnEventType_Break   = 3,            
00672             AkActionOnEventType_ReleaseEnvelope = 4     
00673         };
00674 
00678         AK_EXTERNAPIFUNC( AKRESULT, ExecuteActionOnEvent )(
00679             AkUniqueID in_eventID,                                              
00680             AkActionOnEventType in_ActionType,                                  
00681             AkGameObjectID in_gameObjectID = AK_INVALID_GAME_OBJECT,            
00682             AkTimeMs in_uTransitionDuration = 0,                                
00683             AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear,   
00684             AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID                    
00685             );
00686 
00687 #ifdef AK_SUPPORT_WCHAR
00688 
00689 
00690 
00691         AK_EXTERNAPIFUNC( AKRESULT, ExecuteActionOnEvent )(
00692             const wchar_t* in_pszEventName,                                     
00693             AkActionOnEventType in_ActionType,                                  
00694             AkGameObjectID in_gameObjectID = AK_INVALID_GAME_OBJECT,            
00695             AkTimeMs in_uTransitionDuration = 0,                                
00696             AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear,   
00697             AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID                    
00698             );
00699 #endif //AK_SUPPORT_WCHAR
00700 
00704         AK_EXTERNAPIFUNC( AKRESULT, ExecuteActionOnEvent )(
00705             const char* in_pszEventName,                                        
00706             AkActionOnEventType in_ActionType,                                  
00707             AkGameObjectID in_gameObjectID = AK_INVALID_GAME_OBJECT,            
00708             AkTimeMs in_uTransitionDuration = 0,                                
00709             AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear,   
00710             AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID                    
00711             );
00712 
00713 
00720         AK_EXTERNAPIFUNC( AKRESULT, PostMIDIOnEvent )(
00721             AkUniqueID in_eventID,                                          
00722             AkGameObjectID in_gameObjectID,                                 
00723             AkMIDIPost* in_pPosts,                                          
00724             AkUInt16 in_uNumPosts                                           
00725             );
00726 
00733         AK_EXTERNAPIFUNC( AKRESULT, StopMIDIOnEvent )(
00734             AkUniqueID in_eventID = AK_INVALID_UNIQUE_ID,                   
00735             AkGameObjectID in_gameObjectID = AK_INVALID_GAME_OBJECT         
00736             );
00737 
00738 
00755         AK_EXTERNAPIFUNC( AKRESULT, PinEventInStreamCache )(
00756             AkUniqueID in_eventID,                                          
00757             AkPriority in_uActivePriority,                                  
00758             AkPriority in_uInactivePriority                                 
00759             );
00760 
00761 #ifdef AK_SUPPORT_WCHAR
00762 
00763 
00764 
00765 
00766 
00767 
00768 
00769 
00770 
00771 
00772 
00773 
00774 
00775 
00776 
00777 
00778         AK_EXTERNAPIFUNC( AKRESULT, PinEventInStreamCache )(
00779             const wchar_t* in_pszEventName,                                 
00780             AkPriority in_uActivePriority,                                  
00781             AkPriority in_uInactivePriority                                 
00782             );
00783 #endif //AK_SUPPORT_WCHAR
00784 
00801         AK_EXTERNAPIFUNC( AKRESULT, PinEventInStreamCache )(
00802             const char* in_pszEventName,                                    
00803             AkPriority in_uActivePriority,                                  
00804             AkPriority in_uInactivePriority                                 
00805             );
00806 
00812         AK_EXTERNAPIFUNC( AKRESULT, UnpinEventInStreamCache )(
00813             AkUniqueID in_eventID                                           
00814             );  
00815 
00816 #ifdef AK_SUPPORT_WCHAR
00817 
00818 
00819 
00820 
00821 
00822         AK_EXTERNAPIFUNC( AKRESULT, UnpinEventInStreamCache )(
00823             const wchar_t* in_pszEventName                                  
00824             );
00825 #endif //AK_SUPPORT_WCHAR
00826 
00832         AK_EXTERNAPIFUNC( AKRESULT, UnpinEventInStreamCache )(
00833             const char* in_pszEventName                                     
00834             );
00835 
00844         AK_EXTERNAPIFUNC( AKRESULT, GetBufferStatusForPinnedEvent )(
00845             AkUniqueID in_eventID,                                          
00846             AkReal32& out_fPercentBuffered,                                 
00847             bool& out_bCachePinnedMemoryFull                                
00848             );
00849 
00858         AK_EXTERNAPIFUNC( AKRESULT, GetBufferStatusForPinnedEvent )(
00859             const char* in_pszEventName,                                    
00860             AkReal32& out_fPercentBuffered,                                 
00861             bool& out_bCachePinnedMemoryFull                                
00862             );
00863 
00864 #ifdef AK_SUPPORT_WCHAR
00865 
00866 
00867 
00868 
00869 
00870 
00871 
00872 
00873         AK_EXTERNAPIFUNC( AKRESULT, GetBufferStatusForPinnedEvent )(
00874             const wchar_t* in_pszEventName,                                 
00875             AkReal32& out_fPercentBuffered,                                 
00876             bool& out_bCachePinnedMemoryFull                                
00877             );
00878 #endif
00879 
00925         AK_EXTERNAPIFUNC( AKRESULT, SeekOnEvent )( 
00926             AkUniqueID in_eventID,                                      
00927             AkGameObjectID in_gameObjectID,                             
00928             AkTimeMs in_iPosition,                                      
00929             bool in_bSeekToNearestMarker = false,                       
00930             AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID            
00931             );
00932 
00933 #ifdef AK_SUPPORT_WCHAR
00934 
00935 
00936 
00937 
00938 
00939 
00940 
00941 
00942 
00943 
00944 
00945 
00946 
00947 
00948 
00949 
00950 
00951 
00952 
00953 
00954 
00955 
00956 
00957 
00958 
00959 
00960 
00961 
00962 
00963 
00964 
00965 
00966 
00967 
00968 
00969 
00970 
00971 
00972 
00973 
00974 
00975 
00976 
00977 
00978 
00979 
00980 
00981         AK_EXTERNAPIFUNC( AKRESULT, SeekOnEvent )( 
00982             const wchar_t* in_pszEventName,                             
00983             AkGameObjectID in_gameObjectID,                             
00984             AkTimeMs in_iPosition,                                      
00985             bool in_bSeekToNearestMarker = false,                       
00986             AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID            
00987             );
00988 #endif //AK_SUPPORT_WCHAR
00989 
01037         AK_EXTERNAPIFUNC( AKRESULT, SeekOnEvent )( 
01038             const char* in_pszEventName,                                
01039             AkGameObjectID in_gameObjectID,                             
01040             AkTimeMs in_iPosition,                                      
01041             bool in_bSeekToNearestMarker = false,                       
01042             AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID            
01043             );
01044 
01091         AK_EXTERNAPIFUNC( AKRESULT, SeekOnEvent )( 
01092             AkUniqueID in_eventID,                                      
01093             AkGameObjectID in_gameObjectID ,                            
01094             AkReal32 in_fPercent,                                       
01095             bool in_bSeekToNearestMarker = false,                       
01096             AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID            
01097             );
01098 
01099 #ifdef AK_SUPPORT_WCHAR
01100 
01101 
01102 
01103 
01104 
01105 
01106 
01107 
01108 
01109 
01110 
01111 
01112 
01113 
01114 
01115 
01116 
01117 
01118 
01119 
01120 
01121 
01122 
01123 
01124 
01125 
01126 
01127 
01128 
01129 
01130 
01131 
01132 
01133 
01134 
01135 
01136 
01137 
01138 
01139 
01140 
01141 
01142 
01143 
01144 
01145         AK_EXTERNAPIFUNC( AKRESULT, SeekOnEvent )( 
01146             const wchar_t* in_pszEventName,                             
01147             AkGameObjectID in_gameObjectID ,                            
01148             AkReal32 in_fPercent ,                                      
01149             bool in_bSeekToNearestMarker = false,                       
01150             AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID            
01151             );
01152 #endif //AK_SUPPORT_WCHAR
01153 
01199         AK_EXTERNAPIFUNC( AKRESULT, SeekOnEvent )( 
01200             const char* in_pszEventName,                                
01201             AkGameObjectID in_gameObjectID,                             
01202             AkReal32 in_fPercent,                                       
01203             bool in_bSeekToNearestMarker = false,                       
01204             AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID            
01205             );
01206 
01210         AK_EXTERNAPIFUNC( void, CancelEventCallbackCookie )( 
01211             void * in_pCookie                           
01212             );
01213 
01217         AK_EXTERNAPIFUNC( void, CancelEventCallback )( 
01218             AkPlayingID in_playingID                    
01219             );
01220 
01236         AK_EXTERNAPIFUNC( AKRESULT, GetSourcePlayPosition )(
01237             AkPlayingID     in_PlayingID,               
01238             AkTimeMs*       out_puPosition,             
01239             bool            in_bExtrapolate = true      
01240             );
01241 
01256         AK_EXTERNAPIFUNC(AKRESULT, GetSourcePlayPositions)(
01257             AkPlayingID     in_PlayingID,               
01258             AkSourcePosition* out_puPositions,          
01259             AkUInt32 *      io_pcPositions,             
01260             bool            in_bExtrapolate = true      
01261             );
01262 
01279         AK_EXTERNAPIFUNC( AKRESULT, GetSourceStreamBuffering )(
01280             AkPlayingID     in_PlayingID,               
01281             AkTimeMs &      out_buffering,              
01282             bool &          out_bIsBuffering            
01283             );
01284 
01287         AK_EXTERNAPIFUNC( void, StopAll )( 
01288             AkGameObjectID in_gameObjectID = AK_INVALID_GAME_OBJECT 
01289             );
01290 
01292         AK_EXTERNAPIFUNC( void, StopPlayingID )( 
01293             AkPlayingID in_playingID,                                           
01294             AkTimeMs in_uTransitionDuration = 0,                                
01295             AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear    
01296             );
01297 
01304         AK_EXTERNAPIFUNC( void, SetRandomSeed )( 
01305             AkUInt32 in_uSeed                                                   
01306             );
01307 
01311         AK_EXTERNAPIFUNC( void, MuteBackgroundMusic ) (
01312             bool in_bMute 
01313             );
01315 
01319         AK_EXTERNAPIFUNC(bool, GetBackgroundMusicMute) ();
01321 
01322 
01327         AK_EXTERNAPIFUNC( AKRESULT, SendPluginCustomGameData ) (
01328             AkUniqueID in_busID,        
01329             AkUInt32 in_uFXIndex,       
01330             const void* in_pData,       
01331             AkUInt32 in_uSizeInBytes    
01332             );
01334 
01337 
01338         
01349         AK_EXTERNAPIFUNC( AKRESULT, RegisterGameObj )(
01350             AkGameObjectID in_gameObjectID,             
01351             AkUInt32 in_uListenerMask = 0x01            
01352             );
01353 
01364         AK_EXTERNAPIFUNC( AKRESULT, RegisterGameObj )(
01365             AkGameObjectID in_gameObjectID,             
01366             const char * in_pszObjName,                 
01367             AkUInt32 in_uListenerMask = 0x01            
01368             );
01369 
01383         AK_EXTERNAPIFUNC( AKRESULT, UnregisterGameObj )(
01384             AkGameObjectID in_gameObjectID              
01385 
01386             );
01387 
01400         AK_EXTERNAPIFUNC( AKRESULT, UnregisterAllGameObj )();
01401 
01409         AK_EXTERNAPIFUNC( AKRESULT, SetPosition )( 
01410             AkGameObjectID in_GameObjectID,     
01411             const AkSoundPosition & in_Position 
01412             );
01413 
01425         AK_EXTERNAPIFUNC( AKRESULT, SetMultiplePositions )( 
01426             AkGameObjectID in_GameObjectID,                     
01427             const AkSoundPosition * in_pPositions,              
01428             AkUInt16 in_NumPositions,                           
01429             MultiPositionType in_eMultiPositionType = MultiPositionType_MultiDirections 
01430             );
01431 
01443         AK_EXTERNAPIFUNC( AKRESULT, SetMultiplePositions )( 
01444             AkGameObjectID in_GameObjectID,                     
01445             const AkChannelEmitter * in_pPositions,             
01446             AkUInt16 in_NumPositions,                           
01447             MultiPositionType in_eMultiPositionType = MultiPositionType_MultiDirections 
01448             );
01449 
01455         AK_EXTERNAPIFUNC( AKRESULT, SetAttenuationScalingFactor )(
01456             AkGameObjectID in_GameObjectID,             
01457             AkReal32 in_fAttenuationScalingFactor       
01458             );
01459 
01465         AK_EXTERNAPIFUNC( AKRESULT, SetListenerScalingFactor )(
01466             AkUInt32 in_uListenerIndex,             
01467             AkReal32 in_fListenerScalingFactor      
01468             );
01469 
01471 
01474 
01475 
01485         AK_EXTERNAPIFUNC( AKRESULT, ClearBanks )();
01486 
01497         AK_EXTERNAPIFUNC( AKRESULT, SetBankLoadIOSettings )(
01498             AkReal32            in_fThroughput,         
01499             AkPriority          in_priority             
01500             );
01501 
01502 #ifdef AK_SUPPORT_WCHAR
01503 
01504 
01505 
01506 
01507 
01508 
01509 
01510 
01511 
01512 
01513 
01514 
01515 
01516 
01517 
01518 
01519 
01520 
01521 
01522 
01523 
01524 
01525 
01526 
01527 
01528 
01529 
01530 
01531 
01532 
01533 
01534 
01535 
01536 
01537 
01538 
01539 
01540 
01541 
01542 
01543 
01544 
01545 
01546 
01547 
01548         AK_EXTERNAPIFUNC( AKRESULT, LoadBank )(
01549             const wchar_t*      in_pszString,           
01550             AkMemPoolId         in_memPoolId,           
01551             AkBankID &          out_bankID              
01552             );
01553 #endif //AK_SUPPORT_WCHAR
01554 
01600         AK_EXTERNAPIFUNC( AKRESULT, LoadBank )(
01601             const char*         in_pszString,           
01602             AkMemPoolId         in_memPoolId,           
01603             AkBankID &          out_bankID              
01604             );
01605 
01643         AK_EXTERNAPIFUNC( AKRESULT, LoadBank )(
01644             AkBankID            in_bankID,              
01645             AkMemPoolId         in_memPoolId            
01646             );
01647 
01694         AK_EXTERNAPIFUNC( AKRESULT, LoadBank )(
01695             const void *        in_pInMemoryBankPtr,    
01696             AkUInt32            in_uInMemoryBankSize,   
01697             AkBankID &          out_bankID              
01698             );
01699 
01748         AK_EXTERNAPIFUNC( AKRESULT, LoadBank )(
01749             const void *        in_pInMemoryBankPtr,    
01750             AkUInt32            in_uInMemoryBankSize,   
01751             AkMemPoolId         in_uPoolForBankMedia,   
01752             AkBankID &          out_bankID              
01753             );
01754 
01756         AK_EXTERNAPIFUNC( AKRESULT, DecodeBank )(
01757             const void *        in_pInMemoryBankPtr,    
01758             AkUInt32            in_uInMemoryBankSize,   
01759             AkMemPoolId         in_uPoolForDecodedBank, 
01760             void * &            out_pDecodedBankPtr,    
01761             AkUInt32 &          out_uDecodedBankSize    
01762             );
01763 
01764 #ifdef AK_SUPPORT_WCHAR
01765 
01766 
01767 
01768 
01769 
01770 
01771 
01772 
01773 
01774 
01775 
01776 
01777 
01778 
01779 
01780 
01781 
01782 
01783 
01784 
01785 
01786 
01787 
01788 
01789 
01790 
01791 
01792 
01793         // as AkFileSystemFlags::pCustomParam.
01807         AK_EXTERNAPIFUNC( AKRESULT, LoadBank )(
01808             const wchar_t*      in_pszString,           
01809             AkBankCallbackFunc  in_pfnBankCallback,     
01810             void *              in_pCookie,             
01811             AkMemPoolId         in_memPoolId,           
01812             AkBankID &          out_bankID              
01813             );
01814 #endif //AK_SUPPORT_WCHAR
01815 
01844         // as AkFileSystemFlags::pCustomParam.
01858         AK_EXTERNAPIFUNC( AKRESULT, LoadBank )(
01859             const char*         in_pszString,           
01860             AkBankCallbackFunc  in_pfnBankCallback,     
01861             void *              in_pCookie,             
01862             AkMemPoolId         in_memPoolId,           
01863             AkBankID &          out_bankID              
01864             );
01865 
01892         // as AkFileSystemFlags::pCustomParam.
01904         AK_EXTERNAPIFUNC( AKRESULT, LoadBank )(
01905             AkBankID            in_bankID,              
01906             AkBankCallbackFunc  in_pfnBankCallback,     
01907             void *              in_pCookie,             
01908             AkMemPoolId         in_memPoolId            
01909             );
01910 
01949         AK_EXTERNAPIFUNC( AKRESULT, LoadBank )(
01950             const void *        in_pInMemoryBankPtr,    
01951             AkUInt32            in_uInMemoryBankSize,   
01952             AkBankCallbackFunc  in_pfnBankCallback,     
01953             void *              in_pCookie,             
01954             AkBankID &          out_bankID              
01955             );
01956 
01997         AK_EXTERNAPIFUNC( AKRESULT, LoadBank )(
01998             const void *        in_pInMemoryBankPtr,    
01999             AkUInt32            in_uInMemoryBankSize,   
02000             AkBankCallbackFunc  in_pfnBankCallback,     
02001             void *              in_pCookie,             
02002             AkMemPoolId         in_uPoolForBankMedia,   
02003             AkBankID &          out_bankID              
02004             );
02005 
02006 #ifdef AK_SUPPORT_WCHAR
02007 
02008 
02009 
02010 
02011 
02012 
02013 
02014 
02015 
02016 
02017 
02018 
02019 
02020 
02021 
02022 
02023         AK_EXTERNAPIFUNC( AKRESULT, UnloadBank )(
02024             const wchar_t*      in_pszString,           
02025             const void *        in_pInMemoryBankPtr,    
02026             AkMemPoolId *       out_pMemPoolId = NULL   
02027             );
02028 #endif //AK_SUPPORT_WCHAR
02029 
02046         AK_EXTERNAPIFUNC( AKRESULT, UnloadBank )(
02047             const char*         in_pszString,           
02048             const void *        in_pInMemoryBankPtr,    
02049             AkMemPoolId *       out_pMemPoolId = NULL   
02050             );
02051 
02063         AK_EXTERNAPIFUNC( AKRESULT, UnloadBank )(
02064             AkBankID            in_bankID,              
02065             const void *        in_pInMemoryBankPtr,    
02066             AkMemPoolId *       out_pMemPoolId = NULL   
02067             );
02068 
02069 #ifdef AK_SUPPORT_WCHAR
02070 
02071 
02072 
02073 
02074 
02075 
02076 
02077 
02078 
02079 
02080 
02081 
02082 
02083 
02084 
02085         AK_EXTERNAPIFUNC( AKRESULT, UnloadBank )(
02086             const wchar_t*      in_pszString,           
02087             const void *        in_pInMemoryBankPtr,    
02088             AkBankCallbackFunc  in_pfnBankCallback,     
02089             void *              in_pCookie              
02090             );
02091 #endif //AK_SUPPORT_WCHAR
02092 
02108         AK_EXTERNAPIFUNC( AKRESULT, UnloadBank )(
02109             const char*         in_pszString,           
02110             const void *        in_pInMemoryBankPtr,    
02111             AkBankCallbackFunc  in_pfnBankCallback,     
02112             void *              in_pCookie              
02113             );
02114 
02126         AK_EXTERNAPIFUNC( AKRESULT, UnloadBank )(
02127             AkBankID            in_bankID,              
02128             const void *        in_pInMemoryBankPtr,    
02129             AkBankCallbackFunc  in_pfnBankCallback,     
02130             void *              in_pCookie              
02131             );
02132 
02140         AK_EXTERNAPIFUNC( void, CancelBankCallbackCookie )( 
02141             void * in_pCookie                           
02142             );
02143 
02149         enum PreparationType
02150         {
02151             Preparation_Load,   
02152             Preparation_Unload, 
02153             Preparation_LoadAndDecode 
02154         };
02155 
02162         enum AkBankContent
02163         {
02164             AkBankContent_StructureOnly,    
02165             AkBankContent_All               
02166         };
02167 
02168 #ifdef AK_SUPPORT_WCHAR
02169 
02170 
02171 
02172 
02173 
02174 
02175 
02176 
02177 
02178 
02179 
02180 
02181 
02182         AK_EXTERNAPIFUNC( AKRESULT, PrepareBank )(
02183             AK::SoundEngine::PreparationType    in_PreparationType,         
02184             const wchar_t*        in_pszString,                             
02185             AK::SoundEngine::AkBankContent  in_uFlags = AkBankContent_All   
02186             );
02187 #endif //AK_SUPPORT_WCHAR
02188 
02202         AK_EXTERNAPIFUNC( AKRESULT, PrepareBank )(
02203             AK::SoundEngine::PreparationType    in_PreparationType,         
02204             const char*           in_pszString,                             
02205             AK::SoundEngine::AkBankContent  in_uFlags = AkBankContent_All   
02206             );
02207 
02222         AK_EXTERNAPIFUNC( AKRESULT, PrepareBank )(
02223             AK::SoundEngine::PreparationType    in_PreparationType,         
02224             AkBankID            in_bankID,                                  
02225             AK::SoundEngine::AkBankContent  in_uFlags = AkBankContent_All   
02226             );
02227 
02228 #ifdef AK_SUPPORT_WCHAR
02229 
02230 
02231 
02232 
02233 
02234 
02235 
02236 
02237 
02238 
02239 
02240 
02241 
02242         AK_EXTERNAPIFUNC( AKRESULT, PrepareBank )(
02243             AK::SoundEngine::PreparationType    in_PreparationType,         
02244             const wchar_t*      in_pszString,                               
02245             AkBankCallbackFunc  in_pfnBankCallback,                         
02246             void *              in_pCookie,                                 
02247             AK::SoundEngine::AkBankContent  in_uFlags = AkBankContent_All   
02248             );
02249 #endif //AK_SUPPORT_WCHAR
02250 
02264         AK_EXTERNAPIFUNC( AKRESULT, PrepareBank )(
02265             AK::SoundEngine::PreparationType    in_PreparationType,         
02266             const char*         in_pszString,                               
02267             AkBankCallbackFunc  in_pfnBankCallback,                         
02268             void *              in_pCookie,                                 
02269             AK::SoundEngine::AkBankContent  in_uFlags = AkBankContent_All   
02270             );
02271 
02286         AK_EXTERNAPIFUNC( AKRESULT, PrepareBank )(
02287             AK::SoundEngine::PreparationType        in_PreparationType,             
02288             AkBankID            in_bankID,                      
02289             AkBankCallbackFunc  in_pfnBankCallback,             
02290             void *              in_pCookie,                     
02291             AK::SoundEngine::AkBankContent      in_uFlags = AkBankContent_All   
02292             );
02293         
02303         AK_EXTERNAPIFUNC( AKRESULT, ClearPreparedEvents )();
02304 
02305 #ifdef AK_SUPPORT_WCHAR
02306 
02307 
02308 
02309 
02310 
02311 
02312 
02313 
02314 
02315 
02316 
02317 
02318 
02319 
02320 
02321 
02322 
02323 
02324 
02325 
02326 
02327 
02328 
02329 
02330 
02331 
02332 
02333 
02334 
02335 
02336 
02337 
02338         AK_EXTERNAPIFUNC( AKRESULT, PrepareEvent )( 
02339             PreparationType     in_PreparationType,     
02340             const wchar_t**     in_ppszString,          
02341             AkUInt32            in_uNumEvent            
02342             );
02343 #endif //AK_SUPPORT_WCHAR
02344 
02377         AK_EXTERNAPIFUNC( AKRESULT, PrepareEvent )( 
02378             PreparationType     in_PreparationType,     
02379             const char**        in_ppszString,          
02380             AkUInt32            in_uNumEvent            
02381             );
02382 
02414         AK_EXTERNAPIFUNC( AKRESULT, PrepareEvent )( 
02415             PreparationType     in_PreparationType,     
02416             AkUniqueID*         in_pEventID,            
02417             AkUInt32            in_uNumEvent            
02418             );
02419 
02420 #ifdef AK_SUPPORT_WCHAR
02421 
02422 
02423 
02424 
02425 
02426 
02427 
02428 
02429 
02430 
02431 
02432 
02433 
02434 
02435 
02436 
02437 
02438 
02439 
02440 
02441 
02442 
02443 
02444         AK_EXTERNAPIFUNC( AKRESULT, PrepareEvent )( 
02445             PreparationType     in_PreparationType,     
02446             const wchar_t**     in_ppszString,          
02447             AkUInt32            in_uNumEvent,           
02448             AkBankCallbackFunc  in_pfnBankCallback,     
02449             void *              in_pCookie              
02450             );
02451 #endif //AK_SUPPORT_WCHAR
02452 
02476         AK_EXTERNAPIFUNC( AKRESULT, PrepareEvent )( 
02477             PreparationType     in_PreparationType,     
02478             const char**        in_ppszString,          
02479             AkUInt32            in_uNumEvent,           
02480             AkBankCallbackFunc  in_pfnBankCallback,     
02481             void *              in_pCookie              
02482             );
02483 
02507         AK_EXTERNAPIFUNC( AKRESULT, PrepareEvent )( 
02508             PreparationType     in_PreparationType,     
02509             AkUniqueID*         in_pEventID,            
02510             AkUInt32            in_uNumEvent,           
02511             AkBankCallbackFunc  in_pfnBankCallback,     
02512             void *              in_pCookie              
02513             );
02514 
02518         AK_EXTERNAPIFUNC( AKRESULT, SetMedia )( 
02519             AkSourceSettings *  in_pSourceSettings,     
02520             AkUInt32            in_uNumSourceSettings   
02521             );
02522 
02526         AK_EXTERNAPIFUNC( AKRESULT, UnsetMedia )( 
02527             AkSourceSettings *  in_pSourceSettings,     
02528             AkUInt32            in_uNumSourceSettings   
02529             );
02530 
02531 #ifdef AK_SUPPORT_WCHAR
02532 
02533 
02534 
02535 
02536 
02537 
02538 
02539 
02540 
02541 
02542 
02543 
02544 
02545 
02546 
02547 
02548 
02549 
02550 
02551 
02552 
02553 
02554 
02555 
02556 
02557 
02558 
02559 
02560 
02561         AK_EXTERNAPIFUNC( AKRESULT, PrepareGameSyncs )(
02562             PreparationType in_PreparationType,         
02563             AkGroupType     in_eGameSyncType,           
02564             const wchar_t*  in_pszGroupName,            
02565             const wchar_t** in_ppszGameSyncName,        
02566             AkUInt32        in_uNumGameSyncs            
02567             );
02568 #endif //AK_SUPPORT_WCHAR
02569 
02599         AK_EXTERNAPIFUNC( AKRESULT, PrepareGameSyncs )(
02600             PreparationType in_PreparationType,         
02601             AkGroupType     in_eGameSyncType,           
02602             const char*     in_pszGroupName,            
02603             const char**    in_ppszGameSyncName,        
02604             AkUInt32        in_uNumGameSyncs            
02605             );
02606 
02636         AK_EXTERNAPIFUNC( AKRESULT, PrepareGameSyncs )(
02637             PreparationType in_PreparationType,         
02638             AkGroupType     in_eGameSyncType,           
02639             AkUInt32        in_GroupID,                 
02640             AkUInt32*       in_paGameSyncID,            
02641             AkUInt32        in_uNumGameSyncs            
02642             );
02643 
02644 #ifdef AK_SUPPORT_WCHAR
02645 
02646 
02647 
02648 
02649 
02650 
02651 
02652 
02653 
02654 
02655 
02656 
02657 
02658 
02659 
02660 
02661 
02662 
02663 
02664 
02665 
02666         AK_EXTERNAPIFUNC( AKRESULT, PrepareGameSyncs )(
02667             PreparationType     in_PreparationType,     
02668             AkGroupType         in_eGameSyncType,       
02669             const wchar_t*      in_pszGroupName,        
02670             const wchar_t**     in_ppszGameSyncName,    
02671             AkUInt32            in_uNumGameSyncs,       
02672             AkBankCallbackFunc  in_pfnBankCallback,     
02673             void *              in_pCookie              
02674             );
02675 #endif //AK_SUPPORT_WCHAR
02676 
02698         AK_EXTERNAPIFUNC( AKRESULT, PrepareGameSyncs )(
02699             PreparationType     in_PreparationType,     
02700             AkGroupType         in_eGameSyncType,       
02701             const char*         in_pszGroupName,        
02702             const char**        in_ppszGameSyncName,    
02703             AkUInt32            in_uNumGameSyncs,       
02704             AkBankCallbackFunc  in_pfnBankCallback,     
02705             void *              in_pCookie              
02706             );
02707 
02729         AK_EXTERNAPIFUNC( AKRESULT, PrepareGameSyncs )(
02730             PreparationType     in_PreparationType,     
02731             AkGroupType         in_eGameSyncType,       
02732             AkUInt32            in_GroupID,             
02733             AkUInt32*           in_paGameSyncID,        
02734             AkUInt32            in_uNumGameSyncs,       
02735             AkBankCallbackFunc  in_pfnBankCallback,     
02736             void *              in_pCookie              
02737             );
02738 
02740 
02741 
02744 
02745 
02751         AK_EXTERNAPIFUNC( AKRESULT, SetActiveListeners )(
02752             AkGameObjectID in_GameObjectID,             
02753             AkUInt32 in_uListenerMask                   
02754             );
02755 
02760         AK_EXTERNAPIFUNC( AKRESULT, SetListenerPosition )( 
02761             const AkListenerPosition & in_Position,     
02762             AkUInt32 in_uIndex = 0                      
02763             );
02764 
02777         AK_EXTERNAPIFUNC( AKRESULT, SetListenerSpatialization )(
02778             AkUInt32 in_uIndex,                         
02779             bool in_bSpatialized,                       
02780             AkChannelConfig in_channelConfig,           
02781             AK::SpeakerVolumes::VectorPtr in_pVolumeOffsets = NULL  
02782             );
02783 
02793         AK_EXTERNAPIFUNC( AKRESULT, SetListenerPipeline )(
02794             AkUInt32 in_uIndex,                     
02795             bool in_bAudio,                         
02796             bool in_bMotion                         
02797             );
02798 
02799 
02801 
02802 
02805 
02806 
02825         AK_EXTERNAPIFUNC( AKRESULT, SetRTPCValue )( 
02826             AkRtpcID in_rtpcID,                                     
02827             AkRtpcValue in_value,                                   
02828             AkGameObjectID in_gameObjectID = AK_INVALID_GAME_OBJECT,
02829             AkTimeMs in_uValueChangeDuration = 0,                   
02830             AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear,   
02831             bool in_bBypassInternalValueInterpolation = false       
02832             );
02833 
02834 #ifdef AK_SUPPORT_WCHAR
02835 
02836 
02837 
02838 
02839 
02840 
02841 
02842 
02843 
02844 
02845 
02846 
02847 
02848 
02849 
02850 
02851 
02852 
02853 
02854 
02855         AK_EXTERNAPIFUNC( AKRESULT, SetRTPCValue )( 
02856             const wchar_t* in_pszRtpcName,                          
02857             AkRtpcValue in_value,                                   
02858             AkGameObjectID in_gameObjectID = AK_INVALID_GAME_OBJECT,
02859             AkTimeMs in_uValueChangeDuration = 0,                   
02860             AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear,   
02861             bool in_bBypassInternalValueInterpolation = false       
02862             );
02863 #endif //AK_SUPPORT_WCHAR
02864 
02885         AK_EXTERNAPIFUNC( AKRESULT, SetRTPCValue )( 
02886             const char* in_pszRtpcName,                             
02887             AkRtpcValue in_value,                                   
02888             AkGameObjectID in_gameObjectID = AK_INVALID_GAME_OBJECT,
02889             AkTimeMs in_uValueChangeDuration = 0,                   
02890             AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear,   
02891             bool in_bBypassInternalValueInterpolation = false       
02892             );
02893 
02910         AK_EXTERNAPIFUNC( AKRESULT, SetRTPCValueByPlayingID )( 
02911             AkRtpcID in_rtpcID,                                     
02912             AkRtpcValue in_value,                                   
02913             AkPlayingID in_playingID,                               
02914             AkTimeMs in_uValueChangeDuration = 0,                   
02915             AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear,   
02916             bool in_bBypassInternalValueInterpolation = false       
02917             );
02918 
02919 #ifdef AK_SUPPORT_WCHAR
02920 
02921 
02922 
02923 
02924 
02925 
02926 
02927 
02928 
02929 
02930 
02931 
02932 
02933 
02934 
02935 
02936         AK_EXTERNAPIFUNC( AKRESULT, SetRTPCValueByPlayingID )( 
02937             const wchar_t* in_pszRtpcName,                          
02938             AkRtpcValue in_value,                                   
02939             AkPlayingID in_playingID,                               
02940             AkTimeMs in_uValueChangeDuration = 0,                   
02941             AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear,   
02942             bool in_bBypassInternalValueInterpolation = false       
02943             );
02944 #endif //AK_SUPPORT_WCHAR
02945         
02962         AK_EXTERNAPIFUNC( AKRESULT, SetRTPCValueByPlayingID )( 
02963             const char* in_pszRtpcName,                             
02964             AkRtpcValue in_value,                                   
02965             AkPlayingID in_playingID,                               
02966             AkTimeMs in_uValueChangeDuration = 0,                   
02967             AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear,   
02968             bool in_bBypassInternalValueInterpolation = false       
02969             );
02970 
02987         AK_EXTERNAPIFUNC( AKRESULT, ResetRTPCValue )(
02988             AkRtpcID in_rtpcID,                                     
02989             AkGameObjectID in_gameObjectID = AK_INVALID_GAME_OBJECT,
02990             AkTimeMs in_uValueChangeDuration = 0,                   
02991             AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear,   
02992             bool in_bBypassInternalValueInterpolation = false       
02993             );
02994 
02995 #ifdef AK_SUPPORT_WCHAR
02996 
02997 
02998 
02999 
03000 
03001 
03002 
03003 
03004 
03005 
03006 
03007 
03008 
03009 
03010 
03011 
03012 
03013 
03014         AK_EXTERNAPIFUNC( AKRESULT, ResetRTPCValue )(
03015             const wchar_t* in_pszRtpcName,                          
03016             AkGameObjectID in_gameObjectID = AK_INVALID_GAME_OBJECT,
03017             AkTimeMs in_uValueChangeDuration = 0,                   
03018             AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear,   
03019             bool in_bBypassInternalValueInterpolation = false       
03020             );
03021 #endif //AK_SUPPORT_WCHAR
03022 
03041         AK_EXTERNAPIFUNC( AKRESULT, ResetRTPCValue )(
03042             const char* in_pszRtpcName,                             
03043             AkGameObjectID in_gameObjectID = AK_INVALID_GAME_OBJECT,
03044             AkTimeMs in_uValueChangeDuration = 0,                   
03045             AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear,   
03046             bool in_bBypassInternalValueInterpolation = false       
03047             );
03048 
03054         AK_EXTERNAPIFUNC( AKRESULT, SetSwitch )( 
03055             AkSwitchGroupID in_switchGroup,             
03056             AkSwitchStateID in_switchState,             
03057             AkGameObjectID in_gameObjectID              
03058             );
03059 
03060 #ifdef AK_SUPPORT_WCHAR
03061 
03062 
03063 
03064 
03065 
03066 
03067 
03068 
03069         AK_EXTERNAPIFUNC( AKRESULT, SetSwitch )( 
03070             const wchar_t* in_pszSwitchGroup,           
03071             const wchar_t* in_pszSwitchState,           
03072             AkGameObjectID in_gameObjectID              
03073             );
03074 #endif //AK_SUPPORT_WCHAR
03075 
03084         AK_EXTERNAPIFUNC( AKRESULT, SetSwitch )( 
03085             const char* in_pszSwitchGroup,              
03086             const char* in_pszSwitchState,              
03087             AkGameObjectID in_gameObjectID              
03088             );
03089 
03095         AK_EXTERNAPIFUNC( AKRESULT, PostTrigger )( 
03096             AkTriggerID     in_triggerID,               
03097             AkGameObjectID  in_gameObjectID             
03098             );
03099 
03100 #ifdef AK_SUPPORT_WCHAR
03101 
03102 
03103 
03104 
03105 
03106 
03107 
03108 
03109         AK_EXTERNAPIFUNC( AKRESULT, PostTrigger )( 
03110             const wchar_t* in_pszTrigger,               
03111             AkGameObjectID in_gameObjectID              
03112             );
03113 #endif //AK_SUPPORT_WCHAR
03114 
03123         AK_EXTERNAPIFUNC( AKRESULT, PostTrigger )( 
03124             const char* in_pszTrigger,                  
03125             AkGameObjectID in_gameObjectID              
03126             );
03127 
03133         AK_EXTERNAPIFUNC( AKRESULT, SetState )( 
03134             AkStateGroupID in_stateGroup,               
03135             AkStateID in_state                          
03136             );
03137 
03138 #ifdef AK_SUPPORT_WCHAR
03139 
03140 
03141 
03142 
03143 
03144 
03145 
03146 
03147 
03148         AK_EXTERNAPIFUNC( AKRESULT, SetState )( 
03149             const wchar_t* in_pszStateGroup,                
03150             const wchar_t* in_pszState                      
03151             );
03152 #endif //AK_SUPPORT_WCHAR
03153 
03163         AK_EXTERNAPIFUNC( AKRESULT, SetState )( 
03164             const char* in_pszStateGroup,                   
03165             const char* in_pszState                         
03166             );
03167 
03169 
03172 
03173 
03187         AK_EXTERNAPIFUNC( AKRESULT, SetGameObjectAuxSendValues )( 
03188             AkGameObjectID      in_gameObjectID,        
03189             AkAuxSendValue*     in_aAuxSendValues,      
03190 
03191             AkUInt32            in_uNumSendValues       
03192 
03193             );
03194 
03208         AK_EXTERNAPIFUNC( AKRESULT, RegisterBusVolumeCallback )( 
03209             AkUniqueID in_busID,                        
03210             AkBusCallbackFunc in_pfnCallback            
03211             );
03212 
03224         AK_EXTERNAPIFUNC( AKRESULT, RegisterBusMeteringCallback )( 
03225             AkUniqueID in_busID,                        
03226             AkBusMeteringCallbackFunc in_pfnCallback,   
03227             AkMeteringFlags in_eMeteringFlags           
03228             );
03229 
03237         AK_EXTERNAPIFUNC( AKRESULT, SetGameObjectOutputBusVolume )( 
03238             AkGameObjectID      in_gameObjectID,        
03239             AkReal32            in_fControlValue        
03240 
03241             );
03242 
03250         AK_EXTERNAPIFUNC( AKRESULT, SetActorMixerEffect )( 
03251             AkUniqueID in_audioNodeID,                  
03252             AkUInt32 in_uFXIndex,                       
03253             AkUniqueID in_shareSetID                    
03254             );
03255 
03268         AK_EXTERNAPIFUNC( AKRESULT, SetBusEffect )( 
03269             AkUniqueID in_audioNodeID,                  
03270             AkUInt32 in_uFXIndex,                       
03271             AkUniqueID in_shareSetID                    
03272             );
03273 
03274 #ifdef AK_SUPPORT_WCHAR
03275 
03276 
03277 
03278 
03279 
03280 
03281 
03282 
03283 
03284 
03285 
03286 
03287         AK_EXTERNAPIFUNC( AKRESULT, SetBusEffect )( 
03288             const wchar_t* in_pszBusName,               
03289             AkUInt32 in_uFXIndex,                       
03290             AkUniqueID in_shareSetID                    
03291             );
03292 #endif //AK_SUPPORT_WCHAR
03293 
03306         AK_EXTERNAPIFUNC( AKRESULT, SetBusEffect )( 
03307             const char* in_pszBusName,      
03308             AkUInt32 in_uFXIndex,           
03309             AkUniqueID in_shareSetID        
03310             );
03311 
03319         AK_EXTERNAPIFUNC( AKRESULT, SetMixer )( 
03320             AkUniqueID in_audioNodeID,                  
03321             AkUniqueID in_shareSetID                    
03322             );
03323 
03324 #ifdef AK_SUPPORT_WCHAR
03325 
03326 
03327 
03328 
03329 
03330 
03331 
03332         AK_EXTERNAPIFUNC( AKRESULT, SetMixer )( 
03333             const wchar_t* in_pszBusName,               
03334             AkUniqueID in_shareSetID                    
03335             );
03336 #endif //AK_SUPPORT_WCHAR
03337 
03345         AK_EXTERNAPIFUNC( AKRESULT, SetMixer )( 
03346             const char* in_pszBusName,      
03347             AkUniqueID in_shareSetID        
03348             );
03349 
03354         AK_EXTERNAPIFUNC(AKRESULT, SetBusConfig)(
03355             AkUniqueID in_audioNodeID,                  
03356             AkChannelConfig in_channelConfig            
03357             );
03358 
03359 #ifdef AK_SUPPORT_WCHAR
03360 
03361 
03362 
03363 
03364         AK_EXTERNAPIFUNC(AKRESULT, SetBusConfig)(
03365             const wchar_t* in_pszBusName,               
03366             AkChannelConfig in_channelConfig            
03367             );
03368 #endif //AK_SUPPORT_WCHAR
03369 
03374         AK_EXTERNAPIFUNC(AKRESULT, SetBusConfig)(
03375             const char* in_pszBusName,                  
03376             AkChannelConfig in_channelConfig            
03377             );
03378 
03385         AK_EXTERNAPIFUNC( AKRESULT, SetObjectObstructionAndOcclusion )(  
03386             AkGameObjectID in_ObjectID,         
03387             AkUInt32 in_uListener,              
03388             AkReal32 in_fObstructionLevel,      
03389             AkReal32 in_fOcclusionLevel         
03390             );
03391 
03400         AK_EXTERNAPIFUNC( AKRESULT, GetContainerHistory)(
03401             AK::IWriteBytes * in_pBytes         
03402             );
03403 
03412         AK_EXTERNAPIFUNC(AKRESULT, SetContainerHistory)(
03413             AK::IReadBytes * in_pBytes          
03414             );
03415 
03417         
03420 
03421 
03445         AK_EXTERNAPIFUNC( AKRESULT, StartOutputCapture )( 
03446             const AkOSChar* in_CaptureFileName              
03447             );
03448 
03453         AK_EXTERNAPIFUNC( AKRESULT, StopOutputCapture )();
03454 
03459         AK_EXTERNAPIFUNC( AKRESULT, AddOutputCaptureMarker )(
03460             const char* in_MarkerText                   
03461             );
03462             
03467         AK_EXTERNAPIFUNC( AKRESULT, StartProfilerCapture )( 
03468             const AkOSChar* in_CaptureFileName              
03469             );
03470 
03474         AK_EXTERNAPIFUNC( AKRESULT, StopProfilerCapture )();
03475 
03477 
03480 
03481 
03489         AK_EXTERNAPIFUNC( AKRESULT, AddSecondaryOutput )(
03490             AkUInt32 in_iOutputID,          
03491 
03492 
03493 
03494 
03495 
03496             AkAudioOutputType in_iDeviceType,   
03497 
03498 
03499 
03500 
03501             AkUInt32 in_uListenerMask,      
03502             AkUInt32 in_uOutputFlags = 0,   
03503 
03504             AkUniqueID in_audioDeviceShareset = AK_INVALID_UNIQUE_ID 
03505 
03506 
03507 
03508             );
03509 
03510         AK_EXTERNAPIFUNC( AKRESULT, RemoveSecondaryOutput )(
03511             AkUInt32 in_iOutputID,              
03512             AkAudioOutputType in_iDeviceType    
03513             );
03514         
03516         AK_EXTERNAPIFUNC( AKRESULT, SetSecondaryOutputVolume )(
03517             AkUInt32 in_iOutputID,          
03518             AkAudioOutputType in_iDeviceType, 
03519             AkReal32 in_fVolume             
03520             );
03522 
03535         AK_EXTERNAPIFUNC( AKRESULT, Suspend )(
03536             bool in_bRenderAnyway = false 
03537             );
03538 
03544         AK_EXTERNAPIFUNC( AKRESULT, WakeupFromSuspend )(); 
03545 
03549         AK_EXTERNAPIFUNC(AkUInt32, GetBufferTick)();
03550     }
03551 }
03552 
03553 #endif // _AK_SOUNDENGINE_H_

Cette page a-t-elle été utile ?

Besoin d'aide ?

Des questions ? Des problèmes ? Besoin de plus d'informations ? Contactez-nous, nous pouvons vous aider !

Visitez notre page d'Aide

Décrivez-nous de votre projet. Nous sommes là pour vous aider.

Enregistrez votre projet et nous vous aiderons à démarrer sans aucune obligation !

Partir du bon pied avec Wwise