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 // IAkMotionMixBus.h
00029 
00030 #ifndef _IMOTIONBUS_H
00031 #define _IMOTIONBUS_H
00032 
00033 #include <AK/SoundEngine/Common/AkSoundEngine.h>
00034 #include <AK/SoundEngine/Common/AkCommonDefs.h>
00035 #include <AK/SoundEngine/Common/IAkPlugin.h>
00036 
00037 class IAkMotionMixBus : public AK::IAkPlugin
00038 {
00039 public:
00040     virtual AKRESULT    Init(AK::IAkPluginMemAlloc * in_pAllocator, AK::IAkGlobalPluginContext * in_pContext, AkPlatformInitSettings * io_pPDSettings, AkUInt8 in_iPlayer, void * in_pDevice = NULL) = 0;
00041 
00042     virtual AKRESULT    MixAudioBuffer( AkAudioBuffer &io_rBuffer ) = 0;
00043     virtual AKRESULT    MixFeedbackBuffer( AkAudioBuffer &io_rBuffer, AkReal32 in_fVolume ) = 0;
00044     virtual AKRESULT    RenderData() = 0;
00045     virtual void        CommandTick() = 0;
00046     virtual void        Stop() = 0;
00047 
00048     virtual AkReal32    GetPeak() = 0;
00049     virtual bool        IsStarving() = 0;
00050     virtual bool        IsActive() = 0;
00051     virtual AkChannelMask GetMixingFormat() = 0;
00052     virtual void        SetMasterVolume(AkReal32 in_fVol) = 0;
00053 
00054     virtual void        StartOutputCapture(const AkOSChar* in_CaptureFileName) = 0;
00055     virtual void        StopOutputCapture() = 0;
00056 };
00057 #endif