menu
版本
2018.1.11.6987
2024.1.4.8780
2023.1.12.8706
2022.1.18.8567
2021.1.14.8108
2019.2.15.7667
2019.1.11.7296
2018.1.11.6987
2017.2.10.6745
2017.1.9.6501
2016.2.6.6153
2015.1.9.5624
2024.1.4.8780
2023.1.12.8706
2022.1.18.8567
2021.1.14.8108
2019.2.15.7667
2019.1.11.7296
2018.1.11.6987
2017.2.10.6745
2017.1.9.6501
2016.2.6.6153
2015.1.9.5624
|
Wwise SDK 2018.1.11
|
Moves an object to the given parent.
Graphical User Interface, Command-Line Interface.
| Name | Type | Description |
|---|---|---|
| object * | The ID (GUID), name, or path of the object to be moved. | |
| parent * | The ID (GUID), name, or path of the object's new parent. | |
| onNameConflict | string | The action to take if "parent" already has a child with the same name. Default value is "fail". Possible values : "rename", "replace", "fail" |
(Required *)
description : The ID (GUID), name, or path of the object to be moved.
Possibilities, one of the following :
1) type : string
pattern : ^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$
description : The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported.
2) type : string
pattern : ^\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}$
3) type : string
pattern : ^\
description : The ID (GUID), name, or path of the object's new parent.
Possibilities, one of the following :
1) type : string
pattern : ^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$
description : The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported.
2) type : string
pattern : ^\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}$
3) type : string
pattern : ^\
type : string
description : The action to take if "parent" already has a child with the same name. Default value is "fail".
Possible values : "rename", "replace", "fail"
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the object. |
| name | string | The name of the object. |
| notes | string | The notes of the object. |
| type | string | The type of the object. Refer to Wwise Objects Reference for more information on the types available. |
| path | string | The path of the object from the project root. Ex: '\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1' |
| parent | object | The parent of the object in the hierarchy. |
| owner | object | The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc. |
| isPlayable | boolean | True if the object can be played in Transport. |
| shortId | integer | The short ID of the object. |
| classId | integer | The class ID of the object. |
| category | string | The category of the object. Ex: 'Actor-Mixer Hierarchy' |
| filePath | string | The path to the file containing the object. The path can be a Work Unit file or a project file. For using WAAPI on Mac, please refer to 在 Mac 上使用 WAAPI . |
| workunit | object | The parent workunit containing the object. The 'id' and the 'name' will be returned. |
| childrenCount | number | The number of children for the object. |
| music:transitionRoot | object | The music transition root containing all other music transitions recursively. |
| music:playlistRoot | object | The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only. |
| sound:originalWavFilePath | string | Absolute path to the original wav file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to 在 Mac 上使用 WAAPI . |
| sound:convertedWemFilePath | string | Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to 在 Mac 上使用 WAAPI . |
| soundbank:bnkFilePath | string | Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. For using WAAPI on Mac, please refer to 在 Mac 上使用 WAAPI . |
| audioSource:playbackDuration | object | The duration root that contains the min and max durations and duration type. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants. |
| audioSource:maxDurationSource | object | Audio source with longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants. |
| audioSource:trimValues | object | Range of time for which the audio source is trimmed. |
| audioSource:maxRadiusAttenuation | object | Attenuation with the largest radius. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants. |
| audioSource:language | object | Language associated to the audio source. This only applies to Audio Source objects directly. |
| workunit:isDefault | boolean | True if the work unit is the default. |
| workunit:type | string | The type of the Work Unit. Please note that, like Work Units, physical folders have the type "WorkUnit". Physical folders will have the workunit:type "folder". Possible values : "folder", "rootFile", "nestedFile" |
| workunit:isDirty | boolean | True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved. |
| switchContainerChild:context | object | The context object associated with the child of a Switch Container. This object holds the properties associated with the child that are context-dependent for the Switch Container (for example: property for the 1st only checkbox). |
description : The ID (GUID) of the object.
type : string
pattern : ^\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}$
type : string
description : The name of the object.
type : string
description : The notes of the object.
type : string
description : The type of the object. Refer to Wwise Objects Reference for more information on the types available.
type : string
description : The path of the object from the project root. Ex: '\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1'
type : object
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the object. |
| name | string | The name of the object. |
description : The parent of the object in the hierarchy.
type : object
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the object. |
| name | string | The name of the object. |
description : The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc.
type : boolean
description : True if the object can be played in Transport.
type : integer
description : The short ID of the object.
description : The class ID of the object.
type : integer
minimum : 0
maximum : 4294967295
type : string
description : The category of the object. Ex: 'Actor-Mixer Hierarchy'
type : string
description : The path to the file containing the object. The path can be a Work Unit file or a project file. For using WAAPI on Mac, please refer to 在 Mac 上使用 WAAPI .
type : object
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the object. |
| name | string | The name of the object. |
description : The parent workunit containing the object. The 'id' and the 'name' will be returned.
type : number
description : The number of children for the object.
type : object
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the object. |
description : The music transition root containing all other music transitions recursively.
type : object
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the object. |
description : The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only.
type : string
description : Absolute path to the original wav file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to 在 Mac 上使用 WAAPI .
type : string
description : Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to 在 Mac 上使用 WAAPI .
type : string
description : Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. For using WAAPI on Mac, please refer to 在 Mac 上使用 WAAPI .
type : object
description : The duration root that contains the min and max durations and duration type. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
| Name | Type | Description |
|---|---|---|
| playbackDurationMin | number | The minimum possible time playback can take. |
| playbackDurationMax | number | The maximum possible time playback can take. |
| playbackDurationType | string | The type of duration. |
type : object
description : Audio source with longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the audio source object with longest duration. |
| trimmedDuration | number | The duration in seconds of the longest trimmed source. |
type : object
description : Range of time for which the audio source is trimmed.
| Name | Type | Description |
|---|---|---|
| trimBegin | number | The time value in seconds of the start trim. |
| trimEnd | number | The time value in seconds of the end trim. |
type : object
description : Attenuation with the largest radius. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the attenuation object with the largest radius. |
| radius | number | The radius of the attenuation object. |
type : object
description : Language associated to the audio source. This only applies to Audio Source objects directly.
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the Language object to which the Audio Source object is associated. |
| name | string | The name of the Language object to which the Audio Source object is associated. |
type : boolean
description : True if the work unit is the default.
type : string
description : The type of the Work Unit. Please note that, like Work Units, physical folders have the type "WorkUnit". Physical folders will have the workunit:type "folder".
Possible values : "folder", "rootFile", "nestedFile"
type : boolean
description : True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved.
type : object
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the object. |
description : The context object associated with the child of a Switch Container. This object holds the properties associated with the child that are context-dependent for the Switch Container (for example: property for the 1st only checkbox).
Moves object "id" and makes it a child of "parent". The object will fail if "parent" already contains a child with the same name.
Moves object "id" and makes it a child of "parent". The object will be renamed if "parent" already contains a child with the same name.
Document version : 1