Wwise SDK 2021.1.14
|
1つのSoundBankを生成したときに、送られます。SoundBankの生成中に、SoundBankが生成されるたびに、そしてプラットフォームが生成されるたびに、何回も送ることができます。SoundBankの生成方法については、 ak.wwise.core.soundbank.generate 、またはSoundBank生成コマンドの ak.wwise.ui.commands.execute を参照してください。コマンドのリストについては、 Wwise Authoring Commandの識別子 を参照してください。
Name | タイプ | 概要 |
---|---|---|
infoFile | boolean | レスポンスに、JSON SoundBankのinfoファイルを埋め込みます。 |
bankData | boolean | レスポンスに、base64 SoundBankのデータを埋め込みます。 |
pluginInfo | boolean | レスポンスに、JSON PluginInfoファイルを埋め込みます。 |
return | array | 生成されたSoundBankについて、データを返します。使用可能なプロパティの詳細については、 Wwiseオブジェクトリファレンス を参照してください。 return式のアレイで、Wwiseオブジェクトのどのエレメントを返すのかを定義します。例えば、名前やIDなどの内蔵アクセサや、VolumeやPitchなどのオブジェクトプロパティが含まれます。 |
return [...] | any of: | return式。 |
string | Wwiseオブジェクト用の内蔵アクセサを、1つまたは複数、指定します。可能な値:
|
|
string | クエリを構成し、値またはオブジェクトリファレンスを出す、ドット区切りのアクセサを、1つまたは複数、指定します。1つの@マークを指定すると、関連するオブジェクトのプロパティ値を返します。2つの@マークを指定すると、オーバーライドのソースのプロパティ値を返します。 Wwiseオブジェクトリファレンス を参照してください。 |
Name | タイプ | 概要 |
---|---|---|
soundbank | object | 生成されたSoundBank。詳細を取得するには、returnオプションを使います。 Wwiseオブジェクト。必須のプロパティを指定するには、returnオプションを使います。 |
soundbank.id | string | オブジェクトのID(GUID)。 オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。 |
soundbank.name | string | オブジェクト名。 |
soundbank.notes | string | オブジェクトのnotes。 |
soundbank.type | string | オブジェクトのタイプ。使用可能なタイプの詳細については、 Wwiseオブジェクトリファレンス を参照してください。 |
soundbank.pluginName | string | Source、Effect、Mixer、Device、Metadataプラグインの、プラグイン名。 |
soundbank.path | string | プロジェクトルートからオブジェクトへのパス。例: '\Actor-Mixer Hierarchy\Default Work Unit\Sound1' |
soundbank.parent | object | 階層におけるオブジェクトの親。 |
soundbank.parent.id | string | オブジェクトのID(GUID)。 オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。 |
soundbank.parent.name | string | オブジェクト名。 |
soundbank.owner | object | オブジェクトのオーナー。カスタムエフェクトやカスタム減衰など、ほかのオブジェクトにローカルで所有されているオブジェクトが、該当します。 |
soundbank.owner.id | string | オブジェクトのID(GUID)。 オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。 |
soundbank.owner.name | string | オブジェクト名。 |
soundbank.isPlayable | boolean | オブジェクトをTransportで再生できる場合は、trueです。 |
soundbank.shortId | integer | オブジェクトのShort ID。 |
soundbank.classId | integer | オブジェクトのクラスID。 符号なし整数32-bit。Range: [0,4294967295] |
soundbank.category | string | オブジェクトのカテゴリ。例: 'Actor-Mixer Hierarchy' |
soundbank.filePath | string | オブジェクトを含むファイルへのパス。パスは、Work Unitファイルまたはプロジェクトファイルとします。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。 |
soundbank.workunit | object | オブジェクトを含む、親Work Unit。'id'と'name'を返します。 |
soundbank.workunit.id | string | オブジェクトのID(GUID)。 オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。 |
soundbank.workunit.name | string | オブジェクト名。 |
soundbank.childrenCount | number | このオブジェクトの子の数。 |
soundbank.totalSize | integer | このオブジェクトと、その全ての子が、SoundBankに占めるスペース(単位byte)。objectSizeは含まれません。なお、正確な値を得るには、SoundBankを生成する必要があります。 |
soundbank.mediaSize | integer | このオブジェクトとその全ての子のメディアファイルの、変換後の合計サイズ(単位bytes)。なお、正確な値を得るには、SoundBankを生成する必要があります。 |
soundbank.objectSize | integer | このオブジェクトのメタデータがSoundBankに占めるスペース(単位byte)。メディアファイルは含まれません。なお、正確な値を得るには、SoundBankを生成する必要があります。 |
soundbank.structureSize | integer | このオブジェクトとその全ての子のメタデータが、SoundBankに占めるスペース(単位byte)。メディアファイルは含まれません。なお、正確な値を得るには、SoundBankを生成する必要があります。 |
soundbank.musicTransitionRoot | object | ミュージックトランジションのルートで、ほかの全てのミュージックトランジションを、再帰的に含みます。 |
soundbank.musicTransitionRoot.id | string | オブジェクトのID(GUID)。 オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。 |
soundbank.musicPlaylistRoot | object | ミュージックトランジションのルートで、ほかの全てのミュージックプレイリストアイテムを、再帰的に含みます。これが適用されるのは、Music Playlist Containerだけです。 |
soundbank.musicPlaylistRoot.id | string | オブジェクトのID(GUID)。 オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。 |
soundbank.originalWavFilePath | string | 元のwavファイルへの絶対パス。これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。 |
soundbank.convertedWemFilePath | string | 変換後のwemファイルへの絶対パス。選択肢からプラットフォームを指定。これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。 |
soundbank.soundbankBnkFilePath | string | SoundBankオブジェクトに関連する、生成後のSoundBankファイルへの絶対パス。これは、SoundBankオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。 |
soundbank.playbackDuration | object | 最小と最大のdurationと、durationタイプを含む、durationルート。これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。 |
soundbank.playbackDuration.playbackDurationMin | number | 再生にかかる最短時間。 |
soundbank.playbackDuration.playbackDurationMax | number | 再生にかかる最長時間。 |
soundbank.playbackDuration.playbackDurationType | string | durationタイプ。 |
soundbank.maxDurationSource | object | 最長のdurationのオーディオソース。これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。 |
soundbank.maxDurationSource.id | string | 最長の長さのオーディオソースオブジェクトの、ID(GUID)。 オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。 |
soundbank.maxDurationSource.trimmedDuration | number | トリムした最長のソースの、durationを秒単位で示します。 |
soundbank.audioSourceTrimValues | object | オーディオソースをトリムした時間の範囲。 |
soundbank.audioSourceTrimValues.trimBegin | number | トリム開始の時間値を、秒単位で示します。 |
soundbank.audioSourceTrimValues.trimEnd | number | トリム終了の時間値を、秒単位で示します。 |
soundbank.maxRadiusAttenuation | object | 半径が最大の減衰。これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。 |
soundbank.maxRadiusAttenuation.id | string | 半径が最大の減衰オブジェクトの、ID(GUID)。 オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。 |
soundbank.maxRadiusAttenuation.radius | number | 減衰オブジェクトの半径。 |
soundbank.audioSourceLanguage | object | オーディオソースに関連付けられたランゲージ。これは、Audio Sourceオブジェクトに、直接適用されるだけです。 |
soundbank.audioSourceLanguage.id | string | Audio Sourceオブジェクトに関連するLanguageオブジェクトのID(GUID)。 オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。 |
soundbank.audioSourceLanguage.name | string | Audio Sourcオブジェクトか関連付けられているLanguageオブジェクトの名前。 |
soundbank.workunitIsDefault | boolean | ワークユニットがデフォルトであれば、true。 |
soundbank.workunitType | string | Work Unitのタイプ。なお、Work Unitsと同様に、物理フォルダにも"WorkUnit"というタイプがあります。物理フォルダには、workunitType "folder"があります。可能な値:
|
soundbank.workunitIsDirty | boolean | Work UnitまたはProject(wprojファイル)がダーティである場合、つまり変更したあとに保存していない場合は、true。 |
soundbank.switchContainerChildContext | object | Switch Containerの子に関連付けられた、コンテキストオブジェクト。子に関連する、Switch Containerのコンテキストに依存するプロパティを、このオブジェクトが保持します(例えば、'1st only'チェックボックスのプロパティなど)。 |
soundbank.switchContainerChildContext.id | string | オブジェクトのID(GUID)。 オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。 |
soundbank.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$) | any of: | クエリを構成し、プロパティ値またはオブジェクトリファレンスを出す、ドット区切りのアクセサを指定します。1つの@マークは、関連するオブジェクトのプロパティ値を示します。2つの@マークは、ソースがオーバーライドするプロパティ値を示します。使用可能なすべてのタイプの、プロパティやリファレンスの詳細については、 Wwiseオブジェクトリファレンス を参照してください。 |
string | 文字列値。 | |
number | 数値。 | |
boolean | ブール値。 | |
object | オブジェクトのリファレンス値。 | |
array | オブジェクトリストのリファレンス値。 | |
soundbank.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}。 |
soundbank.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$).name | string | オブジェクト名。 |
soundbank.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$) [...] | object | オブジェクトのリファレンス値。 |
soundbank.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}。 |
soundbank.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$)[...].name | string | オブジェクト名。 |
platform | object | このSoundBankを生成したプラットフォーム。 |
language | object | このSoundBankを生成したランゲージ。特定のランゲージ用にSoundBankを生成したときに限り、表示されます。 |
error | string | エラーが発生した場合の、エラーメッセージ。エラーが発生した場合に限り、表示されます。 |
bankData | object | base64でエンコードした実際のデータとサイズを含む、SoundBankデータオブジェクト。 |
bankData.data | string | base64でエンコードした、SoundBankのデータ。 |
bankData.size | integer | デコードしたSoundBankデータのサイズ。 |
bankInfo | array | SoundBankの全ての情報。 |
bankInfo [...] | object | SoundBankの情報。 |
bankInfo[...].Id | string | 結果として得られるバンクのShort IDを、文字列にエンコードしたもの。 |
bankInfo[...].GUID | string | 結果として得られるSoundBankのGUID。 オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。 |
bankInfo[...].ObjectPath | string | プロジェクト内のオブジェクトパス。 |
bankInfo[...].Language | string | このSoundBankで使われるランゲージの名前。 |
bankInfo[...].ShortName | string | SoundBankの名前。 |
bankInfo[...].Path | string | SoundBankのファイル名。 |
bankInfo[...].IncludedEvents | array | このSoundBankに含まれる全てのイベントと、その情報。 |
bankInfo[...].IncludedEvents [...] | object | イベントの情報 |
bankInfo[...].IncludedEvents[...].Id | string | イベントのShort ID。 |
bankInfo[...].IncludedEvents[...].Name | string | イベントの名前。 |
bankInfo[...].IncludedEvents[...].GUID | string | イベントのGUID。 オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。 |
bankInfo[...].IncludedEvents[...].MaxAttenuation | string | イベントの最大の減衰を、浮動小数点値として。 |
bankInfo[...].IncludedEvents[...].DurationType | string | durationの種類、可能な値: OneShot、Unknown、Infinite、Mixed。 |
bankInfo[...].IncludedEvents[...].DurationMin | string | durationの最小値を、浮動小数点値として。 |
bankInfo[...].IncludedEvents[...].DurationMax | string | durationの最大値を、浮動小数点値として。 |
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles | array | このSoundBankまたはイベントによって使われる、全てのストリーミングファイルのリスト。 |
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles [...] | object | 参照するStreamed Fileエントリ Media Fileリファレンス |
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].Id | string | メディアのShort ID。 |
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].Language | string | このメディアに使われるランゲージ名。 |
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].ShortName | string | 元ファイルのファイル名。 |
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].Path | string | キャッシュフォルダに対する、変換後のメディアの相対パス。 |
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].PrefetchSize | string | プリフェッチのサイズの、bytesサイズ。 |
bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].UseDeviceMemory | string | このメディアが、デバイスメモリを必要とするか否か。可能な値:
|
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles | array | SoundBankまたはイベントで、除外されたメディア。ストリーミングファイルで、プリフェッチを使用中であれば、プリフェッチのサイズがこのリストに含まれます。 |
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles [...] | object | 除外されたMemory Fileエントリ Media Fileリファレンス |
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].Id | string | メディアのShort ID。 |
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].Language | string | このメディアに使われるランゲージ名。 |
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].ShortName | string | 元ファイルのファイル名。 |
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].Path | string | キャッシュフォルダに対する、変換後のメディアの相対パス。 |
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].PrefetchSize | string | プリフェッチのサイズの、bytesサイズ。 |
bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].UseDeviceMemory | string | このメディアが、デバイスメモリを必要とするか否か。可能な値:
|
PluginInfo | object | PluginInfoのファイルinfo |
PluginInfo.Project | string | Wwiseプロジェクトの名前。 |
PluginInfo.Platform | string | プラットフォームの名前。 |
PluginInfo.BasePlatform | string | 現在のプラットフォームの基となる、ベースプラットフォーム。 |
PluginInfo.Plugins | array | プラグインのリスト |
PluginInfo.Plugins [...] | object | プラグイン情報。 |
PluginInfo.Plugins[...].Name | string | プラグインのディスプレイネーム。 |
PluginInfo.Plugins[...].ID | string | プラグインのShort ID。 |
PluginInfo.Plugins[...].DLL | string | プラグインのDLLの名前。 |
Wwise Authoring APIの詳細は、 Wwise Authoring API (WAAPI)を使用する を参照してください。