Version

menu_open
Wwise SDK 2018.1.11
ak.soundengine.setRTPCValue


Set the value of a real-time parameter control. See AK::SoundEngine::SetRTPCValue.

Supported by

Graphical User Interface.

Arguments

Name Type Description
rtpc *   Either the ID (GUID), name, or short ID of the real-time parameter control.
value * number Value to set.
gameObject * integer Associated game object ID.

(Required *)

Arguments Details


rtpc

description : Either the ID (GUID), name, or short ID of the real-time parameter control.
Possibilities, one of the following :

1) type : string
pattern : ^[a-zA-Z_]+[a-zA-Z_0-9]*$

2) type : string
pattern : ^\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}$

3) type : integer
minimum : 0
maximum : 4294967295

value

type : number
description : Value to set.

gameObject

description : Associated game object ID.
type : integer
minimum : 0
maximum : 18446744073709551615


Examples :

Setting an RTPC value using its name.

Sets the value of "rtpc", using its name, to "value" for "gameObject".

Arguments:

{
"rtpc": "Rain_Intensity",
"value": 74,
"gameObject": 1122334
}

Setting an RTPC value using its GUID.

Sets the value of "rtpc", using its GUID, to "value" for "gameObject".

Arguments:

{
"rtpc": "{A076AA65-B71A-45BB-8841-5A20C52CE727}",
"value": 1853,
"gameObject": 22556677
}


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"rtpc": {
"description": "Either the ID (GUID), name, or short ID of the real-time parameter control.",
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z_]+[a-zA-Z_0-9]*$"
},
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
]
},
"value": {
"type": "number",
"description": "Value to set."
},
"gameObject": {
"description": "Associated game object ID.",
"type": "integer",
"minimum": 0,
"maximum": 18446744073709551615
}
},
"required": [
"rtpc",
"value",
"gameObject"
],
"additionalProperties": false
}


Options :

{
"type": "object",
"properties": {},
"additionalProperties": false
}


Response :

{
"type": "object",
"properties": {},
"additionalProperties": false
}

Document version : 1


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