|
Wwise SDK 2024.1.1
|
Adds a new assignment to a Blend Track. Equivalent to performing a drag-and-drop operation in the Blend Tracks Editor.
| Name | Type | Description |
|---|---|---|
| object * | string | The ID (GUID) of the Blend Track. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| child * | any of: | The ID (GUID), name, or path of the object to assign. This object must be the child of a Blend Track's Blend Container. |
| 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. | |
| index | integer | The index of the child among the Blend Track's assignments. If a value is provided, it will be clamped to the range [0-n], where n is the current number of assignments. If a value is not provided, then the assignment will be added at the end. |
| edges | array | The configuration of the edges of the assignment within the Blend Track. This information is only useful if the Blend Track has a crossfade Game Parameter. If not specified, the edges will be configured using default values. If specified, there must be two edges: 0 = left, 1 = right. |
| edges [...] | object | The edge configuration of the Blend Track edge. Defines the characteristics of Blend Track assignment's edge. |
| edges[...].fadeMode * | string | The configuraiton of the edge's crossfade Possible values:
|
| edges[...].fadeShape * | string | The shape of the edge's crossfade curve Possible values:
|
| edges[...].edgePosition * | number | The position of the edge. The position must be within the range of the Blend Track's crossfade Game Parameter's range. If this edge is the left edge, then this position must be less or equal edgePosition of the right edge. If this is the right edge then vice versa. |
| edges[...].fadePosition | number | The start/end position of the fade curve. The position must be within the range of the Blend Track's crossfade Game Parameter's range. If this edge is the left edge, then this position must be greater or equal this edge's edgePosition, and less or equal the right edge's edgePosition. If this is the right edge then vice versa. This argument is used only if fadeMode is 'Manual'. |
(Required *)
| Name | Type | Description |
|---|---|---|
| child | string | The ID (GUID) the assigned object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| index | integer | The index of the child among the Blend Track's assignments. |
| edges | array | The configuration of the edges of the assignment within the Blend Track; 0 = left, 1 = right. |
| edges [...] | object | The edge configuration of the Blend Track edge. Defines the characteristics of Blend Track assignment's edge. |
| edges[...].fadeMode * | string | The configuraiton of the edge's crossfade Possible values:
|
| edges[...].fadeShape * | string | The shape of the edge's crossfade curve Possible values:
|
| edges[...].edgePosition * | number | The position of the edge. The position must be within the range of the Blend Track's crossfade Game Parameter's range. If this edge is the left edge, then this position must be less or equal edgePosition of the right edge. If this is the right edge then vice versa. |
| edges[...].fadePosition | number | The start/end position of the fade curve. The position must be within the range of the Blend Track's crossfade Game Parameter's range. If this edge is the left edge, then this position must be greater or equal this edge's edgePosition, and less or equal the right edge's edgePosition. If this is the right edge then vice versa. This argument is used only if fadeMode is 'Manual'. |
Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise