Table of Contents

include/AK/SoundEngine/Common/IAkRTPCSubscriber.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 // IAkRTPCSubscriber.h
00029 
00030 /// \file 
00031 /// RTPC Subscriber interface.
00032 
00033 #ifndef _IAK_RTPC_SUBSCRIBER_H_
00034 #define _IAK_RTPC_SUBSCRIBER_H_
00035 
00036 #include <AK/SoundEngine/Common/AkTypes.h>
00037 
00038 namespace AK
00039 {   
00040     /// Real-Time Parameter Control Subscriber interface.
00041     /// This interface must be implemented by every AK::IAkPluginParam implementation, allowing
00042     /// real-time editing with Wwise and in-game RTPC control.
00043     /// \warning The functions in this interface are not thread-safe, unless stated otherwise.
00044     /// \sa
00045     /// - AK::IAkPluginParam
00046     class IAkRTPCSubscriber
00047     {
00048     protected:
00049         /// Virtual destructor on interface to avoid warnings.
00050         virtual ~IAkRTPCSubscriber(){}
00051 
00052     public:
00053         /// This function will be called to notify the subscriber every time a selected value is entered or modified
00054         /// \return AK_Success if successful, AK_Fail otherwise
00055         virtual AKRESULT SetParam(
00056             AkPluginParamID in_paramID,         ///< Plug-in parameter ID
00057             const void *    in_pParam,          ///< Parameter value pointer
00058             AkUInt32        in_uParamSize       ///< Parameter size
00059             ) = 0;
00060     };
00061 }
00062 
00063 #endif //_IAK_RTPC_SUBSCRIBER_H_
00064