バージョン
menu_open
Wwise SDK 2024.1.0
ak.wwise.core.soundbank.generate

Generate a list of SoundBanks with the import definition specified in the WAAPI request. If you do not write the SoundBanks to disk, subscribe to ak.wwise.core.soundbank.generated to receive SoundBank structure info and the bank data as base64. Note: This is a synchronous operation.

Arguments

Name タイプ 概要
soundbanks array 生成するSoundBankのリスト。
soundbanks [...] object SoundBank Info。
soundbanks[...].name * string 生成するSoundBankの名前であり、もしこのSoundBankが存在しなければ、仮のSoundBankを作成します。
soundbanks[...].events array このSoundBankに含めるイベントのリスト。バンクがすでに存在していれば、不要です。
soundbanks[...].events [...] any of: SoundBankに含めるイベントの、ID (GUID)、名前、またはパス。
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オブジェクトへのプロジェクトパスで、カテゴリと、ワークユニットを含みます。例えば: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
soundbanks[...].auxBusses array このSoundBankに含めるAuxBusのリスト。
soundbanks[...].auxBusses [...] any of: SoundBankに含めるAuxiliary Busの、ID (GUID)、名前、またはパス。
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オブジェクトへのプロジェクトパスで、カテゴリと、ワークユニットを含みます。例えば: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
soundbanks[...].inclusions array このSoundBankに含めるinclusionタイプのリスト。バンクがすでに存在していれば、不要です。
soundbanks[...].inclusions [...] string 可能な値:
  • event
  • structure
  • media
soundbanks[...].rebuild boolean この特定SoundBankを、強制的にリビルドします。デフォルト値: false
platforms array 生成するプラットフォームのリスト。プラットフォームの指定がなければ、全てのプラットフォームを生成します。
platforms [...] string プラットフォームのID (GUID)または名前。
languages array 生成するランゲージのリスト。ランゲージの指定がなければ、全てのランゲージを生成します。
languages [...] string ランゲージのID (GUID)または名前。
skipLanguages boolean デフォルトで、ランゲージを指定しなければ、全てのランゲージを生成します。このパラメータをtrueに設定すると、ローカライズされたSoundBankは生成しません。
rebuildSoundBanks boolean trueであれば、全てのSoundBankをリビルドします。変換後のメディアもクリアするには、clearAudioFileCacheパラメータを使います。デフォルト値: false
clearAudioFileCache boolean ソースファイルを変換してSoundBankを生成する前に、Wwiseオーディオファイルのキャッシュフォルダの中身を削除し、すべてのソースファイルが確実に再変換されるようにします。なお、プラットフォーム引数に関わらず、すべてのプラットフォームでキャッシュ全体がクリアされることに注意してください。デフォルト値: false
writeToDisk boolean 通常のSoundBank生成プロセスを使い、ディスクにサウンドバンクとinfoファイルを書き込みます。デフォルト値: false
rebuildInitBank boolean rebuildSoundBanksを使わない場合は、このオプションを使い、指定した各プラットフォームのInitバンクを強制的にリビルドします。

引数スキーマ

Result

Name タイプ 概要
logs array SoundBank生成のログ。The log is empty when used in WwiseConsole.
logs [...] object ログのエントリ。
logs[...].severity * string
  • 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. 可能な値:
    • Message
    • Warning
    • Error
    • Fatal Error
logs[...].time * integer システムクロックによる、UTCの1970年1月1日午前0時0分0秒(00:00:00)からの経過秒数。
logs[...].messageId * string ログアイテムのメッセージID。
logs[...].message * string ログアイテムの説明メッセージ。
logs[...].platform object ログアイテムが報告されたプラットフォームの、IDと名前。
logs[...].platform.id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.name string オブジェクト名。
logs[...].platform.notes string オブジェクトのnotes。
logs[...].platform.type string オブジェクトのタイプ。使用可能なタイプの詳細については、 Wwiseオブジェクトリファレンス を参照してください。
logs[...].platform.pluginName string Source、Effect、Mixer、Device、Metadataプラグインの、プラグイン名。
logs[...].platform.path string プロジェクトルートからオブジェクトへのパス。例: '\Actor-Mixer Hierarchy\Default Work Unit\Sound1'
logs[...].platform.parent object 階層におけるオブジェクトの親。
logs[...].platform.parent.id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.parent.name string オブジェクト名。
logs[...].platform.owner object オブジェクトのオーナー。カスタムエフェクトやカスタム減衰など、ほかのオブジェクトにローカルで所有されているオブジェクトが、該当します。
logs[...].platform.owner.id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.owner.name string オブジェクト名。
logs[...].platform.isPlayable boolean オブジェクトをTransportで再生できる場合は、trueです。
logs[...].platform.shortId integer オブジェクトのShort ID。
logs[...].platform.classId integer オブジェクトのクラスID。
符号なし整数32-bit。範囲: [0,4294967295]
logs[...].platform.category string オブジェクトのカテゴリ。例: 'Actor-Mixer Hierarchy'
logs[...].platform.filePath string オブジェクトを含むファイルへのパス。パスは、Work Unitファイルまたはプロジェクトファイルとします。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
logs[...].platform.workunit object オブジェクトを含む、親Work Unit。'id'と'name'を返します。
logs[...].platform.workunit.id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.workunit.name string オブジェクト名。
logs[...].platform.childrenCount number このオブジェクトの子の数。注：これは非推奨です。The same result can be obtained with children.count().
logs[...].platform.totalSize integer このオブジェクトと、その全ての子が、SoundBankに占めるスペース（単位byte）。objectSizeは含まれません。なお、正確な値を得るには、SoundBankを生成する必要があります。
logs[...].platform.mediaSize integer このオブジェクトとその全ての子のメディアファイルの、変換後の合計サイズ（単位bytes）。なお、正確な値を得るには、SoundBankを生成する必要があります。
logs[...].platform.objectSize integer このオブジェクトのメタデータがSoundBankに占めるスペース（単位byte）。メディアファイルは含まれません。なお、正確な値を得るには、SoundBankを生成する必要があります。
logs[...].platform.structureSize integer このオブジェクトとその全ての子のメタデータが、SoundBankに占めるスペース（単位byte）。メディアファイルは含まれません。なお、正確な値を得るには、SoundBankを生成する必要があります。
logs[...].platform.musicTransitionRoot object (DEPRECATED) The music transition root containing all other music transitions recursively. 注：これは非推奨です。The TransitionRoot reference should be used instead.
logs[...].platform.musicTransitionRoot.id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.musicPlaylistRoot object (DEPRECATED) The music playlist root containing all other music playlist items recursively. これが適用されるのは、Music Playlist Containerだけです。注：これは非推奨です。The PlaylistRoot reference should be used instead.
logs[...].platform.musicPlaylistRoot.id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.originalWavFilePath string (DEPRECATED) Absolute path to the original wav file. これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
logs[...].platform.originalFilePath string Absolute path to the original file. これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
logs[...].platform.originalRelativeFilePath string Relative (from project's Originals Folder) path to the original file. これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
logs[...].platform.activeSource object The active source of the sound object.
logs[...].platform.activeSource.id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.activeSource.name string オブジェクト名。
logs[...].platform.convertedWemFilePath string (DEPRECATED) Absolute path to the converted wem file. 選択肢からプラットフォームを指定。これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
logs[...].platform.convertedFilePath string Absolute path to the converted file. 選択肢からプラットフォームを指定。これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
logs[...].platform.soundbankBnkFilePath string SoundBankオブジェクトに関連する、生成後のSoundBankファイルへの絶対パス。これは、SoundBankオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
logs[...].platform.playbackDuration object 最小と最大のdurationと、durationタイプを含む、durationルート。注：これは非推奨です。The duration should be used instead. これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。
logs[...].platform.playbackDuration.playbackDurationMin number 再生にかかる最短時間。
logs[...].platform.playbackDuration.playbackDurationMax number 再生にかかる最長時間。
logs[...].platform.playbackDuration.playbackDurationType string durationタイプ。
logs[...].platform.duration object 最小と最大のdurationと、durationタイプを含む、durationルート。これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。
logs[...].platform.duration.min number 再生にかかる最短時間。
logs[...].platform.duration.max number 再生にかかる最長時間。
logs[...].platform.duration.type string durationタイプ。
logs[...].platform.maxDurationSource object 最長のdurationのオーディオソース。これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。
logs[...].platform.maxDurationSource.id string 最長の長さのオーディオソースオブジェクトの、ID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.maxDurationSource.trimmedDuration number トリムした最長のソースの、durationを秒単位で示します。
logs[...].platform.audioSourceTrimValues object オーディオソースをトリムした時間の範囲。
logs[...].platform.audioSourceTrimValues.trimBegin number トリム開始の時間値を、秒単位で示します。
logs[...].platform.audioSourceTrimValues.trimEnd number トリム終了の時間値を、秒単位で示します。
logs[...].platform.maxRadiusAttenuation object 半径が最大の減衰。これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。
logs[...].platform.maxRadiusAttenuation.id string 半径が最大の減衰オブジェクトの、ID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.maxRadiusAttenuation.radius number 減衰オブジェクトの半径。
logs[...].platform.audioSourceLanguage object オーディオソースに関連付けられたランゲージ。これは、Audio Sourceオブジェクトに、直接適用されるだけです。
logs[...].platform.audioSourceLanguage.id string Audio Sourceオブジェクトに関連するLanguageオブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.audioSourceLanguage.name string Audio Sourcオブジェクトか関連付けられているLanguageオブジェクトの名前。
logs[...].platform.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.
logs[...].platform.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.
logs[...].platform.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.
logs[...].platform.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.
logs[...].platform.originalAnonymousChannelCount number The number of anonymous channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.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.
logs[...].platform.originalChannelMask number The mask associated with the channel's configuration. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalSampleRate number The sample rate for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.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.
logs[...].platform.originalFileSize number The file size in bytes for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalDataSize number The data size for bytes the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalSampleCount number The number of samples in the audio file. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.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.
logs[...].platform.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.
logs[...].platform.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.
logs[...].platform.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.
logs[...].platform.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.
logs[...].platform.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.
logs[...].platform.convertedAnonymousChannelCount number The number of anonymous channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.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.
logs[...].platform.convertedChannelMask number The mask associated with the channel's configuration. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedSampleRate number The sample rate for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.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.
logs[...].platform.convertedFileSize number The file size in bytes for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedDataSize number The data size for bytes the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedSampleCount number The number of samples in the audio file. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.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.
logs[...].platform.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.
logs[...].platform.workunitIsDefault boolean ワークユニットがデフォルトであれば、true。
logs[...].platform.workunitType string Work Unitのタイプ。なお、Work Unitsと同様に、物理フォルダにも"WorkUnit"というタイプがあります。物理フォルダには、workunitType "folder"があります。可能な値:
  • folder
  • rootFile
  • nestedFile
logs[...].platform.workunitIsDirty boolean Work UnitまたはProject（wprojファイル）がダーティである場合、つまり変更したあとに保存していない場合は、true。
logs[...].platform.switchContainerChildContext object Switch Containerの子に関連付けられた、コンテキストオブジェクト。子に関連する、Switch Containerのコンテキストに依存するプロパティを、このオブジェクトが保持します（例えば、'1st only'チェックボックスのプロパティなど）。
logs[...].platform.switchContainerChildContext.id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.isExplicitMute boolean Whether or not the object has been muted explicitly. Explicitly muting an object implicitly mutes the descendant objects.
logs[...].platform.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.
logs[...].platform.isImplicitMute boolean Whether or not the object has been muted implicitly. Explicitly muting an object implicitly mutes the descendant objects.
logs[...].platform.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.
logs[...].platform.isIncluded boolean Whether or not the object is Included. 選択肢からプラットフォームを指定。This takes into consideration the Inclusion status of the object's ancestors.
logs[...].platform.points array This only applies to Curve objects.
An array of points defining a curve.
logs[...].platform.points [...] object カーブ上の点。
logs[...].platform.points[...].x * number カーブの点の、X座標。
logs[...].platform.points[...].y * number カーブの点の、Y座標。
logs[...].platform.points[...].shape * string この点から、次の点までの、カーブセグメントの形状。可能な値:
  • Constant
  • Linear
  • Log3
  • Log2
  • Log1
  • InvertedSCurve
  • SCurve
  • Exp1
  • Exp2
  • Exp3
logs[...].platform.stateProperties array An array of state properties to set.
logs[...].platform.stateProperties [...] string The name of the property to set.
logs[...].platform.stateGroups array The State Group objects associated with this object.
logs[...].platform.stateGroups [...] object A State Group object.
logs[...].platform.stateGroups[...].id string The ID (GUID) of the State Group object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
logs[...].platform.stateGroups[...].name string The name of the State Group object.
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) any of: クエリを構成し、プロパティ値またはオブジェクトリファレンスを出す、ドット区切りのアクセサを指定します。1つの@マークは、関連するオブジェクトのプロパティ値を示します。2つの@マークは、ソースがオーバーライドするプロパティ値を示します。使用可能なすべてのタイプの、プロパティやリファレンスの詳細については、 Wwiseオブジェクトリファレンス を参照してください。
string 文字列値。
array An array of string values.
number 数値。
array An array of numeric values.
boolean ブール値。
array An array of boolean values.
object オブジェクトのリファレンス値。
array オブジェクトリストのリファレンス値。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] string 文字列値。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] number 数値。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] boolean ブール値。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).name string オブジェクト名。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] object オブジェクトのリファレンス値。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].name string オブジェクト名。
logs[...].parameters array ログアイテム内のパラメータのアレイ。これは、パラメータがなければ存在しません。
logs[...].parameters [...] string ログエントリのパラメータ。通常は、オブジェクト名です。

結果スキーマ

関連情報

例

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

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

サポートは必要ですか？

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

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

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

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

Wwiseからはじめよう