Wwise Authoring APIを使用してWwiseオブジェクトを作成するには、いくつかの方法があります。
Wwise オブジェクトの作成
It is possible to create most Wwise Objects using ak.wwise.core.object.create and ak.wwise.core.object.set. 制限についての詳細は、 Limitations with ak.wwise.core.object.create and ak.wwise.core.object.set を参照してください。
名前の衝突モードを理解します
When calling ak.wwise.core.object.create, or ak.wwise.core.object.set, it is possible to specify one of the four name conflict modes.
同じ名前の宛先にすでにオブジェクトが存在する場合は、次のようにします：
- fail：create関数はエラーを返します。
- replace：送信先のオブジェクトが削除され（子オブジェクトを含む）、新しいオブジェクトが作成されます。
- rename：新しいオブジェクトに新しい固有の名前が自動的に割り当てられ、番号が追加されます。
- merge：宛先のオブジェクトが再利用され、指定されたプロパティ、参照、子オブジェクトがデスティネーションにマージされ、残りのオブジェクトはそのまま残ります。
Understanding lists and list modes
Lists are generic containers for storing objects. The objects in a given list are typically of the same type. Lists provide a convenient mechanism for populating and retrieving objects through WAAPI that are "owned" by another object. For example, the RTPCs for a given object are contained in the "RTPC" list of that object.
When calling ak.wwise.core.object.set, it is possible to specify one of two list modes.
If a list already contains objects:
- append: Add the new objects to the list if possible, keeping existing objects. Some lists might not permit duplicate equivalent objects: e.g., some properties of RTPCs in the RTPC list are exclusive so there can only be one RTPC with that property.
- replaceAll: Remove all existing objects and add the new objects, with the duplicate restriction.
For empty lists the behavior is to append.
Limitations with ak.wwise.core.object.create and ak.wwise.core.object.set
サウンド
It is possible to create Sound objects using ak.wwise.core.object.create and ak.wwise.core.object.set. However, there are significant limitations:
- It is not possible to associate an original WAV or MIDI file with a child Audio File Source object.
- It is not possible to associate a language with a child Audio File Source object.
- It is, however, possible to associate a Source plug-in with a child of a Sound object using ak.wwise.core.object.set.
For this reason, we don't recommend using ak.wwise.core.object.create and ak.wwise.core.object.set to create Sound objects that use WAV or MIDI files until these limitations are resolved in a future release of Wwise. Instead refer to オーディオファイルのインポート and ak.wwise.core.audio.import.
Work Units
Creating Work Units with ak.wwise.core.object.create and ak.wwise.core.object.set requires the undo/redo history and the clipboard to be cleared. Work Unitは作成と同時に保存されるので、その結果、対応するWWUファイルがプロジェクトに作成されます。
onNameConflict 引数は、必ず 'fail' 、 'merge' 、または 'rename' とします。 'replace' モードには対応していません。
Queries
It is not possible to create Query objects with ak.wwise.core.object.create and ak.wwise.core.object.set.
Plug-ins
It is not possible to create plug-ins of the type Source, Effect, or Metadata with ak.wwise.core.object.create.
Lists
It is not possible to create objects to populate the "Metadata" and "Clips" lists with ak.wwise.core.object.set.
- Metadata are plug-ins which cannot be created.
- Clips require an AudioSourceRef which cannot be specified.
Due to the limitations below we do not recommend creating objects in the "Sequences" and "Stingers" lists with ak.wwise.core.object.set.
- Without the ability to assign a Segment to a stinger through WAAPI we do not recommend creating a Stinger in the "Stingers" list.
- Without the ability to create a MusicClip through WAAPI we do not recommend creating a MusicSequence in the "Sequences" list.
ak.wwise.core.object.create を使用して単一のActor-Mixerを作成します
詳細は、 ak.wwise.core.object.create を参照してください。
{
"parent": "{a9129d80-07e0-11e7-93ae-92361f002671}",
"type": "ActorMixer",
"name": "My Actor-Mixer",
"children": []
}
| info | 注釈: 親フィールドは、プロジェクト内でオブジェクトを作成する場所を示します。親フィールドは、Wwiseオブジェクトのほぼすべてのフィールドと同様に、object id (GUID) やオブジェクトパスをサポートします。オブジェクトIDを回収するには、 ak.wwise.core.object.get を参照してください。たとえば、プロジェクトパスでオブジェクトIDを回収できます。 |
| info | 注釈: WwiseプロジェクトからオブジェクトIDを回収するには、SHIFTキーを押しながらオブジェクトを右クリックして、GUIDをクリップボードにコピーする（Copy GUID）を選択します。 |
ak.wwise.core.object.create を使用して、プロパティを持つオブジェクトの階層を作成します。
詳細は、 ak.wwise.core.object.create を参照してください。
{
"parent": "{a9129d80-07e0-11e7-93ae-92361f002671}",
"type": "ActorMixer",
"name": "Weapons",
"@Volume": "-2",
"children": [
{
"type": "RandomSequenceContainer",
"name": "BigGun",
"@RandomOrSequence": "1",
"children": [
{
"type": "Sound",
"name": "Gun1",
},
{
"type": "Sound",
"name": "Gun2",
}
]
}
]
}
ak.wwise.core.object.createを使用してEventを作成します
詳細は、 ak.wwise.core.object.create を参照してください。
{
"parent": "\\Events\\Default Work Unit",
"type": "Folder",
"name": "WAAPI",
"onNameConflict": "merge",
"children": [
{
"type": "Event",
"name": "Play_SFX",
"children": [
{
"name": "",
"type": "Action",
"@ActionType": 1,
"@Target": "\\Actor-Mixer Hierarchy\\Default Work Unit\\SFX"
}
]
}
]
}
可能なイベントプロパティやアクションタイプのリストについては、 Action を参照してください。
Using ak.wwise.core.object.set to create a single Actor-Mixer
詳細は、 ak.wwise.core.object.set を参照してください。
{
"objects": [
{
"object": "{a9129d80-07e0-11e7-93ae-92361f002671}",
"children": [
{
"type": "ActorMixer",
"name": "My Actor-Mixer"
}
]
}
]
}
| info | 注釈: The object field indicates where to create the object in the project. The object field, like most Wwise object fields, supports object IDs (GUID) and object paths. オブジェクトIDを回収するには、 ak.wwise.core.object.get を参照してください。たとえば、プロジェクトパスでオブジェクトIDを回収できます。 |
| info | 注釈: To retrieve an object ID from a Wwise project, you can hold the Shift key while right-clicking an object, then select Copy GUID(s) to clipboard. |
ak.wwise.core.object.set を使用して、プロパティを持つオブジェクトの階層を作成します。
詳細は、 ak.wwise.core.object.set を参照してください。
{
"objects": [
{
"object": "{a9129d80-07e0-11e7-93ae-92361f002671}",
"children": [
{
"type": "ActorMixer",
"name": "Weapons",
"@Volume": "-2",
"children": [
{
"type": "RandomSequenceContainer",
"name": "BigGun",
"@RandomOrSequence": "1",
"children": [
{
"type": "Sound",
"name": "Gun1"
},
{
"type": "Sound",
"name": "Gun2"
}
]
}
]
}
]
}
]
}
ak.wwise.core.object.set を使用してEventを作成します
詳細は、 ak.wwise.core.object.set を参照してください。
{
"objects": [
{
"object": "\\Events\\Default Work Unit",
"children": [
{
"type": "Folder",
"name": "WAAPI",
"children": [
{
"type": "Event",
"name": "Play_SFX",
"children": [
{
"name": "",
"type": "Action",
"@ActionType": 1,
"@Target": "\\Actor-Mixer Hierarchy\\Default Work Unit\\SFX"
}
]
}
]
}
]
}
],
"onNameConflict": "merge"
}
Refer to Action for the list of possible Event properties and Action types.
Using ak.wwise.core.object.set to create an RTPC with curve in the RTPC list using a Custom Control Input
詳細は、 ak.wwise.core.object.set を参照してください。
{
"objects": [
{
"object": "\\Actor-Mixer Hierarchy\\Default Work Unit\\My Sound",
"@RTPC": [
{
"type": "RTPC",
"name": "",
"@Curve": {
"type": "Curve",
"points": [
{ "x": 100.0, "y": -20.82785, "shape": "Linear" },
{ "x": 10000.0, "y": 21.8509, "shape": "Linear" }
]
},
"notes": "Property: OutputBusLowpass, ControlInput: RPM",
"@PropertyName": "OutputBusLowpass",
"@ControlInput": {
"type": "ModulatorLfo",
"name": "RAND",
"@LfoWaveform": 5
}
}
]
}
]
}
Using ak.wwise.core.object.set to create objects under multiple parents in one operation
詳細は、 ak.wwise.core.object.set を参照してください。
{
"objects": [
{
"object": "{a9129d80-07e0-11e7-93ae-92361f002671}",
"children": [
{
"type": "ActorMixer",
"name": "My Actor-Mixer"
}
]
},
{
"object": "{a9129d80-07e0-11e7-93ae-92361f002671}",
"children": [
{
"type": "ActorMixer",
"name": "Weapons",
"@Volume": "-2",
"children": [
{
"type": "RandomSequenceContainer",
"name": "BigGun",
"@RandomOrSequence": "1",
"children": [
{
"type": "Sound",
"name": "Gun1"
},
{
"type": "Sound",
"name": "Gun2"
}
],
"@RTPC": [
{
"type": "RTPC",
"name": "",
"@Curve": {
"type": "Curve",
"points": [
{ "x": 100.0, "y": -20.82785, "shape": "Linear" },
{ "x": 10000.0, "y": 21.8509, "shape": "Linear" }
]
},
"notes": "RTPC on BigGun. Property: OutputBusLowpass, ControlInput: RPM",
"@PropertyName": "OutputBusLowpass",
"@ControlInput": "{E31BAE21-CFA6-4655-81F6-E6FBDC802E9D}"
}
]
}
]
}
]
}
]
}
Using ak.wwise.core.object.set to set the Name, the Notes, a property, and a reference of an Object
詳細は、 ak.wwise.core.object.set を参照してください。
{
"objects": [
{
"object": "\\Actor-Mixer Hierarchy\\Default Work Unit\\MySound",
"name": "new name",
"notes": "This object's notes are set.",
"@Volume": 5.7,
"@OutputBus": "\\Master-Mixer Hierarchy\\Default Work Unit\\Master Audio Bus\\Environment Bus"
}
]
}
Using ak.wwise.core.object.set to set the Effect0 of a sound to a newly created Custom RoomVerb Effect plug-in
詳細は、 ak.wwise.core.object.set を参照してください。
{
"objects": [
{
"object": "\\Actor-Mixer Hierarchy\\Default Work Unit\\MySound",
"@Effect0": {
"type": "Effect",
"name": "myCustomEffect",
"classId": 7733251,
"@PreDelay": 24,
"@RoomShape": 99
}
}
]
}
オーディオファイルのインポート
オーディオファイルは、Audio File ImporterのTab Delimitedインポートで使用できるのと同じインポートプロセッサを使用して、Wwise Authoring APIを使用してインポートできます。
Wwise Authoring APIを使用すると、インポートプロセスを完全に自動化し、選択したプログラミング言語で直接制御することができます。
インポート形式により大きな柔軟性が得られます。以下をインポートすることができます：:
以下が、オーディオファイルのインポート機能で可能です:
- オーディオファイルのインポート、ローカリゼーション
- Actor Mixer Hierarchyの自動作成
- Eventの作成
- Property値のアサイン、例えばVolumeなど
- 参照先のアサイン、例えばOutput Bus
詳細については https://www.audiokinetic.com/library/edge/?source=Help&id=importing_media_files_from_tab_delimited_text_fileを参照してください。
例：
WAVファイルをインポートし、関連付けられたSoundオブジェクトを作成します。
ak.wwise.core.audio.importを使い、オーディオファイルをインポートする
詳細は、 ak.wwise.core.audio.import を参照してください。
Importing multiple sounds:
{
importOperation: "createNew",
default: {
importLanguage: "SFX"
},
imports: [
{
objectPath: "\\Actor-Mixer Hierarchy\\Default Work Unit\\<Sound>MyNewSound1",
audioFile: "C:\\sources\\1.wav",
"@Volume": 0.42
},
{
objectPath: "\\Actor-Mixer Hierarchy\\Default Work Unit\\<Sound>MyNewSound2",
audioFile: "C:\\sources\\2.wav",
"@Volume": 0.1
}
]
}
Importing multiple Audio Sources in the same Sound SFX object. Note that an underscore prefix was added to one of the Audio Source to ensure it stays first when sorted and becomes the active source:
{
importOperation: "replaceExisting"
default: {
importLanguage: "SFX"
},
imports: [
{
audioFile: "D:\\sources\\Version1.wav",
objectPath: "\\Actor-Mixer Hierarchy\\Default Work Unit\\<Sound SFX>MySound\\<AudioFileSource>_MyActiveSource"
},
{
audioFile: "D:\\sources\\Version2.wav",
objectPath: "\\Actor-Mixer Hierarchy\\Default Work Unit\\<Sound SFX>MySound\\<AudioFileSource>OtherSource"
}
]
}
ak.wwise.core.audio.importを使い、オーディオファイルをローカライズする
詳細は、 ak.wwise.core.audio.import を参照してください。
サウンドボイスを英語でインポートするには:
{
importOperation: "useExisting",
default: {
importLanguage: "English(US)"
},
imports: [
{
objectPath: "\\Actor-Mixer Hierarchy\\Default Work Unit\\<Sound>MyVoice",
audioFile: "C:\\sources\\en\\Hello.wav"
}
]
}
サウンドボイスをフランス語でローカライズするには:
{
importOperation: "useExisting",
default: {
importLanguage: "French"
},
imports: [
{
objectPath: "\\Actor-Mixer Hierarchy\\Default Work Unit\\<Sound>MyVoice",
audioFile: "C:\\sources\\fr\\Hello.wav"
}
]
}
Import several Audio Sources of different languages in the same Sound Voice at the same time:
{
importOperation: "useExisting",
imports: [
{
audioFile: "D:\\sources\\hello_en.wav",
objectPath: "\\Actor-Mixer Hierarchy\\Default Work Unit\\<Sound Voice>hello\\<AudioFileSource>hello_en",
importLanguage:"EN_US"
},
{
audioFile: "D:\\sources\\hello_fr.wav",
objectPath: "\\Actor-Mixer Hierarchy\\Default Work Unit\\<Sound Voice>hello\\<AudioFileSource>hello_fr",
importLanguage:"FR_CA"
}
]
}
| info | 注釈: あなたのプロジェクトに、その言語が存在し、大文字小文字の区別も一致することを確認してください。 |