バージョン
menu
Wwise SDK 2025.1.2
ak.wwise.core.mediaPool.get

Retrieve files from Media Pool. Use the return options to specify which properties of the files to return.

Arguments

Name タイプ 概要
searchText string The text for the fuzzy search in the Media Pool. The search is case-insensitive.
databases array The list of databases to include. If not specified, all databases are included.
databases [...]

The ID (GUID) or path of the database to include in the search. For the database representing the project originals, use the path '\Databases\Project Originals'.

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 オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
string Wwiseオブジェクトへのプロジェクトパスで、カテゴリと、ワークユニットを含みます。For example: \Containers\Default Work Unit\New Sound SFX.
filters array The list of filters to apply.
filters [...] object The filter to apply to the search.
filters[...].type *

The type of the filter.

Any of:

string field : Filter by a specific field in the Media Pool. See ak.core.mediaPool.getFields for the list of supported fields.
string audioDescription : Filter by description of the desired audio content. You can also specify a weight for the filter.
string audioSimilarity : Filter by audio similarity, which find files that are similar to the audio file at the specified path. You can also specify a weight for the filter.
filters[...].weight number The weight of the filter. Normally as decimal value between 0 and 1. The higher the weight, the more important the filter is in the search results. If not specified, a default weight of 1 is used. The weight is only used for audio similarity filters.
filters[...].field

The name of the field by which to filter. Possible fields include standard WAV fields, file system fields, extracted audio features, and metadata fields from the IXML chunk. The supported fields depend on files in the Media Pool databases. See ak.core.mediaPool.getFields for the list of supported fields. Use this property when the type is 'field'.

Any of:

string Filename : The name of the file, including the extension.
string WAV/Duration : The duration of the file in seconds.
string WAV/Sample Rate : The sample rate of the audio file in Hz.
string WAV/Bit Depth : The bit depth of the audio file. Possible values are 8, 16, 24, or 32.
string WAV/Channels : The number of channels of the audio file.
string WAV/Channel Configuration : The channel configuration of the audio file, such as '1.0', '2.0', '5.1', '7.1.4', etc.
string WAV/Data Size : The size of the audio data in bytes.
string WAV/Loop Start : The position in seconds where the audio file loop starts.
string WAV/Loop End : The position in seconds where the audio file loops back to the start.
string WAV/Marker Count : The number of markers in the audio file.
string WAV/Samples : The number of samples in the audio file, for one channel.
string Other fields found in the IXML chunk of the file. Use ak.core.mediaPool.getFields to get the list of supported fields.
filters[...].operator

The type of operator to use to evaluate a field value. Supported operators vary by field type (numeric or text). Use this property when the type is 'field'.

Any of:

string equals : The field value is exactly equal to the specified value.
string notEquals : The field value is not equal to the specified value.
string contains : The field value contains the specified text (case-sensitive). Text value only.
string startsWith : The field value begins with the specified text. Text value only.
string endsWith : The field value ends with the specified text. Text value only.
string matchesRegex : The field value matches the specified regular expression. Text value only.
string lessThan : The numeric field value is less than the specified value. Numeric value only.
string greaterThan : The numeric field value is greater than the specified value. Numeric value only.
string lessThanOrEqual : The numeric field value is less than or equal to the specified value. Numeric value only.
string greaterThanOrEqual : The numeric field value is greater than or equal to the specified value. Numeric value only.
filters[...].value *

Any of:

string The value to which to compare the field if the field is a text value.
number The value to which to compare the field if the field is a numeric value.
string The description text to use when the filter type is audio description.
string The path to an audio file when the filter type is audio similarity.
maxResults integer The maximum number of results to return. If not specified, a maximum 1000 files are returned.

Arguments Schema

Options

Name タイプ 概要
return array The list of properties to return for each file. If not specified, the following properties are returned: 'Path', 'FileId', 'Db'.
return [...]

A property to return for each file. The name is case-sensitive. Not all properties are available for all files.

Any of:

string Score : The search result score. A value greater than 0. The higher the score, the better the results.
string FileId : A GUID representing the file in the database.
string Db : The database object containing the file. This is an object with 'id' and 'name' properties, where 'id' is the GUID of the database and 'name' is the name of the database.
string Path : The absolute path to the file in the file system.
string Size : The size of the file in bytes.
string Markers : An array of markers in the audio file. Each marker is an object with 'name' and 'time' properties, where 'name' is the marker's name and 'time' is its position in seconds.
string DetectedRegions : An array of detected regions in the audio file. Each region is an object with 'start' and 'end' properties, where 'start' and 'end' are the positions in seconds.

Any of:

string Filename : The name of the file, including the extension.
string WAV/Duration : The duration of the file in seconds.
string WAV/Sample Rate : The sample rate of the audio file in Hz.
string WAV/Bit Depth : The bit depth of the audio file. Possible values are 8, 16, 24, or 32.
string WAV/Channels : The number of channels of the audio file.
string WAV/Channel Configuration : The channel configuration of the audio file, such as '1.0', '2.0', '5.1', '7.1.4', etc.
string WAV/Data Size : The size of the audio data in bytes.
string WAV/Loop Start : The position in seconds where the audio file loop starts.
string WAV/Loop End : The position in seconds where the audio file loops back to the start.
string WAV/Marker Count : The number of markers in the audio file.
string WAV/Samples : The number of samples in the audio file, for one channel.
string Other fields found in the IXML chunk of the file. Use ak.core.mediaPool.getFields to get the list of supported fields.

Options Schema

Result

Name タイプ 概要
return array The list of files matching the search criteria. Each file is represented as an object with properties defined by the options.
return [...] object A file in the Media Pool. The properties of the file depend on the options.

Result Schema

See Also

Examples

Wwise Authoring APIの詳細は、 Wwise Authoring API (WAAPI)を使用する を参照してください。

このページはお役に立ちましたか？

サポートは必要ですか？

ご質問や問題、ご不明点はございますか？お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう