Supported by

Graphical User Interface.

Arguments

Name	Type	Description
emitter *	integer	Associated emitter game object ID.
listener *	integer	Associated listener game object ID.
controlValue *	number	A multiplier where 0 means silence and 1 means no change. Therefore, values between 0 and 1 will attenuate the sound, and values greater than 1 will amplify it.

(Required *)

Arguments Details

emitter

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

listener

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

controlValue

type : number
description : A multiplier where 0 means silence and 1 means no change. Therefore, values between 0 and 1 will attenuate the sound, and values greater than 1 will amplify it.

Examples :

Setting the "emitter"'s output bus volume for the "listener"

Amplifies the output bus volume of "emitter" for "listener" by using the multiplier "controlValue".

Arguments:

{
    "emitter": 1122334, 
    "listener": 4455667, 
    "controlValue": 2
}

Result:

{}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "emitter": {
            "description": "Associated emitter game object ID.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 18446744073709551615
        }, 
        "listener": {
            "description": "Associated listener game object ID.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 18446744073709551615
        }, 
        "controlValue": {
            "type": "number", 
            "description": "A multiplier where 0 means silence and 1 means no change. Therefore, values between 0 and 1 will attenuate the sound, and values greater than 1 will amplify it."
        }
    }, 
    "required": [
        "emitter", 
        "listener", 
        "controlValue"
    ], 
    "additionalProperties": false
}

Options :

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

Response :

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

Document version : 1