Version
menu_open
link
Wwise SDK 2023.1.4
IAkRTPCSubscriber.h
Go to the documentation of this file.
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  Copyright (c) 2024 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 // IAkRTPCSubscriber.h
28 
29 /// \file
30 /// RTPC Subscriber interface.
31 
32 #ifndef _IAK_RTPC_SUBSCRIBER_H_
33 #define _IAK_RTPC_SUBSCRIBER_H_
34 
36 
37 namespace AK
38 {
39  /// Real-Time Parameter Control Subscriber interface.
40  /// This interface must be implemented by every AK::IAkPluginParam implementation, allowing
41  /// real-time editing with Wwise and in-game RTPC control.
42  /// \akwarning
43  /// The functions in this interface are not thread-safe, unless stated otherwise.
44  /// \endakwarning
45  /// \sa
46  /// - AK::IAkPluginParam
48  {
49  protected:
50  /// Virtual destructor on interface to avoid warnings.
51  virtual ~IAkRTPCSubscriber(){}
52 
53  public:
54  /// This function will be called to notify the subscriber every time a selected value is entered or modified
55  /// \return AK_Success if successful, AK_Fail otherwise
56  virtual AKRESULT SetParam(
57  AkPluginParamID in_paramID, ///< Plug-in parameter ID
58  const void * in_pParam, ///< Parameter value pointer
59  AkUInt32 in_uParamSize ///< Parameter size
60  ) = 0;
61  };
62 }
63 
64 #endif //_IAK_RTPC_SUBSCRIBER_H_
65 
Audiokinetic namespace.
virtual AKRESULT SetParam(AkPluginParamID in_paramID, const void *in_pParam, AkUInt32 in_uParamSize)=0
AKRESULT
Standard function call result.
Definition: AkTypes.h:131
virtual ~IAkRTPCSubscriber()
Virtual destructor on interface to avoid warnings.
uint32_t AkUInt32
Unsigned 32-bit integer.
AkInt16 AkPluginParamID
Source or effect plug-in parameter ID.
Definition: AkTypes.h:66

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise