Version

menu_open
Wwise SDK 2024.1.1
ak.wwise.core.audio.convert

Creates a converted audio file. When errors occur, this function returns a list of messages with corresponding levels of severity.

Arguments

Name Type Description
objects * array An array of objects. Each object is an ID (GUID), name, or object path.
objects [...] any of:
string The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
string A project path to a Wwise object, including the category and the work-unit. For example: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
platforms * array An array of platforms. Each platform is an ID (GUID) or a unique name.
platforms [...] any of:
string The name of the object.
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
languages * array An array of languages. Each language is a unique name.
languages [...] string A language is a unique name.

(Required *)

Arguments Schema

Result

Name Type Description
errors array List of logged entries with associated messages and severities.
errors [...] object Logged entry with severity and message.
errors[...].severity string

Severity of the logged message.

  • Message: Does not affect the integrity of the current operation.
  • Warning: Might affect the integrity of the current operation.
  • Error: Affects the integrity of the current operation.
  • Fatal Error: Prevents the completion of the current operation.

Possible values:

  • Message
  • Warning
  • Error
  • Fatal Error
errors[...].message string Message logged by the system (Error or warning).

Result Schema

See Also

Examples

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.


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