Version
arrow_right Table of Contents

Other Documentation

Wwise SDK 2021.1.8
JavaScript, Node.js - WAMP

Initializing the project

Note: This example requires the most recent Node.js LTS to be installed.

Run the following command from the sample directory <Wwise installation path>/SDK/samples/WwiseAuthoringAPI/js/hello-wwise-node-wamp to install dependencies.

npm install

Project Code

The sample file, index.js, in the hello-wwise-node-wamp sample directory allows to connect to the Wwise Authoring API.

var ak = require('../../../../include/AK/WwiseAuthoringAPI/js/waapi.js').ak;
var autobahn = require('autobahn');
// Create the WAMP connection
var connection = new autobahn.Connection({
url: 'ws://localhost:8080/waapi',
realm: 'realm1',
protocols: ['wamp.2.json']
});
// Setup handler for connection opened
connection.onopen = function (session) {
// Call getInfo
session.call(ak.wwise.core.getInfo, [], {}).then(
function (res) {
console.log(`Hello ${res.kwargs.displayName} ${res.kwargs.version.displayName}!`);
},
function (error) {
console.log(`Error: ${error}`);
}
).then(
function() {
connection.close();
}
);
};
connection.onclose = function (reason, details) {
if (reason !== 'lost') {
console.log("Connection closed. Reason: " + reason);
}
process.exit();
};
// Open the connection
connection.open();

Note: The line var ak = require('../../../../include/AK/WwiseAuthoringAPI/js/waapi.js').ak imports a declaration of the API paths.

It is located in <Wwise installation path>/SDK/include/AK/WwiseAuthoringAPI/js.

For the sample, the path to this file is relative to the sample's location.

Running the project

Run the following command in the sample's directory:

node index.js

If the Wwise Authoring API successfully connects to Wwise, you should see the following output:

Hello Wwise 20??.?.?