Creating Audio Plug-ins

Wwise SDK 2024.1.3

You can create plug-ins with a Python script included with Wwise. Before you do so, ensure that the \Scripts\Build\Plugins directory is writable and not under source control (see Using Wwise with your source control system for more information).

To create a new plug-in, run the following commands and answer the prompts:

python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" new

以下は、セッションの例です:

> python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" new
plug-in type {source, sink, object_processor, mixer, effect}: effect
Do you need to do out-of-place processing?(no)
project name: MyNewFX
display name: (MyNewFX) My New FX
author: Audio Kinetic
description: A brand new effect plug-in
About to create project with:
{'author': 'Audio Kinetic',
 'description': 'A brand new effect plug-in.',
 'display_name': 'My New FX',
 'name': 'MyNewFX',
 'out_of_place': False,
 'type': 'effect'}
Is this OK?(yes)
Generating project structure for MyNewFX

これで、プラグインのカレントワーキングディレクトリの名前がついたディレクトリが作成されます。作成するプラグインタイプのためのスケルトンが、ディレクトリに入っています。

MyNewFX/
├── FactoryAssets
│   └── Manifest.xml
├── Help
├── MyNewFXConfig.h
├── PremakePlugin.lua
├── SoundEnginePlugin
│   ├── MyNewFXFX.cpp
│   ├── MyNewFXFX.h
│   ├── MyNewFXFXFactory.h
│   ├── MyNewFXFXParams.cpp
│   ├── MyNewFXFXParams.h
│   └── MyNewFXFXShared.cpp
├── WwisePlugin
│   ├── MyNewFX.def
│   ├── MyNewFX.xml
│   ├── MyNewFXPlugin.cpp
│   ├── MyNewFXPlugin.h
│   └── Win32
│       ├── MyNewFXPluginGUI.cpp
│       └── MyNewFXPluginGUI.h
│   └── res
│       └── Md
│           └── en
│               └── Placeholder.md
├── additional_artifacts.json  
└── bundle_template.json

これらのファイルやディレクトリの目的は、以下の通りです:

PremakePlugin.lua -> プラグインの、特定プラットフォーム用ソリューションを生成するのに使うPremakeファイル。
ProjectNameConfig.h -> プラグインのグローバル識別変数を含むヘッダファイル。Company IDやPlugin IDをここで変更できます。
WwisePlugin -> プラグインのオーサリング部分を含むディレクトリで、Authoringアプリケーションが動的ライブラリとして使います。
- ProjectName.def -> プラグインライブラリをエクスポートするために使うDLLモジュール定義ファイル（Windows限定）。
- ProjectName.xml -> プラグインのいくつかの面についての情報が入った、定義ファイル。詳細は Wwiseプラグイン XML 記述ファイルを参照してください。
- ProjectNamePlugin.h/.cpp -> プラグインのバックエンド部分を実装するクラス。詳細は Authoring Plug-in Library Format を参照してください。
- Win32/ProjectNamePluginGUI.h/.cpp -> WindowsでAuthoring用プラグインのフロントエンド部分を実装するクラス。詳細は Authoring Plug-in Library Format を参照してください。
- res/Md/en directory -> プラグインのプロパティのドキュメンテーションを、HTMLフォーマットでビルドするのに使うファイル。
SoundEnginePlugin -> プラグインのサウンドエンジンの部分が入っているディレクトリ。あなたのゲームでサウンドエンジンが使うもので、静的ライブラリまたは共有ライブラリとしてビルドできます。
- PluginNameFactory.h -> プラグインの登録マクロが入った、ファクトリヘッダ。
- PluginNameParams.h/.cpp -> プラグインパラメータのインターフェース。詳細はパラメータノードインターフェースの実装を参照してください。
- PluginNameShared.cpp -> プラグインの動的ライブラリのエクスポートシンボルを定義。
- PluginName.h/.cpp -> プラグインのサウンドエンジン部分を実装するクラス。詳細はオーディオプラグインサウンドエンジン部分の記述を参照してください。
FactoryAssets -> プラグインと一緒にインストールするファクトリーアセトの入ったディレクトリ。このディレクトリにあるManifest.xmlファイルが、プロジェクトに含めるファクトリーアセットの、必要な依存性を指定します。
Help -> パッケージして Authoring/Help/<PluginName> フォルダにインストールされる、プラグインのドキュメンテーションファイルを含むディレクトリ。
additional_artifacts.json -> パッケージする追加ファイルのパスのリストがある、JSONファイル。
bundle_template.json -> プラグインのバンドルを作成するときに使う、プラグインのメタデータが入ったJSONファイル。

プラグインを書く準備が完了しました！オーディオプラグインの書き方については、オーディオプラグインを参照してください。

info

注釈: プラグインツールは、Plug-in IDを生成するのにプラグイン名のハッシュを使います。ユーザーがCompany IDやPlug-in IDを変更する場合は、ユーザーがそれらを次の3つのファイルで変更する必要があります: ProjectNameConfig.h、FactoryAssets/Manifest.xml、WwisePlugin/ProjectName.xml。

info

注釈: 同じ設定を使った複数のプラグインを生成するときにあるタスクを自動化したければ、プロンプトをコマンドライン引数として出せば事前入力できます。

python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" new [--sink | --mixer | --object_processor | --source | --effect] [--out-of-place] [-a AUTHOR] [-d DESCRIPTION] [-t DISPLAY_NAME] [-n NAME] [--no-prompt]

各引数の意味については、 new コマンドのヘルプを参照してください。

python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" new -h

次のセクション: プリメイクでプロジェクトを設定する

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

サポートは必要ですか？

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

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

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

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

Wwiseからはじめよう