目录

Wwise SDK 2018.1.11
IAkRTPCSubscriber.h
浏览该文件的文档.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Version: <VERSION> Build: <BUILDNUMBER>
25  Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.
26 *******************************************************************************/
27 
28 // IAkRTPCSubscriber.h
29 
30 /// \file
31 /// RTPC Subscriber interface.
32 
33 #ifndef _IAK_RTPC_SUBSCRIBER_H_
34 #define _IAK_RTPC_SUBSCRIBER_H_
35 
37 
38 namespace AK
39 {
40  /// Real-Time Parameter Control Subscriber interface.
41  /// This interface must be implemented by every AK::IAkPluginParam implementation, allowing
42  /// real-time editing with Wwise and in-game RTPC control.
43  /// \warning The functions in this interface are not thread-safe, unless stated otherwise.
44  /// \sa
45  /// - AK::IAkPluginParam
47  {
48  protected:
49  /// Virtual destructor on interface to avoid warnings.
50  virtual ~IAkRTPCSubscriber(){}
51 
52  public:
53  /// This function will be called to notify the subscriber every time a selected value is entered or modified
54  /// \return AK_Success if successful, AK_Fail otherwise
55  virtual AKRESULT SetParam(
56  AkPluginParamID in_paramID, ///< Plug-in parameter ID
57  const void * in_pParam, ///< Parameter value pointer
58  AkUInt32 in_uParamSize ///< Parameter size
59  ) = 0;
60  };
61 }
62 
63 #endif //_IAK_RTPC_SUBSCRIBER_H_
64 
AkInt16 AkPluginParamID
Source or effect plug-in parameter ID
Definition: AkTypes.h:76
AKRESULT
Standard function call result.
Definition: AkTypes.h:126
Audiokinetic namespace
virtual AKRESULT SetParam(AkPluginParamID in_paramID, const void *in_pParam, AkUInt32 in_uParamSize)=0
uint32_t AkUInt32
Unsigned 32-bit integer
Definition: AkTypes.h:79
virtual ~IAkRTPCSubscriber()
Virtual destructor on interface to avoid warnings.