Warning: you were redirected to the latest documentation corresponding to your major release ( 2024.1.1.8691 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Go to the documentation of this file.
35 #include "./V1/HostPropertySet.h"
40 :
public ak_wwise_plugin_host_property_set_v1
44 struct ak_wwise_plugin_host_property_set_v1;
51 ak_wwise_plugin_host_property_set_v1( 2)
76 #define AK_WWISE_PLUGIN_HOST_PROPERTY_SET_V2_ID() \
77 AK_WWISE_PLUGIN_BASE_INTERFACE_FROM_ID(AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_PROPERTY_SET, 2)
78 #define AK_WWISE_PLUGIN_HOST_PROPERTY_SET_V2_CTOR() \
80 .m_baseInterface = AK_WWISE_PLUGIN_HOST_PROPERTY_SET_V2_ID() \
91 class PropertySet :
public AK::Wwise::Plugin::V1::PropertySetBase<CHostPropertySet, 2>
103 g_cinterface->OpenBraces(
this, in_bracesToOpen);
112 g_cinterface->CloseBraces(
this, in_bracesToClose);
119 return g_cinterface->GetOpenedBraces(
this);
122 #if defined( DOXYGEN_INCLUDE )
124 const GUID & in_guidPlatform,
125 const char * in_pszPropertyName,
126 AK::WwiseAuthoringAPI::AkVariantBase& out_varProperty
129 const GUID & in_guidPlatform,
130 const char * in_pszPropertyName,
131 AK::WwiseAuthoringAPI::AkVariantBase& out_varProperty
134 const GUID & in_guidPlatform,
135 const char * in_pszPropertyName,
136 const AK::WwiseAuthoringAPI::AkVariantBase& in_varProperty
139 const GUID & in_guidPlatform,
140 const char * in_pszPropertyName
143 const char * in_pszPropertyName
146 const char* in_pszPropertyName
149 const char* in_pszPropertyName
152 const char* in_pszPropertyName
155 const GUID& in_guidPlatform,
156 const char* in_pszPropertyName
160 const GUID& in_guidPlatform,
161 const char* in_pszPropertyName
164 const GUID& in_guidPlatform,
165 const char* in_pszPropertyName
168 const GUID & in_guidPlatform,
169 const char * in_pszPropertyName,
170 const char * in_propertyValue
173 const GUID & in_guidPlatform,
174 const char * in_pszPropertyName,
175 int64_t in_propertyValue
178 const GUID & in_guidPlatform,
179 const char * in_pszPropertyName,
180 int32_t in_propertyValue
183 const GUID & in_guidPlatform,
184 const char * in_pszPropertyName,
185 int16_t in_propertyValue
188 const GUID & in_guidPlatform,
189 const char * in_pszPropertyName,
190 int8_t in_propertyValue
193 const GUID & in_guidPlatform,
194 const char * in_pszPropertyName,
195 uint64_t in_propertyValue
198 const GUID & in_guidPlatform,
199 const char * in_pszPropertyName,
200 uint32_t in_propertyValue
203 const GUID & in_guidPlatform,
204 const char * in_pszPropertyName,
205 uint16_t in_propertyValue
208 const GUID & in_guidPlatform,
209 const char * in_pszPropertyName,
210 uint8_t in_propertyValue
213 const GUID & in_guidPlatform,
214 const char * in_pszPropertyName,
215 double in_propertyValue
218 const GUID & in_guidPlatform,
219 const char * in_pszPropertyName,
220 float in_propertyValue
223 const GUID & in_guidPlatform,
224 const char * in_pszPropertyName,
225 bool in_propertyValue
228 const GUID & in_guidPlatform,
229 const char * in_pszPropertyName,
230 const char*& out_propertyValue
233 const GUID & in_guidPlatform,
234 const char * in_pszPropertyName,
235 int64_t& out_propertyValue
238 const GUID & in_guidPlatform,
239 const char * in_pszPropertyName,
240 int32_t& out_propertyValue
243 const GUID & in_guidPlatform,
244 const char * in_pszPropertyName,
245 int16_t& out_propertyValue
248 const GUID & in_guidPlatform,
249 const char * in_pszPropertyName,
250 int8_t& out_propertyValue
253 const GUID & in_guidPlatform,
254 const char * in_pszPropertyName,
255 uint64_t& out_propertyValue
258 const GUID & in_guidPlatform,
259 const char * in_pszPropertyName,
260 uint32_t& out_propertyValue
263 const GUID & in_guidPlatform,
264 const char * in_pszPropertyName,
265 uint16_t& out_propertyValue
268 const GUID & in_guidPlatform,
269 const char * in_pszPropertyName,
270 uint8_t& out_propertyValue
273 const GUID & in_guidPlatform,
274 const char * in_pszPropertyName,
275 double& out_propertyValue
278 const GUID & in_guidPlatform,
279 const char * in_pszPropertyName,
280 float& out_propertyValue
283 const GUID & in_guidPlatform,
284 const char * in_pszPropertyName,
285 bool& out_propertyValue
288 const GUID & in_guidPlatform,
289 const char * in_pszPropertyName
292 const GUID & in_guidPlatform,
293 const char * in_pszPropertyName
296 const GUID & in_guidPlatform,
297 const char * in_pszPropertyName
300 const GUID & in_guidPlatform,
301 const char * in_pszPropertyName
304 const GUID & in_guidPlatform,
305 const char * in_pszPropertyName
308 const GUID & in_guidPlatform,
309 const char * in_pszPropertyName
312 const GUID & in_guidPlatform,
313 const char * in_pszPropertyName
316 const GUID & in_guidPlatform,
317 const char * in_pszPropertyName
320 const GUID & in_guidPlatform,
321 const char * in_pszPropertyName
324 const GUID & in_guidPlatform,
325 const char * in_pszPropertyName
328 const GUID & in_guidPlatform,
329 const char * in_pszPropertyName
332 const GUID & in_guidPlatform,
333 const char * in_pszPropertyName
uint32_t GetUInt32(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
bool GetValueUInt32(const GUID &in_guidPlatform, const char *in_pszPropertyName, uint32_t &out_propertyValue) const
ak_wwise_plugin_host_property_set_instance_v1 Instance
This interface is compatible with the v1 instance.
int GetType(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
bool SetValueInt8(const GUID &in_guidPlatform, const char *in_pszPropertyName, int8_t in_propertyValue)
bool SetValueUInt64(const GUID &in_guidPlatform, const char *in_pszPropertyName, uint64_t in_propertyValue)
bool GetValueReal64(const GUID &in_guidPlatform, const char *in_pszPropertyName, double &out_propertyValue) const
const GUID * GetID() const
bool SetValueInt16(const GUID &in_guidPlatform, const char *in_pszPropertyName, int16_t in_propertyValue)
RequestedHostInterface< PropertySet > RequestPropertySet
Requests a PropertySet interface, provided as m_propertySet variable.
bool SetValueInt64(const GUID &in_guidPlatform, const char *in_pszPropertyName, int64_t in_propertyValue)
bool SetValueUInt8(const GUID &in_guidPlatform, const char *in_pszPropertyName, uint8_t in_propertyValue)
bool GetValueBool(const GUID &in_guidPlatform, const char *in_pszPropertyName, bool &out_propertyValue) const
ak_wwise_plugin_host_property_set_v2 CHostPropertySet
bool GetValueInt8(const GUID &in_guidPlatform, const char *in_pszPropertyName, int8_t &out_propertyValue) const
bool SetValueInt32(const GUID &in_guidPlatform, const char *in_pszPropertyName, int32_t in_propertyValue)
bool GetValueUInt8(const GUID &in_guidPlatform, const char *in_pszPropertyName, uint8_t &out_propertyValue) const
ak_wwise_plugin_property_set_braces(* GetOpenedBraces)(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this)
Retrieve the currently open braces.
uint32_t ak_wwise_plugin_property_set_braces
Bitfield composed of values defined in ak_wwise_plugin_property_set_braces_values.
bool GetBool(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
bool PropertyHasUnlinked(const char *in_pszPropertyName) const
bool SetValueUInt32(const GUID &in_guidPlatform, const char *in_pszPropertyName, uint32_t in_propertyValue)
bool SetValue(const GUID &in_guidPlatform, const char *in_pszPropertyName, const AK::WwiseAuthoringAPI::AkVariantBase &in_varProperty)
bool GetValueReal32(const GUID &in_guidPlatform, const char *in_pszPropertyName, float &out_propertyValue) const
ak_wwise_plugin_property_set_braces GetOpenedBraces() const
Retrieve the currently open braces.
bool GetValueUInt16(const GUID &in_guidPlatform, const char *in_pszPropertyName, uint16_t &out_propertyValue) const
bool SetValueReal32(const GUID &in_guidPlatform, const char *in_pszPropertyName, float in_propertyValue)
bool HasPropertyValue(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
bool GetValue(const GUID &in_guidPlatform, const char *in_pszPropertyName, AK::WwiseAuthoringAPI::AkVariantBase &out_varProperty) const
uint8_t GetUInt8(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
void(* OpenBraces)(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, ak_wwise_plugin_property_set_braces in_bracesToOpen)
Open one or more brace that denotes the start of a change.
bool SetValueBool(const GUID &in_guidPlatform, const char *in_pszPropertyName, bool in_propertyValue)
bool SetValueReal64(const GUID &in_guidPlatform, const char *in_pszPropertyName, double in_propertyValue)
Wwise Authoring Plug-ins - C++ class helper to automatically determine the plug-in interfaces used in...
uint16_t GetUInt16(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
void OpenBraces(ak_wwise_plugin_property_set_braces in_bracesToOpen)
Open one or more brace that denotes the start of a change.
const char * GetString(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
bool PropertyPlatformIsLinked(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
bool GetValueInt64(const GUID &in_guidPlatform, const char *in_pszPropertyName, int64_t &out_propertyValue) const
bool PropertyHasRTPC(const char *in_pszPropertyName) const
int64_t GetInt64(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
bool SetValueUInt16(const GUID &in_guidPlatform, const char *in_pszPropertyName, uint16_t in_propertyValue)
int8_t GetInt8(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION(AudioPlugin)
void(* CloseBraces)(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, ak_wwise_plugin_property_set_braces in_bracesToClose)
Close one or more brace that denotes the end of a change.
bool GetValueUInt64(const GUID &in_guidPlatform, const char *in_pszPropertyName, uint64_t &out_propertyValue) const
bool SetValueString(const GUID &in_guidPlatform, const char *in_pszPropertyName, const char *in_propertyValue)
int32_t GetInt32(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
float GetReal32(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Base host-provided instance type for ak_wwise_plugin_host_property_set_v1.
ak_wwise_plugin_host_property_set_v2()
bool GetValueInt16(const GUID &in_guidPlatform, const char *in_pszPropertyName, int16_t &out_propertyValue) const
int16_t GetInt16(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
#define AK_WWISE_PLUGIN_SPECIALIZE_HOST_INTERFACE(in_name, in_varname,...)
PluginInfoGenerator: Creates a C++ host specialization for interface class specified in in_name,...
bool ClearValue(const GUID &in_guidPlatform, const char *in_pszPropertyName)
double GetReal64(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
bool PropertyHasLinked(const char *in_pszPropertyName) const
bool PropertyHasState(const char *in_pszPropertyName) const
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS(AudioPlugin)
uint64_t GetUInt64(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
void CloseBraces(ak_wwise_plugin_property_set_braces in_bracesToClose)
Close one or more brace that denotes the end of a change.
bool GetValueInt32(const GUID &in_guidPlatform, const char *in_pszPropertyName, int32_t &out_propertyValue) const
bool GetValueString(const GUID &in_guidPlatform, const char *in_pszPropertyName, const char *&out_propertyValue) const
V2::PropertySet PropertySet
Latest version of the C++ PropertySet interface.
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