Merge pull request #66 from microsoft/user/ashtat/AddQuickStart

Added a quick start doc
This commit is contained in:
Ashu Tatake 2022-01-11 21:29:01 -08:00 коммит произвёл GitHub
Родитель 6e038f0ccd c5fe38e4c6
Коммит 5884ae1c2f
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 52 добавлений и 0 удалений

Двоичные данные
Documentation/Images/AudioObjectSettings.png Normal file

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 43 KiB

Двоичные данные
Documentation/Images/ProjectSettings.png Normal file

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 59 KiB

Двоичные данные
Documentation/Images/SpatializerMixerSetup.png Normal file

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 36 KiB

Просмотреть файл

@ -0,0 +1,52 @@
# How to add the plugin to Unity projects
## 1. Add the spatializer package reference to manifest.json
This is the recommended way to add the plugin package to a project.
- Open the `manifest.json` file from the project in a text editor
- Add Microsoft's scoped registry and the package reference
<pre>
{
"scopedRegistries": [
{
"name": "Microsoft Spatializer",
"url": "https://microsoft.pkgs.visualstudio.com/Analog/_packaging/MixedReality-UPM-Internal/npm/registry/",
"scopes": [
"com.microsoft.spatialaudio"
]
},
...
],
"dependencies": {
...
"com.microsoft.spatialaudio.spatializer.unity": "2.0.5-prerelease",
...
}
}
</pre>
For an example, see the [sample project manifest.](../samples/MicrosoftSpatializerSample/Packages/manifest.json)
The plugin package can also be downloaded from GitHub releases and imported into the project using `Assets > Import Package > Custom Package` menu.
## 2. Configure the project to use Microsoft Spatializer
- Open the project settings using `Edit > Project Settings`
- In the `Audio` tab, select `Microsoft Spatializer` in the `Spatializer Settings` dropdown. No other changes are necessary.
![Project Settings](./Images/ProjectSettings.png)
## 3. Add the Microsoft Spatializer Mixer to the project
`Microsoft Spatializer Mixer` effect is necessary to process all the spatialized audio objects in a scene.
- Add an audio mixer to the project
- In the `Project` pane, right-click on the `Assets` folder, then `Create > Audio Mixer`
- Give the mixer a name, e.g. `Master`
- Open the mixer and right-click, then select `Add effect at bottom > Microsoft Spatializer Mixer`
![Microsoft Spatializer Mixer](./Images/SpatializerMixerSetup.png)
## 4. Spatialize audio objects
- Setup spatialized audio objects as usual, making sure to route the `Output` to the `Master` audio mixer setup above.
![Audio Object Settings](./Images/AudioObjectSettings.png)