|
Wwise SDK 2024.1.0
|
Retrieve all original files.
| Name | Type | Description |
|---|---|---|
| folder | string | Base folder for search relative to Originals folder. Default to the Originals folder. |
| recursive | boolean | Search in all subfolders of the base folder. Default to true. |
| filter | string | Filter the files are in the search result.
|
| Name | Type | Description |
|---|---|---|
| return | array | Array of fields to return for each file or folder found. |
| return [...] | string | Fields to return for each file or folder found:
|
| objectReturn | array | The array of return expressions defines which elements of the Wwise object is returned. This can include built-in accessors, such as the name or id, or object properties, such as the Volume or the Pitch. |
| objectReturn [...] | any of: | A return expression. |
| string | Specifies one or many of the built-in accessors for Wwise objects. Possible values:
| |
| string | Specifies one or many dot-separated accessors that form a query and yields a value or an object reference. Specifying a single @ returns the value of the property for the associated object. Specifying a double @ returns the value of the property for the source of override. Refer to Wwise Objects Reference . |
| Name | Type | Description |
|---|---|---|
| return * | array | Files and folders found. |
| return [...] | object | Specifies what is returned for every item found. |
| return[...].file | string | File path relative to Originals folder. |
| return[...].folder | string | Folder path relative to Originals folder. |
| return[...].isUsed | boolean | Indicates whether a file is used by a Wwise Object in the project. |
| return[...].usage | array | List of objects from the project that are using this file. (see objectReturn options) |
| return[...].usage [...] | object | A Wwise object. Use the return options to specify which property is required. |
| return[...].usage[...].id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| return[...].usage[...].name | string | The name of the object. |
| return[...].usage[...].notes | string | The notes of the object. |
| return[...].usage[...].type | string | The type of the object. Refer to Wwise Objects Reference for more information on the types available. |
| return[...].usage[...].pluginName | string | The name of the plug-in for Source, Effect, Mixer, Device and Metadata plug-in. |
| return[...].usage[...].path | string | The path of the object from the project root. Ex: '\Actor-Mixer Hierarchy\Default Work Unit\Sound1' |
| return[...].usage[...].parent | object | The parent of the object in the hierarchy. |
| return[...].usage[...].parent.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| return[...].usage[...].parent.name | string | The name of the object. |
| return[...].usage[...].owner | object | The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc. |
| return[...].usage[...].owner.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| return[...].usage[...].owner.name | string | The name of the object. |
| return[...].usage[...].isPlayable | boolean | True if the object can be played in Transport. |
| return[...].usage[...].shortId | integer | The Short ID of the object. |
| return[...].usage[...].classId | integer | The class ID of the object. Unsigned Integer 32-bit. Range: [0,4294967295] |
| return[...].usage[...].category | string | The category of the object. Ex: 'Actor-Mixer Hierarchy' |
| return[...].usage[...].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 Using WAAPI on Mac . |
| return[...].usage[...].workunit | object | The parent Work Unit containing the object. The 'id' and the 'name' is returned. |
| return[...].usage[...].workunit.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| return[...].usage[...].workunit.name | string | The name of the object. |
| return[...].usage[...].childrenCount | number | The number of children for the object. Note, this is deprecated. The same result can be obtained with children.count(). |
| return[...].usage[...].totalSize | integer | The amount of space (in bytes) this object and all of its children take up in a SoundBank. This does not include the objectSize. Note that SoundBanks need to be generated for this value to be accurate. |
| return[...].usage[...].mediaSize | integer | The total converted size (in bytes) of the media files of this object and all of its children. Note that SoundBanks need to be generated for this value to be accurate. |
| return[...].usage[...].objectSize | integer | The amount of space (in bytes) the meta-data of the object takes up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate. |
| return[...].usage[...].structureSize | integer | The amount of space (in bytes) the meta-data of the object and all of its children take up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate. |
| return[...].usage[...].musicTransitionRoot | object | (DEPRECATED) The music transition root containing all other music transitions recursively. Note, this is deprecated. The TransitionRoot reference should be used instead. |
| return[...].usage[...].musicTransitionRoot.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| return[...].usage[...].musicPlaylistRoot | object | (DEPRECATED) The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only. Note, this is deprecated. The PlaylistRoot reference should be used instead. |
| return[...].usage[...].musicPlaylistRoot.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| return[...].usage[...].originalWavFilePath | string | (DEPRECATED) Absolute path to the original wav file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac . |
| return[...].usage[...].originalFilePath | string | Absolute path to the original file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac . |
| return[...].usage[...].originalRelativeFilePath | string | Relative (from project's Originals Folder) path to the original file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac . |
| return[...].usage[...].activeSource | object | The active source of the sound object. |
| return[...].usage[...].activeSource.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| return[...].usage[...].activeSource.name | string | The name of the object. |
| return[...].usage[...].convertedWemFilePath | string | (DEPRECATED) Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects. To use WAAPI on Mac, please refer to Using WAAPI on Mac . |
| return[...].usage[...].convertedFilePath | string | Absolute path to the converted file. Specify the platform in the options. Only valid for Sound and Audio Source objects. To use WAAPI on Mac, please refer to Using WAAPI on Mac . |
| return[...].usage[...].soundbankBnkFilePath | string | Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. To use WAAPI on Mac, please refer to Using WAAPI on Mac . |
| return[...].usage[...].playbackDuration | object | The duration root that contains the min and max durations and duration type. Note, this is deprecated. The duration should be used instead. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants. |
| return[...].usage[...].playbackDuration.playbackDurationMin | number | The minimum possible time playback can take. |
| return[...].usage[...].playbackDuration.playbackDurationMax | number | The maximum possible time playback can take. |
| return[...].usage[...].playbackDuration.playbackDurationType | string | The type of duration. |
| return[...].usage[...].duration | 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. |
| return[...].usage[...].duration.min | number | The minimum possible time playback can take. |
| return[...].usage[...].duration.max | number | The maximum possible time playback can take. |
| return[...].usage[...].duration.type | string | The type of duration. |
| return[...].usage[...].maxDurationSource | object | Audio source with the longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants. |
| return[...].usage[...].maxDurationSource.id | string | The ID (GUID) of the audio source object with the longest duration. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| return[...].usage[...].maxDurationSource.trimmedDuration | number | The duration in seconds of the longest trimmed source. |
| return[...].usage[...].audioSourceTrimValues | object | Range of time for which the audio source is trimmed. |
| return[...].usage[...].audioSourceTrimValues.trimBegin | number | The time value in seconds of the start trim. |
| return[...].usage[...].audioSourceTrimValues.trimEnd | number | The time value in seconds of the end trim. |
| return[...].usage[...].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. |
| return[...].usage[...].maxRadiusAttenuation.id | string | The ID (GUID) of the attenuation object with the largest radius. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| return[...].usage[...].maxRadiusAttenuation.radius | number | The radius of the attenuation object. |
| return[...].usage[...].audioSourceLanguage | object | Language associated to the audio source. This only applies to Audio Source objects directly. |
| return[...].usage[...].audioSourceLanguage.id | string | The ID (GUID) of the Language object to which the Audio Source object is associated. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| return[...].usage[...].audioSourceLanguage.name | string | The name of the Language object to which the Audio Source object is associated. |
| return[...].usage[...].originalTotalChannelCount | number | The total number of channels present in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].originalNormalChannelCount | number | The number of channel in the normal plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].originalHeightChannelCount | number | The number of channel in the height plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].originalLFEChannelCount | number | The number of low frequency channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].originalAnonymousChannelCount | number | The number of anonymous channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].originalChannelConfig | string | The configuration of the channels in the audio source (Ex : 7.1.4). For anonymous channels, returns Anonymous. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].originalChannelMask | number | The mask associated with the channel's configuration. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].originalSampleRate | number | The sample rate for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].originalBitDepth | number | The sample rate for the audio source. Either 16 or 24. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].originalFileSize | number | The file size in bytes for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].originalDataSize | number | The data size for bytes the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].originalSampleCount | number | The number of samples in the audio file. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].originalDuration | number | The file duration. Differs from generic Duration field because the original file does not include Trim Begind/End. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].originalCodec | string | The audio file's codec. For original files, it will always be PCM. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].convertedTotalChannelCount | number | The total number of channels present in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].convertedNormalChannelCount | number | The number of channel in the normal plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].convertedHeightChannelCount | number | The number of channel in the height plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].convertedLFEChannelCount | number | The number of low frequency channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].convertedAnonymousChannelCount | number | The number of anonymous channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].convertedChannelConfig | string | The configuration of the channels in the audio source (Ex : 7.1.4). For anonymous channels, returns Anonymous. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].convertedChannelMask | number | The mask associated with the channel's configuration. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].convertedSampleRate | number | The sample rate for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].convertedBitDepth | number | The sample rate for the audio source. Either 16 or 24. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].convertedFileSize | number | The file size in bytes for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].convertedDataSize | number | The data size for bytes the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].convertedSampleCount | number | The number of samples in the audio file. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].convertedDuration | number | The file duration. Differs from generic Duration field because the original file does not include Trim Begind/End. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].convertedCodec | string | The audio file's codec. For original files, it will always be PCM. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
| return[...].usage[...].workunitIsDefault | boolean | True if the work unit is the default. |
| return[...].usage[...].workunitType | string | The type of the Work Unit. Please note that, like Work Units, physical folders have the type "WorkUnit". Physical folders have the workunitType "folder". Possible values:
|
| return[...].usage[...].workunitIsDirty | boolean | True if a Work Unit or a Project (wproj file) is dirty, meaning it was modified but not saved. |
| return[...].usage[...].switchContainerChildContext | 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: the properties of the '1st only' checkbox). |
| return[...].usage[...].switchContainerChildContext.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| return[...].usage[...].isExplicitMute | boolean | Whether or not the object has been muted explicitly. Explicitly muting an object implicitly mutes the descendant objects. |
| return[...].usage[...].isExplicitSolo | boolean | Whether or not the object has been soloed explicitly. Soloing an object silences all the other objects in the project except this one. |
| return[...].usage[...].isImplicitMute | boolean | Whether or not the object has been muted implicitly. Explicitly muting an object implicitly mutes the descendant objects. |
| return[...].usage[...].isImplicitSolo | boolean | Whether or not the object has been soloed implicitly. Soloing an object silences all the other objects in the project except this one. |
| return[...].usage[...].isIncluded | boolean | Whether or not the object is Included. Specify the platform in the options. This takes into consideration the Inclusion status of the object's ancestors. |
| return[...].usage[...].points | array | This only applies to Curve objects. An array of points defining a curve. |
| return[...].usage[...].points [...] | object | A point in the curve. |
| return[...].usage[...].points[...].x * | number | X coordinate of curve point. |
| return[...].usage[...].points[...].y * | number | Y coordinate of curve point. |
| return[...].usage[...].points[...].shape * | string | Shape of the curve segment between this point and the next. Possible values:
|
| return[...].usage[...].stateProperties | array | An array of state properties to set. |
| return[...].usage[...].stateProperties [...] | string | The name of the property to set. |
| return[...].usage[...].stateGroups | array | The State Group objects associated with this object. |
| return[...].usage[...].stateGroups [...] | object | A State Group object. |
| return[...].usage[...].stateGroups[...].id | string | The ID (GUID) of the State Group object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| return[...].usage[...].stateGroups[...].name | string | The name of the State Group object. |
| return[...].usage[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) | any of: | Specifies dot-separated accessors that form a query and yields a property value or an object reference. A single @ specifies the value of the property for the associated object. A double @ specifies the value of the property for the source of override. Refer to Wwise Objects Reference for more information on the properties and references for all types available. |
| string | A string value. | |
| array | An array of string values. | |
| number | A numeric value. | |
| array | An array of numeric values. | |
| boolean | A boolean value. | |
| array | An array of boolean values. | |
| object | An object reference value. | |
| array | An object list reference value. | |
| return[...].usage[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] | string | A string value. |
| return[...].usage[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] | number | A numeric value. |
| return[...].usage[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] | boolean | A boolean value. |
| return[...].usage[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| return[...].usage[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).name | string | The name of the object. |
| return[...].usage[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] | object | An object reference value. |
| return[...].usage[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| return[...].usage[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].name | string | The name of the object. |
| return[...].isMissing | boolean | Indicates that the file exists in source control but is not present in the local file system. |
(Required *)
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