Version

    Other Documentation

menu_open

◆ SetValue

bool(* ak_wwise_plugin_host_property_set_v1::SetValue) (struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, const AK::WwiseAuthoringAPI::AkVariantBase *in_varProperty)

Modifies the value of a specific property as a variant.

Updates the property in_pszPropertyName to contain in_varProperty under the in_guidPlatform platform.

The property type, as contained by in_varProperty, should be equal to the type as defined in the plug-in XML definition file.

Note: Your changes might be substantially altered or replaced if your property is bound to an RTPC ( PropertyHasRTPC ) or a State ( PropertyHasState ).

More than one platform will be affected if the property is linked ( PropertyPlatformIsLinked ); all platforms are linked by default.

Warning: This is a semi-private function. You should use the typed SetValue methods instead.

SetValueString, SetValueInt64, SetValueInt32, SetValueInt16, SetValueInt8, SetValueUInt64, SetValueUInt32, SetValueUInt16, SetValueUInt8, SetValueReal64 SetValueReal32, SetValueBool

The function can still be useful if you want to handle parameters as a black box, getting a
value without knowing the type, and then setting that value elsewhere.
See also
Parameters
[in] in_this Current instance of this interface.
[in] in_guidPlatform The unique ID of the platform whose property you want to modify.
[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
[out] in_varProperty The new value of the property.
Returns
true if successful.

Definition at line 162 of file HostPropertySet.h.

Referenced by AK.Wwise::Plugin::V1::PropertySet::SetValue().


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