Version
menu_open
Wwise SDK 2024.1.0
Authoring Lua API

NameDescriptionParametersReturn
wa_abs_pathReturns a path referencing the same file system location as the input, but where wa::Path::IsAbsolute is true

string Path: The directory to convert to absolute path.

string The path as an absolute path

wa_callCalls a Waapi function.

string Uri: The identifier of the Waapi function to call.

table Args: The table containing arguments.

table Options: The table containing options.

Value according to the specific function called.

wa_connect_as_remoteFakes the WAL behavior when connected to a remote instance.

boolean Value: The boolean value to set offline rendering to.

wa_copy_directoryCopies a source directory to the destination directory.

string Source: The directory path to copy.

string Destination: The destination path directory.

wa_copy_fileCopies a source file to the destination file.

string Source: The file path to copy.

string Destination: The destination file path.

boolean True if the copy is successful, false otherwise.

wa_copy_to_clipboardCopies a given string to the clipboard.

string Content: The string to copy onto the clipboard.

wa_debug_breakCauses a breakpoint to occur in the current process.
wa_directory_existsChecks whether a given directory exists.

string Path: The directory to validate.

boolean True if the directory exists, false otherwise.

wa_enable_originals_watcherEnable or disable the originals directory watcher

boolean Boolean: true to enable directory watchers,

wa_ensure_directory_existVerifies that a given directory exists. If it does not exist, the directory is created.

string Path: The directory to validate or create.

wa_get_api_statisticsReturn the Lua API statistics in a table, then flush the statistic data.

table

wa_get_from_clipboardRetrieves the clipboard contents.

string The clipboard contents.

wa_get_project_curveTry to get a project curve and its points

string Arg: The command line argument.

string Push the curve points into a json array

wa_json_pretty_printConvert a lua table to JSON, and return the pretty print string

table Table: to format as

string

wa_logLogs a string message in Wwise.

string Message: The message to log.

wa_moveMoves a source directory to a path destination.

string Path: The source directory to move.

string Path: The destination path to move to.

boolean True if the move is successful, false otherwise.

wa_originals_directory_changeSimulate the OS's DirectoryWatch event, specifying the list of paths that changed

table Table: list of paths to declare as changed

wa_read_jsonConvert a json string to lua table

string strJson: json object in string format

lua table

wa_remove_directoryRemoves a directory from the filesystem.

string Path: The directory to remove.

boolean True if the directory is removed, false otherwise.

wa_render_audioRenders the audio.
wa_reset_transportResets the transport.
wa_set_local_read_onlySets local read only

boolean Value: The boolean value to set offline rendering to.

wa_set_offline_renderingSets offline rendering to true or false.

boolean Value: The boolean value to set offline rendering to.

wa_set_user_prefSets user preferences.

string Location: The location associated with the preferences to set.

string Name: The name associated with the preferences to set.

number, or boolean, or string Value: The value to set.

wa_shell_executeExecutes a shell command.

string Arg: The command line argument.

integer The exit code.

string The output string.

wa_sleepAllows the thread to pause execution for a specified number of milliseconds.

number Milliseconds: The number of milliseconds to yield for.

wa_start_capture_console_outputStarts capture of the console output.
wa_start_output_captureStarts output capture.

string Filename: The string path to the file where the output capture should be saved.

wa_std_channel_index_to_meter_indexConvert a channel index from WEM/Sound Engine order and return the channel index in the meter display order

number ChannelIndex: Index of the channel from WAV file

number ChannelMask: Channel for the configuration

number

wa_stop_capture_console_outputStops capture of the console output.
wa_stop_output_captureStops output capture.
wa_subscribeSubscribes to a Waapi function.

string Uri: The identifier of the Waapi function to subscribe to.

table Options: The table containing options.

function Func: The function to call upon event.

integer The id subscription integer.

wa_temporary_directoryCreates a temporary directory.

string The path to the temporary directory.

wa_timeRetrieves the current time.

double The current time.

wa_unsubscribeUnsubscribes from a Waapi subscription.

number IdSubscription: identifier that had been returned by the Waapi function wa_subscribe.

wa_unsubscribe_allUnsubscribes from all Waapi subscriptions.
wa_user_nameRetrieves the username.

string The username.

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